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, 2001 @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, 2001 @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, 2000 or later
176 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
177 @item Courier-IMAP 1.3.2 or later
178 @item AIR MAIL (AIRC imapd release 2.00)
180 @item Microsoft Exchange Server 5.5
181 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
184 LDAP connectivity with following LDAPd are confirmed to work with
188 @item OpenLDAP 2.0.6 or later
192 @node Start Me Up, Folders, Introduction, Top
193 @chapter Start up Wanderlust
196 The necessary procedure for starting Wanderlust is explained in steps
199 (Of course, you need a mail/news readable environment in advance)
202 * MIME Modules:: Installing the MIME modules.
203 * Download:: Download and extract the packages.
204 * Install:: Byte-compile and install.
205 * Minimal Settings:: @file{.emacs} setup.
206 * Mail Addresses:: Address book definition.
207 * Folder Definition:: Folder definition.
208 * Start Wanderlust:: Starting Wanderlust
212 @node MIME Modules, Download, Start Me Up, Start Me Up
213 @section Installing MIME modules
221 SEMI or tm must be installed to make Wanderlust work correctly. Refer
222 to the @file{INSTALL} for detailed installation procedure.
224 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
228 @node Download, Install, MIME Modules, Start Me Up
229 @section Download and Extract the Package
232 You can download Wanderlust package from following sites:
236 ftp://ftp.gohome.org/wl/
239 Mirrored ftp/http sites:
243 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
244 http://www.jpl.org/elips/wl/
245 http://www.ring.gr.jp/archives/text/elisp/wl/
246 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
247 ftp://opaopa.org/pub/mirror/elisp/wl/
248 @c ftp://roguelife.org/pub/tsumura/wl/
252 Extract the obtained package to your working directory:
257 % tar zxvf wl-@var{version}.tar.gz
258 % cd wl-@var{version}
262 @subsection To use SSL (Secure Socket Layer)
267 SSL (Secure Socket Layer) can be used for SMTP, IMAP, NNTP and POP
268 connections in Wanderlust.
270 There are two ways to use SSL. One is to start SSL negotiation just
271 after the connection establishment (generic way). The other one is to
272 start SSL negotiation by invoking STARTTLS command in the each session.
274 To use the formal SSL (generic SSL), you must install @file{ssl.el} in
275 the @file{utils} directory. OpenSSL command @command{openssl} is also
276 required to use @file{ssl.el}. You must set @env{PATH} to the directory
277 that OpenSSL commands are installed.
279 To use the latter SSL(STARTTLS), you must install starttls package in
281 You can download starttls package from the following site.
284 ftp://opaopa.org/pub/elisp/
287 @node Install, Minimal Settings, Download, Start Me Up
288 @section Byte-compile and install
295 @subsection Installation
297 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
298 Set the Emacs's command name to @code{EMACS}.
299 Set package installation directory to @code{LISPDIR}.
300 Then, please execute following commands.
309 Destination directory is auto-probed if you leave @code{LISPDIR}
310 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
312 If you are using an Emacs variant which does not merge specified
313 directory to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28), then
314 you will see the error message:
317 Cannot open load file: mime-setup
321 In this case, either add destination directories of custom, APEL, FLIM
322 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
323 @code{load-path} in @file{WL-CFG} in extracted directory.
325 If you want to use BBDB, then the necessary modules are byte-compiled
326 and installed when BBDB directory is added to @code{load-path}.
329 @subsection @file{WL-CFG}
331 Contents of the file @file{WL-CFG} is loaded under installation if a file
332 with that name exists in extracted directory. You can use @file{WL-CFG} to
333 configure @code{load-path} to extra packages such as SEMI if needed.
335 If you want to specify the install directory of Wanderlust related
336 files, then set following variables in @file{WL-CFG}
340 A directory to install WL modules.
341 This directory is relative directory from @code{LISPDIR}.
342 WL modules include @file{wl*.el}, @file{wl*.elc} files.
343 @c Modules under the directory @file{util/} are also installed if
344 @c it detected as necessary.
347 A directory to install ELMO modules.
348 This directory is relative directory from @code{LISPDIR}.
349 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
350 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
354 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
356 If you want to install ELMO related files under a sub-directory
357 such as "elmo" then add following to @file{WL-CFG}:
360 (setq ELMO_PREFIX "elmo")
363 @subsection Install as a XEmacs package
364 @cindex XEmacs package
365 @cindex XEmacs package install
366 @cindex Package, XEmacs
367 @cindex Package install, XEmacs
368 @c @cindex install-package
370 It is possible to install Wanderlust as one of packages of XEmacs (21.0
371 or later). Configuration for autoload and icon-path in local
372 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
375 Follow the next example to install Wanderlust as an XEmacs package.
381 % make install-package
385 package directory is auto-probed, if SEMI is installed.
386 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
388 @subsection Run in place
390 If wl and elmo directories are defined in @code{load-path}, then
391 byte-compilation and installation are not necessary to start Wanderlust.
392 For example, if package is extracted in @file{~/work}, Wanderlust can be
393 invoked with following setting in @file{~/.emacs}.
397 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
398 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
404 Manual is described in Info format. Please do following.
413 If you install Wanderlust as a XEmacs package, Info file is already
414 installed too, so there are no need of these commands.
416 Manual directory is automatically detected. Of course, it can be
417 configured by @code{INFODIR} in @file{Makefile}.
419 You can read manual at the following URL:
422 http://www.gohome.org/wl/doc/wl-euc_toc.html
425 @node Minimal Settings, Mail Addresses, Install, Start Me Up
426 @section Set up .emacs
427 @cindex Minimal Settings
429 @cindex Configuration
433 The Wanderlust package contains two module groups.
436 @item ELMO (elmo-*.el)
437 These modules show everything as folders. This is the back-end for WL.
439 These modules controls the behavior of main body of Wanderlust.
440 They are also the front-end for ELMO.
443 You can customize the behavior of Wanderlust by changing the value
444 of environmental variables which begins with @code{elmo-} and @code{wl-}.
446 The minimal requirement for settings is as the following.
450 ;; @r{The setting to use SEMI/tm}
453 ;; @r{autoload configuration}
454 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
455 (autoload 'wl "wl" "Wanderlust" t)
456 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
458 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
459 ;; @r{Default: @code{nil}.}
460 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
461 (setq wl-icon-dir "~/work/wl/etc")
463 ;; @r{SMTP server for mail posting. Default: @code{nil}}
464 (setq wl-smtp-posting-server "your.smtp.example.com")
465 ;; @r{NNTP server for news posting. Default: @code{nil}}
466 (setq wl-nntp-posting-server "your.nntp.example.com")
470 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
471 file exists). So it is convenient to gather Wanderlust specific settings
472 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
473 because you can't write them in @file{.emacs}
474 (if you write it to @file{.emacs}, you'll get an error).
477 All above described settings except (load "mime-setup") and autoload
478 configuration can be written in
481 @subsection @code{mail-user-agent}
482 @cindex Default Mailer
483 @cindex Mailer, Default
484 @vindex mail-user-agent
487 If you write following setting in you @file{.emacs}, you can
488 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
489 This means it enables you to run Wanderlust as a default mail composer
492 It is effective only when your Emacs can define @code{mail-user-agent}.
493 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
497 (autoload 'wl-user-agent-compose "wl-draft" nil t)
498 (if (boundp 'mail-user-agent)
499 (setq mail-user-agent 'wl-user-agent))
500 (if (fboundp 'define-mail-user-agent)
501 (define-mail-user-agent
503 'wl-user-agent-compose
511 @node Mail Addresses, Folder Definition, Minimal Settings, Start Me Up
512 @section Address book
513 @cindex Address book Definition
515 @cindex Alias, Address
517 The file @file{~/.addresses} is a simple address book for Wanderlust.
518 Make address file @file{~/.addresses}, and edit to suit your requirement.
520 The data written in @file{~/.addresses} are used for address completion
521 under draft editing mode. Furthermore, they are used when showing names
522 in summary display mode. You can safely skip this section, if you don't
523 want to customize address completion and summary display.
524 It is possible to add/change/remove addresses from @file{~/.addresses} in
525 summary buffer after Wanderlust is invoked. @refill
527 The format is very simple. Like this. @refill
532 # @r{Lines begin with @samp{#} are comment.}
533 # @r{Empty lines are ignored}
535 # @r{Format of each line:}
536 # @var{email-address} "@var{nickname} "@var{realname}"
538 teranisi@@gohome.org "YT" "Yuuichi Teranishi"
539 foo@@example.com "Mr. Foo" "John Foo"
540 bar@@example.org "Mr. Bar" "Michael Bar"
545 One line defines one persons description.
547 Actually, in default setup, @var{nickname} is used in summary-mode and
548 @var{realname} is used in draft preparation mode. This behavior is
549 better understood if you try it and confirmed the function first. You
550 can write and try a small definition, so you will know the idea of the
551 address book before writing a big one.
553 And, if MH alias file is specified in variable @code{wl-alias-file},
554 it is used as an address information in the draft preparation mode.
556 If variable @code{wl-use-ldap} is non-nil (initial setting is
557 @code{nil}), address completion in draft mode uses LDAP information.
559 If you use LDAP, you have to set @code{wl-ldap-server},
560 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
561 not have LDAP feature as built-in feature (Currently only XEmacs can
562 have built-in LDAP feature), you have to set command exec @env{PATH} to
563 the program @command{ldapsearch}.
565 @node Folder Definition, Start Wanderlust, Mail Addresses, Start Me Up
566 @section Folder Definition
567 @cindex Folder Definition
570 You can skip this section because it is possible to add/edit the
571 subscribe folders from the buffer for list of folders.
572 @xref{Folder Manager}.
574 Define the folders you want to subscribe in file @file{~/.folders}. The
575 contents written in @file{~/.folders} become the folders which you
576 subscribe to as it is.
578 Format for @file{~/.folders} is very simple. Here is an example:
583 # @r{Lines begin with @samp{#} are comment.}
584 # @r{Empty lines are ignored}
586 # @var{folder name} "@var{folder nickname}"
587 # @r{(nicknames are not necessary)}
592 %#mh/Backup@@my.imap.example.com "Sent"
595 %#mh/spool/wl "Wanderlust ML"
596 %#mh/spool/elips "ELIPS ML"
597 %#mh/spool/apel-ja "APEL Japanese ML"
598 %#mh/spool/xemacs-beta "XEmacs beta"
599 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
600 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
603 # @r{If folder name ends with @samp{/}, that means an `access group',}
604 # @r{all subfolders automatically included in one folder group.}
606 %#mh/expire@@localhost /
607 # @r{All MH folders are included in one folder group.}
612 Each line contains one folder you want to read. The definition of
613 folders will be explained in detail in the next section.
615 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
616 become one folder group. One folder group is treated as a directory
617 which can be opened and closed in folder mode. It is convenient for
618 collecting some folders and putting them in order.
620 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
621 line and you have to write it that way (It is because the parser sucks).
623 There are two types of groups. One is like @samp{Emacsen} from above
624 example which the user chooses his favorite folders as a group.
626 The other one is @dfn{access group} like @samp{+} from above example.
627 It makes all the sub-folders in a folder to a group. (It differs from
628 the type of the folder. For example, @samp{+} makes entire MH
629 sub-directories to one group)
631 This behavior is better understood if you try it and confirmed the
632 function first. You can write and try a small folder definition, so you
633 will know the idea of the folder function before writing the real one.
635 @node Start Wanderlust, , Folder Definition, Start Me Up
636 @section Start Wanderlust
637 @cindex Start Wanderlust
639 If installation and configuration worked well, you can invoke Wanderlust by
640 typing following command in Emacs.
647 After initialization, Folder Mode which shows the list of folders will appear.
648 That means the folders you defined in the @file{~/.folders} are listed
649 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
650 can skip folder checking.
653 @node Folders, Folder, Start Me Up, Top
654 @chapter Wanderlust's folders
657 This chapter describes the folder types which Wanderlust is able to handle.
659 Wanderlust uses ELMO as it's interface, so every folder types supported
660 by ELMO is usable in Wanderlust.
662 As of version @value{VERSION}, 11 types of folders are predefined. These are
663 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
664 Pipe and Internal folder types.
667 * IMAP Folder:: @samp{%} -- IMAP folder
668 * NNTP Folder:: @samp{-} -- NNTP folder
669 * MH Folder:: @samp{+} -- MH folder
670 * Maildir Folder:: @samp{.} -- Maildir folder
671 * News Spool Folder:: @samp{=} -- News spool folder
672 * Archive Folder:: @samp{$} -- Archive folder
673 * POP Folder:: @samp{&} -- POP folder
674 * Multi Folder:: @samp{*} -- Multi folder
675 * Filter Folder:: @samp{/} -- Filter folder
676 * Pipe Folder:: @samp{|} -- Pipe folder
677 * Internal Folder:: @samp{'} -- Internal folder
681 @node IMAP Folder, NNTP Folder, Folders, Folders
688 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
694 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
698 You can specify @code{login} (encoded password transmission),
699 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
700 authentication) or @code{clear} (or @code{nil}, plain password
701 transmission) as @var{authenticate-type}. (To use CRAM-MD5 or
702 DIGEST-MD5 authentication, you must install @file{utils/sasl} package if FLIM version is earlier than 1.14.0. If FLIM version is 1.14.0 or later, you need not install @file{utils/sasl})
707 @var{username} -> The value of @code{elmo-default-imap4-user}.
708 Initial setting is @env{USER} environment variable or
709 @env{LOGNAME} environment variable or return value of
710 @code{(user-login-name)}.
711 @var{authenticate-type} -> The value of @code{elmo-default-imap4-authenticate-type}.
712 Initial setting is "auth".
713 @var{hostname} -> The value of @code{elmo-default-imap4-server}.
714 Initial setting is "localhost".
715 @var{port} -> The value of @code{elmo-default-imap4-port}.
716 Initial setting is 143.
719 You can omit the @var{hostname} from folder names if you set
720 @code{elmo-default-imap4-server} as your main IMAP server.
721 For example, you can specify a folder as @samp{foo%imap@@gateway} even
722 if you have to go through a firewall.
725 ;; Example: imap4.exaple.org as main IMAP server
726 (setq elmo-default-imap4-server "imap4.example.org")
729 SSL (Secure Socket Layer) connection will be used if a folder name ends
730 with @samp{!}. Or, if the value of @code{elmo-default-imap4-stream-type}
731 is @code{ssl}, SSL will be the default connection. If a folder name
732 ends with @samp{!!}, STARTTLS connection will be established. If the
733 value of @code{elmo-default-imap4-stream-type} is @code{starttls},
734 STARTTLS will be the default connection.
737 ;; Example: Use SSL connection
738 (setq elmo-default-imap4-stream-type 'ssl)
741 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
742 authentication method, the password is sent in encoded form. But, if
743 your server is unable to receive an encoded password, authentication
744 will fall back to @code{clear} (that is, sending password in raw format)
745 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
746 authentication will fall back to @code{clear} without confirmation
747 (default value is @code{nil}).
750 ;; Example: password in raw format
751 (setq elmo-default-imap4-authenticate-type 'clear)
758 %inbox -> IMAP mailbox "inbox"
759 %#mh/inbox -> IMAP mailbox "#mh/inbox"
761 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
762 %inbox:hoge/clear@@server1
763 -> server1's IMAP mailbox "inbox"
764 of user "hoge", with plain password authentication
769 @subsection International mailbox names (Modified UTF7)
770 @cindex Modified UTF7
777 You can use international mailbox names in @var{mailbox} part, if you
778 are using Emacs which can treat unicode and
779 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
780 value is @code{nil}).
782 Currently, following Emacsen can treat unicode.
785 @item Emacs 20.3 or later + Mule-UCS
787 If you installed Mule-UCS package, Emacs can treat unicode.
788 You can obtain Mule-UCS package from following URL.
791 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
794 @item XEmacs 21.2.13 or later + ucs-conv package
796 By default, XEmacs 21 cannot treat unicodes, but if you installed
797 ucs-conv package, it can.
798 You can obtain ucs-conv package from following anonymous CVS.
802 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
803 Password: @var{NULL} (Just enter return key)
804 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
808 You also need utf7 conversion programs, @command{u7tou8} and
809 @command{u8tou7} to use international mailbox name in the current
810 XEmacs. These programs are included in the UTF7 package which can be
811 obtained from following URL.
814 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
818 @node NNTP Folder, MH Folder, IMAP Folder, Folders
823 A folder to access USENET news via NNTP protocol (RFC 977).
824 One newsgroup is treated as a folder.
830 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
836 @var{hostname} -> The value of @code{elmo-default-nntp-server}.
837 Initial setting is @samp{localhost}.
838 @var{username} -> The value of @code{elmo-default-nntp-user}.
839 Initial setting is @code{nil}.
840 @var{port} -> The value of @code{elmo-default-nntp-port}.
841 Initial setting is 119.
844 AUTHINFO is used as authentication method if the @var{username} is non-nil.
845 SSL will be default method if @code{elmo-default-nntp-stream-type} is non-nil even
846 if the folder name doesn't end with @samp{!}.
847 If a folder name ends with @samp{!!}, STARTTLS connection will be established.
848 if the value of @code{elmo-default-nntp-stream-type} is @code{starttls},
849 STARTTLS will be the default connection.
855 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
856 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
860 @node MH Folder, Maildir Folder, NNTP Folder, Folders
866 A folder to access MH format mail (1 file is 1 mail).
871 @samp{+} @var{directory-name}
874 Normally, @var{directory-name} is an relative path to the variable
875 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
876 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
877 (this is also true for drive-letters).
879 Message number is used for the name of the message file.
885 +inbox -> @file{~/Mail/inbox}
886 +from/teranisi -> @file{~/Mail/from/teranisi}
887 +~/test -> @file{~/test}
891 @node Maildir Folder, News Spool Folder, MH Folder, Folders
892 @section Maildir Folder
893 @cindex Maildir Folder
897 A folder to access to Maildir format (1 file is 1 mail).
902 @samp{.} [@var{directory-name}]
905 Normally, @var{directory-name} is a relative path to the variable
906 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
907 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
908 (this is also true for drive-letters).
910 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
911 Messages are contained in the @file{cur} directory. All message files
912 in the @file{new} directory are moved to @file{cur} directory when you
913 access to the folder. All message files contained in the @file{tmp}
914 directory and not accessed for 36 hours are deleted.
916 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
922 . -> @file{~/Maildir}
923 .inbox -> @file{~/Maildir/inbox}
924 .from/teranisi -> @file{~/Maildir/from/teranisi}
925 .~/test -> @file{~/test}
930 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
931 @section News Spool Folder
932 @cindex News spool Folder
936 This folder handles locally saved news articles which are proposed by
937 Mew/IM. You can also read articles directly from a spool-file which is
938 retrieved by an utility like @command{gnspool}.
943 @samp{=} @var{directory-name}
946 @var{directory-name} is a sub-directory to the directory defined by
947 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
948 You can use @samp{.} as directory delimiter as well as @samp{/}.
954 =fj/os/os2 -> @file{~/News/fj/os/os2}
955 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
960 @node Archive Folder, POP Folder, News Spool Folder, Folders
961 @section Archive Folder
962 @cindex Archive Folder
966 This method can handle archive files, which are compressed by utilities
967 such as Info-ZIP or LHA, as one folder.
973 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
977 @var{path-name} is the relative path from
978 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
979 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
980 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
981 also permitted under the environment of ange-ftp, efs.
983 The actual file name of the archive folder is
984 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
985 under the @var{path-name}. If a file named @var{path-name} exists, it is
986 treated as folder. The suffix is automatically decided for
989 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
990 (Initial setting is @code{zip}) is referred.
992 @var{prefix} specifies the internal directory structure of the archive.
993 For example, if the ML server is fml, @file{msend.tar.gz} has a
994 structure like @file{spool/1}, so you have to specify @samp{spool} as
1001 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1002 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1003 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1004 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1009 * Archiver:: Archivers supported
1010 * Archive Tips:: TIPS
1011 * Archive Vars:: Customization
1015 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1016 @subsection Supported Archives
1026 By default, following archives are supported.
1030 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1031 GNU TAR('tgz, 'tar) ;; read-only
1035 If your archiver can include multiple files in one archive, you have a
1036 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1037 of the candidate. TAR is supported read-only because it cannot delete
1038 file in the archive (@code{mv})).
1040 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1041 archiver of Wanderlust because they cannot include multiple
1042 files. Archivers that cannot extract files to standard output are also
1045 @subsection OS specific information about archiver.
1047 Behaviors of the following archivers are confirmed by further experiences.
1048 (@samp{*} mark means recommended archiver).
1051 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1052 LHA OS/2 version Rel.2.06b Feb 18, 1998
1053 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1054 *Zip 2.2 (November 3rd 1997).
1055 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1056 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1057 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1059 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1060 LHa for UNIX V 1.14c
1061 UnZip 5.32 of 3 November 1997
1062 Zip 2.2 (November 3rd 1997)
1063 GNU tar 1.12 (1.11.x is no good)
1064 gzip 1.2.4 (18 Aug 93)
1066 [Win32] Win.98/Meadow
1070 GNU tar 1.11.8 + 1.5(WIN32)
1077 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1078 Hiramatsu version of LHA is only supported.
1079 In Win32, LHa32 is only supported (DOS version is no good).
1081 * Caution about GNU tar
1083 You have to take care about GNU tar's version because many version has
1084 problem on deleting file from archive.
1086 Please test @option{--delete} @option{-f} options work. Otherwise, your
1087 archive will be destroyed. No problem is reported on above versions of
1091 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1093 @cindex Archive Tips
1095 For comfortable migration, usage of @code{wl-summary-archive}
1096 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1097 archive folders created by expiration, you must set non-nil value to
1098 @code{elmo-archive-treat-file}.
1100 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1101 in processing speed. For comfortable use, Emacs20 is recommended.
1102 (If re-search's performance is the problem, 19.3x or later may be okay.)
1104 If many files are included in one archive,
1105 it takes long time to access to the archive folder because
1106 archiver starting overhead is increased (especially LHA).
1107 150-200 messages in one archive is recommended.
1109 Of course, following is possible @t{:-)}
1110 (meanings of these variables are described later.)
1114 (setq wl-fcc "$backup")
1115 (setq wl-trash-folder "$trash;lha")
1119 @node Archive Vars, , Archive Tips, Archive Folder
1120 @subsection Variables About Archive Folder
1121 @cindex Archive variables
1124 @item elmo-archive-default-type
1125 @vindex elmo-archive-default-type
1126 The initial setting is @code{zip}.
1127 Set archiver type by symbol.
1129 @item elmo-archive-@var{type}-method-alist
1130 @vindex elmo-archive-TYPE-method-alist
1131 Define archiver @var{type}'s methods.
1132 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1133 Each element of the alist is following.
1137 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1138 (@var{action} . @var{function}) ;; function
1142 Currently available actions are following.
1146 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1147 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1154 actions enclosed with braces are optional (They are used for better
1157 @item elmo-archive-suffix-alist
1158 @vindex elmo-archive-suffix-alist
1159 An alist of archiver-type (symbol) and suffix.
1161 @item elmo-archive-file-regexp-alist
1162 @vindex elmo-archive-file-regexp-alist
1163 An alist of a regexp to get file number from list output of archiver
1164 and archiver-type (symbol).
1166 @item elmo-archive-method-list
1167 @vindex elmo-archive-method-list
1168 A list of elmo-archive-@var{type}-method-alist
1169 (@var{type} is a symbol of archiver-type).
1171 @item elmo-archive-lha-dos-compatible
1172 @vindex elmo-archive-lha-dos-compatible
1173 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1174 DOS (Mr. Yoshizaki original) compatible.
1176 @item elmo-archive-cmdstr-max-length
1177 @vindex elmo-archive-cmdstr-max-length
1178 The initial setting is 8000.
1180 Max length of command line argument for external archiver program.
1181 Emacs does not have a limit of command line byte length, but some OS
1182 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1183 this limit because it calls external archiver program directly (not
1184 called via shell). For example, you cannot delete messages if archiver
1185 program must receive larger bytes of arguments to delete. OS/2 have a
1186 command line argument limit of 8190 bytes, so we defined default as 8000
1189 However, you don't have an influence of command line argument limit
1190 if the archiver has `actions' to receive target file information from
1191 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1194 @node POP Folder, Multi Folder, Archive Folder, Folders
1202 A folder to access e-mails via POP3 protocol (RFC 1939).
1208 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1213 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1214 as @var{authenticate-type}.
1218 @var{username} -> The value of @code{elmo-default-pop3-user}.
1219 Initial setting is @env{USER} environment variable or
1220 @env{LOGNAME} environment variable or return value of
1221 @code{(user-login-name)}.
1222 @var{authenticate-type} -> The value of @code{elmo-default-pop3-authenticate-type}.
1223 Initial setting is @samp{user}.
1224 @var{hostname} -> The value of @code{elmo-default-pop3-server}.
1225 Initial setting is @samp{localhost}.
1226 @var{port} -> The value of @code{elmo-default-pop3-port}.
1227 Initial setting is 110.
1234 &hoge@@localhost -> access to localhost as user @samp{hoge}.
1235 &hoge@@popserver:109 -> access to the server "popserver" on port 109
1236 as user @samp{hoge}.
1240 To use APOP as an @var{authenticate-type}, @file{md5.el} is needed
1241 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1242 @file{utils/sasl/lisp/} or Emacs/W3 package
1243 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1246 If the last character of the folder name is @samp{!}, Wanderlust
1247 connects to the POP server via SSL (Secure Socket Layer). If you set
1248 non-nil value to @code{elmo-default-pop3-stream-type}, you don't have to put
1249 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1250 with @samp{!!}, STARTTLS connection will be established. if the value
1251 of @code{elmo-default-pop3-stream-type} is @code{starttls}, STARTTLS will be the
1254 @node Multi Folder, Filter Folder, POP Folder, Folders
1255 @section Multi Folder
1256 @cindex Multi Folder
1258 @cindex Folder, Multiple
1259 @cindex Folder, Marge
1261 A folder to access to a folder which collects messages from
1262 multiple folders virtually.
1268 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1272 After @samp{*} character, specify multiple folders you want to collect
1273 separated by @samp{,} like
1274 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1280 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1281 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1282 treated as one folder.
1284 *+inbox,-fj.rec.tv,%inbox
1285 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1290 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1291 @section Filter Folder
1292 @cindex Filter Folder
1294 @cindex Folder, Filtering
1295 @cindex Folder, Virtual
1297 A folder to access to a folder which collects all messages that
1298 satisfy a condition virtually.
1303 @samp{/} @var{condition} @samp{/} @var{target-folder}
1306 In the @var{condition} part, you can specify following.
1310 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1312 first: @var{number} messages are picked from top of folder.
1313 last: @var{number} messages are picked from bottom of folder.
1319 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1320 /first:20/%inbox -> First 20 messages from %inbox are picked.
1325 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1327 since: only messages arrived since @var{date} are picked.
1328 before: only messages arrived before @var{date} are picked.
1330 You can specify following as @var{date}.
1334 yesterday -> a day before today.
1335 lastweek -> same day of last week.
1336 lastmonth -> same day of last month.
1337 lastyear -> same day of last year.
1338 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1339 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1347 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1349 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1355 Field filter: @samp{@var{field}:@var{value}}
1357 All messages that have @var{field} and its value is @var{value} are picked.
1358 @var{field} and @var{value} are case insensitive.
1364 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1365 and its value includes "teranisi" string are picked.
1366 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1374 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1375 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1377 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1378 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1384 /from:teranisi&!to:teranisi/+inbox
1385 -> In +inbox, messages are picked if the message's
1386 From: field includes "teranisi" and
1387 To: field doesn't include "teranisi".
1389 /tocc:"Yuuichi Teranishi"/+inbox
1390 -> In +inbox, messages are picked if the
1391 message's To: field or Cc: field includes
1392 "Yuuichi Teranishi".
1394 /(from:yt|from:teranisi)&subject:report/+inbox
1395 -> In +inbox, messages are picked if the message's
1396 From: field includes "yt" or "teranisi", and
1397 Subject includes "report".
1403 Tip for string description:
1405 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1406 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1407 should be escaped with @samp{\} in it). You can enclose the string with
1408 @samp{"} even it does not contain these characters.
1414 *%inbox,/from:teranisi/%inbox@@server
1415 -> Messages in %inbox or
1416 message is in the %inbox@@server folder and it's From field
1417 includes "teranisi" are collected.
1419 /last:100//to:teranisi/*+inbox,%inbox
1420 -> Latest 100 messages which is in the +inbox or %inbox folder
1421 and To: field matches "teranisi".
1423 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1424 -> Pick messages which have From: field and it includes "hogehoge"
1425 from latest 20 messages in the %#mh/inbox@@localhost
1426 and To: or Cc: field includes "teranisi".
1429 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1430 @section Pipe Folder
1434 @cindex Download Message
1435 @cindex Incorporate Message
1437 In the pipe folder, messages are automatically transferred from the source
1438 folder to destination folder.
1443 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1446 When you access to the pipe folder, messages are automatically transferred
1447 from @var{source-folder} to @var{destination-folder}.
1448 It is convenient if you want to download messages to local disk via POP.
1449 For example, if you specify following
1452 |&username@@popserver|+inbox
1456 and access to it, messages are downloaded automatically from
1457 @samp{&username@@popserver} to @samp{+inbox}.
1463 %inbox|%myinbox -> Download %inbox to %myinbox.
1464 *&user@@popserver1,&user@@popserver2|+inbox
1465 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1469 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1471 @node Internal Folder, , Pipe Folder, Folders
1472 @section Internal folder
1473 @cindex Internal Folder
1475 @cindex Folder, @samp{$} mark
1477 A folder to access to internal messages of Wanderlust.
1489 A folder named @samp{'mark} is a special virtual folder which collects
1490 messages which have important mark @samp{$}.
1492 You can review important messages at once after you put important marks
1493 on the messages in the different folders.
1495 In this folder, if you delete message, important mark @samp{$} put on
1496 the message is removed. If you append messages to this folder, the
1497 message will have @samp{$} mark.
1499 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1500 folder. If you want IMAP folder's message remove from @samp{'mark}
1501 folder, remove important mark at IMAP Folder.)
1503 You can access to the cached messages fetched via network by accessing
1504 to the folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1505 the name of the subdirectories of the cache directory
1506 (@file{~/.elmo/cache}).
1509 @node Folder, Summary, Folders, Top
1510 @chapter Folder mode
1513 After you start Wanderlust, folder mode is appeared firstly.
1514 It contains folder list you subscribed.
1515 You can select and edit folders in this mode.
1518 * Selecting Folder:: Select folder you want to read.
1519 * Folder Manager:: Editing folders.
1523 @node Selecting Folder, Folder Manager, Folder, Folder
1524 @section Selecting Folder
1525 @cindex Selecting Folder
1527 @subsection Usage (TIPS)
1529 @subsubsection Check new, unread number
1531 Folder mode looks like this.
1532 (In XEmacs, it looks much nicer @t{;-)})
1536 [-]Desktop:14186/35580/67263
1541 [-]Emacsen:0/34/4837
1542 Wanderlust ML:0/0/558
1545 XEmacs Beta:0/29/255
1556 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1560 @kbd{s} key on the folder line updates these numbers.
1561 It changes its color if it has many new messages.
1563 The whole folder mode is a folder group named @samp{Desktop}.
1564 Folder group open/close by return key.
1565 A operation to a folder group is treated as operations on the
1567 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1568 six children folders update its unread number status.
1570 @subsubsection Select Folder
1572 To enter summary mode of the folder, type return (or space) key on
1574 If the variable @code{wl-stay-folder-window} has non-nil value,
1575 summary window appears on the right of the folder mode window.
1577 @subsection Key bindings
1579 Folder mode's key binding (related to selecting folders) is following.
1584 @kindex @key{SPC} (Folder)
1585 @kindex @key{RET} (Folder)
1586 @findex wl-folder-jump-to-current-entity
1587 Enter to the summary mode of the folder at the current cursor point.
1588 If the cursor is on the top of folder group line,
1589 the folder group is opened or closed.
1590 When the cursor is on the access group and this command is called
1591 with prefix argument, folder children list is updated to the newest one.
1592 (Children list is updated recursively if the access folder has hierarchical
1594 (@code{wl-folder-jump-to-current-entity})
1597 @kindex M-@key{RET} (Folder)
1598 @findex wl-folder-update-recursive-current-entity
1599 Folder children list of the access group at the current cursor point
1600 is updated to the newest one.
1601 (Children list is updated recursively if the access folder has hierarchical
1603 (@code{wl-folder-update-recursive-current-entity})
1608 Create a new draft message.
1613 @findex wl-folder-write-current-folder
1614 If the current cursor point is on the NNTP folder, create a new draft
1615 message which already has @samp{Newsgroups:} field. If the current
1616 cursor point is on the folder for mailing list (refile destination),
1617 create a new draft message which already has @samp{To:} field with
1618 guessed mailing list adderss (If @code{wl-subscribed-mailing-list} is
1620 (@code{wl-folder-write-current-folder})
1623 @kindex C-c C-o (Folder)
1624 @findex wl-jump-to-draft-buffer
1625 Move to the draft buffer if available. If multiple draft buffer exists,
1626 moved to one after another. If prefix argument is specified, load draft
1627 folder's message to the draft buffer and jump to it.
1628 (@code{wl-jump-to-draft-buffer})
1632 @findex wl-folder-check-current-entity
1633 Update new and unread number information of the folder at the current
1635 (@code{wl-folder-check-current-entity})
1639 @findex wl-folder-sync-current-entity
1640 Update summary information of the folder at the current cursor point.
1641 (@code{wl-folder-sync-current-entity})
1644 @kindex r s (Folder)
1645 @findex wl-folder-check-region
1646 Update new and unread number information of the folders in the currently
1648 (@code{wl-folder-check-region})
1651 @kindex r S (Folder)
1652 @findex wl-folder-sync-region
1653 Update summary information of the folders in the currently selected region.
1654 (@code{wl-folder-sync-region})
1658 @findex wl-status-update
1659 Sync up address book status with @file{~/.addresses}'s content.
1660 (@code{wl-status-update})
1664 @findex wl-folder-prev-unread
1665 Jump cursor to the folder which have unread messages on the upward from
1666 current cursor point.
1667 (@code{wl-folder-prev-unread})
1671 Jump cursor to the folder which have unread messages on the downward
1672 from current cursor point.
1673 (@code{wl-folder-next-unread})
1677 Move cursor to the folder on the previous line.
1678 (@code{wl-folder-prev-entity})
1682 Move cursor to the folder on the next line.
1683 (@code{wl-folder-next-entity})
1687 Jump to the folder specified by the user input.
1688 (@code{wl-folder-jump-folder})
1692 @findex wl-folder-prefetch-current-entity
1693 Prefetch new messages of the folder at the current cursor point by
1694 @code{wl-summary-incorporate}.
1695 If the cursor is on the folder group, it is executed recursively.
1696 (@code{wl-folder-prefetch-current-entity})
1700 @findex wl-folder-mark-as-read-all-current-entity
1701 Mark all unread messages of the folder at the current cursor point as read.
1702 If the cursor is on the folder group, it is executed recursively.
1703 (@code{wl-folder-mark-as-read-all-current-entity})
1707 @findex wl-folder-goto-first-unread-folder
1708 Enter summary mode of the first unread folder.
1709 (@code{wl-folder-goto-first-unread-folder})
1713 @findex wl-folder-empty-trash
1715 (@code{wl-folder-empty-trash})
1719 @findex wl-folder-open-all-unread-folder
1720 All unread folder is opened.
1721 (@code{wl-folder-open-all-unread-folder})
1725 @findex wl-folder-open-close
1726 Folder group is opened/closed.
1727 (@code{wl-thread-open-close})
1731 All folder group is opened.
1732 (@code{wl-folder-open-all})
1736 All folder group is closed.
1737 (@code{wl-folder-close-all})
1747 (@code{wl-folder-suspend})
1750 @kindex M-s (Folder)
1751 Save current folder status.
1755 @kindex M-t (Folder)
1756 Toggle Wanderlust's offline/online status.
1757 (@code{wl-toggle-plugged})
1760 @kindex C-t (Folder)
1761 Start Wanderlust's plug-status manager.
1762 (@code{wl-plugged-change})
1765 @subsection Customize variables
1768 @item wl-folders-file
1769 @vindex wl-folders-file
1770 The initial setting is @file{~/.folders}.
1771 Subscribed folders are described (saved) in this file.
1773 @item wl-folder-info-save
1774 @vindex wl-folder-info-save
1775 The initial setting is @code{t}. If non-nil, unread information is
1776 saved and used in the next Wanderlust session.
1778 @item wl-stay-folder-window
1779 @vindex wl-stay-folder-window
1780 The initial setting is @code{nil}.
1781 If non-nil, summary window is appeared on the right side of the folder buffer.
1783 @item wl-folder-window-width
1784 @vindex wl-folder-window-width
1785 The initial setting is 20.
1786 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1788 @item wl-folder-many-unsync-threshold
1789 @vindex wl-folder-many-unsync-threshold
1790 The initial setting is 70.
1791 If the number of unread messages is more than this value,
1792 folder color is changed.
1794 @item wl-highlight-folder-by-numbers
1795 @vindex wl-highlight-folder-by-numbers
1796 This option controls how to highlight each line in the folder buffer.
1797 The default value is @code{t}, highlighting with various colors based on
1798 the message numbers. If it is @code{nil}, highlighting with various
1799 colors based on the folder status. In addition, if it is a number
1800 (e.g. 1), highlighting will be done based on both the message numbers
1801 and the folder status.
1803 @item wl-folder-desktop-name
1804 @vindex wl-folder-desktop-name
1805 The initial setting is @samp{Desktop}.
1806 The name of top folder group.
1808 @item wl-folder-petname-alist
1809 @vindex wl-folder-petname-alist
1810 The initial setting is @code{nil}.
1811 An alist of folder's realname and its nickname.
1813 @item wl-folder-access-subscribe-alist
1814 @vindex wl-folder-access-subscribe-alist
1815 The initial setting is @code{nil}.
1817 Control automatic subscribing and unsubscribing of the children list
1823 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1827 If @var{subscribe-flag} is non-nil, folders which have name matched to
1828 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1829 already unsubscribed folder is not displayed even when the
1830 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1837 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1838 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1839 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1840 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1844 @item wl-folder-hierarchy-access-folders
1845 @vindex wl-folder-hierarchy-access-folders
1846 The initial setting is the list shown below:
1855 A list of access groups which creates children folder list hierarchically.
1857 For example, if you specify
1858 @code{wl-folder-hierarchy-access-folders} like following,
1862 (setq wl-folder-hierarchy-access-folders
1863 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1868 such access group hierarchy is obtained.
1874 -fj.comp.announce:0/0/2
1875 -fj.comp.dev.cdrom:0/0/0
1877 [+]-japan:238/238/1688
1880 -comp.unix.admin:0/0/0
1881 -comp.unix.dos-under-unix:0/0/0
1882 -comp.unix.programmer:0/0/0
1883 [-]-comp.unix.bsd:0/0/23
1884 -comp.unix.bsd.freebsd.announce:0/0/0
1889 If you opened @samp{-} in this example, only the direct children is created
1890 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1891 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1892 is not created until the children access group is opened.
1896 @node Folder Manager, , Selecting Folder, Folder
1897 @section Editing Folders
1898 @cindex Folder Manager
1899 @cindex Folder, Edit
1900 @cindex Folder, Subscribe
1901 @cindex Folder, Unsubscribe
1903 As described before, subscribed folder list is saved in @file{~/.folders} file.
1904 But you don't have to edit @file{~/.folders} directly.
1905 You can append, delete, edit folders from folder mode.
1907 @subsection Usage (Tips)
1909 @subsubsection Append Folder
1911 @kbd{m a} appends new folder to the folder mode.
1912 @kbd{m g} appends new folder group.
1913 To append new folder to this group, firstly open it,
1914 then execute append command in the next line.
1916 @subsubsection Edit Folder
1918 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1919 Thus, you can change folder position as if you were editing a normal file.
1921 @subsubsection Create Multi Folder.
1925 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
1927 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
1929 Type @kbd{m m}, then you can create multi folder.
1932 @subsubsection Delete Nickname, Filter
1934 You can delete nickname or filter by putting ``''(@var{NULL}) from the
1935 minibuffer while appending.
1937 @subsubsection Append Folder to Empty Group
1939 To append new folder to the empty folder group
1940 (after you create folder group by typing @kbd{m g}),
1941 firstly open it, then execute append command in the next line.
1942 If it is closed, folder is appended on the same level with
1943 the above folder group. It is difficult to explain by words so try it.
1944 In other words, appended position depends on the
1945 above folder group's open/close status.
1947 @subsubsection Charset of the Folders File.
1949 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
1951 @subsubsection Create Filter
1953 @kbd{m f} adds filter to the folder at the current cursor point. To
1954 create new filter folder and leave the current folder unchanged, copy it
1955 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
1956 filter can be specified while appending filter. If you put
1957 ``''(@var{NULL}), filter is deleted.
1959 @subsubsection Sort Folders
1961 Sorting of the folders is executed by the function specified by
1962 @code{wl-fldmgr-sort-func}.
1963 The initial setting is @code{wl-fldmgr-sort-standard},
1964 which sorts alphabetically.
1965 Sorting affects only on the current folder group. It does not
1966 affect on the child groups.
1968 @subsubsection Hiding Folders in the Access Group
1970 Usually, access group displays all children folders, but you can set
1971 some folders hidden. Following operations are only available on access
1974 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
1975 (subscribe/unsubscribe) of the folder at current cursor point. Against
1976 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
1979 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
1980 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
1981 argument and if the argument has positive number, the unsubscribe it.
1982 If the prefix argument has negative value, folder becomes visible and if
1983 zero, folder visibility is toggled.
1985 The other commands, @code{wl-fldmgr-subscribe} and
1986 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
1989 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
1990 executed in the access group, they have a same effect with
1991 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
1992 The difference is that cut commands deletes folders from the current
1995 @subsubsection Operations in the Access Group
1997 You can insert and delete folders in the access group like usual folder
1998 group. But insert and delete commands can be only available for the
1999 children folders of the access group and they only sets the subscribe
2000 status. In other words, insertion of the folder means subscribing,
2001 deletion means unsubscribing.
2002 @footnote{In the current implementation,
2003 it is faster to delete region than to unsubscribe region.}
2005 To update the access group when children folders are inserted or deleted
2006 by other way (other than Wanderlust),
2007 open the access group by typing @kbd{C-u @key{RET}}.
2008 @xref{Selecting Folder}.
2010 The order of children folders of access group is saved after
2011 insertion/deletion/sorting.
2012 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2013 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2014 newly created folders are inserted on the top of the access group.
2016 @subsection Key bindings
2017 @cindex Keybind, Folder Mode
2018 @cindex Keybind, Folder Buffer
2020 Key bindings on the folder mode related to folder editing are shown below.
2021 All bindings starts with @kbd{m}, and primary commands are binded to
2022 one stroke key binding.
2026 @kindex m a (Folder)
2027 @findex wl-fldmgr-add
2029 (@code{wl-fldmgr-add})
2034 @kindex m g (Folder)
2035 @findex wl-fldmgr-make-group
2036 Create a folder group.
2037 (@code{wl-fldmgr-make-group})
2040 @kindex m A (Folder)
2041 @findex wl-fldmgr-make-access-group
2042 Create an access group.
2043 (@code{wl-fldmgr-make-access-group})
2046 @kindex m d (Folder)
2047 @findex wl-fldmgr-delete
2048 Delete folder itself and msgdb.
2049 If the folder itself cannot be deleted like NNTP folder,
2050 only msgdb is deleted.
2051 (@code{wl-fldmgr-delete})
2056 @kindex m R (Folder)
2057 @findex wl-fldmgr-rename
2058 Change the name of folder or folder group.
2059 msgdb's path is also changed.
2060 (@code{wl-fldmgr-rename})
2066 @findex wl-fldmgr-make-multi
2067 Create a multi folders in the cutlist (cut, copied folders).
2068 (@code{wl-fldmgr-make-multi})
2073 @kindex m f (Folder)
2074 @findex wl-fldmgr-make-filter
2075 Create a filter folder. (Put a filter on the folder).
2076 (@code{wl-fldmgr-make-filter})
2080 @kindex M-c (Folder)
2081 @kindex m c (Folder)
2082 @findex wl-fldmgr-copy
2083 Copy folder (it is not available on folder group).
2084 (@code{wl-fldmgr-copy})
2088 @kindex M-w (Folder)
2089 @kindex m W (Folder)
2090 @findex wl-fldmgr-copy-region
2091 Copy folders in the specified region.
2092 (@code{wl-fldmgr-copy-region})
2096 @kindex C-k (Folder)
2097 @kindex m k (Folder)
2098 @findex wl-fldmgr-cut
2099 Cut folder. Folder itself is not deleted.
2100 (@code{wl-fldmgr-cut})
2104 @kindex C-w (Folder)
2105 @kindex m C-w (Folder)
2106 @findex wl-fldmgr-cut-region
2107 Cut folders in the specified region.
2108 (@code{wl-fldmgr-cut-region})
2112 @kindex C-y (Folder)
2113 @kindex m y (Folder)
2114 @findex wl-fldmgr-yank
2115 Paste folders that are copied or cut (folders in the cut-list).
2116 (@code{wl-fldmgr-yank})
2119 @kindex m p (Folder)
2120 @findex wl-fldmgr-set-petname
2121 Put nickname on the folder.
2122 (@code{wl-fldmgr-set-petname})
2125 @kindex m q (Folder)
2126 @findex wl-fldmgr-clear-cut-entity-list
2127 Clear the cut-list. (cut, copied folder information is cleared,
2128 you cannot paste after this)
2129 (@code{wl-fldmgr-clear-cut-entity-list})
2132 @kindex m s (Folder)
2133 @findex wl-fldmgr-sort
2134 Sort folders in the current folder group.
2135 (@code{wl-fldmgr-sort})
2138 @kindex m C-s (Folder)
2139 @findex wl-fldmgr-save
2140 Save current folder view to the @file{wl-folders-file}.
2141 (@code{wl-fldmgr-save})
2144 [Following commands are only available on the access groups]
2150 @kindex m u (Folder)
2151 @findex wl-fldmgr-unsubscribe
2152 Set the visibility of folder (subscribe/unsubscribe).
2153 (@code{wl-fldmgr-unsubscribe})
2158 @kindex r u (Folder)
2159 @findex wl-fldmgr-unsubscribe-region
2160 Set the visibility of the folders (subscribe/unsubscribe) in the
2162 (@code{wl-fldmgr-unsubscribe-region})
2167 @kindex m l (Folder)
2168 @findex wl-fldmgr-access-display-normal
2169 List folders that are currently available.
2170 (@code{wl-fldmgr-access-display-normal})
2175 @kindex m L (Folder)
2176 @findex wl-fldmgr-access-display-all
2177 List all folders regardless of the subscription status.
2178 (@code{wl-fldmgr-access-display-all})
2182 @subsection Customize variables
2185 @item wl-interactive-save-folders
2186 @vindex wl-interactive-save-folders
2187 The initial setting is @code{t}. If non-nil and folder view is
2188 modified, confirm saving it before Wanderlust or Emacs exits. If
2189 @code{nil}, save without confirmation.
2191 @item wl-fldmgr-make-backup
2192 @vindex wl-fldmgr-make-backup
2193 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2194 created before saving the folder status.
2196 @item wl-fldmgr-sort-func
2197 @vindex wl-fldmgr-sort-func
2198 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2199 sort folders. By default function, folders are sorted alphabetically
2200 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2203 @item wl-fldmgr-sort-group-first
2204 @vindex wl-fldmgr-sort-group-first
2205 The initial setting is @code{t}. If non-nil,
2206 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2207 does not care whether it is folder group or not.
2209 @item wl-folder-check-async
2210 @vindex wl-folder-check-async
2211 The initial setting is @code{t}. If non-nil, check folder's unread
2212 status asynchronously. It boosts newsgroup checking.
2214 @item wl-folder-check-fast
2215 @vindex wl-folder-check-fast
2216 The initial setting is @code{nil}.
2217 If non-nil, it does not update folder status while checking.
2219 @item wl-folder-notify-deleted
2220 @vindex wl-folder-notify-deleted
2221 The initial setting is @code{nil}.
2223 If non-nil, negative value is displayed when the message is deleted. If
2224 @code{sync}, folder is synchronized when the message is deleted. If
2225 @code{nil}, message deletion is ignored.
2228 @subsection Miscellanea
2230 Following is a note for folder editing.
2234 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2235 paste(yank) command pastes the folders on one cut or copy command
2236 (If copy command is executed by region, folders in the region are pasted
2237 by one paste command)
2240 You cannot cut @samp{Desktop} group.
2241 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2244 You cannot copy folder group.
2247 Operations on the access group are only available for the folders
2248 in the same access group.
2251 You cannot create a folder which has same name with the folders already exist.
2254 You cannot insert folders which have same name in one group.
2255 You can insert them in the different groups.
2256 You cannot put same nickname to the different folders.
2260 @node Summary, Message, Folder, Top
2261 @chapter Summary Mode
2263 After you select the folder via folder mode, you enter to the summary
2267 * Usage of Summary Mode:: TIPS.
2268 * Thread Operations:: Thread operations.
2269 * Cache:: File cache, Buffer cache, and Prefetch.
2270 * Auto Refile:: Auto refile settings.
2271 * Sticky Summary:: Summary make sticky.
2272 * Key Bindings of Summary:: Key bindings.
2273 * Variables of Summary:: Customize Summary Mode.
2277 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2278 @section Usage (Tips)
2280 @subsection Summary Content
2282 In the summary mode, messages are displayed like following.
2286 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2287 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2288 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2289 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2296 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2300 You cannot change this in the current version.
2302 @var{Message number} is the message's unique number in the folder. In
2303 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2304 in the MH folder, it is the filename of the message.
2306 @var{Temporal mark} and @var{Persistent mark} are described later.
2308 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2309 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2310 Japanese, but if you want to display it in English, set the value of
2311 @code{wl-summary-weekday-name-lang} as @samp{en}.
2313 @var{Sender}'s indentation corresponds to the depth of the thread.
2314 Sender name is displayed as nickname if it is defined in the address
2315 book. Set @code{wl-use-petname} as @samp{nil}, if you want to quit
2316 displaying with nickname.
2318 If number is printed at the head of @var{Sender} part like @samp{+2},
2319 that means the message have 2 follow messages.
2321 @var{Subject} is the @samp{Subject:} header field of the message. If
2322 the message have same @samp{Subject:} with the parent message, it is not
2323 displayed. Some mailing list puts its sequence number in the
2324 @samp{Subject:} field, but it is
2325 ignored. @code{wl-summary-no-subject-message} is displayed when the
2326 message has empty subject field.
2328 @subsection Temporary Marks
2329 @cindex Mark, Temporary
2331 There are four temporary marks,
2332 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2333 Temporary marks indicates message operations.
2338 You can execute a command on the all messages that have @samp{*} mark,
2339 with the key bindings which begins with @kbd{m}.
2342 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2346 After you type @kbd{o} key, prompt appears to input refile destination.
2347 Your answer is printed in the summary line.
2351 You can put this mark by typing @kbd{O} key.
2352 The difference between this mark and refile mark is,
2353 this mark does not delete the message while latter does.
2356 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2358 @subsection Persistent Marks
2360 There are five persistent marks,
2361 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2363 The persistent mark indicates the message's status and it is saved.
2364 Each persistent mark indicates:
2370 It is unread message.
2372 It is unread but cached message.
2374 It is read but it is not cached.
2376 It is important message. You can put @samp{$} mark by typing @kbd{$}
2377 key (if already exists, the mark is deleted). It is convenient to put
2378 this mark on the messages to remember (If you want to remember to write
2379 a reply for the message, for example) because this mark remains after
2380 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2381 even the message itself is deleted in the actual folder.
2384 If the message is read and cached (or local message),there are no
2388 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2389 cache. Messages with the marks other than these, you can read them in
2390 the offline status even they are in the IMAP folder or netnews folder.
2392 @subsection How To Read
2394 Basically, you can read messages only typing space key again and again.
2396 To update summary status to the newest status (synchronize),
2399 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2400 moves cursor to the next message.
2401 Enter message buffer by typing @kbd{j} key.
2402 To operate multipart, you have to enter to the message buffer.
2405 @subsection Pack the Message Numbers
2406 You can pack the message numbers in Summary by
2407 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2408 News Spool Folder and Maildir Folder are supported folder types.
2411 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2412 @section Thread Operations
2414 For example, the following line indicates one thread (a context of a topic).
2417 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2421 If you type @kbd{/} on this line, the thread is opened and it changes
2422 the appearance like following.
2426 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2427 388 09/17(Thu)22:34 +-[ Murata san ]
2431 (Message 388 is the replied message to the message 384.)
2432 If you type @kbd{/} key once again, the thread is closed.
2433 With prefix argument, @kbd{/} opens all children threads.
2435 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2438 Commands with the key binding that begins with @kbd{t} executes commands
2439 on the messages in the thread.
2440 @xref{Key Bindings of Summary}.
2442 @subsection reconstruct thread by hand
2444 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2445 (@code{wl-summary-save-current-message}) at the corresponding message,
2446 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2447 message then you have the reconstructed thread.
2450 @node Cache, Auto Refile, Thread Operations, Summary
2453 @subsection Cache File
2455 The messages which have to access via network (e.x. IMAP, NNTP folder)
2456 are cached as a local file. The cache file is saved under the directory
2457 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2458 elmo-cache-expire-by-size}. The command deletes cache files to the
2459 specified size by the order of last accessed time.
2461 @subsection Buffer Cache and Prefetching
2463 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2464 that are read are kept in the cache buffer. It is called `buffer
2465 cache'. The number of cache buffer is specified by
2466 @code{elmo-buffer-cache-size}.
2468 There are message prefetching mechanism in the Wanderlust that
2469 prefetches next message while you are reading. This function requires
2470 that the value of @code{elmo-use-buffer-cache} is non-nil.
2472 You can control the message prefetching mechanism by these two
2476 @item wl-cache-prefetch-folder-type-list
2477 @vindex wl-cache-prefetch-folder-type-list
2478 The initial setting is the list shown below:
2486 It specifies the folder types in which message prefetching is enabled.
2487 In the initial setting, multi folder that contains localdir and imap4
2488 prefetches only imap4 messages. This variable precedes the value of
2489 @code{wl-cache-prefetch-folder-list}.
2491 If you want to prefetch localdir and localnews also, following setting
2496 (setq wl-cache-prefetch-folder-type-list
2497 '(nntp imap4 localdir localnews))
2501 @item wl-cache-prefetch-folder-list
2502 @vindex wl-cache-prefetch-folder-list
2503 The initial setting is @code{nil}.
2504 A list of regexp of folders to enable message prefetching.
2508 @node Auto Refile, Sticky Summary, Cache, Summary
2509 @section Auto Refile
2510 @vindex elmo-msgdb-extra-fields
2511 @vindex wl-refile-rule-alist
2512 @findex wl-summary-auto-refile
2514 You can refile messages automatically, by typing @kbd{C-o}
2515 (@code{wl-summary-auto-refile}). It decides destination of refile by
2516 the content of the message header information (information in the msgdb).
2518 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2519 available. If you want to decide destination by other header fields,
2520 set the variable @code{elmo-msgdb-extra-fields} like following.
2524 (setq elmo-msgdb-extra-fields
2534 By this setting, Wanderlust saves extra fields in the msgdb. You have
2535 to type @kbd{s all} to get extra fields for the messages that are
2536 already exists in the summary.
2538 Then, specify the refile rule. The refile target folder of auto
2539 refiling is decided by the value of @code{wl-refile-rule-alist}.
2540 @code{wl-refile-rule-alist} is a list of a rule:
2544 (@var{field} (@var{regexp} . @var{target})
2545 (@var{regexp} . @var{target})
2550 Each rule means `if @var{field} value matches @var{regexp},
2551 then refile to @var{target} folder'.
2552 The rule matched first is applied.
2554 @var{field} is a string of field name. You can specify a list of field name
2555 string, too. In this case, if one of these fields is matched, then the
2556 rule is fired (i.e. OR condition).
2558 @var{regexp} is a regular expression for field value. @var{target} is a target
2559 folder string. You can specify a rule at @var{target} part, too. In this
2560 case, If the field value of the rule and the current rule is matched,
2561 then the current rule is fired (i.e. AND condition).
2563 In @var{target} part, you can refer matched substring of @var{regexp}.
2564 To refer substring, specify following in @var{target}:
2568 means substitute original matched text.
2571 means substitute what matched the @var{N}th `\(@dots{}\)'.
2572 (@var{N} is a number.)
2575 Following is an example of @code{wl-refile-rule-alist}.
2579 (setq wl-refile-rule-alist
2581 ("^Wanderlust" . "+wl")
2582 ("^Elisp" . "+elisp"))
2584 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2586 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2587 "+from-me-to-you"))))))
2591 After these settings, refile marks are automatically put on the condition
2592 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2594 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2596 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2597 with these persistent marks are not automatically refiled.
2598 It means Wanderlust does not execute auto refile on unread messages by
2599 the default setting.
2600 To execute auto refile on all messages, set following.
2603 (setq wl-summary-auto-refile-skip-marks nil)
2607 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2608 @section Sticky Summary
2609 @cindex Summary, Sticky
2610 @cindex Sticky Summary
2612 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2614 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2615 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2617 The buffer name of the sticky summary becomes like
2618 @samp{Summary:@var{folder-name}}.
2620 You can visit the sticky summary at any time by @kbd{C-x b}
2621 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2622 q}. Other operations in the sticky summary are same as normal summary.
2624 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2625 are automatically sticked.
2628 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2629 @section Key bindings
2630 @cindex Keybind, Summary Mode
2631 @cindex Keybind, Summary Buffer
2633 Key bindings of the summary mode are shown below.
2637 @kindex @key{SPC} (Summary)
2638 @findex wl-summary-read
2639 Proceed reading a message at the current cursor point.
2640 (@code{wl-summary-read})
2644 @findex wl-summary-redisplay
2645 Redisplay a message at the current cursor point.
2646 If this command is called with prefix argument,
2647 Redisplay message regardless of the message cache (message is re-loaded
2649 (@code{wl-summary-redisplay})
2653 @findex wl-summary-display-top
2654 Display the top message in the folder.
2655 (@code{wl-summary-display-top})
2659 @findex wl-summary-display-bottom
2660 Display the bottom message in the folder.
2661 (@code{wl-summary-display-bottom})
2665 @kindex @key{BS} (Summary)
2666 @kindex @key{DEL} (Summary)
2667 Display the previous page of the message at the current cursor point.
2668 @findex wl-summary-prev-page
2669 (@code{wl-summary-prev-page})
2672 @kindex @key{RET} (Summary)
2673 @findex wl-summary-next-line-content
2674 Display the next line of the message at the current cursor point.
2675 Display the message at the current cursor point if it is not displayed yet.
2676 (@code{wl-summary-next-line-content})
2681 @kindex M-@key{RET} (Summary)
2682 @findex wl-summary-prev-line-content
2683 Display the previous line of the message at the current cursor point.
2684 Display the message at the current cursor point if it is not displayed yet.
2685 (@code{wl-summary-prev-line-content})
2689 @findex wl-thread-open-close
2690 Toggle open or close the thread at the current cursor point.
2691 (@code{wl-thread-open-close})
2696 @findex wl-thread-open-all
2697 (@code{wl-thread-open-all})
2702 @findex wl-thread-close-all
2703 (@code{wl-thread-close-all})
2707 @findex wl-summary-goto-folder
2709 (@code{wl-summary-goto-folder})
2713 Mark all messages in the folder as read.
2714 @findex wl-summary-mark-as-read-all
2715 (@code{wl-summary-mark-as-read-all})
2719 @findex wl-summary-reply
2720 Prepare a draft for reply the message at the current cursor point.
2721 (@code{wl-summary-reply})
2725 @findex wl-summary-reply-with-citation
2726 Prepare a draft for reply the message at the current cursor point.
2727 (@code{wl-summary-reply-with-citation})
2731 @findex wl-summary-cancel-message
2732 If the message at current cursor point is your own netnews article,
2734 (@code{wl-summary-cancel-message})
2738 @findex wl-summary-reedit
2739 Prepare a draft for re-editing the message at current cursor point.
2740 If the message at current cursor point is your own netnews article,
2741 a draft for `supersedes message' for the message is prepared.
2742 (@code{wl-summary-reedit})
2745 @kindex M-e (Summary)
2746 @findex wl-summary-resend-bounced-mail
2747 If the message at current cursor point is a bounced message,
2748 a draft for re-sending original message is prepared.
2749 (@code{wl-summary-resend-bounced-mail})
2753 @findex wl-summary-forward
2754 A draft for forwarding the message at current cursor point is prepared.
2755 (@code{wl-summary-forward})
2759 @findex wl-summary-mark-as-important
2760 Put @samp{$} mark on the message at current cursor point.
2761 If already marked as @samp{$}, delete it.
2762 (@code{wl-summary-mark-as-important})
2768 Save the message at current cursor point.
2769 @findex wl-summary-save
2770 (@code{wl-summary-save})
2774 @findex wl-summary-next
2775 Move cursor to the next message.
2776 If message is marked with a temporal mark in
2777 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2778 In the offline mode, cursor is not moved to the messages which are not cached
2780 (@code{wl-summary-next})
2784 @findex wl-summary-prev
2785 Move cursor to the previous message.
2786 If message is marked with a temporal mark in
2787 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2788 In the offline mode, cursor is not moved to the messages which are not cached
2790 (@code{wl-summary-prev})
2794 @findex wl-summary-down
2795 Move cursor to the downward message which is unread or marked
2797 In the offline mode, cursor is not moved to the messages which are not cached
2799 If there are messages which have target mark @samp{*} in the summary,
2800 cursor is moved to the downward message which have a target mark.
2801 This behavior is changed according to the value of @code{wl-summary-move-order}.
2802 (@code{wl-summary-down})
2806 @findex wl-summary-up
2807 Move cursor to the upward message which is unread or marked
2809 In the offline mode, cursor is not moved to the messages which are not cached
2811 If there are messages which have target mark @samp{*} in the summary,
2812 cursor is moved to the downward message which have a target mark.
2813 This behavior is changed according to the value of @code{wl-summary-move-order}.
2814 (@code{wl-summary-up})
2818 @findex wl-summary-write
2819 Prepare a new draft.
2820 (@code{wl-summary-write})
2824 @findex wl-summary-write-current-folder
2825 Prepare a new draft. If the current folder is NNTP folder,
2826 @samp{Newsgroups:} field is completed. If the current folder is mailing
2827 list folder (refile destination), guess @samp{To:} field and completed
2828 (If @code{wl-subscribed-mailing-list} is valid list)
2829 (@code{wl-summary-write-current-folder})
2833 @findex wl-summary-redisplay-all-header
2834 Redisplay the message at current cursor point with all header fields.
2835 (@code{wl-summary-redisplay-all-header})
2839 @findex wl-summary-redisplay-no-mime
2840 Redisplay the message at current cursor point without MIME analysis.
2841 (@code{wl-summary-redisplay-no-mime})
2845 @findex wl-summary-burst
2846 If the message at current cursor point has
2847 encapsulates multiple messages using MIME,
2848 de-capsulate and extract them on the current folder.
2849 (@code{wl-summary-burst})
2852 @kindex @@ (Summary)
2853 @findex wl-summary-edit-addresses
2854 Append/change/delete the message's sender information to the address
2855 book @file{~/.addresses} interactively. If this command is called with
2856 prefix argument, arbitrary address can be edited.
2857 (@code{wl-summary-edit-petname})
2861 @findex wl-status-update
2862 Sync up address book status with @file{~/.addresses}'s content.
2863 (@code{wl-status-update})
2867 @findex wl-summary-pipe-message
2868 Pipe current message's content to the external process.
2869 (@code{wl-summary-pipe-message})
2873 @findex wl-summary-print-message
2874 Print out current message's content.
2875 It uses @code{ps-print} module in Emacs 20.x.
2876 If you don't use color printer, you might want to set
2877 @code{wl-ps-print-buffer-func} to @code{ps-print-buffer}.
2880 (setq wl-ps-print-buffer-func 'ps-print-buffer)
2883 (@code{wl-summary-print-message})
2887 @findex wl-summary-exit
2888 Exit current folder.
2889 (@code{wl-summary-exit})
2893 @findex wl-summary-jump-to-current-message
2894 Jump cursor to the currently displayed message's window.
2895 (@code{wl-summary-jump-to-current-message})
2899 Jump cursor to the other message.
2900 @findex wl-summary-jump-to-msg
2901 (@code{wl-summary-jump-to-msg})
2905 Update summary status and
2906 prefetch all messages which have marks included in the
2907 @code{wl-summary-incorporate-marks}.
2908 @findex wl-summary-incorporate
2909 (@code{wl-summary-incorporate})
2912 @kindex M-j (Summary)
2913 @findex wl-summary-jump-to-msg-by-message-id
2914 Jump cursor to the message which have specified @samp{Message-Id:}. If
2915 @code{elmo-use-database} is non-nil, other folder is also searched.
2916 (@code{wl-summary-jump-to-msg-by-message-id})
2920 Jump to parent message.
2921 @findex wl-summary-jump-to-parent-message
2922 (@code{wl-summary-jump-to-parent-message})
2926 @findex wl-summary-mark-as-unread
2927 Mark as unread the message at current cursor point.
2928 (@code{wl-summary-mark-as-unread})
2932 @findex wl-summary-sync
2933 Synchronize summary view after prompting the update range
2934 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
2938 all ...Discard current summary and update all message.
2939 update ...Update the difference between summary and the folder itself.
2940 rescan ...Rescan the msgdb and display again.
2941 rescan-noscore ...Rescan the msgdb and display again (without scoring).
2942 first, last ...Move to the filter folder(partial filter).
2947 (@code{wl-summary-sync})
2951 @findex wl-summary-sort
2953 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
2954 (@code{wl-summary-sort})
2958 @findex wl-summary-toggle-thread
2959 Toggle the threading.
2960 Threading status is displayed on the modeline.
2961 @samp{@{S@}} means threading is off (Sequence) and
2962 @samp{@{T@}} means threading is on (Thread).
2963 (@code{wl-summary-toggle-thread})
2967 @findex wl-summary-toggle-disp-folder
2968 Toggle displaying of folder window.
2969 (@code{wl-summary-toggle-disp-folder})
2973 Toggle displaying of message window.
2974 @findex wl-summary-toggle-disp-msg
2975 (@code{wl-summary-toggle-disp-msg})
2979 Move to the virtual folder with the condition specified.
2980 If called with prefix argument and current folder is virtual, exit it.
2981 @findex wl-summary-virtual
2982 (@code{wl-summary-virtual})
2985 @kindex @key{TAB} (Summary)
2986 @findex wl-summary-goto-last-displayed-msg
2987 Jump to the message which is displayed last.
2988 (@code{wl-summary-goto-last-displayed-msg})
2992 Put @samp{*} mark on the messages that satisfies the specified condition.
2993 @findex wl-summary-pick
2994 (@code{wl-summary-pick})
2998 @findex wl-summary-mark-as-read
2999 Mark as read the message at the current cursor point.
3000 (@code{wl-summary-mark-as-read})
3004 Prefetch the message at the current cursor point.
3005 With prefix argument, prefetch the message even if it is cached.
3006 @findex wl-summary-prefetch
3007 (@code{wl-summary-prefetch})
3011 Execute @samp{D}, @samp{o} and @samp{O} marks.
3012 @findex wl-summary-exec
3013 (@code{wl-summary-exec})
3017 @findex wl-summary-target-mark-line
3018 Put target mark on the message at the current cursor point.
3019 (@code{wl-summary-target-mark-line})
3023 Put refile mark on the message at the current cursor point.
3024 @findex wl-summary-refile
3025 (@code{wl-summary-refile})
3028 @kindex C-o (Summary)
3029 Execute auto refile.
3030 @findex wl-summary-auto-refile
3031 (@code{wl-summary-auto-refile})
3035 Put copy mark on the message at the current cursor point.
3036 @findex wl-summary-copy
3037 (@code{wl-summary-copy})
3040 @kindex M-o (Summary)
3041 Put refile mark on the message at the current cursor point with the destination
3042 previously specified.
3043 @findex wl-summary-refile-prev-destination
3044 (@code{wl-summary-refile-prev-destination})
3048 @findex wl-summary-delete
3049 Put delete mark on the message at the current cursor point.
3050 (@code{wl-summary-delete})
3054 @findex wl-summary-unmark
3055 Unmark the temporal mark on the message at the current cursor point.
3056 (@code{wl-summary-unmark})
3060 Unmark all the temporal marks.
3061 @findex wl-summary-unmark-all
3062 (@code{wl-summary-unmark-all})
3065 @kindex r R (Summary)
3066 @findex wl-summary-mark-as-read-region
3067 Mark as read messages in the specified region.
3068 (@code{wl-summary-mark-as-read-region})
3071 @kindex r $ (Summary)
3072 @findex wl-summary-mark-as-important-region
3073 Mark as important @samp{$} messages in the specified region.
3074 If @samp{$} already exists, it is deleted.
3075 (@code{wl-summary-mark-as-important-region})
3078 @kindex r ! (Summary)
3079 @findex wl-summary-mark-as-unread-region
3080 Mark as unread messages in the specified region.
3081 (@code{wl-summary-mark-as-unread-region})
3084 @kindex r i (Summary)
3085 @findex wl-summary-prefetch-region
3086 Prefetch messages in the specified region.
3087 (@code{wl-summary-prefetch-region})
3090 @kindex r x (Summary)
3091 @findex wl-summary-exec-region
3092 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3094 (@code{wl-summary-exec-region})
3097 @kindex r * (Summary)
3098 @findex wl-summary-target-mark-region
3099 Put target mark on the messages in the specified region.
3100 (@code{wl-summary-target-mark-region})
3103 @kindex r o (Summary)
3104 @findex wl-summary-refile-region
3105 Put refile mark on the messages in the specified region.
3106 (@code{wl-summary-refile-region})
3109 @kindex r O (Summary)
3110 @findex wl-summary-copy-region
3111 Put copy mark on the messages in the specified region.
3112 (@code{wl-summary-copy-region})
3115 @kindex r d (Summary)
3116 @findex wl-summary-delete-region
3117 Put delete mark on the messages in the specified region.
3118 (@code{wl-summary-delete-region})
3121 @kindex r u (Summary)
3122 @findex wl-summary-unmark-region
3123 Delete temporal mark on the messages in the specified region.
3124 (@code{wl-summary-unmark-region})
3127 @kindex r y (Summary)
3128 Save messages in the specified region.
3129 @findex wl-summary-save-region
3130 (@code{wl-summary-save-region})
3133 @kindex t R (Summary)
3134 @findex wl-thread-mark-as-read
3135 Mark as read messages which are the descendant of the current thread.
3136 With prefix argument, it affects on the all messages in the thread tree.
3137 (@code{wl-thread-mark-as-read})
3140 @kindex t $ (Summary)
3141 @findex wl-thread-mark-as-important
3142 Put important mark @samp{$} on the messages which are the
3143 descendant of the current thread.
3144 If @samp{$} mark exists, it is deleted.
3145 With prefix argument, it affects on the all messages in the thread tree.
3146 (@code{wl-thread-mark-as-important})
3149 @kindex t ! (Summary)
3150 @findex wl-thread-mark-as-unread
3151 Mark as unread messages which are the descendant of the current thread.
3152 With prefix argument, it affects on the all messages in the thread tree.
3153 (@code{wl-thread-mark-as-unread})
3156 @kindex t i (Summary)
3157 @findex wl-thread-prefetch
3158 Prefetch messages which are the descendant of the current thread.
3159 With prefix argument, it affects on the all messages in the thread tree.
3160 (@code{wl-thread-prefetch})
3163 @kindex t x (Summary)
3164 @findex wl-thread-exec
3165 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3166 the descendant of the current thread. With prefix argument, it affects
3167 on the all messages in the thread tree.
3168 (@code{wl-thread-exec})
3171 @kindex t * (Summary)
3172 @findex wl-thread-target-mark
3173 Put target mark @samp{*} on the messages which are the descendant of the
3174 current thread. With prefix argument, it affects on the all messages in
3176 (@code{wl-thread-target-mark})
3179 @kindex t o (Summary)
3180 @findex wl-thread-refile
3181 Put refile mark on the messages which are the descendant of the current thread.
3182 With prefix argument, it affects on the all messages in the thread tree.
3183 (@code{wl-thread-refile})
3186 @kindex t O (Summary)
3187 @findex wl-thread-copy
3188 Put copy mark on the messages which are the descendant of the current thread.
3189 With prefix argument, it affects on the all messages in the thread tree.
3190 (@code{wl-thread-copy})
3193 @kindex t d (Summary)
3194 @findex wl-thread-delete
3195 Put delete mar on the messages which are the descendant of the current thread.
3196 With prefix argument, it affects on the all messages in the thread tree.
3197 (@code{wl-thread-delete})
3200 @kindex t u (Summary)
3201 @findex wl-thread-unmark
3202 Unmark temporal mark on the messages which are the descendant of the
3203 current thread. With prefix argument, it affects on the all messages in
3205 (@code{wl-thread-unmark})
3208 @kindex t y (Summary)
3209 @findex wl-thread-save
3210 Save messages which are the descendant of the current thread.
3211 With prefix argument, it affects on the all messages in the thread tree.
3212 (@code{wl-thread-save})
3215 @kindex m i (Summary)
3216 @findex wl-summary-target-mark-prefetch
3217 Prefetch all messages which have target mark @samp{*}.
3218 (@code{wl-summary-target-mark-prefetch})
3221 @kindex m R (Summary)
3222 @findex wl-summary-target-mark-mark-as-read
3223 Mark as read all messages which have target mark @samp{*}.
3224 (@code{wl-summary-target-mark-mark-as-read})
3227 @kindex m $ (Summary)
3228 @findex wl-summary-target-mark-mark-as-important
3229 Mark as important all messages which have target mark @samp{*}.
3230 If already marked as @samp{$}, it is deleted.
3231 (@code{wl-summary-target-mark-mark-as-important})
3234 @kindex m ! (Summary)
3235 @findex wl-summary-target-mark-mark-as-unread
3236 Mark as unread all messages which have target mark @samp{*}.
3237 (@code{wl-summary-target-mark-mark-as-unread})
3240 @kindex m o (Summary)
3241 @findex wl-summary-target-mark-refile
3242 Put refile mark on the messages which have target mark @samp{*}.
3243 (@code{wl-summary-target-mark-refile})
3246 @kindex m O (Summary)
3247 @findex wl-summary-target-mark-copy
3248 Put copy mark on the messages which have target mark @samp{*}.
3249 (@code{wl-summary-target-mark-copy})
3252 @kindex m d (Summary)
3253 @findex wl-summary-target-mark-delete
3254 Put delete mark on the messages which have target mark @samp{*}.
3255 (@code{wl-summary-target-mark-delete})
3258 @kindex m y (Summary)
3259 @findex wl-summary-target-mark-save
3260 Save messages which have target mark @samp{*}.
3261 (@code{wl-summary-target-mark-save})
3264 @kindex m u (Summary)
3265 Unmark all temporal marks.
3266 (@code{wl-summary-delete-all-temp-marks})
3267 @findex wl-summary-delete-all-temp-marks
3270 @kindex m a (Summary)
3271 Put target mark @samp{*} on the all messages.
3272 (@code{wl-summary-target-mark-all})
3273 @findex wl-summary-target-mark-all
3276 @kindex m t (Summary)
3277 Put target mark @samp{*} on the messages in the current thread.
3278 @findex wl-summary-target-mark-thread
3279 (@code{wl-summary-target-mark-thread})
3282 @kindex m r (Summary)
3283 @findex wl-summary-target-mark-region
3284 Put target mark @samp{*} on the messages in the specified region.
3285 (@code{wl-summary-target-mark-region})
3288 @kindex m A (Summary)
3289 @findex wl-summary-target-mark-reply-with-citation
3290 Prepare a draft which cites all messages which have target mark @samp{*}.
3291 (@code{wl-summary-target-mark-reply-with-citation})
3294 @kindex m f (Summary)
3295 @findex wl-summary-target-mark-forward
3296 Prepare a draft which forwards all messages which have target mark @samp{*}.
3297 (@code{wl-summary-target-mark-forward})
3300 @kindex m U (Summary)
3301 @findex wl-summary-target-mark-uudecode
3302 Uudecode the messages which have target mark @samp{*}.
3303 (@code{wl-summary-target-mark-uudecode})
3306 @kindex m ? (Summary)
3307 @findex wl-summary-target-mark-pick
3308 Pick messages from the @samp{*} marked messages.
3309 That is, @samp{*} marks on the messages are remained
3310 if the specified condition is satisfied.
3311 (@code{wl-summary-target-mark-pick})
3314 @kindex M-t (Summary)
3315 @findex wl-toggle-plugged
3316 Toggle offline/online status of Wanderlust.
3317 (@code{wl-toggle-plugged})
3320 @kindex C-t (Summary)
3321 Start Wanderlust's plug-status manager.
3322 (@code{wl-plugged-change})
3325 @kindex C-c C-o (Summary)
3326 @findex wl-jump-to-draft-buffer
3327 Move to the draft buffer if available. If multiple draft buffer exists,
3328 moved to one after another. If prefix argument is specified, load draft
3329 folder's message to the draft buffer and jump to it.
3330 (@code{wl-jump-to-draft-buffer})
3333 @kindex M-w (Summary)
3334 @findex wl-summary-save-current-message
3335 Save the message at the current cursor point.
3336 (@code{wl-summary-save-current-message})
3339 @kindex C-y (Summary)
3340 @findex wl-summary-yank-saved-message
3341 Regard the message at the current cursor point as
3342 parent, connect the message saved by
3343 @code{wl-summary-save-current-message}
3345 (@code{wl-summary-yank-saved-message})
3349 @node Variables of Summary, , Key Bindings of Summary, Summary
3350 @section Customiziable variables
3353 @item wl-summary-move-order
3354 @vindex wl-summary-move-order
3355 The initial setting is @code{unread}. Specify cursor moving policy. If
3356 you want to precede new messages, set @code{new}. If you want to
3357 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3360 @item wl-auto-select-first
3361 @vindex wl-auto-select-first
3362 The initial setting is @code{nil}.
3363 If non-nil, first message is automatically displayed.
3365 @item wl-auto-select-next
3366 @vindex wl-auto-select-next
3367 The initial setting is @code{nil}. If non-nil, jump to next summary
3368 automatically. If @code{unread}, jump to next unread folder's summary
3369 after confirmation. If @code{skip-no-unread}, unread folders are
3370 automatically skipped.
3372 @item wl-thread-insert-opened
3373 @vindex wl-thread-insert-opened
3374 The initial setting is @code{nil}.
3375 If non-nil, thread is inserted as opened.
3377 @item wl-thread-open-reading-thread
3378 @vindex wl-thread-open-reading-thread
3379 The initial setting is @code{t}. If non-nil, reading thread is
3380 automatically opened though it is closed thread.
3382 @item wl-summary-exit-next-move
3383 @vindex wl-summary-exit-next-move
3384 The initial setting is @code{t}. If non-nil, move to next folder at
3387 @item wl-folder-move-cur-folder
3388 @vindex wl-folder-move-cur-folder
3389 The initial setting is @code{nil}. If non-nil, cursor position on the
3392 @item wl-summary-weekday-name-lang
3393 @vindex wl-summary-weekday-name-lang
3394 The initial setting is @samp{ja}. Specify language of the weekday.
3395 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3398 @item wl-summary-fix-timezone
3399 @vindex wl-summary-fix-timezone
3400 The initial setting is @samp{nil}.
3401 Time zone of the date string in summary mode is adjusted using this value.
3402 If @code{nil}, it is adjust to the default time zone information
3403 (system's default time zone or environment variable @samp{TZ}).
3405 @item wl-use-petname
3406 @vindex wl-use-petname
3407 The initial setting is @code{t}.
3408 If non-nil, sender part displays nickname.
3410 @item wl-break-pages
3411 @vindex wl-break-pages
3412 The initial setting is @code{t}.
3413 If non-nil, message is splitted as pages by @samp{^L}.
3415 @item wl-message-window-size
3416 @vindex wl-message-window-size
3417 The initial setting is '(1 . 4).
3418 A cons cell to specify the rate of summary and message window.
3419 car:cdr corresponds summary:message.
3421 @item wl-summary-recenter
3422 @vindex wl-summary-recenter
3423 The initial setting is t.
3424 If non-nil, cursor point is moved to the center of the summary window.
3426 @item wl-summary-indent-length-limit
3427 @vindex wl-summary-indent-length-limit
3428 The initial setting is 46.
3429 Specify the limit of thread indent level.
3430 If nil, max indent level is unlimited.
3432 @item wl-summary-no-from-message
3433 @vindex wl-summary-no-from-message
3434 The initial setting is @samp{nobody@@nowhere?}. A string which is
3435 displayed when there's no @samp{From:} field in the message.
3437 @item wl-summary-no-subject-message
3438 @vindex wl-summary-no-subject-message
3439 The initial setting is @samp{(WL:No Subject in original.)}. A string
3440 which is displayed when there's no @samp{Subject:} field in the message.
3442 @item wl-summary-width
3443 @vindex wl-summary-width
3444 The initial setting is 80.
3445 Width of summary line. If @code{nil}, summary line's width is as is.
3447 @item wl-use-folder-petname
3448 @vindex wl-use-folder-petname
3449 The initial setting is the list shown below:
3458 A list of display policy (symbol) of folder nickname. Available symbols
3463 Display folder petname on modeline.
3465 Destination folder is notified as nickname if
3466 @code{wl-auto-select-next} is non-nil.
3468 You can input folder name by nickname in the function
3469 @code{wl-summary-read-folder}.
3472 @item wl-summary-move-direction-toggle
3473 @vindex wl-summary-move-direction-toggle
3474 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3475 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3476 want to aware of reading direction, set this to @code{t}.
3479 @vindex wl-from-width
3480 The initial setting is 17.
3481 Width of sender part of summary line.
3483 @item wl-summary-divide-thread-when-subject-changed
3484 @vindex wl-summary-divide-thread-when-subject-changed
3485 The initial setting is @code{nil}. If non-nil, thread is splitted if
3486 the subject is changed.
3488 @item wl-summary-search-via-nntp
3489 @vindex wl-summary-search-via-nntp
3490 The initial setting is @code{confirm}.
3492 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3493 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3494 from the NNTP server @code{elmo-default-nntp-server}. The value of
3495 @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
3496 @code{elmo-default-nntp-stream-type} are used.
3498 If @code{confirm}, server name can be specified. You can specify NNTP
3499 folder format like @samp{-:username@@servername:119!}.
3501 @item wl-summary-keep-cursor-command
3502 @vindex wl-summary-keep-cursor-command
3503 The initial setting is the list shown below:
3507 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3512 When you entered to summary by these commands and the target summary
3513 buffer already exists, summary status is not automatically updated and
3514 cursor position is saved.
3516 @item wl-summary-update-confirm-threshold
3517 @vindex wl-summary-update-confirm-threshold
3518 The initial setting is 500. If updated message number is larger than
3519 this value, confirm whether drop them or not.
3521 @item wl-summary-always-sticky-folder-list
3522 @vindex wl-summary-always-sticky-folder-list
3523 The initial setting is @code{nil}.
3524 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3525 are automatically sticked. Each element is regexp of folder name.
3527 @item wl-summary-reserve-mark-list
3528 @vindex wl-summary-reserve-mark-list
3529 The initial setting is the list shown below:
3538 If a message is already marked as temporal marks in this list, the
3539 message is not marked by any mark command.
3541 @item wl-summary-skip-mark-list
3542 @vindex wl-summary-skip-mark-list
3543 The initial setting is the list shown below:
3552 If a message is already marked as temporal marks in this list, the
3553 message is skipped at cursor move.
3555 @item wl-fetch-confirm-threshold
3556 @vindex wl-fetch-confirm-threshold
3557 The initial setting is 30000 (bytes). If displaying message has larger
3558 size than this value, Wanderlust confirms whether fetch the message or
3559 not. If @code{nil}, the message is fetched without confirmation.
3561 @item wl-prefetch-threshold
3562 @vindex wl-prefetch-threshold
3563 The initial setting is 30000 (bytes). If prefetching message has larger
3564 size than this value and @code{wl-prefetch-confirm} is non-nil,
3565 Wanderlust confirms whether prefetch the message or not. If
3566 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3567 without confirmation.
3569 @item wl-prefetch-confirm
3570 @vindex wl-prefetch-confirm
3571 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3572 prefetch the message or not if the message has larger size than
3573 @code{wl-prefetch-threshold}.
3575 @item wl-cache-fetch-threshold
3576 @vindex wl-cache-fetch-threshold
3577 The initial setting is 30000 (bytes). The messages which have larger
3578 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3579 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3582 @item elmo-imap4-use-cache
3583 @vindex elmo-imap4-use-cache
3584 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3587 @item elmo-nntp-use-cache
3588 @vindex elmo-nntp-use-cache
3589 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3592 @item elmo-pop3-use-cache
3593 @vindex elmo-pop3-use-cache
3594 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3599 @node Message, Draft, Summary, Top
3600 @chapter Message Buffer
3602 Message Buffers utilize MIME-View mode of SEMI/tm. For operational
3603 procedures and key bindings, refer to respective documents.
3604 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3606 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3607 brings you back to Summary mode. @kbd{l} toggles display of Summary
3610 @section Key Bindings
3616 @findex wl-message-toggle-disp-summary
3617 Toggles display of Summary mode buffer.
3618 (@code{wl-message-toggle-disp-summary})
3621 @findex wl-message-refer-article-or-url
3622 @kindex Button-2 (Message)
3623 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3624 corresponding message if found.
3625 (@code{wl-message-refer-article-or-url})
3627 @item Button-4 (upward movement of a wheel)
3628 @kindex Button-4 (Message)
3629 @findex wl-message-wheel-down
3630 Scrolls the message backwards. When the top of the message is hit,
3631 moves to the previous message.
3632 (@code{wl-message-wheel-down})
3634 @item Button-5 (downward movement of a wheel)
3635 @kindex Button-5 (Message)
3636 @findex wl-message-wheel-up
3637 Scrolls the message forward. When the bottom of the message is hit,
3638 moves to the next message.
3639 (@code{wl-message-wheel-up})
3642 @section Customizable Variables
3645 @item wl-message-window-size
3646 @vindex wl-message-window-size
3647 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3648 its car and cdr value corresponds to the ratio of Summary and Message
3650 @item wl-message-ignored-field-list
3651 @vindex wl-message-ignored-field-list
3652 (SEMI only) Initial setting is nil.
3653 All fields that match this list will be hidden in message buffer.
3654 Each elements are regexp of field-name.
3655 If nil, the value of mime-view-ignored-field-list is used.
3656 @item wl-message-visible-field-list
3657 @vindex wl-message-visible-field-list
3658 (SEMI only) Initial setting is nil.
3659 All fields that match this list will be hidden in message buffer.
3660 Each elements are regexp of field-name. This value precedes
3661 wl-message-ignored-field-list.
3662 If nil, the value of mime-view-visible-field-list is used.
3663 @item wl-message-sort-field-list
3664 @vindex wl-message-sort-field-list
3665 (SEMI only) Initial setting is
3666 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3667 Header fields in message buffer are orderd by this value.
3668 Each elements are regexp of field-name.
3671 @node Draft, Disconnected Operations, Message, Top
3672 @chapter Draft Buffer
3674 At Summary mode, pressing @kbd{w} and the like creates a new draft
3675 buffer. You can edit and send mail and news articles in this buffer.
3679 Basically it is Emacs-standard mail mode.
3681 @subsection Address Completion
3683 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3684 addresses. @kbd{@key{TAB}} completes them.
3686 If you want to submit a news article, add @samp{Newsgroups:} field by
3687 yourself. Field names can be completed by @kbd{@key{TAB}}.
3689 If you save the draft buffer you are editing, it is appended to the
3690 folder specified by @code{wl-draft-folder}.
3692 Using @samp{FCC:} field, you can specify the folder to which a copy of
3693 the message is saved when it is sent.
3695 @subsection Editing Messages
3697 Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
3698 editing, refer to respective documents.
3699 @xref{MIME-Edit, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3701 @subsection Dynamic Modification of Messages
3702 @vindex wl-draft-config-alist
3703 @c @cindex Change Message
3704 @c @cindex Message, Change Dynamic
3706 You can set @code{wl-draft-config-alist} so that header and body of the
3707 message will automatically modified depending on information of header
3710 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3712 In the example below, the header is modified when
3713 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3714 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3715 before sending the message.
3719 (setq wl-draft-config-alist
3720 '(((string-match "aaa.example.com$" (system-name))
3721 ;; @r{applied if the expression is non-nil}
3722 (wl-smtp-posting-server . "mailserver-B")
3723 (wl-nntp-posting-server . "newsserver-B")
3724 ;; @r{settings of temporary variables}
3726 ("^To: .*user@@aaa.bbb.example.com"
3727 ;; @r{applied if it matches the header of the draft buffer}
3728 ("Organization" . (format "Go %s" my-webpage)))
3729 ;; @r{you can write elisp expressions here (eval only)}
3730 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3731 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3736 The format of @code{wl-draft-config-alist} is:
3740 '(("@var{regexp of the header}" or @var{elisp expression}
3741 ("@var{Field}" . value(@var{elisp expression}))
3742 (@var{variable} . value(@var{elisp expression}))
3743 (@var{sub-function} . value(@var{elisp expression}))
3746 ("@var{regexp of the header}" or @var{elisp expression}
3747 ("@var{Field}" . value(@var{elisp expression}))
3752 Per default, there are 10 following sub-functions.
3755 'header: Inserts the specified string at the bottom of the header.
3756 'header-file: Inserts the specified file at the bottom of the header.
3757 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3758 'top: Inserts the specified string at the top of the body.
3759 'top-file: Inserts the specified file at the top of the body.
3760 'body: Replaces the body with the specified string.
3761 Specifying @code{nil} deletes the entire body string.
3762 'body-file: Replaces the body with the content of the specified file.
3763 'bottom: Inserts the specified string at the bottom of the body.
3764 'bottom-file: Inserts the specified file at the top of the body.
3765 'template: Applies the specified template.
3766 (refer to the next subsection)
3769 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3770 change them or add your own functions. If you read the code, you can
3771 easily find how to write the functions.
3773 At the first of each item, @var{a regular expression of the header} or
3774 an @var{elisp expression} should be specified. In the case of an elisp
3775 expression, the item is applied when the expression is evaluated
3778 Per default, when multiple items match or are evaluated non-nil, all
3779 such items are applied, but if you set a variable
3780 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3783 At the second of the item, a cons or a list of functions should be
3784 specified. The car part of the cons should be a header field, a
3785 variable, or a sub-function. When a header field is specified, the
3786 field will be modified. If a variable is specified, the value of the
3787 variable will be modified temporarily.
3789 In the cdr part of a cons, not only a variable but also an elisp
3790 expression can be specified as is. If the car part is a header field
3791 and the cdr part is @code{nil}, the field will be deleted.
3793 See the next example as well:
3797 (setq wl-draft-config-alist
3799 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3800 ;; @r{applied if it matches the header of the buffer being replied}
3801 (body . " Hello.\n")
3802 (template . "default")
3807 As in the (1) above, if a header regexp is prepended with @code{reply},
3808 it is applied when the draft is prepared by @code{wl-summary-reply} for
3809 example, and when it matches the header being replied. It is ignored
3810 when there is no buffer being replied, like after @code{wl-draft} was
3813 Note that @code{wl-draft-config-alist} is applied only once when
3814 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3815 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3816 aborting transmission, execute @kbd{C-c C-e}
3817 (@code{wl-draft-config-exec}) explicitly.
3819 If you don't want to apply @code{wl-draft-config-alist} when
3820 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3824 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3827 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3828 prepared, do the following:
3831 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3834 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3835 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3839 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3842 @subsection Inserting Templates
3844 @cindex Apply Template
3846 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3847 @kbd{M-x wl-template-select} in the draft buffer.
3849 The format of @code{wl-template-alist} is almost the same as
3850 @code{wl-draft-config-alist}.
3854 (setq wl-template-alist
3857 ("Organization" . "~/.wl sample")
3858 (body . "Hello.\n"))
3860 (template . "default") ;; @r{(a)}
3861 ("To" . "boss@@example.com")
3862 ("Subject" . "Report")
3863 (body-file . "~/work/report.txt")
3869 As you can see, the only difference is item (template) names such as
3870 @samp{default} and @samp{report}, instead of a regexp of header.
3871 Because definition of each item is the same as
3872 @code{wl-draft-config-alist}, you can call another template, like (a).
3874 Executing the command @code{wl-template-select} results in template
3875 selection, but the result differs depending on variable
3876 @code{wl-template-visible-select}.
3878 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3879 window is shown below the draft buffer. You can select a template by
3880 @kbd{n} and @kbd{p} seeing the buffer window.
3882 Press the @key{RET} key and the template is actually applied to the draft
3883 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3884 adjust the window size by @code{wl-template-buffer-lines}.
3886 If @code{wl-template-visible-select} is @code{nil}, you should type the
3887 name of the template in the mini buffer.
3889 As shown in the example in @code{wl-draft-config-alist}, you can select
3890 @samp{default} template by writing:
3893 (template . "default")
3896 @subsection Sending mail by POP-before-SMTP
3897 @cindex POP-before-SMTP
3899 You can send mail by POP-before-SMTP with this single line:
3902 (setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
3906 Configure the following variables if you need.
3909 @item wl-pop-before-smtp-user
3910 The POP user name for POP-before-SMTP authentication.
3911 If unset, @code{elmo-default-pop3-user} is used.
3913 @item wl-pop-before-smtp-server
3914 The POP server name for POP-before-SMTP authentication.
3915 If unset, @code{elmo-default-pop3-server} is used.
3917 @item wl-pop-before-smtp-authenticate-type
3918 The POP authentication method for POP-before-SMTP authentication.
3919 If unset, @code{elmo-default-pop3-authenticate-type} is used.
3921 @item wl-pop-before-smtp-port
3922 The POP port number for POP-before-SMTP authentication.
3923 If unset, @code{elmo-default-pop3-port} is used.
3925 @item wl-pop-before-smtp-stream-type
3926 If non-nil, POP connection is established using SSL. If
3927 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
3928 unset, @code{elmo-default-pop3-stream-type} is used.
3931 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
3932 unset, settings for POP folders (@code{elmo-default-pop3-*}) are
3934 Therefore, if SMTP server and POP server are actually the same, and if
3935 POP folder per default (such as @samp{&}) is available, no settings are
3938 Refer to the following URL about POP-before-SMTP.
3942 http://spam.ayamura.org/tools/smPbS.html
3943 http://www.iecc.com/pop-before-smtp.html
3947 @section Key Bindings
3948 @cindex Keybind, Draft Mode
3949 @cindex Keybind, Draft Buffer
3954 @kindex C-c C-y (Draft)
3955 @findex wl-draft-yank-original
3956 Cites the content of the current message buffer.
3957 (@code{wl-draft-yank-original})
3960 @kindex C-c C-p (Draft)
3961 @findex wl-draft-preview-message
3962 Previews the content of the current draft.
3963 This is useful for previewing MIME multi-part messages.
3964 (@code{wl-draft-preview-message})
3967 @kindex C-c C-s (Draft)
3968 @findex wl-draft-send
3969 Sends the content of the current draft. Does not erase the draft buffer.
3970 This is useful for sending multiple messages, which are a little different
3972 (@code{wl-draft-send})
3975 @kindex C-c C-c (Draft)
3976 @findex wl-draft-send-and-exit
3977 Sends the content of the current draft and erases the draft buffer.
3978 (@code{wl-draft-send-and-exit})
3981 @kindex C-x C-s (Draft)
3982 @findex wl-draft-save
3983 Save the current draft.
3984 (@code{wl-draft-save})
3987 @kindex C-c C-k (Draft)
3988 @findex wl-draft-kill
3989 Kills the current draft.
3990 (@code{wl-draft-kill})
3993 @kindex C-x k (Draft)
3994 @findex wl-draft-mimic-kill-buffer
3995 Kills the current draft.
3996 (@code{wl-draft-mimic-kill-buffer})
3999 @kindex C-c C-z (Draft)
4000 @findex wl-draft-save-and-exit
4001 Saves the current draft, and erases the draft buffer.
4002 This is useful if you want to suspend editing of the draft.
4003 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4004 the @samp{+draft} folder.
4005 (@code{wl-draft-save-and-exit})
4008 @kindex C-c C-r (Draft)
4009 @findex wl-caesar-region
4010 Encodes or decodes the specified region in Caesar cipher.
4011 (@code{wl-caesar-region})
4015 @findex wl-toggle-plugged
4016 Toggles off-line/on-line states of Wanderlust.
4017 (@code{wl-toggle-plugged})
4020 @kindex C-c C-o (Draft)
4021 @findex wl-jump-to-draft-buffer
4022 Jumps to the other draft buffer, if exists.
4023 With prefix argument, reads a file (if any) from the draft folder when
4024 there is no such buffer.
4025 (@code{wl-jump-to-draft-buffer})
4028 @kindex C-c C-e (Draft)
4029 @findex wl-draft-config-exec
4030 Applies @code{wl-draft-config-alist}.
4031 (@code{wl-draft-config-exec})
4034 @kindex C-c C-j (Draft)
4035 @findex wl-template-select
4037 (@code{wl-template-select})
4040 @kindex C-c C-a (Draft)
4041 @findex wl-draft-insert-x-face-field
4042 Inserts the content of a file @file{~/.xface} (the value of the variable
4043 @code{wl-x-face-file}) as an @samp{X-Face:} field in the draft buffer.
4045 There should be encoded X-Face strings as a content of a file @file{~/.xface}.
4046 (@code{wl-draft-insert-x-face-field})
4049 @section Customizable Variables
4052 @item wl-subscribed-mailing-list
4053 @vindex wl-subscribed-mailing-list
4054 The initial setting is @code{nil}. Mailing lists to which you
4055 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4056 field of a reply draft, removes your own address from
4057 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4058 contained in @samp{To:} or @samp{Cc:} field of a message to be
4059 automatically re-filed, the destination folder will be leaned in
4060 connection with the address.
4066 (setq wl-subscribed-mailing-list
4067 '("wl@@lists.airs.net"
4069 "emacs-mime-ja@@m17n.org"))
4073 @item wl-insert-mail-followup-to
4074 @vindex wl-insert-mail-followup-to
4075 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4076 field is automatically inserted in the draft buffer.
4078 @item wl-insert-mail-reply-to
4079 @vindex wl-insert-mail-reply-to
4080 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4081 field is automatically inserted in the draft buffer.
4083 @item wl-auto-insert-x-face
4084 @vindex wl-auto-insert-x-face
4085 The initial setting is @code{t}. If non-nil and there is an encoded
4086 X-Face string in a file @file{~/.xface} (the value of the variable
4087 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4088 draft buffer. If @code{nil}, it is not automatically inserted. Press
4089 @kbd{C-c C-a} to insert.
4091 @item wl-insert-message-id
4092 @vindex wl-insert-message-id
4093 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4094 is automatically inserted on the transmission.
4096 @item wl-local-domain
4097 @vindex wl-local-domain
4098 The initial setting is @code{nil}. If @code{nil}, the return value of
4099 the function @code{system-name} will be used as the domain part of
4102 If @code{system-name} does not return FQDN (i.e. the full name of the
4103 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4104 to the string of the local domain name without hostname (like
4105 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4106 @samp{.} @code{wl-local-domain} is used as domain part of the
4109 If your terminal does not have global IP, set the value of
4110 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4111 you use invalid @samp{Message-ID:}.)
4113 Moreover, concatenation of @code{system-name} @samp{.}
4114 @code{wl-local-domain} will be used as an argument to the HELO command
4117 @item wl-message-id-domain
4118 @vindex wl-message-id-domain
4119 The initial setting is @code{nil}. If non-nil, this value is used as a
4120 domain part of the @samp{Message-ID:}. If your terminal does not have
4121 global IP address, set unique string to this value (e.x. your e-mail
4124 @item wl-message-id-domain
4125 @vindex wl-message-id-domain
4126 The initial setting is @code{nil}. If @code{nil}, the return value of
4127 the function @code{system-name} will be used as the domain part of
4128 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4129 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4130 @strong{must} set this variable to the string of the full name of the
4131 host. Otherwise, you might be beaten up on the Net News.
4133 @item wl-draft-config-alist
4134 @vindex wl-draft-config-alist
4135 The initial setting is @code{nil}. Modifies the draft message just
4136 before the transmission. The content of @code{wl-draft-config-alist}
4137 will be automatically applied only once on the transmission. If you
4138 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4141 @item wl-template-alist
4142 @vindex wl-template-alist
4143 The initial setting is @code{nil}.
4144 This variable specifies the template to be applied in the draft buffer.
4146 @item wl-draft-config-matchone
4147 @vindex wl-draft-config-matchone
4148 The initial setting is @code{nil}. If non-nil, only the first matching
4149 item is used when @code{wl-draft-config-alist} is applied. If
4150 @code{nil}, all matching items are used.
4152 @item wl-template-visible-select
4153 @vindex wl-template-visible-select
4154 The initial setting is @code{t}.
4155 If non-nil, you can preview the result of the template selection in
4158 @item wl-template-confirm
4159 @vindex wl-template-confirm
4160 The initial setting is @code{nil}.
4161 If non-nil, asks for confirmation when you press the enter key to select
4162 template while previewing.
4164 @item wl-template-buffer-lines
4165 @vindex wl-template-buffer-lines
4166 The initial setting is 7.
4167 If @code{wl-template-visible-select} is non-nil, this variable specifies
4168 the size of the preview window.
4170 @item wl-draft-reply-buffer-style
4171 @vindex wl-draft-reply-buffer-style
4172 The initial setting is @code{split}. @code{split} or @code{full} can be
4173 specified. In the case of @code{full}, the whole frame will be used for
4174 a reply draft buffer when it is prepared.
4176 @item wl-draft-use-frame
4177 @vindex wl-draft-use-frame
4178 The initial setting is @code{nil}.
4179 If non-nil, use new frame for the draft.
4183 The initial setting is the value of the variable
4184 @code{user-mail-address}. The value of this variable is inserted as a
4185 @samp{From:} field of the draft when it is prepared.
4187 @item wl-envelope-from
4188 @vindex wl-envelope-from
4189 The initial setting is @code{nil}.
4190 The value of this variable is used for envelope from (MAIL FROM).
4191 If @code{nil}, the address part of @code{wl-from} is used.
4193 @item wl-user-mail-address-list
4194 @vindex wl-user-mail-address-list
4195 The initial setting is @code{nil}.
4196 This is the User's address list. If you have multiple addresses,
4201 The initial setting is @code{nil}.
4202 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4203 the draft when it is prepared. If function is specified, its return
4208 The initial setting is @code{nil}.
4209 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4210 the draft when it is prepared.
4212 @item wl-reply-subject-prefix
4213 @vindex wl-reply-subject-prefix
4214 The initial setting is @samp{Re: }.
4215 In the @samp{Subject:} of the reply draft, this string is prepended to
4216 the @samp{Subject:} of being replied.
4218 @item wl-draft-reply-use-address-with-full-name
4219 @vindex wl-draft-reply-use-address-with-full-name
4220 The initial setting is @code{t}.
4221 If non-nil, insert her full name with address when prepare a draft for
4222 reply a message. If it is @code{nil}, insert her address only.
4224 @item wl-draft-enable-queuing
4225 @vindex wl-draft-enable-queuing
4226 The initial setting is @code{t}.
4227 This flag controls off-line transmission. If non-nil, the draft is
4230 @item wl-draft-use-cache
4231 @vindex wl-draft-use-cache
4232 The initial setting is @code{nil}. If the value is non-nil and
4233 @code{wl-insert-message-id} is nil, cache the message which is sent.
4235 @item wl-auto-flush-queue
4236 @vindex wl-auto-flush-queue
4237 The initial setting is t.
4238 This flag controls automatic transmission of the queue when Wanderlust
4239 becomes on-line. If non-nil, the queue is automatically transmitted
4240 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4241 manually, press @kbd{F} in the folder mode.
4243 @item wl-ignored-forwarded-headers
4244 @vindex wl-ignored-forwarded-headers
4245 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4246 All headers that match this regexp will be deleted when forwarding a message.
4248 @item wl-ignored-resent-headers
4249 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4250 All headers that match this regexp will be deleted when resending a message.
4252 @item wl-draft-always-delete-myself
4253 @vindex wl-draft-always-delete-myself
4254 If non-nil, always removes your own address from @samp{To:} and
4255 @samp{Cc:} when you are replying to the mail addressed to you.
4257 @item wl-draft-delete-myself-from-bcc-fcc
4258 @vindex wl-draft-delete-myself-from-bcc-fcc
4259 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4260 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4262 @item wl-smtp-posting-server
4263 @vindex wl-smtp-posting-server
4264 The initial setting is @code{nil}.
4265 This is the SMTP server name for mail transmission.
4267 @item wl-smtp-posting-user
4268 @vindex wl-smtp-posting-user
4269 The initial setting is @code{nil}.
4270 This is the user name for SMTP AUTH authentication. If @code{nil},
4271 @code{smtp-authenticate-user} is used.
4273 @item wl-smtp-authenticate-type
4274 @vindex wl-smtp-authenticate-type
4275 The initial setting is @code{nil}.
4276 This is the authentication method for SMTP AUTH authentication. If
4277 @code{nil}, @code{smtp-authenticate-type} is used. If
4278 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4281 @item wl-smtp-connection-type
4282 @vindex wl-smtp-connection-type
4283 The initial setting is @code{nil}.
4284 This variable specifies how to establish SMTP connections.
4285 If @code{nil}, @code{smtp-connection-type} is used.
4286 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4288 @item wl-nntp-posting-server
4289 @vindex wl-nntp-posting-server
4290 The initial setting is @code{nil}.
4291 This is the NNTP server name used for news submission.
4292 If @code{nil}, @code{elmo-default-nntp-server} is used.
4294 @item wl-nntp-posting-user
4295 @vindex wl-nntp-posting-user
4296 The initial setting is @code{nil}.
4297 This is the user name for AUTHINFO authentication on news submission.
4298 If @code{nil}, @code{elmo-default-nntp-user} is used.
4299 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4301 @item wl-nntp-posting-port
4302 @vindex wl-nntp-posting-port
4303 The initial setting is @code{nil}.
4304 This is the port number of the NNTP server used for news submission.
4305 If @code{nil}, @code{elmo-default-nntp-server} is used.
4307 @item wl-nntp-posting-stream-type
4308 @vindex wl-nntp-posting-stream-type
4309 The initial setting is @code{nil}.
4310 If @code{nil}, @code{elmo-default-nntp-stream-type} is evaluated. If non-nil,
4311 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4312 connection will be established.
4314 @item wl-pop-before-smtp-user
4315 @vindex wl-pop-before-smtp-user
4316 The initial setting is @code{nil}.
4317 This is the POP user name for POP-before-SMTP.
4318 If it is @code{nil}, @code{elmo-default-pop3-user} is used.
4320 @item wl-pop-before-smtp-server
4321 @vindex wl-pop-before-smtp-server
4322 The initial setting is @code{nil}.
4323 This is the POP server name for POP-before-SMTP.
4324 If it is @code{nil}, @code{elmo-default-pop3-server} is used.
4326 @item wl-pop-before-smtp-authenticate-type
4327 @vindex wl-pop-before-smtp-authenticate-type
4328 The initial setting is @code{nil}.
4329 This is the authentication method for POP-before-SMTP authentication.
4330 If it is @code{nil}, @code{elmo-default-pop3-authenticate} is used.
4332 @item wl-pop-before-smtp-port
4333 @vindex wl-pop-before-smtp-port
4334 The initial setting is @code{nil}.
4335 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4336 @code{elmo-default-pop3-port} is used.
4338 @item wl-pop-before-smtp-stream-type
4339 @vindex wl-pop-before-smtp-stream-type
4340 The initial setting is @code{nil}.
4341 This flag controls the use of SSL for POP-before-SMTP. If it is
4342 @code{nil}, @code{elmo-default-pop3-stream-type} is used. If @code{starttls},
4343 STARTTLS (RFC2595) connection will be established.
4345 @item wl-draft-queue-save-variables
4346 @vindex wl-draft-queue-save-variables
4347 Specifies a list of variable to which queued messages are saved on the
4348 off-line transmission.
4350 @item wl-draft-sendlog
4351 @vindex wl-draft-sendlog
4352 The initial setting is @code{t}.
4353 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4357 @item drafts are sent by smtp or qmail
4358 @item saved into folders by fcc
4359 @item saved into folders by queuing
4362 (it is written even if the transmission fails).
4363 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4364 and left to the logging function of @command{imput}.
4367 @item wl-draft-sendlog-max-size
4368 @vindex wl-draft-sendlog-max-size
4369 The initial setting is 20000 (in bytes).
4370 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4371 beyond the size specified by this variable.
4375 The initial setting is @code{nil}.
4376 If non-nil, address completion uses LDAP.
4378 @item wl-ldap-server
4379 @vindex wl-ldap-server
4380 The initial setting is @samp{localhost}.
4381 LDAP server name for address completion.
4384 @vindex wl-ldap-port
4385 The initial setting is @code{nil}.
4386 If non-nil, the value is used as port number.
4389 @vindex wl-ldap-base
4390 The initial setting is @samp{c=US}.
4391 LDAP search starting point (base) for address completion.
4393 @item wl-draft-remove-group-list-contents
4394 @vindex wl-draft-remove-group-list-contents
4395 The initial setting is @code{t}.
4396 If non-nil, remove the group-lists' members in the recipients when
4397 sending the message (group-list means the description such as
4398 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4401 @node Disconnected Operations, Expire and Archive, Draft, Top
4402 @chapter Off-line Management
4403 @cindex Disconnected Operations
4405 Wanderlust has on-line and off-line states.
4408 * Off-line State:: Wanderlust has on-line and off-line states.
4409 * Enable Operations:: Enable Disconeected Operations.
4410 * Plugged Mode:: Switching On-line/Off-line per Server/Port.
4411 * Off-line State settings:: Invoking Wanderlust in the Off-line State.
4412 * Variables of Plugged Mode:: Customize Plugged Mode.
4416 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4417 @section Off-line State
4419 Wanderlust has on-line and off-line states. In the off-line state, you
4420 cannot access messages via network, unless they are cached.
4422 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4423 in the mode line indicates the off-line state. In folder or summary
4424 modes, press @kbd{M-t} to switch between off- and on-line.
4426 You can invoke Wanderlust in the off-line state by setting
4427 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4429 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4430 ignores uncached messages.
4433 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4434 @section Enable Disconeected Operations
4436 Even in the off-line state, provided that relevant messages are cached,
4437 and the variable @code{elmo-enable-disconnected-operation} (described
4438 later) is non-nil, you can following operations:
4439 @xref{Plugged Mode}, @xref{Off-line State settings}.
4442 * Send Messages off-line:: Transmit Messages.
4443 * Re-file and Copy queue:: Re-file and Copy (IMAP4).
4444 * Creation of Folders:: Create Folders off-line (IMAP4).
4445 * Marking:: Mark (IMAP4).
4446 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP).
4449 As soon as Wanderlust becomes on-line, such operations invoked off-line
4450 are reflected in the servers via network.
4453 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4454 @subsection Transmission of Messages
4456 You can send mail/news messages off-line (if you are using
4457 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4458 accumulated in the queue folder, @samp{+queue}. These messages are
4459 transmitted at once when Wanderlust becomes on-line.
4461 You can visit @samp{+queue} in the off-line state and confirm content of
4462 messages in the queue. You can also remove messages. Removed messages
4463 are not transmitted even in the on-line state.
4466 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4467 @subsection Re-file and Copy (IMAP4)
4469 Re-file and copy operations to IMAP folders invoked during the off-line
4470 state are accumulated in the queue, and reflected in the server side
4471 when Wanderlust becomes on-line. If you visit destination folders after
4472 off-line re-file or copy, it looks as if messages were appended even in
4475 For the safety reasons, messages re-filed off-line are removed from
4476 source folders only if their @samp{Message-ID:} match messages on the
4477 servers. While the queue is processed, messages that failed to be
4478 re-filed or copied to the specified folders are appended to the folder
4482 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4483 @subsection Creation of Folders (IMAP4)
4485 You can create IMAP folders off-line. The creation of folders are
4486 reflected in the servers when Wanderlust becomes on-line. At that time,
4487 if folders failed to be created on the servers for any reasons, messages
4488 re-filed to such folders are appended to the folder @samp{+lost+found}.
4491 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4492 @subsection Marking (IMAP4)
4494 Off-line changes in unread/read and importance mark @samp{$} information
4495 are also reflected in the servers when Wanderlust becomes on-line.
4498 @node Pre-fetching Reservations, , Marking, Enable Operations
4499 @subsection Pre-fetching (IMAP4, NNTP)
4501 You can make reservations for pre-fetching messages in IMAP or NNTP
4502 folders. Reserved messages are marked with @samp{!} but not cached
4503 yet. When Wanderlust becomes on-line, they are pre-fetched from
4506 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4507 these off-line operations for IMAP4 and NNTP do not take place, and
4508 off-line re-file, copy or suchlike simply results in error.
4510 Because off-line operations use cache files, it is a bad idea to erase
4511 them by hand; it may cause Wanderlust to malfunction.
4513 If you want to remove caches, be sure to execute @kbd{M-x
4514 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4515 remove caches for messages relevant to off-line operations.
4518 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4519 @section Switching On-line/Off-line per Server/Port
4521 @kbd{M-t} described above switches networking states as a whole, but you
4522 can switch on-line/off-line per server/port.
4524 Pressing @kbd{C-t} in the folder or summary modes brings you in
4525 wl-plugged-mode shown below, in which you can change the plugged state
4530 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4533 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4534 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4536 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4537 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4543 The first line indicates status of the following three variables, and
4544 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
4545 column modifies the values of these variables.
4549 "Queuing" @code{wl-draft-enable-queuing}
4550 "AutoFlushQueue" @code{wl-auto-flush-queue}
4551 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4555 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4558 The second and after lines indicate on-line/off-line states of servers
4559 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4560 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4561 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4563 @dfn{sending queue} means messages accumulated in the folder
4564 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4565 off-line operations when @code{elmo-enable-disconnected-operation} is
4567 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4568 @c off-line operations are enabled.
4570 They are displayed if there are any of them. In the example above, in
4571 the sending queue there are two messages (the first and the second in
4572 the queue folder) for smtp to hosta and one (the third) for nntp to
4573 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4576 If you change @samp{(wl-plugged)} in the second line, the variable
4577 @code{wl-plugged} is changed, so that the mode line indicator and
4578 plugged states of all ports are affected. If you change plugged states
4579 of any servers or ports, @samp{(wl-plugged)} in the second line is
4580 affected depending on @code{elmo-plugged-condition} settings and the
4581 plugged state of each port.
4584 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4585 @section Invoking Wanderlust in the Off-line State
4587 As described before, if you set @code{wl-plugged} to @code{nil} in
4588 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4589 off-line state. You can specify off-line state on a per server or port
4590 basis. Refer to @code{wl-reset-plugged-alist} also.
4592 Usually, when Wanderlust starts up, the plugged state of each port is
4593 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4594 @code{wl-nntp-posting-server} and so on. If you want to change the
4595 plugged state of these ports or to add other ports, configure
4596 @code{wl-make-plugged-hook} with a function.
4600 (add-hook 'wl-make-plugged-hook
4602 (elmo-set-plugged plugged-value(t/nil) server port)
4603 ;; @r{add or change plugged states of the port of the server}
4604 (elmo-set-plugged plugged-value(t/nil) server)
4605 ;; @r{if the port is omitted, all ports are affected}
4606 ;; @r{(you cannot omit the port if you newly add the server)}
4612 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4613 @section Customizable Variables
4618 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4619 mode from the beginning.
4621 @item wl-queue-folder
4622 @vindex wl-queue-folder
4623 The initial setting is @samp{+queue}.
4624 This is the folder in which messages in the transmission queue are
4627 @item wl-auto-flush-queue
4628 @vindex wl-auto-flush-queue
4629 The initial setting is @code{t}.
4630 This flag controls automatic transmission of the queue when Wanderlust
4631 becomes on-line. If non-nil, the queue is automatically transmitted
4632 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4633 manually, press @kbd{F} in the folder mode.
4635 @item elmo-enable-disconnected-operation
4636 @vindex elmo-enable-disconnected-operation
4637 The initial setting is @code{nil}. Controls off-line operations
4638 regarding IMAP4. If non-nil, off-line operations are carried out.
4640 @item elmo-lost+found-folder
4641 @vindex elmo-lost+found-folder
4642 The initial setting is @samp{+lost+found}.
4643 This is the folder to which messages are saved when they fails to be
4644 appended while the off-line re-file/copy queue is processed.
4646 @item elmo-plugged-condition
4647 @vindex elmo-plugged-condition
4648 The initial setting is @code{one}.
4649 The value of @code{wl-plugged} reflects the return value of the function
4650 @code{elmo-plugged-p} (without arguments).
4651 This variable @code{elmo-plugged-condition} specifies the condition on
4652 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4653 plugged state of each port.
4656 'one : plugged if one or more ports are plugged.
4657 'all : plugged if all ports are plugged.
4658 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4659 states of the ports.
4660 @var{function} : reflects the return value of the @var{function}
4661 functions available per default
4662 'elmo-plug-on-by-servers
4663 : reflects the plugged state of the servers specified by the
4664 variable elmo-plug-on-servers.
4665 'elmo-plug-on-by-exclude-servers
4666 : reflects the plugged state of the servers that are not
4667 in elmo-plug-on-exclude-servers.
4668 elmo-plug-on-exclude-servers defaults to
4671 (system-name)without the domain part)
4677 (setq elmo-plugged-condition 'all)
4679 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4680 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4682 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4683 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4687 @item wl-reset-plugged-alist
4688 @vindex wl-reset-plugged-alist
4689 The initial setting is @code{t}. If non-nil, plugged states are
4690 initialized on a per server or port basis when Wanderlust starts up.
4692 If @code{nil}, plugged states are retained while Emacs is running. In
4693 other words, they are initialized when Emacs is restarted even if the
4694 value is @code{nil}.
4698 @node Expire and Archive, Scoring, Disconnected Operations, Top
4699 @chapter Automatic Expiration and Archiving of Messages
4700 @cindex Expire and Archive
4703 * Expire:: Expiration and Archiving
4704 * Archive:: Archiving All Messages
4708 @node Expire, Archive, Expire and Archive, Expire and Archive
4710 @cindex Expire Message
4712 Expiration means deletion of old messages which have outlasted a
4713 certain period of time.
4715 @code{wl-expire} supports not only simple deletion, but also moving to
4716 specified archiving folders.
4720 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4721 or @kbd{M-e} in the summary mode.
4723 @subsection Configuring @code{wl-expire-alist}
4725 An example configuration of @code{wl-expire-alist} is shown below.
4726 Everything in this @code{wl-expire-alist} makes a great difference in
4727 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4728 to @code{t}, especially in the initial stage.
4732 (setq wl-expire-alist
4733 '(("^\\+trash$" (date 14) remove)
4735 ("^\\+tmp$" (date 7) trash)
4736 ;; @r{re-file to @code{wl-trash-folder}}
4737 ("^\\+outbox$" (number 300) "$outbox;lha")
4738 ;; @r{re-file to the specific folder}
4740 ;; @r{do not expire}
4741 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4742 ;; @r{archive by message number (retaining numbers)}
4743 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4744 ;; @r{archive by a fixed number (retaining numbers)}
4745 ("^\\+diary$" (date 30) wl-expire-archive-date)
4746 ;; @r{archive by year and month (numbers discarded)}
4751 Items in the list has the format of:
4754 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4758 The folder is examined if it matches @var{regexp-for-folders} from the
4759 beginning of the list. If you invoke expiration on the folder that does
4760 not match any of them, nothing will happen. And if either the second or
4761 the third element of the item is @code{nil}, expiration will not take
4764 You can use any one of the following for
4765 @var{specification-of-message-to-be-deleted}:
4768 @item (number @var{n1} [@var{n2}])
4769 deletes messages depending on the number of messages in the folder.
4771 @var{n1} is the number of messages which should survive deletion, for example
4772 if its value is 500, the newest 500 messages survive and the rests are
4775 @var{n2} is the number of messages in the folder on which expiration should
4776 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4777 folders with 510 or more messages are expired.
4778 If you configured automatic expiration, frequently used folders may
4779 expire every time it receive messages, and you may be annoyed with the
4780 long delay in reading mail.
4781 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4782 expiration would not take place until a certain number of messages
4785 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4786 with important/new/unread) are not deleted.
4787 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4788 will expire so as to have 500 messages including such ones.
4789 Otherwise, it will have 500 messages except such ones.
4791 @item (date @var{d1})
4792 deletes messages depending on the dates.
4794 Messages dated @var{d1} or more days ago are deleted, for example if its
4795 value is seven, messages seven days old or more are deleted. Note that
4796 the date is the one in the @samp{Date:} field of the message, not when
4797 the message entered the folder.
4799 Messages with no or invalid @samp{Date:} field does not expire; you
4800 might have to delete them by hand.
4803 You can use any one of the following in the place of @var{destination}:
4807 deletes the messages instantly.
4810 hide the messages from summary (messages are not deleted).
4813 moves the messages to @code{wl-trash-folder}.
4815 @item @var{string}(folder)
4816 moves the messages to the folder specified with @var{string}.
4818 It would be useful for specifying an archiving folder, but because this
4819 does not move important messages, it might be better to use the
4820 standard functions described below.
4822 @item @var{function}
4823 invokes the specified @var{function}.
4825 To the @var{function}, three arguments are passed: a folder name, a list
4826 of messages to be deleted, and msgdb information of the summary. You
4827 can specify function-specific arguments after the name of the
4828 @var{function}. Note that the list contains messages with marks in
4829 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4832 These are three standard functions; they moves messages to an archive
4833 folder in the specified way. This means old messages can be compressed
4834 and saved in a file, being deleted from the original folder.
4837 @item wl-expire-archive-number1
4838 re-files to archiving folders corresponding to the message numbers of
4839 the messages being deleted. For example, a message numbered 102 will be
4840 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4841 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4842 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4844 The archiving folders to which messages are re-filed are determined by
4845 the name of the folder as follows (in this case, archiving folders are
4846 handled as if @code{elmo-archive-treat-file} were non-nil).
4849 @item If the folder type is localdir:
4850 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4852 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4853 (@file{~/Mail/ml/wl-00100.zip}).
4855 @item The folder type is other than localdir:
4856 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4858 For example, @samp{%#mh/ml/wl} corresponds to
4859 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4862 As you can see, in the case of localdir, the folder type is not included
4863 in the path name, but otherwise it is included.
4864 And you can control the prefix to the archiving folder name by
4865 @code{wl-expire-archive-folder-prefix}.
4866 Refer to @code{wl-expire-archive-folder-prefix} for details.
4868 @item wl-expire-archive-number2
4869 re-files every certain number of messages to archiving folders.
4871 This differs from @samp{wl-expire-archive-number1} in that this re-files
4872 to the folder up to the specified number regardless of message numbers.
4873 The archiving folders to which messages are re-filed are determined in the
4874 same way as @code{wl-expire-archive-number1}.
4876 @item wl-expire-archive-date
4877 re-files messages depending on its date (year and month) to archive
4880 For example, a message dated December 1998 is re-filed to
4881 @code{$folder-199812;zip}. The name of the archiving folders except the
4882 date part are determined in the same way as
4883 @code{wl-expire-archive-number1}.
4886 You can set the first argument to these three standard functions to non-nil
4887 in @code{wl-expire-alist} so as to retain message numbers in the folder.
4888 For example, it can be specified just after the name of the function:
4891 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
4894 If you omit the argument, consecutive numbers from 1 are assigned for
4895 each archiving folder.
4898 @subsection Treatment for Important or Unread Messages
4900 If you specify any of @code{remove}, @code{trash}, a folder name, or a
4901 standard function, messages with marks in
4902 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
4903 messages} thereafter) are retained.
4905 Per default, this variable include the important, new, and unread marks,
4906 so that messages with these marks are not removed.
4907 Note that you cannot include the temporary mark (i.e. temporary marks
4908 are removed anyway), and be sure to process temporary marks before you
4911 @subsection Auto Expiration
4913 The following setup invokes expiration when you move into the summary
4914 mode. There will be no confirmation, so make sure you made no mistake
4915 in regexp and other settings before you set up this.
4919 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
4923 In the folder mode, you can invoke expiration per group as well as per
4924 folder. Therefore, if you specify @samp{Desktop} group, all folders
4925 matching @code{wl-expire-alist} expire.
4929 @subsection Treating archive folders.
4930 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
4931 you must set non-nil value to @code{elmo-archive-treat-file}.
4933 @subsection Confirming
4935 If you are to use @code{remove}, try @code{trash} at first and see
4936 messages move to @code{wl-trash-folder} as expected, then replace it
4937 with @code{remove}. It would be dangerous to use @code{remove} from the
4940 If you are to use @code{wl-expire-archive-number1} and the like, try to
4941 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
4942 you can append messages to it. Even if settings in
4943 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
4944 would not be saved anywhere and disappeared in case the archiver program
4947 After you make sure you can archive to the folder correctly, you can
4948 invoke expiration and utilize the log.
4950 If you set @code{wl-expire-use-log} to @code{t},
4951 @file{~/.elmo/expired-log} should contain the log, for example:
4955 delete +ml/wl (593 594 595 596 597 598 599)
4956 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
4960 The first column indicates the operation, i.e. @samp{delete},
4961 @samp{copy}, or @samp{move}. The next is the name of the folder that
4962 expired. In the case of @samp{copy} and @samp{move}, the destination
4963 folder is recorded after @samp{->}. The last is the list of message
4964 numbers that are actually deleted or moved (in the case of @samp{copy}
4965 and @samp{move}, the number is the one in the source folder, rather than
4966 the destination folder).
4968 @subsection Re-filing Reserved Messages
4970 The three standard functions copy reserved messages to the archive
4971 folder, but do not delete them from the source folder. Because
4972 reserved messages and the like always remain, they are recorded in
4973 @file{~/.elmo/expired-alist} so that they are not copied over and over
4974 again. They are not recorded if copied by @code{wl-summary-archive}.
4976 If you enabled logging, usually @samp{move} is recorded for re-filing,
4977 but instead @samp{copy} and @samp{delete} are recorded separately if
4978 reserved messages are involved. This is because it actually copies
4979 messages including reserved, then deletes ones except reserved in that
4982 @section Customizable Variables
4985 @item wl-expire-alist
4986 @vindex wl-expire-alist
4987 The initial setting is @code{nil}.
4988 This variable specifies folders and methods to expire. For details,
4989 refer to @code{wl-expire-alist} settings above.
4991 @item wl-summary-expire-reserve-marks
4992 @vindex wl-summary-expire-reserve-marks
4993 The initial setting is the list below.
4997 (list wl-summary-important-mark
4999 wl-summary-unread-mark
5000 wl-summary-unread-uncached-mark
5001 wl-summary-unread-cached-mark)
5005 Messages with these marks are retained in the folder, even after
5007 Only permanent marks can be listed, not temporary marks.
5009 You can list marks one by one as in the default; you can use the
5010 following settings as well:
5014 All messages with permanent marks are retained,
5015 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5019 All messages are handled as usual ones that are already read, no matter
5020 what marks they have; even important messages are deleted.
5023 @item wl-expire-archive-files
5024 @vindex wl-expire-archive-files
5025 The initial setting is 100.
5026 This variable specifies the number of messages to be retained in one
5029 @item wl-expire-number-with-reserve-marks
5030 @vindex wl-expire-number-with-reserve-marks
5031 The initial setting is @code{nil}.
5032 If non-nil, if expiring messages are specified by @code{number},
5033 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5035 @item wl-expire-archive-get-folder-func
5036 @vindex wl-expire-archive-get-folder-func
5037 The initial setting is @code{wl-expire-archive-get-folder}.
5039 This variable specifies a function that returns the name of an archiving
5040 folder for standard functions in the place of @var{destination}.
5041 You can use the following three variables for simple modification of
5042 folder names; if you want more complex settings, define your own
5043 function in this variable.
5045 @code{wl-expire-archive-get-folder} can be customized by these
5048 @item @code{wl-expire-archive-folder-name-fmt}
5049 @item @code{wl-expire-archive-folder-type}
5050 @item @code{wl-expire-archive-folder-prefix}
5053 @item wl-expire-archive-folder-name-fmt
5054 @vindex wl-expire-archive-folder-name-fmt
5055 The initial setting is @samp{%s-%%05d;%s}.
5056 This is a @code{format} string for archiving folders used in
5057 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5058 Note that you must specify the message number by @samp{%%d}, because it
5059 is parsed twice by @code{format}.
5061 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5064 @item wl-expire-archive-date-folder-name-fmt
5065 @vindex wl-expire-archive-date-folder-name-fmt
5066 The initial setting is @samp{%s-%%04d%%02d;%s}.
5067 This is a @code{format} string for archiving folders used in
5068 @code{wl-expire-archive-date}. Note that you must specify the message
5069 number by @samp{%%d}, because it is parsed twice by @code{format}.
5070 There should be @samp{%%d} twice, one for the year and the other for the
5073 If you modify this, adjust
5074 @code{wl-expire-archive-date-folder-num-regexp} as well.
5076 @item wl-expire-archive-folder-type
5077 @vindex wl-expire-archive-folder-type
5078 The initial setting is @code{zip}.
5079 This variable specifies an archiver type of the archiving folders.
5081 @item wl-expire-archive-folder-prefix
5082 @vindex wl-expire-archive-folder-prefix
5083 The initial setting is @code{nil}.
5084 This variable specifies the prefix (directory structure) to archiving
5086 Exercise extreme caution in using this feature, as it has not been
5088 In the worst case, there is a fear of destructing archiving folders.
5092 There will be no prefix.
5095 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5096 @samp{$ml/wl-00000;zip;wl}.
5099 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5102 @samp{$ml/wl-00000;zip;ml/wl}.
5105 @item wl-expire-archive-folder-num-regexp
5106 @vindex wl-expire-archive-folder-num-regexp
5107 The initial setting is @samp{-\\([-0-9]+\\);}.
5108 This variable specifies the regular expression to be used for getting
5109 message numbers from multiple archiving folders specified by
5110 @code{elmo-list-folders}.
5111 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5113 @item wl-expire-archive-date-folder-num-regexp
5114 @vindex wl-expire-archive-date-folder-num-regexp
5115 The initial setting is @samp{-\\([-0-9]+\\);}.
5116 This is the regular expression to be used for getting message numbers
5117 from multiple archiving folders specified by @code{elmo-list-folders}.
5118 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5120 @item wl-expire-delete-oldmsg-confirm
5121 @vindex wl-expire-delete-oldmsg-confirm
5122 The initial setting is @code{t}.
5123 If non-nil, messages older than the one with the largest number will be
5124 deleted with confirmation.
5125 If @code{nil}, they are deleted without confirmation.
5127 This feature is valid only if non-nil is specified as a argument to the
5128 standard functions so as to retain numbers.
5130 @item wl-expire-use-log
5131 @vindex wl-expire-use-log
5132 The initial setting is @code{nil}.
5133 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5134 They are appended but not truncated or rotated automatically; you might
5135 need to remove it manually.
5137 @item wl-expire-add-seen-list
5138 @vindex wl-expire-add-seen-list
5139 The initial setting is @code{t}.
5141 If non-nil, when messages are re-filed by expiration, read/unread
5142 information is passed to the destination folder.
5144 However if you do not read the destination folder from Wanderlust,
5145 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5146 want to set this to @code{nil} if you are simply saving to some
5147 archiving folders. Even if its value is @code{nil}, messages in the
5148 archiving folders are simply treated as unread; it does not affect
5151 @item wl-expire-folder-update-msgdb
5152 @vindex wl-expire-folder-update-msgdb
5153 The initial setting is @code{t}.
5154 If @code{t}, in the folder mode, expiration is carried out after
5155 updating summary information. If you specified a list of regular
5156 expressions of folder names, summary information is updated for matching
5161 @node Archive, , Expire, Expire and Archive
5162 @section Archiving Messages
5164 @subsection Archiving Messages
5165 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5166 folders. If there are the archiving folders already, only new messages
5169 You can use @code{wl-archive-alist} in order to specify how messages are
5170 archived according to their folder names, as in @code{wl-expire-alist}.
5175 (setq wl-archive-alist
5176 '(("^\\+tmp$" wl-archive-date)
5177 ("^\\+outbox$" wl-archive-number2)
5178 (".*" wl-archive-number1)))
5182 Each item in the list has the following format:
5185 (@var{folders-regexp} @var{deleting-function})
5188 As you can see, you can only use a function after @var{folders-regexp}.
5189 Per default, there are three functions:
5192 @item @code{wl-archive-number1}
5193 @item @code{wl-archive-number2}
5194 @item @code{wl-archive-date}
5197 As inferred from their names, they work similarly to "expire" versions,
5198 other than the following points:
5201 @item No messages are deleted
5202 @item Message numbers are retained even if invoked without arguments
5205 These functions are good to archive all messages in a folder by their
5206 numbers or by their dates.
5207 These are also useful for backup or confirmation purposes before
5209 If you try to re-file them after they are archived, they are deleted but
5212 Per default, the archiving folders to which messages are copied are
5213 determined automatically by @code{wl-expire-archive-get-folder-func}.
5214 You can copy to a specific folder by invoking with a prefix argument,
5215 i.e. @kbd{C-u M-x wl-summary-archive}.
5217 Note that this feature has not been seriously tested, because you can
5218 simply copy to an archiving folder, for example by
5219 @code{wl-summary-copy-region}.
5221 The archiving folders are determined by the same logic as in
5222 @code{wl-summary-expire}; the following customizable variables are
5226 @item @code{wl-expire-archive-files}
5227 @item @code{wl-expire-archive-get-folder-func}
5228 @item @code{wl-expire-archive-folder-name-fmt}
5229 @item @code{wl-expire-archive-folder-type}
5230 @item @code{wl-expire-archive-folder-prefix}
5231 @item @code{wl-expire-archive-folder-num-regexp}
5234 @subsection Customizable Variables
5237 @item wl-archive-alist
5238 @vindex wl-archive-alist
5239 The initial setting is the list shown below:
5243 ((".*" wl-archive-number1))
5248 This variable specifies a function that copies to archiving folders.
5249 To the function, three arguments are passed: a folder name, a list of
5250 messages in the folder, and msgdb information of the summary.
5251 Needless to say, you can use your own function.
5255 @node Scoring, Customization, Expire and Archive, Top
5256 @chapter Score of the Messages
5258 @c @cindex Kill File
5260 Scoring is the function that associates a score (value) with each
5261 message, and marks as read or deletes from the summary according to it.
5263 You can put target or important marks on essential messages, or read marks
5264 on the ones you do not want to read, for example spam articles.
5266 This scoring function has a capability and a format similar to the one
5267 that Gnus has, although there are some unsupported features and
5268 Wanderlust specifics.
5269 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5272 * Score Commands:: Score Commands
5273 * Score File Format:: Score File Format
5277 @node Score Commands, Score File Format, Scoring, Scoring
5278 @section Score Commands
5279 @cindex Score Commands
5281 @subsection Score File Specification
5283 @code{wl-score-folder-alist} specifies score files or variables in which
5284 scores are defined, corresponding to folder names.
5288 (setq wl-score-folder-alist
5297 If paths to the score files are omitted, the directory specified in the
5298 variable @code{wl-score-files-dir} is assumed.
5300 No matter what you write in @code{wl-score-folder-alist}, the default
5301 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5302 read (it does not have to exist).
5303 Therefore, in the example above, the three score files,
5304 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5305 the folders that matches @samp{^-.*}.
5307 @subsection Scored Messages
5309 Scores are attached to the messages that are specified by
5310 @code{wl-summary-score-marks} temporarily when the summary is updated;
5311 when you exit from the summary, the scores are removed and reverts to
5314 @subsection Creation of Score Files
5316 In the summary buffer, move to an appropriate message and type @kbd{L}.
5317 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5318 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5320 This makes @minus{}1000 are scored for messages with the same
5321 @samp{Subject:} as the string you entered. That is, such a score file
5322 is created automatically.
5324 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5325 The score file you just made appears.
5326 This buffer is called @dfn{score editing buffer} thereafter.
5327 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5328 as you are previously; type @kbd{a}. Then a score entry for "From"
5330 In this way, you can create a score file easily either in the summary
5331 buffer or in the score editing buffer.
5333 By the way, you might be aware the numbers of key strokes are different
5334 between @kbd{s s p} and @kbd{a}.
5335 This is determined by @code{wl-score-header-default-entry}.
5336 This variable specifies the default score entries corresponding to
5338 For example, for "subject" field, a type and a time limit are prompted,
5339 but for "from" field, they are fixed upon automatically as substring and
5340 permanent respectively.
5341 However, score values can be modified by the prefix argument.
5342 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5345 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5346 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5347 erasing contents of the buffer deletes the score file being edited.
5351 @subsubsection Selecting Score Files
5353 You can change score files to which scores are appended by
5354 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5355 @code{wl-score-change-score-file}.
5357 @subsubsection Summing Up the Score
5359 If you add the same entries by @code{wl-summary-increase-score},
5360 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5361 scores for the entry is summed up.
5363 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5364 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5365 @minus{}1200 will be created as a result.
5367 @subsubsection Creating Thread Key
5369 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5370 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5372 @subsubsection Creating Followup Key
5374 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5375 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5376 at the cursor to @samp{References} key.
5377 If @code{wl-score-auto-make-followup-entry} is non-nil,
5378 @samp{Message-ID} of all messages to be followed up within dates
5379 specified by @code{wl-score-expiry-days}.
5381 @subsection Key Bindings
5386 @findex wl-summary-increase-score
5387 Increases the score for the current message.
5388 And the score entry is appended to the score file at the same moment.
5389 You can specify the score value by a prefix argument.
5393 @findex wl-summary-lower-score
5394 Decreases the score for the current message.
5395 And the score entry is appended to the score file at the same moment.
5396 You can specify the score value by a prefix argument.
5399 @kindex h R (Summary)
5400 @findex wl-summary-rescore
5401 Re-applies the scoring.
5402 However, already scored messages are not scored anew.
5405 @kindex h c (Summary)
5406 @findex wl-score-change-score-file
5407 Changes the score file currently selected.
5410 @kindex h e (Summary)
5411 @findex wl-score-edit-current-scores
5412 Edits the score file currently selected.
5413 If there are multiple score files, the previously specified one is
5417 @kindex h f (Summary)
5418 @findex wl-score-edit-file
5419 Edits an arbitrary score file and selects it.
5422 @kindex h F (Summary)
5423 @findex wl-score-flush-cache
5424 Erases caches associated to the score files that are read.
5425 If you modified score files directly (from other than Wanderlust), you
5426 need to re-read them after erasing the cache.
5429 @kindex h m (Summary)
5430 @findex wl-score-set-mark-below
5431 Specifies the criterion for scores to be marked as read.
5432 Messages with scores less than this value are marked as read.
5435 @kindex h x (Summary)
5436 @findex wl-score-set-expunge-below
5437 Specifies the criterion for scores to be deleted from the summary.
5438 Messages with scores less than this value are deleted.
5439 "Deleted" means it is not shown; they are not removed from the summary
5440 information or the folder.
5441 The deleted messages can be shown by rescan-noscore again.
5444 @subsection Key Bindings in the Score Editing Buffer
5448 @kindex C-c C-k (Score Mode)
5449 @findex wl-score-edit-kill
5450 Abandons the file being edited.
5453 @kindex C-c C-c (Score Mode)
5454 @findex wl-score-edit-exit
5455 Saves the file being edited, and quits from the edit mode.
5458 @kindex C-c C-p (Score Mode)
5459 @findex wl-score-pretty-print
5463 @kindex C-c C-d (Score Mode)
5464 @findex wl-score-edit-insert-date
5465 Inserts the number of dates from Dec. 31, 1 B.C.
5466 It is used for creating the third factor of time-limited scores.
5469 @kindex C-c C-s (Score Mode)
5470 @findex wl-score-edit-insert-header
5471 Inserts the header of the message selected in the summary buffer.
5474 @kindex C-c C-e (Score Mode)
5475 @findex wl-score-edit-insert-entry
5476 Inserts the score entry of the message selected in the summary buffer.
5479 @subsection Customizable Variables
5482 @item wl-summary-default-score
5483 @vindex wl-summary-default-score
5484 The initial setting is 0 (zero).
5485 This variable specifies the default value of the score.
5486 The score is increased or decreased based upon this value.
5488 @item wl-summary-important-above
5489 @vindex wl-summary-important-above
5490 The initial setting is @code{nil}.
5491 Messages with scores larger than this value are attached with the
5492 important mark (@samp{$}).
5493 If @code{nil}, no important marks are attached.
5495 @item wl-summary-target-above
5496 @vindex wl-summary-target-above
5497 The initial setting is @code{nil}.
5498 Messages with scores larger than this value are attached with the target
5500 If @code{nil}, no target marks are attached.
5502 @item wl-summary-mark-below
5503 @vindex wl-summary-mark-below
5504 The initial setting is 0 (zero).
5505 Messages with scores smaller than this value are marked as read.
5507 @item wl-summary-expunge-below
5508 @vindex wl-summary-expunge-below
5509 The initial setting is @code{nil}.
5510 Messages with scores smaller than this value are deleted from the
5512 If @code{nil}, they are not deleted.
5514 @item wl-summary-score-marks
5515 @vindex wl-summary-score-marks
5516 The initial setting is the list shown below:
5520 (list wl-summary-new-mark)
5525 Messages with these marks are scored.
5527 @item wl-use-scoring
5528 @vindex wl-use-scoring
5529 The initial setting is t.
5530 If non-nil, scoring is enabled.
5532 @item wl-score-files-dir
5533 @vindex wl-score-files-dir
5534 The initial setting is @file{~/.elmo/}.
5535 The default directory for score files.
5537 @item wl-score-interactive-default-score
5538 @vindex wl-score-interactive-default-score
5539 The initial setting is 1000.
5540 This value is used as a score when a score factor is @code{nil} in the
5541 score file. It is also used in @code{wl-summary-increase-score} and
5542 @code{wl-summary-lower-score}, on condition that the value of
5543 @code{wl-score-header-default-entry} is @code{nil}.
5545 @item wl-score-expiry-days
5546 @vindex wl-score-expiry-days
5547 The initial setting is 7.
5548 This is the number of days before time-limited scores are deleted.
5550 @item wl-score-update-entry-dates
5551 @vindex wl-score-update-entry-dates
5552 The initial setting is @code{t}.
5553 If non-nil, it enables deletion of time-limited scores.
5555 @item wl-score-header-default-entry
5556 @vindex wl-score-header-default-entry
5557 Specifies the default value for each header field for score entries
5558 created by @code{wl-summary-increase-score},
5559 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5561 @item wl-score-simplify-fuzzy-regexp
5562 @vindex wl-score-simplify-fuzzy-regexp
5563 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5564 regular expression to be deleted from the string.
5565 Because this is usually used for Subject, the default is prefixes that
5566 are attached by mailing list programs.
5568 @item wl-summary-rescore-partial-threshold
5569 @vindex wl-summary-rescore-partial-threshold
5570 The initial setting is 200.
5571 When sync-all or rescan is executed, if there are messages more than
5572 this value, only the last same number of messages as this value are
5575 @item wl-summary-auto-sync-marks
5576 @vindex wl-summary-auto-sync-marks
5577 If non-nil, unread/important marks are synchronized when the summary
5579 Unread marks reflect information on the IMAP4 server.
5580 Important marks reflect information on the IMAP4 server (flagged or
5581 not), and contents of @samp{'mark} folder.
5582 The initial setting is @code{t}.
5586 @node Score File Format, , Score Commands, Scoring
5587 @section Score File Format
5588 @cindex Score File Format
5590 The format of score files are the same as Gnus, and basically you can
5591 use Gnus score files as they are. But they are not fully compatible
5592 because some keys are not supported and there are Wanderlust specifics.
5593 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5598 ("for sale" -1000 nil s)
5599 ("profit" -1000 nil s))
5601 ("spam@@spamspamspam" -10000 nil s))
5603 ("my@@address" 3001 nil s))
5605 (1000000 -10 nil >))
5615 If the key is a string, it is the name of the header to be matched.
5616 The following keys are available:
5617 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5618 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5619 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5620 @code{Chars} and @code{Lines} mean the size and the number of lines of
5621 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5622 are described later.
5623 The rest corresponds the field of the same name.
5625 Arbitrary numbers of core entries are specified after the key.
5626 Each score entry consists of these five factors:
5630 A factor that matches header. This should be a number in the cases of
5631 @code{lines} and @code{chars}, otherwise a string.
5634 A score factor. When the first item matches, the score of the message
5635 is increased or decreased by this value.
5638 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5639 of a number, the score is deleted if it does not match for days
5640 (@code{wl-score-expiry-days}) from the date specified by this.
5641 The date is since Dec. 31, 1 B.C.
5644 A type factor. This specifies the way the first factor matches.
5645 Available types depend on keys.
5648 @item From, Subject, References, Message-ID
5649 For these keys in string, @code{r} and @code{R} (regexp),
5650 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5651 as well as @code{f} and @code{F} (fuzzy) can be used.
5652 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5655 For these keys, the following five numerical relative operators can be
5656 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5659 This key matches @code{From} header, and scores all follow-ups to the
5661 For example, it would be useful for increasing scores for follow-ups to
5664 You can use the same types as @code{From} except for @code{f}.
5665 And a @samp{Followup} entry is automatically appended to the score file.
5668 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5669 A @samp{Thread} entry is automatically appended for each article that
5670 has @var{x} in the @code{References} header.
5671 You can make sure the whole thread including messages that does not have
5672 all ancestors @code{Message-ID} in @code{References} is scored.
5674 You can use the same types as @code{References} except for @code{f}.
5675 And a @samp{Thread} entry is automatically appended to the score file.
5679 A factor for extension header. This is meaningful only if the key is
5681 This specifies headers to be matched other than standard headers like
5682 @code{Subject} and @code{From}.
5683 Note that you should specify the header in
5684 @code{elmo-msgdb-extra-fields} also.
5685 Therefore it does not work in folders where extension headers cannot be
5690 The sum of these scores @emph{after all factors are applied} becomes the
5691 score of the message.
5693 @cindex Score File Atoms
5695 Messages with a score less than this value is marked as read.
5696 The default is @code{wl-summary-mark-below}.
5699 Messages with a score less than this value is deleted from the summary.
5700 The default is @code{wl-summary-expunge-below}.
5702 @item mark-and-expunge
5703 Both @code{mark} and @code{expunge} are applied,
5704 i.e. messages with a score less than this value is marked as read and
5705 deleted from the summary.
5708 Messages with a score greater than this value is attached with temp
5710 The default is @code{wl-summary-target-above}.
5713 Messages with a score greater than this value is attached with important
5715 The default is @code{wl-summary-important-above}.
5720 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5721 are used, you need to set @code{elmo-msgdb-extra-fields}.
5724 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5727 There are other restrictions as shown below:
5730 @item Because @samp{References} field in the summary information
5731 contains only the last @samp{Message-ID}, @code{references} key matches
5735 Keys that can be seen by folder of types:
5739 chars lines xref extra
5740 localdir,localnews Y E E E
5741 nntp (supporting xover) Y E E N
5747 N: cannot be seen (ignored)
5748 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5753 @node Customization, Mailing List, Scoring, Top
5754 @chapter Customizing Wanderlust
5755 @cindex Customization
5758 * Living with other packages:: Living with other packages
5759 * Highlights:: Highlights
5760 * Biff:: Notify Mail arrival
5761 * Advanced Settings:: Advanced Settings
5762 * Customizable Variables:: Customizable Variables
5767 @node Living with other packages, Highlights, Customization, Customization
5768 @section Living with other packages
5770 Examples with other packages.
5773 * imput:: imput (im-wl.el)
5775 * supercite:: supercite.el
5776 * mu-cite:: mu-cite.el
5777 * x-face-mule:: x-face-mule.el
5778 * dired-dd:: dired-dd.el
5783 @node imput, BBDB, Living with other packages, Living with other packages
5788 Place @file{util/im-wl.el} on the @code{load-path} and do the following
5791 If @command{imput} is on the @code{exec-path} at the installation,
5792 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
5796 (autoload 'wl-draft-send-with-imput-async "im-wl")
5797 (setq wl-draft-send-func 'wl-draft-send-with-imput-async)
5802 @node BBDB, supercite, imput, Living with other packages
5806 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
5809 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
5810 byte-compiled and installed.
5818 ;; @r{enable pop-ups}
5819 (setq bbdb-use-pop-up t)
5820 ;; @r{auto collection}
5821 (setq bbdb/mail-auto-create-p t)
5822 (setq signature-use-bbdb t)
5823 (setq bbdb-north-american-phone-numbers-p nil)
5824 ;; @r{shows the name of bbdb in the summary} :-)
5825 (setq wl-summary-from-func 'bbdb-wl-from-func)
5826 ;; @r{automatically add mailing list fields}
5827 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
5828 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
5832 @node supercite, mu-cite, BBDB, Living with other packages
5833 @subsection sc.el(supercite), sc-register.el
5837 The same setting as usual mailers should be OK. The following is an
5838 example of settings:
5842 (autoload 'sc-cite-original "sc" nil t)
5843 (setq mail-yank-hooks 'sc-cite-original)
5844 (setq sc-preferred-header-style 1)
5845 (setq sc-electric-references-p nil)
5846 (setq sc-citation-leader "")
5847 (setq sc-load-hook '(lambda () (require 'sc-register)))
5848 (setq sc-preferred-attribution 'registeredname)
5853 @node mu-cite, x-face-mule, supercite, Living with other packages
5854 @subsection mu-cite.el
5857 The same setting as usual mailers should be OK. The following is an
5858 example of settings.
5860 If you use mu-cite version 8.0 or earlier:
5864 (autoload 'mu-cite/cite-original "mu-cite" nil t)
5865 (setq mail-citation-hook 'mu-cite/cite-original)
5869 If you use mu-cite version 8.1 or later:
5873 (autoload 'mu-cite-original "mu-cite" nil t)
5874 (add-hook 'mail-citation-hook (function mu-cite-original))
5878 @node x-face-mule, dired-dd, mu-cite, Living with other packages
5879 @subsection x-face-mule.el
5883 It depends on the version of x-face-mule.
5884 If you use x-face-mule 0.19 or older, do the following:
5888 (setq wl-highlight-x-face-func
5890 (lambda (&optional beg end)
5891 (x-face-mule:x-face-decode-message-header))))
5892 (require 'x-face-mule)
5896 If you use x-face-mule 0.20 or later, try the following:
5900 (setq wl-highlight-x-face-func
5902 (lambda (&optional beg end)
5903 (x-face-mule-x-face-decode-message-header))))
5904 (require 'x-face-mule)
5908 Use these settings when you use @file{x-face-mule.el} attached to
5909 bitmap-mule 8.0 or later:
5913 (autoload 'x-face-decode-message-header "x-face-mule")
5914 (setq wl-highlight-x-face-func 'x-face-decode-message-header)
5918 If there is an encoded X-Face string in a file @file{~/.xface} (the
5919 value of the variable @code{wl-x-face-file}), it is inserted as a
5920 @samp{X-Face:} field in the draft buffer (if
5921 @code{wl-auto-insert-x-face} is non-nil).
5924 @node dired-dd, MHC, x-face-mule, Living with other packages
5925 @subsection dired-dd(Dired-DragDrop)
5926 @pindex Dired-DragDrop
5928 @cindex Drag and Drop
5930 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
5931 compose multi-part by simple Drag-and-Drop from dired to the draft
5932 buffer being edited in GNU Emacs (this feature is not Wanderlust
5933 specific, but general-purpose for tm/SEMI).
5937 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
5943 ;; @r{Set dired-x variables here.}
5944 ;; @r{To and flo@dots{}}
5946 (progn (require 'dired-dd)
5947 (require 'dired-dd-mime))))))
5951 @node MHC, , dired-dd, Living with other packages
5955 Message Harmonized Calendaring system
5956 (@uref{http://www.quickhack.net/mhc/})
5958 By using MHC, you can make a calendar from the messages.
5964 (setq mhc-mailer-package 'wl)
5965 (autoload 'mhc-mode "mhc" nil t)
5966 (add-hook 'wl-summary-mode-hook 'mhc-mode)
5967 (add-hook 'wl-folder-mode-hook 'mhc-mode)
5975 (autoload 'mhc-wl-setup "mhc-wl")
5976 (add-hook 'wl-init-hook 'mhc-wl-setup)
5980 @node Highlights, Biff, Living with other packages, Customization
5983 @subsection Customizable Variables
5986 @item wl-summary-highlight
5987 @vindex wl-summary-highlight
5988 The initial setting is @code{t}.
5989 If non-nil, the summary is highlighted.
5991 @item wl-highlight-max-summary-lines
5992 @vindex wl-highlight-max-summary-lines
5993 The initial setting is 10000.
5994 The summary is not highlighted if it has more lines than this value.
5996 @item wl-summary-highlight-partial-threshold
5997 @vindex wl-summary-highlight-partial-threshold
5998 The initial setting is 1000.
5999 This is a threshold whether the whole summary is highlighted.
6000 If there are more lines of messages in the summary, it is partially
6003 @item wl-summary-partial-highlight-above-lines
6004 @vindex wl-summary-partial-highlight-above-lines
6005 The initial setting is 30. If there are more lines of messages than
6006 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6007 after the point that is the same number of lines as this value above the
6008 cursor line are highlighted partially. (If this value is @code{nil},
6009 the last same number of lines as the value of
6010 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6012 @item wl-highlight-body-too
6013 @vindex wl-highlight-body-too
6014 The initial setting is @code{t}.
6015 If non-nil, bodies of drafts and messages are also highlighted.
6017 @item wl-highlight-message-header-alist
6018 @vindex wl-highlight-message-header-alist
6019 When highlighting headers of drafts and messages, this variable
6020 specifies which faces are allocated to important
6021 (@code{wl-highlight-message-important-header-contents}), secondly
6022 important (@code{wl-highlight-message-important-header-contents2}), and
6023 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6025 Similarly, it can be used for allocating arbitrary faces to arbitrary
6026 regular expressions.
6028 @item wl-highlight-citation-prefix-regexp
6029 @vindex wl-highlight-citation-prefix-regexp
6030 Specifies a regular expression to which quoted lines in bodies of
6031 drafts and messages match.
6032 Bodies matching to this regular expression are highlighted by the faces
6033 specified by (@code{wl-highlight-message-cited-text-*}).
6035 @item wl-highlight-highlight-citation-too
6036 @vindex wl-highlight-highlight-citation-too
6037 The initial setting is @code{nil}.
6038 If non-nil, the quoting regular expression itself given by
6039 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6041 @item wl-highlight-citation-header-regexp
6042 @vindex wl-highlight-citation-header-regexp
6043 Specifies a regular expression that denotes beginning of quotation.
6044 Bodies matching to this regular expression are highlighted by the face
6045 specified by @code{wl-highlight-message-headers}.
6047 @item wl-highlight-max-header-size
6048 @vindex wl-highlight-max-header-size
6049 The initial setting is @code{nil}. If a header size is larger than this
6050 value, it will not be highlighted. If @code{nil}, always highlighted
6051 (ignore header size).
6053 @item wl-highlight-max-message-size
6054 @vindex wl-highlight-max-message-size
6055 The initial setting is 10000.
6056 If a message is larger than this value, it will not be highlighted.
6057 With this variable, highlight is suppressed for uuencode or huge digest
6060 @item wl-highlight-signature-separator
6061 @vindex wl-highlight-signature-separator
6062 Specifies regular expressions that denotes the boundary of a signature.
6063 It can be a regular expression, or a list of ones.
6064 Messages after the place that matches this regular expression are
6065 highlighted by the face specified by
6066 @code{wl-highlight-message-signature}.
6068 @item wl-max-signature-size
6069 @vindex wl-max-signature-size
6070 The initial setting is 400.
6071 This is the largest size for a signature to be highlighted.
6073 @item wl-use-highlight-mouse-line
6074 @vindex wl-use-highlight-mouse-line
6075 The initial setting is @code{t}.
6076 If non-nil, the line pointed by the mouse is highlighted in the folder
6077 mode, summary mode, and the like.
6080 @subsection Setting Colors and Fonts of the Characters
6082 If you want to change colors or fonts of the characters, you need to
6083 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6084 want to change fonts, and @code{set-face-foreground} for colors, and so
6085 on. You cannot write face settings in @file{.emacs}; write in
6088 For example, if you want to change the color for signatures to yellow,
6092 (set-face-foreground 'wl-highlight-message-signature "yellow")
6098 Faces defined in Wanderlust:
6101 @item wl-highlight-message-headers
6102 The face for field names of message headers.
6104 @item wl-highlight-message-header-contents
6105 The face for field bodies of message headers.
6107 @item wl-highlight-message-important-header-contents
6108 The face for important parts of message headers.
6109 Per default, this face is used for a body of @samp{Subject:} field.
6110 You can change its value by editing
6111 @code{wl-highlight-message-header-alist}.
6113 @item wl-highlight-message-important-header-contents2
6114 The face for secondly important parts of message headers.
6115 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6116 fields. You can change its value by editing
6117 @code{wl-highlight-message-header-alist}.
6119 @item wl-highlight-message-unimportant-header-contents
6120 The face for unimportant parts of message headers.
6121 Per default, this face is used for bodies of @samp{X-} fields
6122 @samp{User-Agent:} fields. You can change its value by editing
6123 @code{wl-highlight-message-header-alist}.
6125 @item wl-highlight-message-citation-header
6126 The face for headers of quoted messages.
6128 @item wl-highlight-message-cited-text-*
6129 The face for texts of quoted messages. The last @samp{*} is a
6130 @var{single figure} so that 10 different colors can be used according to
6133 @item wl-highlight-message-signature
6134 The face for signatures of messages. The initial settings are
6135 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6136 dark background colors.
6138 @item wl-highlight-header-separator-face
6139 The face for header separators of draft messages.
6141 @item wl-highlight-summary-important-face
6142 The face for message lines with important marks in the summary.
6144 @item wl-highlight-summary-new-face
6145 The face for message lines with new marks in the summary.
6147 @item wl-highlight-summary-displaying-face
6148 The face for the message line that is currently displayed.
6149 This face is overlaid.
6151 @item wl-highlight-thread-indent-face
6152 The face for the threads that is currently displayed.
6154 @item wl-highlight-summary-unread-face
6155 The face for message lines with unread marks in the summary.
6157 @item wl-highlight-summary-deleted-face
6158 The face for message lines with delete marks in the summary.
6160 @item wl-highlight-summary-refiled-face
6161 The face for message lines with re-file marks in the summary.
6163 @item wl-highlight-refile-destination-face
6164 The face for re-file information part of message lines with re-file
6165 marks in the summary.
6167 @item wl-highlight-summary-copied-face
6168 The face for message lines with copy marks in the summary.
6170 @item wl-highlight-summary-target-face
6171 The face for message lines with target marks @samp{*} in the summary.
6173 @item wl-highlight-summary-thread-top-face
6174 The face for message lines that are on the top of the thread in the
6177 @item wl-highlight-summary-normal-face
6178 The face for message lines that are not on top of the thread in the
6181 @item wl-highlight-folder-unknown-face
6182 The face for folders that are not known to have how many unsync messages
6185 @item wl-highlight-folder-zero-face
6186 The face for folders that have no unsync messages in the folder mode.
6188 @item wl-highlight-folder-few-face
6189 The face for folders that have some unsync messages in the folder mode.
6191 @item wl-highlight-folder-many-face
6192 The face for folders that have many unsync messages in the folder mode.
6193 The boundary between `some' and `many' is specified by the variable
6194 @code{wl-folder-many-unsync-threshold}.
6196 @item wl-highlight-folder-unread-face
6197 The face for folders that have no unsync but unread messages in the
6200 @item wl-highlight-folder-killed-face
6201 The face for folders that are deleted from the access group in the
6204 @item wl-highlight-folder-opened-face
6205 The face for open groups in the folder mode.
6206 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6207 @code{nil} or a @var{number}.
6209 @item wl-highlight-folder-closed-face
6210 The face for close groups in the folder mode.
6211 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6212 @code{nil} or a @var{number}.
6214 @item wl-highlight-folder-path-face
6215 The face for the path to the currently selected folder in the folder
6218 @item wl-highlight-logo-face
6219 The face for logo in the demo.
6221 @item wl-highlight-demo-face
6222 The face for strings (for example, a version number) in the demo.
6226 @node Biff, Advanced Settings, Highlights, Customization
6227 @section Notify Mail arrival
6230 Following setting is to notify mail arrival of @samp{%inbox}
6231 by the indicator on the modeline
6234 (setq wl-biff-check-folder-list '("%inbox"))
6237 @subsection Customizable Variables
6239 @item wl-biff-check-folder-list
6240 @vindex wl-biff-check-folder-list
6241 The initial setting is @code{nil}.
6242 This is the list of folders to check mail arrival.
6243 If @code{nil}, wl doesn't check mail arrival.
6245 @item wl-biff-check-interval
6246 @vindex wl-biff-check-interval
6247 The initial setting is 40 (in seconds).
6248 Check mail arrival in this period.
6250 @item wl-biff-notify-hook
6251 @vindex wl-biff-notify-hook
6252 The initial setting is @code{nil}.
6253 This is a hook run at the arrival of the new mail.
6256 (setq wl-biff-notify-hook '(beep))
6261 @node Advanced Settings, Customizable Variables, Biff, Customization
6262 @section Advanced Settings
6265 * Draft for Reply:: Draft for Reply
6266 * Thread Format:: Appearance of Thread
6267 * User-Agent Field:: @samp{User-Agent:} Header Field
6271 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6272 @subsection Draft for Replay
6273 @vindex wl-draft-reply-with-argument-list
6274 @vindex wl-draft-reply-without-argument-list
6275 @vindex wl-draft-reply-myself-with-argument-list
6276 @vindex wl-draft-reply-myself-without-argument-list
6278 If you want, when you replying to articles in mailing lists, the address
6279 in Reply-To field of the original message to be prepared to To field of
6280 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6285 (setq wl-draft-reply-without-argument-list
6286 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6287 ("Followup-To" . (nil nil ("Followup-To")))
6288 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6289 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6294 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6295 in the original message, @samp{Reply-To:} field in the original is
6296 copied to @samp{To:} field.)
6298 Moreover, the behavior of @kbd{a} with prefix argument can
6299 be directed by @code{wl-draft-reply-with-argument-list} as well.
6301 Note: To set the behavior when you reply to the message written by yourself, use
6302 @code{wl-draft-reply-myself-without-argument-list} and
6303 @code{wl-draft-reply-myself-with-argument-list}
6306 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6307 @subsection Appearance of Threads
6311 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6312 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6313 391 09/18(Fri)19:24 +-[ Murata-san ]
6314 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6315 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6316 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6317 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6318 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6319 412 09/22(Tue)09:28 | +-[ Teranishi ]
6320 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6321 416 09/22(Tue)12:38 | +-[ Teranishi ]
6322 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6323 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6327 Settings to make appearance of threads like shown above:
6331 (setq wl-thread-indent-level 2)
6332 (setq wl-thread-have-younger-brother-str "+")
6333 (setq wl-thread-youngest-child-str "+")
6334 (setq wl-thread-vertical-str "|")
6335 (setq wl-thread-horizontal-str "-")
6336 (setq wl-thread-space-str " ")
6340 If you do not want to see branches, do the following:
6344 (setq wl-thread-indent-level 2)
6345 (setq wl-thread-have-younger-brother-str " ")
6346 (setq wl-thread-youngest-child-str " ")
6347 (setq wl-thread-vertical-str " ")
6348 (setq wl-thread-horizontal-str " ")
6349 (setq wl-thread-space-str " ")
6354 @node User-Agent Field, , Thread Format, Advanced Settings
6355 @subsection User-Agent Field
6359 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6360 @samp{User-Agent:} fields, define a function that generate appropriate
6361 strings as you like, and set it to variable
6362 @code{wl-generate-mailer-string-func}.
6364 If you do not want verbose @samp{User-Agent:} field, do the following:
6368 (setq wl-generate-mailer-string-func
6371 (concat "User-Agent: "
6372 (wl-generate-user-agent-string-1 nil)))))
6376 The following is a example:
6380 (setq mime-edit-insert-user-agent-field nil)
6381 (setq wl-generate-mailer-string-func
6384 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6389 @node Customizable Variables, Hooks, Advanced Settings, Customization
6390 @section Customizable Variables
6392 Customizable variables that have not been described yet:
6395 @item wl-default-folder
6396 @vindex wl-default-folder
6397 The initial setting is @samp{%inbox}. This is the default value for moving to
6398 a folder and the like.
6400 @item wl-draft-folder
6401 @vindex wl-draft-folder
6402 The initial setting is @samp{+draft}. It is the folder to which drafts are
6403 saved. It must be a localdir folder.
6405 @item wl-trash-folder
6406 @vindex wl-trash-folder
6407 The initial setting is @samp{+trash}. It is the wastebasket folder.
6408 If you changed this variable, you had better restart Wanderlust.
6410 @item wl-interactive-exit
6411 @vindex wl-interactive-exit
6412 The initial setting is @code{t}.
6413 If non-nil, you are asked for confirmation when Wanderlust terminates.
6415 @item wl-interactive-send
6416 @vindex wl-interactive-send
6417 The initial setting is @code{nil}.
6418 If non-nil, you are asked for confirmation when mail is sent.
6420 @item wl-folder-sync-range-alist
6421 @vindex wl-folder-sync-range-alist
6422 The initial setting is the alist shown below:
6427 ("^\\+draft$\\|^\\+queue$" . "all"))
6432 This is an associative list of regular expressions of folder names and
6433 update range of the summary. Update range is one of the @samp{all},
6434 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6435 @samp{last}. If a folder do not match, @samp{update} is used.
6438 @vindex wl-ask-range
6439 The initial setting is @code{t}.
6440 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6441 for updating the summary when you changed folders.
6443 @item wl-mime-charset
6444 @vindex wl-mime-charset
6445 The initial setting is @code{x-ctext}.
6446 This is the MIME charset for messages that are not MIME (e.g. without
6447 @samp{Content-Type:}). This value also used as default charset for
6448 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6449 this value as @code{iso-2022-jp}.)
6451 @item wl-highlight-folder-with-icon
6452 @vindex wl-highlight-folder-with-icon
6453 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6454 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6456 @item wl-strict-diff-folders
6457 @vindex wl-strict-diff-folders
6458 This is a list of regular expressions of folders.
6459 Unread messages are checked, for example when you press @kbd{s} in
6460 the folder mode, usually in a brief way (rapidly processed but not
6462 The folders matching this variable are seriously checked.
6463 You may want to set this variable so as to match conditional filter
6464 folders for IMAP4 folders.
6465 The initial setting is @code{nil}.
6467 @item wl-folder-use-server-diff
6468 @vindex wl-folder-use-server-diff
6469 When unread messages are checked, for example when you press @kbd{s} in
6470 the folder mode, usually (the number of messages on the server) @minus{}
6471 (the number of local messages) will be the number of unread messages.
6472 However, if this variable is non-nil, the number of unread messages on
6473 the server is checked. This affects IMAP4 folders only, but IMAP4
6474 folders in mail boxes matching
6475 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6476 the number of unread messages on the server, even if they matches this
6477 variable. The initial setting is @code{t}.
6479 @item wl-auto-check-folder-name
6480 @vindex wl-auto-check-folder-name
6481 The initial setting is @code{nil}.
6482 If non-nil, the folder with the name of the value is checked for unread
6483 messages at the start.
6484 If it is @code{none}, no folders are checked.
6485 If it is a list, all folders in the list are checked at the start.
6487 @item wl-auto-uncheck-folder-list
6488 @vindex wl-auto-uncheck-folder-list
6489 The initial setting is the list shown below:
6498 Folders with the name matching this variable are not checked for unread
6499 messages at the start, even if they are included in the groups in
6500 @code{wl-auto-check-folder-name}.
6502 @item wl-auto-check-folder-list
6503 @vindex wl-auto-check-folder-list
6504 The initial setting is @code{nil}.
6505 Folders with the name matching this variable are always checked for
6506 unread messages at the start, if they are included in the groups in
6507 @code{wl-auto-check-folder-name}.
6508 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6510 @item wl-no-save-folder-list
6511 @vindex wl-no-save-folder-list
6512 The initial setting is the list shown below:
6521 This is a list of regular expressions of folders not to be saved.
6523 @item wl-save-folder-list
6524 @vindex wl-save-folder-list
6525 The initial setting is @code{nil}.
6526 This is a list of regular expressions of folders to be saved.
6527 This takes precedence over @code{wl-no-save-folder-list}.
6529 @item wl-folder-mime-charset-alist
6530 @vindex wl-folder-mime-charset-alist
6531 The initial setting is the alist shown below:
6535 (("^-alt\\.chinese" . big5)
6536 ("^-relcom\\." . koi8-r)
6538 ("^-han\\." . euc-kr))
6543 This is an associative list of regular expressions of folder names and
6545 If a folder do not match, @code{wl-mime-charset} is used.
6547 @item wl-folder-init-load-access-folders
6548 @vindex wl-folder-init-load-access-folders
6549 The initial setting is @code{nil}.
6550 This is a list of access groups to be loaded specifically at the start.
6551 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6553 @item wl-folder-init-no-load-access-folders
6554 @vindex wl-folder-init-no-load-access-folders
6555 The initial setting is @code{nil}.
6556 This is a list of access groups not to be loaded specifically at the
6558 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6560 @item wl-delete-folder-alist
6561 @vindex wl-delete-folder-alist
6562 The initial setting is the alist shown below:
6571 This list determines disposition of messages with delete marks.
6572 Each item in the list is a folder and destination; you can specify any
6573 one of the following in the place of destination:
6576 @code{remove} or @code{null} : deletes the messages instantly.
6577 string : moves the messages to the specific folder.
6578 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6581 @item wl-refile-policy-alist
6582 @vindex wl-refile-policy-alist
6583 The initial setting is the list shown below:
6593 This list determines whether messages with re-file marks are moved or
6594 copied. Each item in the list is a cons cell of a folder and
6595 @code{copy} or @code{move}.
6597 @item wl-x-face-file
6598 @vindex wl-x-face-file
6599 The initial setting is @file{~/.xface}.
6600 The name of the file that contains encoded X-Face strings.
6603 @item wl-demo-display-logo
6604 @vindex wl-demo-display-logo
6605 If non-nil, bitmap image is shown on the opening demo. If you set
6606 @code{xpm} or @code{xbm}, (if possible) display selected image type
6609 @item elmo-use-database
6610 @vindex elmo-use-database
6611 This is meaningful for XEmacs only. The initial setting depends on
6612 XEmacs (@code{t} for XEmacs with dbm).
6613 If non-nil, Message-ID is controlled by dbm.
6615 @item elmo-passwd-alist-file-name
6616 @vindex elmo-passwd-alist-file-name
6617 The initial setting is @file{passwd}.
6618 This is the name of the file in which passwords are saved.
6619 @code{elmo-passwd-alist-save} saves current passwords to the file.
6621 @item elmo-nntp-list-folders-use-cache
6622 @vindex elmo-nntp-list-folders-use-cache
6623 The initial setting is 600 (in seconds).
6624 This is period in seconds during which results of @samp{list} and
6625 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6628 @item elmo-nntp-max-number-precedes-list-active
6629 @vindex elmo-nntp-max-number-precedes-list-active
6630 The initial setting is @code{nil}.
6631 If non-nil, the number of article obtained by @samp{list active} in NNTP
6632 are used as the maximum article number of the folder.
6633 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6634 and if the number of read messages is not correct.
6636 @item elmo-nntp-default-use-listgroup
6637 @vindex elmo-nntp-default-use-listgroup
6638 The initial setting is @code{t}.
6639 If non-nil, @samp{listgroup} is used for checking the total number of
6640 articles. If it is @code{nil}, @samp{group} is used. In the latter
6641 case, the processing will be a little faster at the sacrifice of
6644 @item elmo-pop3-send-command-synchronously
6645 @vindex elmo-pop3-send-command-synchronously
6646 The initial setting is @code{nil}.
6647 If non-nil, POP3 commands are issued synchronously. Some implementation
6648 of POP3 server fails to get summary information without this setting.
6649 You may have to set this variable to @code{t}, if the process hangs
6650 while looking up POP3.
6652 @item elmo-dop-flush-confirm
6653 @vindex elmo-dop-flush-confirm
6654 The initial setting is @code{t}.
6655 If non-nil, you are asked for confirmation if accumulated off-line
6656 operations are executed.
6658 @item elmo-display-progress-threshold
6659 @vindex elmo-display-progress-threshold
6660 The initial setting is 20.
6661 Threshold for display of progress gauge. If number of renewal is more than
6662 this value, display progress gauge.
6666 @node Hooks, , Customizable Variables, Customization
6672 @node Mailing List, Addition, Customization, Top
6673 @chapter Wanderlust Mailing List
6678 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6681 Topics related to Wanderlust are discussed in the mailing list.
6682 The latest version is also announced there (in Japanese, sorry).
6684 A guide can be obtained automatically by sending mail to
6685 @t{wl-ctl@@lists.airs.net} with the body
6690 Please send bug reports or patches to the mailing list. You can post to
6691 the mailing list even though you are not a member of it.
6693 If you send a bug report, please attach Backtrace with it.
6694 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6697 I would like to express my thanks to the members of the mailing list for
6698 valuable advice and many pieces of code they contributed.
6701 @node Addition, Index, Mailing List, Top
6702 @chapter Additional Information
6704 @section Brief History
6707 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6708 3/10 Made a msgdb mechanism by elisp.
6709 3/26 IMAP and NNTP can be displayed in threads.
6710 4/13 Began to assemble thread display modules as elmo.
6711 5/01 Finished 0.1.0, initial version with many defects.
6712 6/12 I made a slip of the tongue and said I was writing elisp
6713 mailer supporting IMAP
6714 6/16 0.1.3 was announced at tm-ja, elisp ML.
6715 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6716 7/01 Support for mm-backend (0.3.0).
6717 8/25 multi folder added (0.5.0).
6718 8/28 filter folder added (0.5.1).
6719 9/10 You can open/close threads (0.6.0).
6720 9/11 fldmgr by Murata-san made editing folders easy.
6721 9/18 lha folders added by Okunishi-san (0.6.3).
6722 9/24 Display of branches of threads (0.6.5).
6723 9/28 Compression folder supporting multiple archivers by Okunishi-san.
6724 10/28 Off-line operations (0.7.4).
6725 12/09 Becomes beta version.
6726 12/21 wl-expire by Murata-san.
6727 1999 2/03 auto-refile by Tsumura-san.
6728 4/28 wl-template by Murata-san.
6729 5/18 Released 1.0.0 stable.
6730 7/05 Scoring by Murata-san (2.1.0).
6731 9/26 New plugged system by Murata-san (2.2.2).
6732 12/20 Support Modified UTF7.
6733 2000 3/24 Released 1.1.0 stable.
6734 4/03 CVS development started.
6735 5/07 Thread restoration & Its speed up with Murata-san.
6736 6/12 Address completion with LDAP with Chiba-san & Goto-san.
6737 7/11 killed message feature.
6738 7/18 Use UIDL in POP3.
6739 9/12 biff feature with Satata-san & Yamaoka-san.
6740 10/17 expire-hide by Okada-san.
6741 11/08 Released 2.4.0 stable.
6742 2001 7/04 Released 2.6.0 stable.
6745 See @file{ChangeLog} for details.
6749 According to a dictionary, Wanderlust has the meaning:
6753 n eager longing for or impulse towards travelling in distant lands
6754 [Ger, fr wandern to wander + lust desire, pleasure]
6758 but I had no profound intention. (if farfetched, IMAP @result{} you can
6759 read mail anywhere @result{} desire to wander ?)
6761 Elmo is the abbreviation of @samp{Elisp Library for Message
6762 Orchestration}. At first I meant the red puppet in the Sesame Street,
6763 but you may associate it with Wandering @result{} Drifting @result{}
6764 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
6768 Each versions has code names (they are almost jokes).
6769 Currently they are picked up alphabetically from the top 40 hits of
6770 U.S. Billboard magazines in 1980s.
6772 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
6775 @node Index, , Addition, Top
6779 * Concept Index:: Concept Index
6780 * Key Index:: Key Index
6781 * Variable Index:: Variable Index
6782 * Function Index:: Function Index
6785 @node Concept Index, Key Index, Index, Index
6786 @unnumberedsec Concept Index
6789 @node Key Index, Variable Index, Concept Index, Index
6790 @unnumberedsec Key Index
6793 @node Variable Index, Function Index, Key Index, Index
6794 @unnumberedsec Variable Index
6797 @node Function Index, , Variable Index, Index
6798 @unnumberedsec Function Index