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, 2002 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
25 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
27 This edition is for Wanderlust version @value{VERSION}.
29 Permission is granted to make and distribute verbatim copies of this
30 manual provided the copyright notice and this permission notice are
31 preserved on all copies.
34 Permission is granted to process this file through TeX and print the
35 results, provided the printed document carries copying permission notice
36 identical to this one except for the removal of this paragraph (this
37 paragraph not being relevant to the printed manual).
40 Permission is granted to copy and distribute modified versions of this
41 manual under the conditions for verbatim copying, provided that the
42 entire resulting derived work is distributed under the terms of a
43 permission notice identical to this one.
45 Permission is granted to copy and distribute translations of this manual
46 into another language, under the above conditions for modified versions.
52 @title Wanderlust User's Manual
53 @subtitle Yet another message interface on Emacsen
54 @subtitle for Wanderlust version @value{VERSION}
55 @author Yuuichi Teranishi
56 @author Fujikazu Okunishi
57 @author Masahiro Murata
59 @author Kaoru Takahashi
61 @author Masayuki Osada
62 @author Katsumi Yamaoka
64 @author Yoichi Nakayama
67 @vskip 0pt plus 1filll
68 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
69 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
70 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
71 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
73 This manual is for Wanderlust version @value{VERSION}.
75 Permission is granted to make and distribute verbatim copies of this
76 manual provided the copyright notice and this permission notice are
77 preserved on all copies.
79 Permission is granted to copy and distribute modified versions of this
80 manual under the conditions for verbatim copying, provided that the
81 entire resulting derived work is distributed under the terms of a
82 permission notice identical to this one.
84 Permission is granted to copy and distribute translations of this manual
85 into another language, under the above conditions for modified versions.
91 @node Top, Introduction, (dir), (dir)
92 @top Wanderlust User's Manual
107 This manual is for Wanderlust @value{VERSION}.
112 * Introduction:: Read this first
113 * Start Me Up:: Invoking Wanderlust
114 * Folders:: How to specify folders
115 * Folder:: Selecting and editing folders
116 * Summary:: Reading and refiling messages
117 * Message:: Saving and playing MIME multipart entities
118 * Draft:: Draft buffer, sending mail and news
119 * Disconnected Operations:: Off-Line management
120 * Expire and Archive:: Automatic expiration and archiving of messages
121 * Scoring:: Score of the messages
122 * Address Book:: Management of Address Book
123 * Customization:: Customizing Wanderlust
124 * Mailing List:: Wanderlust mailing list
125 * Addition:: Additional Information
130 @node Introduction, Start Me Up, Top, Top
131 @chapter Introduction of Wanderlust
134 Wanderlust is an mail/news management system on Emacsen.
135 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
137 The main features of Wanderlust:
140 @item Pure elisp implementation.
141 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
142 @item Unified access method to messages based on Mew-like Folder Specification.
143 @item Mew-like Key-bind and mark handling.
144 @item Manages unread messages.
145 @item Interactive thread display.
146 @item Folder Mode shows the list of subscribed folders.
147 @item Message Cache, Disconnected Operation (Read Only).
148 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
149 @item MIME compliant (by SEMI).
150 @item Transmission of news and mail are unified by Message transmitting draft.
151 @item Graphical list of folders (XEmacs and Emacs 21).
152 @item View a part of message without retrieving the whole message (IMAP4).
153 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
154 @item Virtual Folders.
155 @item Supports compressed folder using common archiving utilities.
156 @item Old articles in folders are automatically removed/archived (Expiration).
157 @item Automatic re-file.
158 @item Template function makes it convenient to send fixed form messages.
164 Wanderlust is supposed to run on following Emacsen:
167 @item Mule 2.3 based on Emacs 19.34
168 @item Emacs 20.2 or later
169 @item XEmacs 20.4 or later
170 @item Meadow 1.00 or later
171 @item NTEmacs 20.4 or later
175 IMAP4 connectivity with following imapd are confirmed to work with
179 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
180 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
181 @item Courier-IMAP 1.3.2 or later
182 @item AIR MAIL (AIRC imapd release 2.00)
184 @item Microsoft Exchange Server 5.5
185 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
188 LDAP connectivity with following LDAPd are confirmed to work with
192 @item OpenLDAP 2.0.6 or later
196 @node Start Me Up, Folders, Introduction, Top
197 @chapter Start up Wanderlust
200 The necessary procedure for starting Wanderlust is explained in steps
203 (Of course, you need a mail/news readable environment in advance)
206 * MIME Modules:: Installing the MIME modules
207 * Download:: Download and extract the packages
208 * Install:: Byte-compile and install
209 * Minimal Settings:: @file{.emacs} setup
210 * Folder Definition:: Folder definition
211 * Start Wanderlust:: Starting Wanderlust
215 @node MIME Modules, Download, Start Me Up, Start Me Up
216 @section Installing MIME modules
222 SEMI must be installed to make Wanderlust work correctly.
224 SEMI can be downloaded from these sites:
228 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
232 You need packages named APEL and FLIM to use SEMI.
233 You can download APEL and FLIM from following URLs:
237 APEL: ftp://ftp.m17n.org/pub/mule/apel/
238 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
242 You have to install APEL, FLIM and SEMI in this order. Generally,
243 @samp{make install} will do the job. (In XEmacs 21, @samp{make
246 Refer to the documents of each package for detailed installation
247 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
248 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
252 Recommended combination of APEL, FLIM and SEMI are following:
255 @item APEL 10.3, FLIM 1.14.3 and SEMI 1.14.3
258 You can also use many other FLIM/SEMI variants. Combination of the
259 latest versions should work. For example, the following combination are
263 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
264 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
267 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
270 @node Download, Install, MIME Modules, Start Me Up
271 @section Download and Extract the Package
274 You can download Wanderlust package from following sites:
278 ftp://ftp.gohome.org/wl/
281 Mirrored ftp/http sites:
285 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
286 http://www.jpl.org/elips/wl/
287 http://www.ring.gr.jp/archives/text/elisp/wl/
288 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
289 ftp://opaopa.org/pub/mirror/elisp/wl/
290 @c ftp://roguelife.org/pub/tsumura/wl/
294 Extract the obtained package to your working directory:
299 % tar zxvf wl-@var{version}.tar.gz
300 % cd wl-@var{version}
304 @subsection To use SSL (Secure Socket Layer)
309 SSL (Secure Socket Layer) can be used for
310 SMTP, IMAP, NNTP and POP connections in Wanderlust.
312 There are two ways to use SSL. One is to start SSL negotiation just
313 after the connection establishment (generic way). The other one is to
314 start SSL negotiation by invoking STARTTLS command in the each session.
316 To use the formal SSL (generic SSL), you must set @env{PATH} to the
317 directory that OpenSSL commands are installed.
319 To use the latter SSL(STARTTLS), you must install starttls package in
321 You can download starttls package from the following site.
324 ftp://opaopa.org/pub/elisp/
327 @node Install, Minimal Settings, Download, Start Me Up
328 @section Byte-compile and install
335 @subsection Installation
337 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
338 Set the Emacs's command name to @code{EMACS}.
339 Set package installation directory to @code{LISPDIR}.
340 Then, please execute following commands.
349 Destination directory is auto-probed if you leave @code{LISPDIR}
350 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
352 If you are using an Emacs variant which does not merge specified directory
353 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
354 then you will see the error message:
357 Cannot open load file: mime-setup
361 In this case, either add destination directories of custom, APEL, FLIM
362 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
363 @code{load-path} in @file{WL-CFG} in extracted directory.
365 If you want to use BBDB, then the necessary modules are byte-compiled
366 and installed when BBDB directory is added to @code{load-path}.
369 @subsection @file{WL-CFG}
371 Contents of the file @file{WL-CFG} is loaded under installation if a file
372 with that name exists in extracted directory. You can use @file{WL-CFG} to
373 configure @code{load-path} to extra packages such as SEMI if needed.
375 If you want to specify the install directory of Wanderlust related
376 files, then set following variables in @file{WL-CFG}
380 A directory to install WL modules.
381 This directory is relative directory from @code{LISPDIR}.
382 WL modules include @file{wl*.el}, @file{wl*.elc} files.
383 @c Modules under the directory @file{util/} are also installed if
384 @c it detected as necessary.
387 A directory to install ELMO modules.
388 This directory is relative directory from @code{LISPDIR}.
389 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
390 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
394 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
396 If you want to install ELMO related files under a sub-directory
397 such as "elmo" then add following to @file{WL-CFG}:
400 (setq ELMO_PREFIX "elmo")
403 @subsection Install as a XEmacs package
404 @cindex XEmacs package
405 @cindex XEmacs package install
406 @cindex Package, XEmacs
407 @cindex Package install, XEmacs
408 @c @cindex install-package
410 It is possible to install Wanderlust as one of packages of XEmacs (21.0
411 or later). Configuration for autoload and icon-path in local
412 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
415 Follow the next example to install Wanderlust as an XEmacs package.
421 % make install-package
425 package directory is auto-probed, if SEMI is installed.
426 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
428 @subsection Run in place
430 If wl and elmo directories are defined in @code{load-path}, then
431 byte-compilation and installation are not necessary to start Wanderlust.
432 For example, if package is extracted in @file{~/work}, Wanderlust can be
433 invoked with following setting in @file{~/.emacs}.
437 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
438 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
444 Manual is described in Info format. Please do following.
453 If you install Wanderlust as a XEmacs package, Info file is already
454 installed too, so there are no need of these commands.
456 Manual directory is automatically detected. Of course, it can be
457 configured by @code{INFODIR} in @file{Makefile}.
459 You can read manual at the following URL:
462 http://www.gohome.org/wl/doc/wl_toc.html
465 @node Minimal Settings, Folder Definition, Install, Start Me Up
466 @section Set up .emacs
467 @cindex Minimal Settings
469 @cindex Configuration
473 The Wanderlust package contains two module groups.
476 @item ELMO (elmo-*.el)
477 These modules show everything as folders. This is the back-end for WL.
479 These modules controls the behavior of main body of Wanderlust.
480 They are also the front-end for ELMO.
483 You can customize the behavior of Wanderlust by changing the value
484 of environmental variables which begins with @code{elmo-} and @code{wl-}.
486 The minimal requirement for settings is as the following.
490 ;; @r{The setting to use SEMI}
491 (require 'mime-setup)
493 ;; @r{autoload configuration}
494 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
495 (autoload 'wl "wl" "Wanderlust" t)
496 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
498 ;; @r{Directory where icons are placed.}
499 ;; @r{Default: the peculiar value to the running version of Emacs.}
500 ;; @r{(This is not required if the default value has been set properly)}
501 (setq wl-icon-directory "~/work/wl/etc")
503 ;; @r{SMTP server for mail posting. Default: @code{nil}}
504 (setq wl-smtp-posting-server "your.smtp.example.com")
505 ;; @r{NNTP server for news posting. Default: @code{nil}}
506 (setq wl-nntp-posting-server "your.nntp.example.com")
510 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
511 file exists). So it is convenient to gather Wanderlust specific settings
512 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
513 because you can't write them in @file{.emacs}
514 (if you write it to @file{.emacs}, you'll get an error).
517 All above described settings except @samp{(require 'mime-setup)} and autoload
518 configuration can be written in
521 @subsection @code{mail-user-agent}
522 @cindex Default Mailer
523 @cindex Mailer, Default
524 @vindex mail-user-agent
527 If you write following setting in you @file{.emacs}, you can
528 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
529 This means it enables you to run Wanderlust as a default mail composer
532 It is effective only when your Emacs can define @code{mail-user-agent}.
533 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
537 (autoload 'wl-user-agent-compose "wl-draft" nil t)
538 (if (boundp 'mail-user-agent)
539 (setq mail-user-agent 'wl-user-agent))
540 (if (fboundp 'define-mail-user-agent)
541 (define-mail-user-agent
543 'wl-user-agent-compose
552 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
553 @section Folder Definition
554 @cindex Folder Definition
557 You can skip this section because it is possible to add/edit the
558 subscribe folders from the buffer for list of folders.
559 @xref{Folder Manager}.
561 Define the folders you want to subscribe in file @file{~/.folders}. The
562 contents written in @file{~/.folders} become the folders which you
563 subscribe to as it is.
565 Format for @file{~/.folders} is very simple. Here is an example:
570 # @r{Lines begin with @samp{#} are comment.}
571 # @r{Empty lines are ignored}
573 # @var{folder name} "@var{folder nickname}"
574 # @r{(nicknames are not necessary)}
579 %#mh/Backup@@my.imap.example.com "Sent"
582 %#mh/spool/wl "Wanderlust ML"
583 %#mh/spool/elips "ELIPS ML"
584 %#mh/spool/apel-ja "APEL Japanese ML"
585 %#mh/spool/xemacs-beta "XEmacs beta"
586 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
587 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
590 # @r{If folder name ends with @samp{/}, that means an `access group',}
591 # @r{all subfolders automatically included in one folder group.}
593 %#mh/expire@@localhost /
594 # @r{All MH folders are included in one folder group.}
599 Each line contains one folder you want to read. The definition of
600 folders will be explained in detail in the next section.
602 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
603 become one folder group. One folder group is treated as a directory
604 which can be opened and closed in folder mode. It is convenient for
605 collecting some folders and putting them in order.
607 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
608 line and you have to write it that way (It is because the parser sucks).
610 There are two types of groups. One is like @samp{Emacsen} from above
611 example which the user chooses his favorite folders as a group.
613 The other one is @dfn{access group} like @samp{+ /} from above example.
614 It makes all the sub-folders in a folder to a group. (It differs from
615 the type of the folder. For example, @samp{+} followed by @samp{/}
616 makes entire MH sub-directories to one group)
618 This behavior is better understood if you try it and confirmed the
619 function first. You can write and try a small folder definition, so you
620 will know the idea of the folder function before writing the real one.
622 @node Start Wanderlust, , Folder Definition, Start Me Up
623 @section Start Wanderlust
624 @cindex Start Wanderlust
626 If installation and configuration worked well, you can invoke Wanderlust by
627 typing following command in Emacs.
634 After initialization, Folder Mode which shows the list of folders will appear.
635 That means the folders you defined in the @file{~/.folders} are listed
636 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
637 can skip folder checking.
639 Basically, you will handle messages in wanderlust while you come and go
640 from/to each of the following buffers.
644 You can see the list of folders. You can select some folder and go into the summary
645 of it. You can subscribe new folder or edit subscription list.
647 You can see the list of messages in the folder. You can select message and view its
648 contents, and reply to some message. You can delete ones or move ones to another
651 You can see the contents of the message. You can save part to disk or open in external
654 You can edit message.
657 Details of each ones are explained later.
660 @node Folders, Folder, Start Me Up, Top
661 @chapter Wanderlust's folders
664 This chapter describes the folder types which Wanderlust is able to handle.
666 Wanderlust uses ELMO as it's interface, so every folder types supported
667 by ELMO is usable in Wanderlust.
669 As of version @value{VERSION}, 11 types of folders are predefined. These are
670 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
671 Pipe and Internal folder types.
674 * IMAP Folder:: @samp{%} -- IMAP folder
675 * NNTP Folder:: @samp{-} -- NNTP folder
676 * MH Folder:: @samp{+} -- MH folder
677 * Maildir Folder:: @samp{.} -- Maildir folder
678 * News Spool Folder:: @samp{=} -- News spool folder
679 * Archive Folder:: @samp{$} -- Archive folder
680 * POP Folder:: @samp{&} -- POP folder
681 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
682 * Namazu Folder:: @samp{[} -- Namazu Folder
683 * Multi Folder:: @samp{*} -- Multi folder
684 * Filter Folder:: @samp{/} -- Filter folder
685 * Pipe Folder:: @samp{|} -- Pipe folder
686 * Internal Folder:: @samp{'} -- Internal folder
690 @node IMAP Folder, NNTP Folder, Folders, Folders
698 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
704 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
708 You can specify @code{login} (encoded password transmission),
709 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
710 authentication) or @code{clear} (or @code{nil}, plain password
711 transmission) as @var{authenticate-type}.
716 @var{username} -> The value of @code{elmo-imap4-default-user}.
717 Initial setting is @env{USER} environment variable or
718 @env{LOGNAME} environment variable or return value of
719 @code{(user-login-name)}.
720 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
721 Initial setting is "auth".
722 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
723 Initial setting is "localhost".
724 @var{port} -> The value of @code{elmo-imap4-default-port}.
725 Initial setting is 143.
728 You can omit the @var{hostname} from folder names if you set
729 @code{elmo-imap4-default-server} as your main IMAP server.
730 For example, you can specify a folder as @samp{foo%imap@@gateway} even
731 if you have to go through a firewall.
735 ;; @r{Example: imap4.exaple.org as main IMAP server}
736 (setq elmo-imap4-default-server "imap4.example.org")
740 SSL (Secure Socket Layer) connection will be used if a folder name ends
741 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
742 is @code{ssl}, SSL will be the default connection. If a folder name
743 ends with @samp{!!}, STARTTLS connection will be established. If the
744 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
745 STARTTLS will be the default connection.
749 ;; @r{Example: Use SSL connection}
750 (setq elmo-imap4-default-stream-type 'ssl)
754 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
755 authentication method, the password is sent in encoded form. But, if
756 your server is unable to receive an encoded password, authentication
757 will fall back to @code{clear} (that is, sending password in raw format)
758 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
759 authentication will fall back to @code{clear} without confirmation
760 (default value is @code{nil}).
764 ;; @r{Example: password in raw format}
765 (setq elmo-imap4-default-authenticate-type 'clear)
773 %inbox -> IMAP mailbox "inbox"
774 %#mh/inbox -> IMAP mailbox "#mh/inbox"
776 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
777 %inbox:hoge/clear@@server1
778 -> server1's IMAP mailbox "inbox"
779 of user "hoge", with plain password authentication
784 @subsection International mailbox names (Modified UTF7)
785 @cindex Modified UTF7
792 You can use international mailbox names in @var{mailbox} part, if you
793 are using Emacs which can treat unicode and
794 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
795 value is @code{nil}).
797 Currently, following Emacsen can treat unicode.
800 @item Emacs 20.3 or later + Mule-UCS
802 If you installed Mule-UCS package, Emacs can treat unicode.
803 You can obtain Mule-UCS package from following URL.
806 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
809 @item XEmacs 21.2.13 or later + ucs-conv package
811 By default, XEmacs 21 cannot treat unicodes, but if you installed
812 ucs-conv package, it can.
813 You can obtain ucs-conv package from following anonymous CVS.
817 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
818 Password: @var{NULL} (Just enter return key)
819 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
823 You also need utf7 conversion programs, @command{u7tou8} and
824 @command{u8tou7} to use international mailbox name in the current
825 XEmacs. These programs are included in the UTF7 package which can be
826 obtained from following URL.
829 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
834 @node NNTP Folder, MH Folder, IMAP Folder, Folders
845 A folder to access USENET news via NNTP protocol (RFC 977).
846 One newsgroup is treated as a folder.
852 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
858 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
859 Initial setting is @samp{localhost}.
860 @var{username} -> The value of @code{elmo-nntp-default-user}.
861 Initial setting is @code{nil}.
862 @var{port} -> The value of @code{elmo-nntp-default-port}.
863 Initial setting is 119.
866 AUTHINFO is used as authentication method if the @var{username} is
867 non-nil. SSL will be default method if
868 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
869 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
870 STARTTLS connection will be established. if the value of
871 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
872 be the default connection.
878 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
879 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
884 @node MH Folder, Maildir Folder, NNTP Folder, Folders
891 A folder to access MH format mail (1 file is 1 mail).
896 @samp{+} @var{directory-name}
899 Normally, @var{directory-name} is an relative path to the variable
900 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
901 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
902 (this is also true for drive-letters).
904 Message number is used for the name of the message file.
910 +inbox -> @file{~/Mail/inbox}
911 +from/teranisi -> @file{~/Mail/from/teranisi}
912 +~/test -> @file{~/test}
917 @node Maildir Folder, News Spool Folder, MH Folder, Folders
918 @section Maildir Folder
920 @cindex Maildir Folder
924 A folder to access Maildir format (1 file is 1 mail).
929 @samp{.} [@var{directory-name}]
932 Normally, @var{directory-name} is a relative path to the variable
933 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
934 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
935 (this is also true for drive-letters).
937 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
938 Messages are contained in the @file{cur} directory. All message files
939 in the @file{new} directory are moved to @file{cur} directory when you
940 access the folder. All message files contained in the @file{tmp}
941 directory and not accessed for 36 hours are deleted.
943 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
949 . -> @file{~/Maildir}
950 .inbox -> @file{~/Maildir/inbox}
951 .from/teranisi -> @file{~/Maildir/from/teranisi}
952 .~/test -> @file{~/test}
957 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
958 @section News Spool Folder
960 @cindex News spool Folder
963 This folder handles locally saved news articles which are proposed by
964 Mew/IM. You can also read articles directly from a spool-file which is
965 retrieved by an utility like @command{gnspool}.
970 @samp{=} @var{directory-name}
973 @var{directory-name} is a sub-directory to the directory defined by
974 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
975 You can use @samp{.} as directory delimiter as well as @samp{/}.
981 =fj/os/os2 -> @file{~/News/fj/os/os2}
982 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
987 @node Archive Folder, POP Folder, News Spool Folder, Folders
988 @section Archive Folder
990 @cindex Archive Folder
993 This method can handle archive files, which are compressed by utilities
994 such as Info-ZIP or LHA, as one folder.
1000 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1004 @var{path-name} is the relative path from
1005 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1006 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1007 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1008 also permitted under the environment of ange-ftp, efs.
1010 The actual file name of the archive folder is
1011 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1012 under the @var{path-name}. If a file named @var{path-name} exists, it is
1013 treated as folder. The suffix is automatically decided for
1014 @var{archiver-type}.
1016 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1017 (Initial setting is @code{zip}) is referred.
1019 @var{prefix} specifies the internal directory structure of the archive.
1020 For example, if the ML server is fml, @file{msend.tar.gz} has a
1021 structure like @file{spool/1}, so you have to specify @samp{spool} as
1028 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1029 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1030 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1031 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1036 * Archiver:: Supported Archivers
1037 * Archive Tips:: TIPS
1038 * Archive Vars:: Customization
1042 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1043 @subsection Supported Archives
1053 By default, following archives are supported.
1057 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1058 GNU TAR('tgz, 'tar) ;; read-only
1062 If your archiver can include multiple files in one archive, you have a
1063 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1064 of the candidate. TAR is supported read-only because it cannot delete
1065 file in the archive (@code{mv})).
1067 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1068 archiver of Wanderlust because they cannot include multiple
1069 files. Archivers that cannot extract files to standard output are also
1072 @subsection OS specific information about archiver.
1074 Behaviors of the following archivers are confirmed by further experiences.
1075 (@samp{*} mark means recommended archiver).
1078 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1079 LHA OS/2 version Rel.2.06b Feb 18, 1998
1080 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1081 *Zip 2.2 (November 3rd 1997).
1082 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1083 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1084 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1086 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1087 LHa for UNIX V 1.14c
1088 UnZip 5.32 of 3 November 1997
1089 Zip 2.2 (November 3rd 1997)
1090 GNU tar 1.12 (1.11.x is no good)
1091 gzip 1.2.4 (18 Aug 93)
1093 [Win32] Win.98/Meadow
1097 GNU tar 1.11.8 + 1.5(WIN32)
1104 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1105 Hiramatsu version of LHA is only supported.
1106 In Win32, LHa32 is only supported (DOS version is no good).
1108 * Caution about GNU tar
1110 You have to take care about GNU tar's version because many version has
1111 problem on deleting file from archive.
1113 Please test @option{--delete} @option{-f} options work. Otherwise, your
1114 archive will be destroyed. No problem is reported on above versions of
1118 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1120 @cindex Archive Tips
1122 For comfortable migration, usage of @code{wl-summary-archive}
1123 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1124 archive folders created by expiration, you must set non-nil value to
1125 @code{elmo-archive-treat-file}.
1127 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1128 in processing speed. For comfortable use, Emacs20 is recommended.
1129 (If re-search's performance is the problem, 19.3x or later may be okay.)
1131 If many files are included in one archive,
1132 it takes long time to access the archive folder because
1133 archiver starting overhead is increased (especially LHA).
1134 150-200 messages in one archive is recommended.
1136 Of course, following is possible @t{:-)}
1137 (meanings of these variables are described later.)
1141 (setq wl-fcc "$backup")
1142 (setq wl-trash-folder "$trash;lha")
1146 @node Archive Vars, , Archive Tips, Archive Folder
1147 @subsection Variables About Archive Folder
1148 @cindex Archive variables
1151 @item elmo-archive-default-type
1152 @vindex elmo-archive-default-type
1153 The initial setting is @code{zip}.
1154 Set archiver type by symbol.
1156 @item elmo-archive-@var{type}-method-alist
1157 @vindex elmo-archive-TYPE-method-alist
1158 Define archiver @var{type}'s methods.
1159 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1160 Each element of the alist is following.
1164 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1165 (@var{action} . @var{function}) ;; function
1169 Currently available actions are following.
1173 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1174 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1181 actions enclosed with braces are optional (They are used for better
1184 @item elmo-archive-suffix-alist
1185 @vindex elmo-archive-suffix-alist
1186 An alist of archiver-type (symbol) and suffix.
1188 @item elmo-archive-file-regexp-alist
1189 @vindex elmo-archive-file-regexp-alist
1190 An alist of a regexp to get file number from list output of archiver
1191 and archiver-type (symbol).
1193 @item elmo-archive-method-list
1194 @vindex elmo-archive-method-list
1195 A list of elmo-archive-@var{type}-method-alist
1196 (@var{type} is a symbol of archiver-type).
1198 @item elmo-archive-lha-dos-compatible
1199 @vindex elmo-archive-lha-dos-compatible
1200 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1201 DOS (Mr. Yoshizaki original) compatible.
1203 @item elmo-archive-cmdstr-max-length
1204 @vindex elmo-archive-cmdstr-max-length
1205 The initial setting is 8000.
1207 Max length of command line argument for external archiver program.
1208 Emacs does not have a limit of command line byte length, but some OS
1209 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1210 this limit because it calls external archiver program directly (not
1211 called via shell). For example, you cannot delete messages if archiver
1212 program must receive larger bytes of arguments to delete. OS/2 have a
1213 command line argument limit of 8190 bytes, so we defined default as 8000
1216 However, you don't have an influence of command line argument limit
1217 if the archiver has `actions' to receive target file information from
1218 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1222 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1230 A folder to access e-mails via POP3 protocol (RFC 1939).
1236 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1241 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1242 as @var{authenticate-type}.
1244 You can specify @samp{uidl} (use UIDL command for message numbering) or
1245 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1249 @var{username} -> The value of @code{elmo-pop3-default-user}.
1250 Initial setting is @env{USER} environment variable or
1251 @env{LOGNAME} environment variable or return value of
1252 @code{(user-login-name)}.
1253 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1254 Initial setting is @samp{user}.
1255 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1256 If t, use UIDL for numbering. Initial setting is t.
1257 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1258 Initial setting is @samp{localhost}.
1259 @var{port} -> The value of @code{elmo-pop3-default-port}.
1260 Initial setting is 110.
1267 &hoge@@localhost -> access localhost as user @samp{hoge}.
1268 &hoge@@popserver:109 -> access the server "popserver" on port 109
1269 as user @samp{hoge}.
1273 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1274 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1275 @file{utils/sasl/lisp/} or Emacs/W3 package
1276 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1279 If the last character of the folder name is @samp{!}, Wanderlust
1280 connects to the POP server via SSL (Secure Socket Layer). If you set
1281 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1282 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1283 with @samp{!!}, STARTTLS connection will be established. if the value
1284 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1288 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1289 @section Shimbun Folder
1291 @cindex Shimbun Folder
1292 @cindex Folder, Shimbun
1297 A folder for watching "shimbun" (means "newspaper" in Japanese),
1298 news site and mailing list archives on WWW by using emacs-w3m
1299 (@uref{http://emacs-w3m.namazu.org/}).
1301 You should possess w3m and emacs-w3m to use this.
1307 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1311 Admissible values of @var{module-name} and @var{folder-name} are
1312 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1318 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1319 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1323 @subsection Variables About Shimbun Folder
1326 @item elmo-shimbun-update-overview-folder-list
1327 @vindex elmo-shimbun-update-overview-folder-list
1328 The initial setting is @code{nil}. You can specify a list of regular
1329 expressions of shimbun folder names. The overview of matched shimbun
1330 folder is updated when messages are fetched.
1331 You should @kbd{s rescan} after fetching to update summary.
1335 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1336 @section Namazu Folder
1338 @cindex Namazu Folder
1339 @cindex Folder, Namazu
1340 @cindex Folder, Text Search
1343 A folder to access messages found in namazu-index with some condition.
1344 It uses namazu (@uref{http://www.namazu.org/}) for search.
1350 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1354 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1360 [wanderlust] -> search messages matched with
1361 "wanderlust" from the default index
1362 [semi flim]~/Mail/semi -> search "semi flim" from the index
1363 in the directory "~/Mail/semi"
1369 @subsubsection Enter space to separate keywords
1371 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1373 @subsubsection Alias name for index
1375 You can define an alias name for index.
1380 (setq elmo-nmz-index-alias-alist
1381 '(("cache" . "~/.elmo/cache")
1382 ("docs" . "~/documents")))
1385 Above definition defines two index aliases.
1392 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1393 directory @file{~/.elmo/cache}.
1395 @subsubsection Multiple indices
1397 You can specify a list for @code{elmo-nmz-default-index-path} and
1398 @code{elmo-nmz-index-alias-alist}.
1399 When list is specified, all index contained in the list is used as the
1405 (setq elmo-nmz-index-alias-alist
1406 '(("all" . ("~/.elmo/cache" "~/documents"))
1407 ("cache" . "~/.elmo/cache")))
1410 Using above alias setting, you can specify
1416 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1417 directory @file{~/.elmo/cache} and @file{~/documents}.
1419 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1420 @section Multi Folder
1422 @cindex Multi Folder
1423 @cindex Folder, Multiple
1424 @cindex Folder, Marge
1426 A folder to access virtual folder which collects messages from
1433 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1437 After @samp{*} character, specify multiple folders you want to collect
1438 separated by @samp{,} like
1439 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1445 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1446 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1447 treated as one folder.
1449 *+inbox,-fj.rec.tv,%inbox
1450 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1455 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1456 @section Filter Folder
1458 @cindex Filter Folder
1459 @cindex Folder, Filtering
1460 @cindex Folder, Virtual
1461 @cindex Folder, Conditional
1463 A folder to access virtual folder which collects all messages that
1464 satisfy a condition.
1469 @samp{/} @var{condition} @samp{/} @var{target-folder}
1472 In the @var{condition} part, you can specify following.
1476 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1478 first: @var{number} messages are picked from top of folder.
1479 last: @var{number} messages are picked from bottom of folder.
1485 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1486 /first:20/%inbox -> First 20 messages from %inbox are picked.
1491 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1493 since: only messages arrived since @var{date} are picked.
1494 before: only messages arrived before @var{date} are picked.
1496 You can specify following as @var{date}.
1500 yesterday -> a day before today.
1501 lastweek -> same day of last week.
1502 lastmonth -> same day of last month.
1503 lastyear -> same day of last year.
1504 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1505 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1513 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1515 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1521 Field filter: @samp{@var{field}:@var{value}}
1523 All messages that have @var{field} and its value is @var{value} are picked.
1524 @var{field} and @var{value} are case insensitive.
1530 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1531 and its value includes "teranisi" string are picked.
1532 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1540 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1541 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1543 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1544 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1550 /from:teranisi&!to:teranisi/+inbox
1551 -> In +inbox, messages are picked if the message's
1552 From: field includes "teranisi" and
1553 To: field doesn't include "teranisi".
1555 /tocc:"Yuuichi Teranishi"/+inbox
1556 -> In +inbox, messages are picked if the
1557 message's To: field or Cc: field includes
1558 "Yuuichi Teranishi".
1560 /(from:yt|from:teranisi)&subject:report/+inbox
1561 -> In +inbox, messages are picked if the message's
1562 From: field includes "yt" or "teranisi", and
1563 Subject includes "report".
1569 Tip for string description:
1571 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1572 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1573 should be escaped with @samp{\} in it). You can enclose the string with
1574 @samp{"} even it does not contain these characters.
1580 *%inbox,/from:teranisi/%inbox@@server
1581 -> Messages in %inbox or
1582 message is in the %inbox@@server folder and it's From field
1583 includes "teranisi" are collected.
1585 /last:100//to:teranisi/*+inbox,%inbox
1586 -> Latest 100 messages which is in the +inbox or %inbox folder
1587 and To: field matches "teranisi".
1589 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1590 -> Pick messages which have From: field and it includes "hogehoge"
1591 from latest 20 messages in the %#mh/inbox@@localhost
1592 and To: or Cc: field includes "teranisi".
1595 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1596 @section Pipe Folder
1600 @cindex Download Message
1601 @cindex Incorporate Message
1603 In the pipe folder, messages are automatically transferred from the source
1604 folder to destination folder.
1609 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1612 When you access the pipe folder, messages are automatically transferred
1613 from @var{source-folder} to @var{destination-folder}.
1614 It is convenient if you want to download messages to local disk via POP.
1615 For example, if you specify following
1618 |&username@@popserver|+inbox
1622 and access it, messages are downloaded automatically from
1623 @samp{&username@@popserver} to @samp{+inbox}.
1625 On the other hand, if you put @samp{|:} instead of second @samp{|},
1626 then messages are copied to the destination folder (not deleted from
1627 source-folder). At the next time you access that folder, only new
1628 messages will be copied.
1631 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1634 If you want to copy messages from POP server and view them, specify the
1638 |&username@@popserver|:+inbox
1641 where messages will be kept on the server.
1647 |%inbox|%myinbox -> Download %inbox to %myinbox.
1648 |*&user@@popserver1,&user@@popserver2|+inbox
1649 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1650 |-gnu.emacs.sources|:+sources
1651 -> Copy messages from -gnu.emacs.sources to +sources.
1655 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1657 @node Internal Folder, , Pipe Folder, Folders
1658 @section Internal folder
1660 @cindex Internal Folder
1661 @cindex Folder, @samp{$} mark
1663 @c @cindex Folder, Null
1665 A folder to access internal messages of Wanderlust.
1677 A folder named @samp{'mark} is a special virtual folder which collects
1678 messages which have important mark @samp{$}.
1680 You can review important messages at once after you put important marks
1681 on the messages in the different folders.
1683 In this folder, if you delete message, important mark @samp{$} put on
1684 the message is removed. If you append messages to this folder, the
1685 message will have @samp{$} mark.
1687 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1688 folder. If you want IMAP folder's message remove from @samp{'mark}
1689 folder, remove important mark at IMAP Folder.)
1692 A folder named @samp{'sendlog} is a virtual folder which collects
1693 cached messages which are recoded on @file{~/.elmo/sendlog}.
1694 It might be useful when you forgot to add cc for yourself.
1695 To use this, you should set @code{wl-draft-use-cache} to non-nil
1696 so that sent messages are cached.
1699 You can access cached messages fetched via network by accessing
1700 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1701 the name of the subdirectories of the cache directory
1702 (@file{~/.elmo/cache}).
1705 @node Folder, Summary, Folders, Top
1706 @chapter Folder mode
1709 After you start Wanderlust, folder mode is appeared firstly.
1710 It contains folder list you subscribed.
1711 You can select and edit folders in this mode.
1714 * Selecting Folder:: Select folder you want to read
1715 * Folder Manager:: Editing folders
1719 @node Selecting Folder, Folder Manager, Folder, Folder
1720 @section Selecting Folder
1721 @cindex Selecting Folder
1723 @subsection Usage (TIPS)
1725 @subsubsection Check new, unread number
1727 Folder mode looks like this.
1728 (In XEmacs, it looks much nicer @t{;-)})
1732 [-]Desktop:14186/35580/67263
1737 [-]Emacsen:0/34/4837
1738 Wanderlust ML:0/0/558
1741 XEmacs Beta:0/29/255
1752 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1756 @kbd{s} key on the folder line updates these numbers.
1757 It changes its color if it has many new messages.
1759 The whole folder mode is a folder group named @samp{Desktop}.
1760 Folder group open/close by return key.
1761 A operation to a folder group is treated as operations on the
1763 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1764 six children folders update its unread number status.
1766 @subsubsection Select Folder
1768 To enter summary mode of the folder, type return (or space) key on
1770 If the variable @code{wl-stay-folder-window} has non-nil value,
1771 summary window appears on the right of the folder mode window.
1773 @subsection Key bindings
1775 Folder mode's key binding (related to selecting folders) is following.
1780 @kindex @key{SPC} (Folder)
1781 @kindex @key{RET} (Folder)
1782 @findex wl-folder-jump-to-current-entity
1783 Enter to the summary mode of the folder at the current cursor point.
1784 If the cursor is on the top of folder group line,
1785 the folder group is opened or closed.
1786 When the cursor is on the access group and this command is called
1787 with prefix argument, folder children list is updated to the newest one.
1788 (Children list is updated recursively if the access folder has hierarchical
1790 (@code{wl-folder-jump-to-current-entity})
1793 @kindex M-@key{RET} (Folder)
1794 @findex wl-folder-update-recursive-current-entity
1795 Folder children list of the access group at the current cursor point
1796 is updated to the newest one.
1797 (Children list is updated recursively if the access folder has hierarchical
1799 (@code{wl-folder-update-recursive-current-entity})
1804 Create a new draft message.
1809 @findex wl-folder-write-current-folder
1810 If the current cursor point is on the NNTP folder, create a new draft
1811 message which already has @samp{Newsgroups:} field. If the current
1812 cursor point is on the folder for mailing list (refile destination),
1813 create a new draft message which already has @samp{To:} field with
1814 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1816 (@code{wl-folder-write-current-folder})
1819 @kindex C-c C-o (Folder)
1820 @findex wl-jump-to-draft-buffer
1821 Move to the draft buffer if available. If multiple draft buffer exists,
1822 moved to one after another. If prefix argument is specified, load draft
1823 folder's message to the draft buffer and jump to it.
1824 (@code{wl-jump-to-draft-buffer})
1828 @findex wl-folder-check-current-entity
1829 Update new and unread number information of the folder at the current
1831 (@code{wl-folder-check-current-entity})
1835 @findex wl-folder-sync-current-entity
1836 Update summary information of the folder at the current cursor point.
1837 (@code{wl-folder-sync-current-entity})
1840 @kindex r s (Folder)
1841 @findex wl-folder-check-region
1842 Update new and unread number information of the folders in the currently
1844 (@code{wl-folder-check-region})
1847 @kindex r S (Folder)
1848 @findex wl-folder-sync-region
1849 Update summary information of the folders in the currently selected region.
1850 (@code{wl-folder-sync-region})
1854 @findex wl-status-update
1855 Sync up address book status with @file{~/.addresses}'s content.
1856 (@code{wl-status-update})
1860 @findex wl-folder-prev-unread
1861 Jump cursor to the folder which have unread messages on the upward from
1862 current cursor point.
1863 (@code{wl-folder-prev-unread})
1867 Jump cursor to the folder which have unread messages on the downward
1868 from current cursor point.
1869 (@code{wl-folder-next-unread})
1873 Move cursor to the folder on the previous line.
1874 (@code{wl-folder-prev-entity})
1878 Move cursor to the folder on the next line.
1879 (@code{wl-folder-next-entity})
1883 Jump to the folder specified by the user input.
1884 (@code{wl-folder-jump-folder})
1888 @findex wl-folder-prefetch-current-entity
1889 Prefetch new messages of the folder at the current cursor point by
1890 @code{wl-summary-incorporate}.
1891 If the cursor is on the folder group, it is executed recursively.
1892 (@code{wl-folder-prefetch-current-entity})
1896 @findex wl-folder-mark-as-read-all-current-entity
1897 Mark all unread messages of the folder at the current cursor point as read.
1898 If the cursor is on the folder group, it is executed recursively.
1899 (@code{wl-folder-mark-as-read-all-current-entity})
1903 @findex wl-folder-goto-first-unread-folder
1904 Enter summary mode of the first unread folder.
1905 (@code{wl-folder-goto-first-unread-folder})
1909 @findex wl-folder-empty-trash
1911 (@code{wl-folder-empty-trash})
1915 @findex wl-folder-open-all-unread-folder
1916 All unread folder is opened.
1917 (@code{wl-folder-open-all-unread-folder})
1921 @findex wl-folder-open-close
1922 Folder group is opened/closed.
1923 (@code{wl-thread-open-close})
1927 All folder group is opened.
1928 (@code{wl-folder-open-all})
1932 All folder group is closed.
1933 (@code{wl-folder-close-all})
1943 (@code{wl-folder-suspend})
1946 @kindex M-s (Folder)
1947 Save current folder status.
1951 @kindex M-t (Folder)
1952 Toggle Wanderlust's offline/online status.
1953 (@code{wl-toggle-plugged})
1956 @kindex C-t (Folder)
1957 Start Wanderlust's plug-status manager.
1958 (@code{wl-plugged-change})
1961 @subsection Customize variables
1964 @item wl-folders-file
1965 @vindex wl-folders-file
1966 The initial setting is @file{~/.folders}.
1967 Subscribed folders are described (saved) in this file.
1969 @item wl-folder-info-save
1970 @vindex wl-folder-info-save
1971 The initial setting is @code{t}. If non-nil, unread information is
1972 saved and used in the next Wanderlust session.
1974 @item wl-stay-folder-window
1975 @vindex wl-stay-folder-window
1976 The initial setting is @code{nil}.
1977 If non-nil, summary window is appeared on the right side of the folder buffer.
1979 @item wl-folder-window-width
1980 @vindex wl-folder-window-width
1981 The initial setting is 20.
1982 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1984 @item wl-folder-use-frame
1985 @vindex wl-folder-use-frame
1986 The initial setting is @code{nil}.
1987 If non-nil, use new frame for the folder window.
1989 @item wl-folder-many-unsync-threshold
1990 @vindex wl-folder-many-unsync-threshold
1991 The initial setting is 70.
1992 If the number of unread messages is more than this value,
1993 folder color is changed.
1995 @item wl-highlight-folder-by-numbers
1996 @vindex wl-highlight-folder-by-numbers
1997 This option controls how to highlight each line in the folder buffer.
1998 The default value is @code{t}, highlighting with various colors based on
1999 the message numbers. If it is @code{nil}, highlighting with various
2000 colors based on the folder status. In addition, if it is a number
2001 (e.g. 1), highlighting will be done based on both the message numbers
2002 and the folder status.
2004 @item wl-folder-desktop-name
2005 @vindex wl-folder-desktop-name
2006 The initial setting is @samp{Desktop}.
2007 The name of top folder group.
2009 @item wl-folder-petname-alist
2010 @vindex wl-folder-petname-alist
2011 The initial setting is @code{nil}.
2012 An alist of folder's realname and its nickname.
2014 @item wl-folder-access-subscribe-alist
2015 @vindex wl-folder-access-subscribe-alist
2016 The initial setting is @code{nil}.
2018 Control automatic subscribing and unsubscribing of the children list
2024 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2028 If @var{subscribe-flag} is non-nil, folders which have name matched to
2029 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2030 already unsubscribed folder is not displayed even when the
2031 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2038 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2039 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2040 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2041 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2045 @item wl-folder-hierarchy-access-folders
2046 @vindex wl-folder-hierarchy-access-folders
2047 The initial setting is the list shown below:
2056 A list of access groups which creates children folder list hierarchically.
2058 For example, if you specify
2059 @code{wl-folder-hierarchy-access-folders} like following,
2063 (setq wl-folder-hierarchy-access-folders
2064 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
2069 such access group hierarchy is obtained.
2075 -fj.comp.announce:0/0/2
2076 -fj.comp.dev.cdrom:0/0/0
2078 [+]-japan:238/238/1688
2081 -comp.unix.admin:0/0/0
2082 -comp.unix.dos-under-unix:0/0/0
2083 -comp.unix.programmer:0/0/0
2084 [-]-comp.unix.bsd:0/0/23
2085 -comp.unix.bsd.freebsd.announce:0/0/0
2090 If you opened @samp{-} in this example, only the direct children is created
2091 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2092 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2093 is not created until the children access group is opened.
2097 @node Folder Manager, , Selecting Folder, Folder
2098 @section Editing Folders
2099 @cindex Folder Manager
2100 @cindex Folder, Edit
2101 @cindex Folder, Subscribe
2102 @cindex Folder, Unsubscribe
2104 As described before, subscribed folder list is saved in @file{~/.folders} file.
2105 But you don't have to edit @file{~/.folders} directly.
2106 You can append, delete, edit folders from folder mode.
2108 @subsection Usage (Tips)
2110 @subsubsection Append Folder
2112 @kbd{m a} appends new folder to the folder mode.
2113 @kbd{m g} appends new folder group.
2114 To append new folder to this group, firstly open it,
2115 then execute append command in the next line.
2117 @subsubsection Edit Folder
2119 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2120 Thus, you can change folder position as if you were editing a normal file.
2122 @subsubsection Create Multi Folder.
2126 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2128 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2130 Type @kbd{m m}, then you can create multi folder.
2133 @subsubsection Delete Nickname, Filter
2135 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2136 minibuffer while appending.
2138 @subsubsection Append Folder to Empty Group
2140 To append new folder to the empty folder group
2141 (after you create folder group by typing @kbd{m g}),
2142 firstly open it, then execute append command in the next line.
2143 If it is closed, folder is appended on the same level with
2144 the above folder group. It is difficult to explain by words so try it.
2145 In other words, appended position depends on the
2146 above folder group's open/close status.
2148 @subsubsection Charset of the Folders File.
2150 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2152 @subsubsection Create Filter
2154 @kbd{m f} adds filter to the folder at the current cursor point. To
2155 create new filter folder and leave the current folder unchanged, copy it
2156 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2157 filter can be specified while appending filter. If you put
2158 ``''(@var{NULL}), filter is deleted.
2160 @subsubsection Sort Folders
2162 Sorting of the folders is executed by the function specified by
2163 @code{wl-fldmgr-sort-function}.
2164 The initial setting is @code{wl-fldmgr-sort-standard},
2165 which sorts alphabetically.
2166 Sorting affects only on the current folder group. It does not
2167 affect on the child groups.
2169 @subsubsection Hiding Folders in the Access Group
2171 Usually, access group displays all children folders, but you can set
2172 some folders hidden. Following operations are only available on access
2175 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2176 (subscribe/unsubscribe) of the folder at current cursor point. Against
2177 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2180 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2181 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2182 argument and if the argument has positive number, the unsubscribe it.
2183 If the prefix argument has negative value, folder becomes visible and if
2184 zero, folder visibility is toggled.
2186 The other commands, @code{wl-fldmgr-subscribe} and
2187 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2190 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2191 executed in the access group, they have a same effect with
2192 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2193 The difference is that cut commands deletes folders from the current
2196 @subsubsection Operations in the Access Group
2198 You can insert and delete folders in the access group like usual folder
2199 group. But insert and delete commands can be only available for the
2200 children folders of the access group and they only sets the subscribe
2201 status. In other words, insertion of the folder means subscribing,
2202 deletion means unsubscribing.
2203 @footnote{In the current implementation,
2204 it is faster to delete region than to unsubscribe region.}
2206 To update the access group when children folders are inserted or deleted
2207 by other way (other than Wanderlust),
2208 open the access group by typing @kbd{C-u @key{RET}}.
2209 @xref{Selecting Folder}.
2211 The order of children folders of access group is saved after
2212 insertion/deletion/sorting.
2213 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2214 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2215 newly created folders are inserted on the top of the access group.
2217 @subsection Key bindings
2218 @cindex Keybind, Folder Mode
2219 @cindex Keybind, Folder Buffer
2221 Key bindings on the folder mode related to folder editing are shown below.
2222 All bindings starts with @kbd{m}, and primary commands are binded to
2223 one stroke key binding.
2227 @kindex m a (Folder)
2228 @findex wl-fldmgr-add
2230 (@code{wl-fldmgr-add})
2235 @kindex m g (Folder)
2236 @findex wl-fldmgr-make-group
2237 Create a folder group.
2238 (@code{wl-fldmgr-make-group})
2241 @kindex m A (Folder)
2242 @findex wl-fldmgr-make-access-group
2243 Create an access group.
2244 (@code{wl-fldmgr-make-access-group})
2247 @kindex m d (Folder)
2248 @findex wl-fldmgr-delete
2249 Delete folder itself and msgdb.
2250 If the folder itself cannot be deleted like NNTP folder,
2251 only msgdb is deleted.
2252 (@code{wl-fldmgr-delete})
2257 @kindex m R (Folder)
2258 @findex wl-fldmgr-rename
2259 Change the name of folder or folder group.
2260 msgdb's path is also changed.
2261 (@code{wl-fldmgr-rename})
2267 @findex wl-fldmgr-make-multi
2268 Create a multi folders in the cutlist (cut, copied folders).
2269 (@code{wl-fldmgr-make-multi})
2274 @kindex m f (Folder)
2275 @findex wl-fldmgr-make-filter
2276 Create a filter folder. (Put a filter on the folder).
2277 (@code{wl-fldmgr-make-filter})
2281 @kindex M-c (Folder)
2282 @kindex m c (Folder)
2283 @findex wl-fldmgr-copy
2284 Copy folder (it is not available on folder group).
2285 (@code{wl-fldmgr-copy})
2289 @kindex M-w (Folder)
2290 @kindex m W (Folder)
2291 @findex wl-fldmgr-copy-region
2292 Copy folders in the specified region.
2293 (@code{wl-fldmgr-copy-region})
2297 @kindex C-k (Folder)
2298 @kindex m k (Folder)
2299 @findex wl-fldmgr-cut
2300 Cut folder. Folder itself is not deleted.
2301 (@code{wl-fldmgr-cut})
2305 @kindex C-w (Folder)
2306 @kindex m C-w (Folder)
2307 @findex wl-fldmgr-cut-region
2308 Cut folders in the specified region.
2309 (@code{wl-fldmgr-cut-region})
2313 @kindex C-y (Folder)
2314 @kindex m y (Folder)
2315 @findex wl-fldmgr-yank
2316 Paste folders that are copied or cut (folders in the cut-list).
2317 (@code{wl-fldmgr-yank})
2320 @kindex m p (Folder)
2321 @findex wl-fldmgr-set-petname
2322 Put nickname on the folder.
2323 (@code{wl-fldmgr-set-petname})
2326 @kindex m q (Folder)
2327 @findex wl-fldmgr-clear-cut-entity-list
2328 Clear the cut-list. (cut, copied folder information is cleared,
2329 you cannot paste after this)
2330 (@code{wl-fldmgr-clear-cut-entity-list})
2333 @kindex m s (Folder)
2334 @findex wl-fldmgr-sort
2335 Sort folders in the current folder group.
2336 (@code{wl-fldmgr-sort})
2339 @kindex m C-s (Folder)
2340 @findex wl-fldmgr-save
2341 Save current folder view to the @file{wl-folders-file}.
2342 (@code{wl-fldmgr-save})
2345 [Following commands are only available on the access groups]
2351 @kindex m u (Folder)
2352 @findex wl-fldmgr-unsubscribe
2353 Set the visibility of folder (subscribe/unsubscribe).
2354 (@code{wl-fldmgr-unsubscribe})
2359 @kindex r u (Folder)
2360 @findex wl-fldmgr-unsubscribe-region
2361 Set the visibility of the folders (subscribe/unsubscribe) in the
2363 (@code{wl-fldmgr-unsubscribe-region})
2368 @kindex m l (Folder)
2369 @findex wl-fldmgr-access-display-normal
2370 List folders that are currently available.
2371 (@code{wl-fldmgr-access-display-normal})
2376 @kindex m L (Folder)
2377 @findex wl-fldmgr-access-display-all
2378 List all folders regardless of the subscription status.
2379 (@code{wl-fldmgr-access-display-all})
2383 @subsection Customize variables
2386 @item wl-interactive-save-folders
2387 @vindex wl-interactive-save-folders
2388 The initial setting is @code{t}. If non-nil and folder view is
2389 modified, confirm saving it before Wanderlust or Emacs exits. If
2390 @code{nil}, save without confirmation.
2392 @item wl-fldmgr-make-backup
2393 @vindex wl-fldmgr-make-backup
2394 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2395 created before saving the folder status.
2397 @item wl-fldmgr-sort-function
2398 @vindex wl-fldmgr-sort-function
2399 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2400 sort folders. By default function, folders are sorted alphabetically
2401 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2404 @item wl-fldmgr-sort-group-first
2405 @vindex wl-fldmgr-sort-group-first
2406 The initial setting is @code{t}. If non-nil,
2407 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2408 does not care whether it is folder group or not.
2410 @item wl-folder-check-async
2411 @vindex wl-folder-check-async
2412 The initial setting is @code{t}. If non-nil, check folder's unread
2413 status asynchronously. It boosts newsgroup checking.
2415 @item wl-folder-check-fast
2416 @vindex wl-folder-check-fast
2417 The initial setting is @code{nil}.
2418 If non-nil, it does not update folder status while checking.
2420 @item wl-folder-notify-deleted
2421 @vindex wl-folder-notify-deleted
2422 The initial setting is @code{nil}.
2424 If non-nil, negative value is displayed when the message is deleted. If
2425 @code{sync}, folder is synchronized when the message is deleted. If
2426 @code{nil}, message deletion is ignored.
2428 @item wl-fldmgr-add-complete-with-current-folder-list
2429 @vindex wl-fldmgr-add-complete-with-current-folder-list
2430 The initial setting is @code{nil}.
2431 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2432 candidate for @code{wl-fldmgr-add}.
2435 @subsection Miscellanea
2437 Following is a note for folder editing.
2441 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2442 paste(yank) command pastes the folders on one cut or copy command
2443 (If copy command is executed by region, folders in the region are pasted
2444 by one paste command)
2447 You cannot cut @samp{Desktop} group.
2448 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2451 You cannot copy folder group.
2454 Operations on the access group are only available for the folders
2455 in the same access group.
2458 You cannot create a folder which has same name with the folders already exist.
2461 You cannot insert folders which have same name in one group.
2462 You can insert them in the different groups.
2463 You cannot put same nickname to the different folders.
2467 @node Summary, Message, Folder, Top
2468 @chapter Summary Mode
2470 After you select the folder via folder mode, you enter to the summary
2474 * Usage of Summary Mode:: TIPS
2475 * Thread Operations:: Thread operations
2476 * Cache:: File cache, Buffer cache, and Prefetch
2477 * Auto Refile:: Auto refile settings
2478 * Sticky Summary:: Summary make sticky
2479 * Key Bindings of Summary:: Key bindings
2480 * Variables of Summary:: Customize Summary Mode
2484 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2485 @section Usage (Tips)
2487 @subsection Summary Content
2489 In the summary mode, messages are displayed like following.
2493 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2494 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2495 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2496 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2503 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2507 You cannot change this in the current version.
2509 @var{Message number} is the message's unique number in the folder. In
2510 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2511 in the MH folder, it is the filename of the message.
2513 @var{Temporal mark} and @var{Persistent mark} are described later.
2515 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2516 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2517 Japanese, but if you want to display it in English, set the value of
2518 @code{wl-summary-weekday-name-lang} as @samp{en}.
2520 @var{Sender}'s indentation corresponds to the depth of the thread.
2521 Sender name is displayed as nickname if it is defined in the address
2522 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2523 displaying with nickname.
2525 If number is printed at the head of @var{Sender} part like @samp{+2},
2526 that means the message have 2 follow messages.
2528 @var{Subject} is the @samp{Subject:} header field of the message. If
2529 the message have same @samp{Subject:} with the parent message, it is not
2530 displayed. Some mailing list puts its sequence number in the
2531 @samp{Subject:} field, but it is
2532 ignored. @code{wl-summary-no-subject-message} is displayed when the
2533 message has empty subject field.
2535 @subsection Temporary Marks
2536 @cindex Mark, Temporary
2538 There are four temporary marks,
2539 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2540 Temporary marks indicates message operations.
2545 You can execute a command on the all messages that have @samp{*} mark,
2546 with the key bindings which begins with @kbd{m}.
2549 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2553 After you type @kbd{o} key, prompt appears to input refile destination.
2554 Your answer is printed in the summary line.
2558 You can put this mark by typing @kbd{O} key.
2559 The difference between this mark and refile mark is,
2560 this mark does not delete the message while latter does.
2563 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2565 @subsection Persistent Marks
2567 There are five persistent marks,
2568 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2570 The persistent mark indicates the message's status and it is saved.
2571 Each persistent mark indicates:
2577 It is unread message.
2579 It is unread but cached message.
2581 It is read but it is not cached.
2583 It is important message. You can put @samp{$} mark by typing @kbd{$}
2584 key (if already exists, the mark is deleted). It is convenient to put
2585 this mark on the messages to remember (If you want to remember to write
2586 a reply for the message, for example) because this mark remains after
2587 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2588 @samp{'mark} folder even the message itself is deleted in the actual folder.
2591 If the message is read and cached (or local message),there are no
2595 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2596 cache. Messages with the marks other than these, you can read them in
2597 the offline status even they are in the IMAP folder or netnews folder.
2599 Among messages with persistent marks, ones with marks specified by
2600 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2601 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2603 @subsection How To Read
2605 Basically, you can read messages only typing space key again and again.
2607 To update summary status to the newest status (synchronize),
2610 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2611 moves cursor to the next message.
2612 Enter message buffer by typing @kbd{j} key.
2613 To operate multipart, you have to enter to the message buffer.
2616 @subsection Pack the Message Numbers
2617 You can pack the message numbers in Summary by
2618 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2619 News Spool Folder and Maildir Folder are supported folder types.
2622 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2623 @section Thread Operations
2625 For example, the following line indicates one thread (a context of a topic).
2628 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2632 If you type @kbd{/} on this line, the thread is opened and it changes
2633 the appearance like following.
2637 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2638 388 09/17(Thu)22:34 +-[ Murata san ]
2642 (Message 388 is the replied message to the message 384.)
2643 If you type @kbd{/} key once again, the thread is closed.
2644 With prefix argument, @kbd{/} opens all children threads.
2646 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2649 Commands with the key binding that begins with @kbd{t} executes commands
2650 on the messages in the thread.
2651 @xref{Key Bindings of Summary}.
2653 @subsection reconstruct thread by hand
2655 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2656 (@code{wl-summary-save-current-message}) at the corresponding message,
2657 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2658 message then you have the reconstructed thread.
2661 @node Cache, Auto Refile, Thread Operations, Summary
2664 @subsection Cache File
2666 The messages which have to access via network (e.x. IMAP, NNTP folder)
2667 are cached as a local file. The cache file is saved under the directory
2668 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2669 elmo-cache-expire-by-size}. The command deletes cache files to the
2670 specified size by the order of last accessed time.
2672 @subsection Buffer Cache and Prefetching
2674 The messages that are read are kept in the cache buffer. It is called
2675 `buffer cache'. The number of cache buffer is specified by
2676 @code{wl-message-buffer-cache-size}.
2678 There are message prefetching mechanism in the Wanderlust that
2679 prefetches next message while you are reading.
2681 You can control the message prefetching mechanism by these two
2685 @item wl-message-buffer-prefetch-folder-type-list
2686 @vindex wl-message-buffer-prefetch-folder-type-list
2687 The initial setting is @code{t}. In this case, prefetch messages in all
2689 If it is a list of folder types, it specifies the folder types in which
2690 message prefetching is enabled.
2691 Following is an example (prefetch messages in nntp and imap4 folders)
2695 (setq wl-message-buffer-prefetch-folder-type-list
2700 In this case, multi folder that contains localdir and imap4 prefetches
2701 only imap4 messages. This variable precedes the value of
2702 @code{wl-message-buffer-prefetch-folder-list}.
2704 @item wl-message-buffer-prefetch-folder-list
2705 @vindex wl-message-buffer-prefetch-folder-list
2706 The initial setting is @code{nil}.
2707 A list of regexp of folders to enable message prefetching.
2711 @item wl-message-buffer-prefetch-depth
2712 @vindex wl-message-buffer-prefetch-depth
2713 The initial settionf is 5. The number of prefetching messages.
2716 @item wl-message-buffer-prefetch-idle-time
2717 @vindex wl-message-buffer-prefetch-idle-time
2718 The initial settionf is 0.2 (in seconds). The period of prefetching.
2721 @node Auto Refile, Sticky Summary, Cache, Summary
2722 @section Auto Refile
2723 @vindex elmo-msgdb-extra-fields
2724 @vindex wl-refile-rule-alist
2725 @findex wl-summary-auto-refile
2727 You can refile messages automatically, by typing @kbd{C-o}
2728 (@code{wl-summary-auto-refile}). It decides destination of refile by
2729 the content of the message header information (information in the msgdb).
2731 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2732 available. If you want to decide destination by other header fields,
2733 set the variable @code{elmo-msgdb-extra-fields} like following.
2737 (setq elmo-msgdb-extra-fields
2747 By this setting, Wanderlust saves extra fields in the msgdb. You have
2748 to type @kbd{s all} to get extra fields for the messages that are
2749 already exists in the summary.
2751 Then, specify the refile rule. The refile target folder of auto
2752 refiling is decided by the value of @code{wl-refile-rule-alist}.
2753 @code{wl-refile-rule-alist} is a list of a rule:
2757 (@var{field} (@var{regexp} . @var{target})
2758 (@var{regexp} . @var{target})
2763 Each rule means `if @var{field} value matches @var{regexp},
2764 then refile to @var{target} folder'.
2765 The rule matched first is applied.
2767 @var{field} is a string of field name. You can specify a list of field name
2768 string, too. In this case, if one of these fields is matched, then the
2769 rule is fired (i.e. OR condition).
2771 @var{regexp} is a regular expression for field value. @var{target} is a target
2772 folder string. You can specify a rule at @var{target} part, too. In this
2773 case, If the field value of the rule and the current rule is matched,
2774 then the current rule is fired (i.e. AND condition).
2776 In @var{target} part, you can refer matched substring of @var{regexp}.
2777 To refer substring, specify following in @var{target}:
2781 means substitute original matched text.
2784 means substitute what matched the @var{N}th `\(@dots{}\)'.
2785 (@var{N} is a number.)
2788 Following is an example of @code{wl-refile-rule-alist}.
2792 (setq wl-refile-rule-alist
2794 ("^Wanderlust" . "+wl")
2795 ("^Elisp" . "+elisp"))
2797 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2799 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2800 "+from-me-to-you"))))))
2804 After these settings, refile marks are automatically put on the condition
2805 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2807 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2809 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2810 with these persistent marks are not automatically refiled.
2811 It means Wanderlust does not execute auto refile on unread messages by
2812 the default setting.
2813 To execute auto refile on all messages, set following.
2816 (setq wl-summary-auto-refile-skip-marks nil)
2820 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2821 @section Sticky Summary
2822 @cindex Summary, Sticky
2823 @cindex Sticky Summary
2825 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2827 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2828 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2830 The buffer name of the sticky summary becomes like
2831 @samp{Summary:@var{folder-name}}.
2833 You can visit the sticky summary at any time by @kbd{C-x b}
2834 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2835 q}. Other operations in the sticky summary are same as normal summary.
2837 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2838 are automatically stuck.
2841 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2842 @section Key bindings
2843 @cindex Keybind, Summary Mode
2844 @cindex Keybind, Summary Buffer
2846 Key bindings of the summary mode are shown below.
2850 @kindex @key{SPC} (Summary)
2851 @findex wl-summary-read
2852 Proceed reading a message at the current cursor point.
2853 (@code{wl-summary-read})
2857 @findex wl-summary-redisplay
2858 Redisplay a message at the current cursor point.
2859 If this command is called with prefix argument,
2860 Redisplay message regardless of the message cache (message is re-loaded
2862 (@code{wl-summary-redisplay})
2866 @findex wl-summary-display-top
2867 Display the top message in the folder.
2868 (@code{wl-summary-display-top})
2872 @findex wl-summary-display-bottom
2873 Display the bottom message in the folder.
2874 (@code{wl-summary-display-bottom})
2878 @kindex @key{BS} (Summary)
2879 @kindex @key{DEL} (Summary)
2880 Display the previous page of the message at the current cursor point.
2881 @findex wl-summary-prev-page
2882 (@code{wl-summary-prev-page})
2885 @kindex @key{RET} (Summary)
2886 @findex wl-summary-next-line-content
2887 Display the next line of the message at the current cursor point.
2888 Display the message at the current cursor point if it is not displayed yet.
2889 (@code{wl-summary-next-line-content})
2894 @kindex M-@key{RET} (Summary)
2895 @findex wl-summary-prev-line-content
2896 Display the previous line of the message at the current cursor point.
2897 Display the message at the current cursor point if it is not displayed yet.
2898 (@code{wl-summary-prev-line-content})
2902 @findex wl-thread-open-close
2903 Toggle open or close the thread at the current cursor point.
2904 (@code{wl-thread-open-close})
2909 @findex wl-thread-open-all
2910 (@code{wl-thread-open-all})
2915 @findex wl-thread-close-all
2916 (@code{wl-thread-close-all})
2920 @findex wl-summary-goto-folder
2922 (@code{wl-summary-goto-folder})
2926 Mark all messages in the folder as read.
2927 @findex wl-summary-mark-as-read-all
2928 (@code{wl-summary-mark-as-read-all})
2932 @findex wl-summary-reply
2933 Prepare a draft for reply the message at the current cursor point.
2934 (@code{wl-summary-reply})
2938 @findex wl-summary-reply-with-citation
2939 Prepare a draft for reply the message at the current cursor point.
2940 (@code{wl-summary-reply-with-citation})
2944 @findex wl-summary-cancel-message
2945 If the message at current cursor point is your own netnews article,
2947 (@code{wl-summary-cancel-message})
2951 @findex wl-summary-reedit
2952 Prepare a draft for re-editing the message at current cursor point.
2953 If the message at current cursor point is your own netnews article,
2954 a draft for `supersedes message' for the message is prepared.
2955 (@code{wl-summary-reedit})
2958 @kindex M-e (Summary)
2959 @findex wl-summary-resend-bounced-mail
2960 If the message at current cursor point is a bounced message,
2961 a draft for re-sending original message is prepared.
2962 (@code{wl-summary-resend-bounced-mail})
2966 @findex wl-summary-forward
2967 A draft for forwarding the message at current cursor point is prepared.
2968 (@code{wl-summary-forward})
2972 @findex wl-summary-mark-as-important
2973 Put @samp{$} mark on the message at current cursor point.
2974 If already marked as @samp{$}, delete it.
2975 (@code{wl-summary-mark-as-important})
2981 Save the message at current cursor point.
2982 @findex wl-summary-save
2983 (@code{wl-summary-save})
2987 @findex wl-summary-next
2988 Move cursor to the next message.
2989 If message is marked with a temporal mark in
2990 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2991 In the offline mode, cursor is not moved to the messages which are not cached
2993 (@code{wl-summary-next})
2997 @findex wl-summary-prev
2998 Move cursor to the previous message.
2999 If message is marked with a temporal mark in
3000 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3001 In the offline mode, cursor is not moved to the messages which are not cached
3003 (@code{wl-summary-prev})
3007 @findex wl-summary-down
3008 Move cursor to the downward message which is unread or marked
3010 In the offline mode, cursor is not moved to the messages which are not cached
3012 If there are messages which have target mark @samp{*} in the summary,
3013 cursor is moved to the downward message which have a target mark.
3014 This behavior is changed according to the value of @code{wl-summary-move-order}.
3015 (@code{wl-summary-down})
3019 @findex wl-summary-up
3020 Move cursor to the upward message which is unread or marked
3022 In the offline mode, cursor is not moved to the messages which are not cached
3024 If there are messages which have target mark @samp{*} in the summary,
3025 cursor is moved to the downward message which have a target mark.
3026 This behavior is changed according to the value of @code{wl-summary-move-order}.
3027 (@code{wl-summary-up})
3031 @findex wl-summary-write
3032 Prepare a new draft.
3033 (@code{wl-summary-write})
3037 @findex wl-summary-write-current-folder
3038 Prepare a new draft. If the current folder is NNTP folder,
3039 @samp{Newsgroups:} field is completed. If the current folder is mailing
3040 list folder (refile destination), guess @samp{To:} field and completed
3041 (If @code{wl-subscribed-mailing-list} is valid list)
3042 (@code{wl-summary-write-current-folder})
3046 @findex wl-summary-redisplay-all-header
3047 Redisplay the message at current cursor point with all header fields.
3048 (@code{wl-summary-redisplay-all-header})
3052 @findex wl-summary-redisplay-no-mime
3053 Redisplay the message at current cursor point without MIME analysis.
3054 (@code{wl-summary-redisplay-no-mime})
3058 @findex wl-summary-burst
3059 If the message at current cursor point has
3060 encapsulates multiple messages using MIME,
3061 de-capsulate and extract them on the current folder.
3062 (@code{wl-summary-burst})
3065 @kindex @@ (Summary)
3066 @findex wl-summary-edit-addresses
3067 Append/change/delete the message's sender information to the address
3068 book @file{~/.addresses} interactively. If this command is called with
3069 prefix argument, arbitrary address can be edited.
3070 (@code{wl-summary-edit-petname})
3074 @findex wl-status-update
3075 Sync up address book status with @file{~/.addresses}'s content.
3076 (@code{wl-status-update})
3080 @findex wl-summary-pipe-message
3081 Pipe current message's content to the external process.
3082 (@code{wl-summary-pipe-message})
3086 @findex wl-summary-print-message
3087 Print out current message's content.
3088 It uses @code{ps-print} module in Emacs 20.x.
3089 If you don't use color printer, you might want to set
3090 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3093 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3096 (@code{wl-summary-print-message})
3100 @findex wl-summary-exit
3101 Exit current folder.
3102 (@code{wl-summary-exit})
3106 @findex wl-summary-jump-to-current-message
3107 Jump cursor to the currently displayed message's window.
3108 (@code{wl-summary-jump-to-current-message})
3112 Jump cursor to the other message.
3113 @findex wl-summary-jump-to-msg
3114 (@code{wl-summary-jump-to-msg})
3118 Update summary status and
3119 prefetch all messages which have marks included in the
3120 @code{wl-summary-incorporate-marks}.
3121 @findex wl-summary-incorporate
3122 (@code{wl-summary-incorporate})
3125 @kindex M-j (Summary)
3126 @findex wl-summary-jump-to-msg-by-message-id
3127 Jump cursor to the message which have specified @samp{Message-Id:}. If
3128 @code{elmo-use-database} is non-nil, other folder is also searched.
3129 (@code{wl-summary-jump-to-msg-by-message-id})
3133 Jump to parent message.
3134 @findex wl-summary-jump-to-parent-message
3135 (@code{wl-summary-jump-to-parent-message})
3139 @findex wl-summary-mark-as-unread
3140 Mark as unread the message at current cursor point.
3141 (@code{wl-summary-mark-as-unread})
3145 @findex wl-summary-sync
3146 Synchronize summary view after prompting the update range
3147 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3151 all ...Discard current summary and update all message.
3152 update ...Update the difference between summary and the folder itself.
3153 rescan ...Rescan the msgdb and display again.
3154 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3155 first, last ...Move to the filter folder(partial filter).
3160 (@code{wl-summary-sync})
3164 @findex wl-summary-sort
3166 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3167 (@code{wl-summary-sort})
3171 @findex wl-summary-toggle-thread
3172 Toggle the threading.
3173 Threading status is displayed on the modeline.
3174 @samp{@{S@}} means threading is off (Sequence) and
3175 @samp{@{T@}} means threading is on (Thread).
3176 (@code{wl-summary-toggle-thread})
3180 @findex wl-summary-toggle-disp-folder
3181 Toggle displaying of folder window.
3182 (@code{wl-summary-toggle-disp-folder})
3186 Toggle displaying of message window.
3187 @findex wl-summary-toggle-disp-msg
3188 (@code{wl-summary-toggle-disp-msg})
3192 Move to the virtual folder with the condition specified.
3193 If called with prefix argument and current folder is virtual, exit it.
3194 @findex wl-summary-virtual
3195 (@code{wl-summary-virtual})
3198 @kindex @key{TAB} (Summary)
3199 @findex wl-summary-goto-last-displayed-msg
3200 Jump to the message which is displayed last.
3201 (@code{wl-summary-goto-last-displayed-msg})
3205 Put @samp{*} mark on the messages that satisfies the specified condition.
3206 @findex wl-summary-pick
3207 (@code{wl-summary-pick})
3211 @findex wl-summary-mark-as-read
3212 Mark as read the message at the current cursor point.
3213 (@code{wl-summary-mark-as-read})
3217 Prefetch the message at the current cursor point.
3218 With prefix argument, prefetch the message even if it is cached.
3219 @findex wl-summary-prefetch
3220 (@code{wl-summary-prefetch})
3224 Execute @samp{D}, @samp{o} and @samp{O} marks.
3225 @findex wl-summary-exec
3226 (@code{wl-summary-exec})
3230 @findex wl-summary-target-mark-line
3231 Put target mark on the message at the current cursor point.
3232 (@code{wl-summary-target-mark-line})
3236 Put refile mark on the message at the current cursor point.
3237 @findex wl-summary-refile
3238 (@code{wl-summary-refile})
3241 @kindex C-o (Summary)
3242 Execute auto refile.
3243 @findex wl-summary-auto-refile
3244 (@code{wl-summary-auto-refile})
3248 Put copy mark on the message at the current cursor point.
3249 @findex wl-summary-copy
3250 (@code{wl-summary-copy})
3253 @kindex M-o (Summary)
3254 Put refile mark on the message at the current cursor point with the destination
3255 previously specified.
3256 @findex wl-summary-refile-prev-destination
3257 (@code{wl-summary-refile-prev-destination})
3261 @findex wl-summary-delete
3262 Put delete mark on the message at the current cursor point.
3263 (@code{wl-summary-delete})
3267 @findex wl-summary-unmark
3268 Unmark the temporal mark on the message at the current cursor point.
3269 (@code{wl-summary-unmark})
3273 Unmark all the temporal marks.
3274 @findex wl-summary-unmark-all
3275 (@code{wl-summary-unmark-all})
3278 @kindex r R (Summary)
3279 @findex wl-summary-mark-as-read-region
3280 Mark as read messages in the specified region.
3281 (@code{wl-summary-mark-as-read-region})
3284 @kindex r $ (Summary)
3285 @findex wl-summary-mark-as-important-region
3286 Mark as important @samp{$} messages in the specified region.
3287 If @samp{$} already exists, it is deleted.
3288 (@code{wl-summary-mark-as-important-region})
3291 @kindex r ! (Summary)
3292 @findex wl-summary-mark-as-unread-region
3293 Mark as unread messages in the specified region.
3294 (@code{wl-summary-mark-as-unread-region})
3297 @kindex r i (Summary)
3298 @findex wl-summary-prefetch-region
3299 Prefetch messages in the specified region.
3300 (@code{wl-summary-prefetch-region})
3303 @kindex r x (Summary)
3304 @findex wl-summary-exec-region
3305 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3307 (@code{wl-summary-exec-region})
3310 @kindex r * (Summary)
3311 @findex wl-summary-target-mark-region
3312 Put target mark on the messages in the specified region.
3313 (@code{wl-summary-target-mark-region})
3316 @kindex r o (Summary)
3317 @findex wl-summary-refile-region
3318 Put refile mark on the messages in the specified region.
3319 (@code{wl-summary-refile-region})
3322 @kindex r O (Summary)
3323 @findex wl-summary-copy-region
3324 Put copy mark on the messages in the specified region.
3325 (@code{wl-summary-copy-region})
3328 @kindex r d (Summary)
3329 @findex wl-summary-delete-region
3330 Put delete mark on the messages in the specified region.
3331 (@code{wl-summary-delete-region})
3334 @kindex r u (Summary)
3335 @findex wl-summary-unmark-region
3336 Delete temporal mark on the messages in the specified region.
3337 (@code{wl-summary-unmark-region})
3340 @kindex r y (Summary)
3341 Save messages in the specified region.
3342 @findex wl-summary-save-region
3343 (@code{wl-summary-save-region})
3346 @kindex t R (Summary)
3347 @findex wl-thread-mark-as-read
3348 Mark as read messages which are the descendant of the current thread.
3349 With prefix argument, it affects on the all messages in the thread tree.
3350 (@code{wl-thread-mark-as-read})
3353 @kindex t $ (Summary)
3354 @findex wl-thread-mark-as-important
3355 Put important mark @samp{$} on the messages which are the
3356 descendant of the current thread.
3357 If @samp{$} mark exists, it is deleted.
3358 With prefix argument, it affects on the all messages in the thread tree.
3359 (@code{wl-thread-mark-as-important})
3362 @kindex t ! (Summary)
3363 @findex wl-thread-mark-as-unread
3364 Mark as unread messages which are the descendant of the current thread.
3365 With prefix argument, it affects on the all messages in the thread tree.
3366 (@code{wl-thread-mark-as-unread})
3369 @kindex t i (Summary)
3370 @findex wl-thread-prefetch
3371 Prefetch messages which are the descendant of the current thread.
3372 With prefix argument, it affects on the all messages in the thread tree.
3373 (@code{wl-thread-prefetch})
3376 @kindex t x (Summary)
3377 @findex wl-thread-exec
3378 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3379 the descendant of the current thread. With prefix argument, it affects
3380 on the all messages in the thread tree.
3381 (@code{wl-thread-exec})
3384 @kindex t * (Summary)
3385 @findex wl-thread-target-mark
3386 Put target mark @samp{*} on the messages which are the descendant of the
3387 current thread. With prefix argument, it affects on the all messages in
3389 (@code{wl-thread-target-mark})
3392 @kindex t o (Summary)
3393 @findex wl-thread-refile
3394 Put refile mark on the messages which are the descendant of the current thread.
3395 With prefix argument, it affects on the all messages in the thread tree.
3396 (@code{wl-thread-refile})
3399 @kindex t O (Summary)
3400 @findex wl-thread-copy
3401 Put copy mark on the messages which are the descendant of the current thread.
3402 With prefix argument, it affects on the all messages in the thread tree.
3403 (@code{wl-thread-copy})
3406 @kindex t d (Summary)
3407 @findex wl-thread-delete
3408 Put delete mar on the messages which are the descendant of the current thread.
3409 With prefix argument, it affects on the all messages in the thread tree.
3410 (@code{wl-thread-delete})
3413 @kindex t u (Summary)
3414 @findex wl-thread-unmark
3415 Unmark temporal mark on the messages which are the descendant of the
3416 current thread. With prefix argument, it affects on the all messages in
3418 (@code{wl-thread-unmark})
3421 @kindex t y (Summary)
3422 @findex wl-thread-save
3423 Save messages which are the descendant of the current thread.
3424 With prefix argument, it affects on the all messages in the thread tree.
3425 (@code{wl-thread-save})
3428 @kindex m i (Summary)
3429 @findex wl-summary-target-mark-prefetch
3430 Prefetch all messages which have target mark @samp{*}.
3431 With prefix argument, prefetch all targets even if some of them are cached.
3432 (@code{wl-summary-target-mark-prefetch})
3435 @kindex m R (Summary)
3436 @findex wl-summary-target-mark-mark-as-read
3437 Mark as read all messages which have target mark @samp{*}.
3438 (@code{wl-summary-target-mark-mark-as-read})
3441 @kindex m $ (Summary)
3442 @findex wl-summary-target-mark-mark-as-important
3443 Mark as important all messages which have target mark @samp{*}.
3444 If already marked as @samp{$}, it is deleted.
3445 (@code{wl-summary-target-mark-mark-as-important})
3448 @kindex m ! (Summary)
3449 @findex wl-summary-target-mark-mark-as-unread
3450 Mark as unread all messages which have target mark @samp{*}.
3451 (@code{wl-summary-target-mark-mark-as-unread})
3454 @kindex m o (Summary)
3455 @findex wl-summary-target-mark-refile
3456 Put refile mark on the messages which have target mark @samp{*}.
3457 (@code{wl-summary-target-mark-refile})
3460 @kindex m O (Summary)
3461 @findex wl-summary-target-mark-copy
3462 Put copy mark on the messages which have target mark @samp{*}.
3463 (@code{wl-summary-target-mark-copy})
3466 @kindex m d (Summary)
3467 @findex wl-summary-target-mark-delete
3468 Put delete mark on the messages which have target mark @samp{*}.
3469 (@code{wl-summary-target-mark-delete})
3472 @kindex m y (Summary)
3473 @findex wl-summary-target-mark-save
3474 Save messages which have target mark @samp{*}.
3475 (@code{wl-summary-target-mark-save})
3478 @kindex m u (Summary)
3479 Unmark all temporal marks.
3480 (@code{wl-summary-delete-all-temp-marks})
3481 @findex wl-summary-delete-all-temp-marks
3484 @kindex m a (Summary)
3485 Put target mark @samp{*} on the all messages.
3486 (@code{wl-summary-target-mark-all})
3487 @findex wl-summary-target-mark-all
3490 @kindex m t (Summary)
3491 Put target mark @samp{*} on the messages in the current thread.
3492 @findex wl-summary-target-mark-thread
3493 (@code{wl-summary-target-mark-thread})
3496 @kindex m r (Summary)
3497 @findex wl-summary-target-mark-region
3498 Put target mark @samp{*} on the messages in the specified region.
3499 (@code{wl-summary-target-mark-region})
3502 @kindex m A (Summary)
3503 @findex wl-summary-target-mark-reply-with-citation
3504 Prepare a draft which cites all messages which have target mark @samp{*}.
3505 (@code{wl-summary-target-mark-reply-with-citation})
3508 @kindex m f (Summary)
3509 @findex wl-summary-target-mark-forward
3510 Prepare a draft which forwards all messages which have target mark @samp{*}.
3511 (@code{wl-summary-target-mark-forward})
3514 @kindex m U (Summary)
3515 @findex wl-summary-target-mark-uudecode
3516 Uudecode the messages which have target mark @samp{*}.
3517 (@code{wl-summary-target-mark-uudecode})
3520 @kindex m ? (Summary)
3521 @findex wl-summary-target-mark-pick
3522 Pick messages from the @samp{*} marked messages.
3523 That is, @samp{*} marks on the messages are remained
3524 if the specified condition is satisfied.
3525 (@code{wl-summary-target-mark-pick})
3528 @kindex M-t (Summary)
3529 @findex wl-toggle-plugged
3530 Toggle offline/online status of Wanderlust.
3531 (@code{wl-toggle-plugged})
3534 @kindex C-t (Summary)
3535 Start Wanderlust's plug-status manager.
3536 (@code{wl-plugged-change})
3539 @kindex C-c C-o (Summary)
3540 @findex wl-jump-to-draft-buffer
3541 Move to the draft buffer if available. If multiple draft buffer exists,
3542 moved to one after another. If prefix argument is specified, load draft
3543 folder's message to the draft buffer and jump to it.
3544 (@code{wl-jump-to-draft-buffer})
3547 @kindex M-w (Summary)
3548 @findex wl-summary-save-current-message
3549 Save the message at the current cursor point.
3550 (@code{wl-summary-save-current-message})
3553 @kindex C-y (Summary)
3554 @findex wl-summary-yank-saved-message
3555 Regard the message at the current cursor point as
3556 parent, connect the message saved by
3557 @code{wl-summary-save-current-message}
3559 (@code{wl-summary-yank-saved-message})
3563 @node Variables of Summary, , Key Bindings of Summary, Summary
3564 @section Customiziable variables
3567 @item wl-summary-move-order
3568 @vindex wl-summary-move-order
3569 The initial setting is @code{unread}. Specify cursor moving policy. If
3570 you want to precede new messages, set @code{new}. If you want to
3571 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3574 @item wl-auto-select-first
3575 @vindex wl-auto-select-first
3576 The initial setting is @code{nil}.
3577 If non-nil, first message is automatically displayed.
3579 @item wl-auto-select-next
3580 @vindex wl-auto-select-next
3581 The initial setting is @code{nil}. This controls behavior when there is
3582 no unread message in current summary.
3585 nil: asks whether you want to go back to folder mode
3586 'unread: asks whether you want to go to next unread folder
3587 If the next one comes to be possessing no unread message
3588 by treatment of cross-posted messages or Scoring, then
3589 asks whether you want to go to next to next folder.
3590 'skip-no-unread: similar as unread
3591 But does not ask before going to next to next folder.
3592 otherwise: asks whether you want to go to next unread folder
3595 It might be useful to set @code{'skip-no-unread} for people who
3596 want to continue reading by just pressing and pressing space key.
3598 @item wl-thread-insert-opened
3599 @vindex wl-thread-insert-opened
3600 The initial setting is @code{nil}.
3601 If non-nil, thread is inserted as opened.
3603 @item wl-thread-open-reading-thread
3604 @vindex wl-thread-open-reading-thread
3605 The initial setting is @code{t}. If non-nil, reading thread is
3606 automatically opened though it is closed thread.
3608 @item wl-summary-exit-next-move
3609 @vindex wl-summary-exit-next-move
3610 The initial setting is @code{t}. If non-nil, move to next folder at
3613 @item wl-folder-move-cur-folder
3614 @vindex wl-folder-move-cur-folder
3615 The initial setting is @code{nil}. If non-nil, cursor position on the
3618 @item wl-summary-weekday-name-lang
3619 @vindex wl-summary-weekday-name-lang
3620 The initial setting is @samp{ja}. Specify language of the weekday.
3621 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3622 displays Deutsch. You should rescan summary view after changing this value.
3624 @item wl-summary-fix-timezone
3625 @vindex wl-summary-fix-timezone
3626 The initial setting is @code{nil}.
3627 Time zone of the date string in summary mode is adjusted using this value.
3628 If @code{nil}, it is adjust to the default time zone information
3629 (system's default time zone or environment variable @samp{TZ}).
3631 @item wl-use-petname
3632 @vindex wl-use-petname
3633 The initial setting is @code{t}.
3634 If non-nil, sender part displays nickname.
3636 @item wl-break-pages
3637 @vindex wl-break-pages
3638 The initial setting is @code{t}.
3639 If non-nil, message is split as pages by @samp{^L}.
3641 @item wl-message-window-size
3642 @vindex wl-message-window-size
3643 The initial setting is '(1 . 4).
3644 A cons cell to specify the rate of summary and message window.
3645 car:cdr corresponds summary:message.
3647 @item wl-summary-no-from-message
3648 @vindex wl-summary-no-from-message
3649 The initial setting is @samp{nobody@@nowhere?}. A string which is
3650 displayed when there's no @samp{From:} field in the message.
3652 @item wl-summary-no-subject-message
3653 @vindex wl-summary-no-subject-message
3654 The initial setting is @samp{(WL:No Subject in original.)}. A string
3655 which is displayed when there's no @samp{Subject:} field in the message.
3657 @item wl-summary-use-frame
3658 @vindex wl-summary-use-frame
3659 The initial setting is @code{nil}.
3660 If non-nil, use new frame for the summary.
3662 @item wl-use-folder-petname
3663 @vindex wl-use-folder-petname
3664 The initial setting is the list shown below:
3673 A list of display policy (symbol) of folder nickname. Available symbols
3678 Display folder petname on modeline.
3680 Destination folder is notified as nickname if
3681 @code{wl-auto-select-next} is non-nil.
3683 You can input folder name by nickname in the function
3684 @code{wl-summary-read-folder}.
3687 @item wl-summary-move-direction-toggle
3688 @vindex wl-summary-move-direction-toggle
3689 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3690 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3691 want to aware of reading direction, set this to @code{t}.
3693 @item wl-summary-width
3694 @vindex wl-summary-width
3695 The initial setting is 80.
3696 Width of summary line. If @code{nil}, summary line's width is as is.
3698 @item wl-summary-from-width
3699 @vindex wl-summary-from-width
3700 The initial setting is 17.
3701 Width of sender part of summary line.
3703 @item wl-summary-subject-length-limit
3704 @vindex wl-summary-subject-length-limit
3705 The initial setting is @code{nil}. Specify the limit for the length of
3706 subject parts in summary. @code{nil} means unlimited.
3708 @item wl-summary-indent-length-limit
3709 @vindex wl-summary-indent-length-limit
3710 The initial setting is 46.
3711 Specify the limit of thread indent level. @code{nil} means unlimited
3713 If you set this to @code{nil} you should set @code{wl-summary-width}
3716 @item wl-summary-recenter
3717 @vindex wl-summary-recenter
3718 The initial setting is t.
3719 If non-nil, cursor point is moved to the center of the summary window.
3721 @item wl-summary-divide-thread-when-subject-changed
3722 @vindex wl-summary-divide-thread-when-subject-changed
3723 The initial setting is @code{nil}. If non-nil, thread is split if
3724 the subject is changed.
3726 @item wl-summary-search-via-nntp
3727 @vindex wl-summary-search-via-nntp
3728 The initial setting is @code{confirm}.
3730 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3731 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3732 from the NNTP server @code{elmo-nntp-default-server}. The value of
3733 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3734 @code{elmo-nntp-default-stream-type} are used.
3736 If @code{confirm}, server name can be specified. You can specify NNTP
3737 folder format like @samp{-:username@@servername:119!}.
3739 @item wl-summary-keep-cursor-command
3740 @vindex wl-summary-keep-cursor-command
3741 The initial setting is the list shown below:
3745 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3750 When you entered to summary by these commands and the target summary
3751 buffer already exists, summary status is not automatically updated and
3752 cursor position is saved.
3754 @item elmo-folder-update-threshold
3755 @vindex elmo-folder-update-threshold
3756 The initial setting is 500. If updated message number is larger than
3757 this value, confirm whether drop them or not (in the case where the value
3758 of @code{elmo-folder-update-confirm} is non-nil).
3760 @item elmo-folder-update-confirm
3761 @vindex elmo-folder-update-confirm
3762 The initial setting is @code{t}. If the value is non-nil, do check with
3763 @code{elmo-folder-update-threshold}.
3765 @item wl-summary-always-sticky-folder-list
3766 @vindex wl-summary-always-sticky-folder-list
3767 The initial setting is @code{nil}.
3768 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3769 are automatically stuck. Each element is regexp of folder name.
3771 @item wl-summary-reserve-mark-list
3772 @vindex wl-summary-reserve-mark-list
3773 The initial setting is the list shown below:
3782 If a message is already marked as temporal marks in this list, the
3783 message is not marked by any mark command.
3785 @item wl-summary-skip-mark-list
3786 @vindex wl-summary-skip-mark-list
3787 The initial setting is the list shown below:
3796 If a message is already marked as temporal marks in this list, the
3797 message is skipped at cursor move.
3799 @item elmo-message-fetch-threshold
3800 @vindex elmo-message-fetch-threshold
3801 The initial setting is 30000 (bytes). If displaying message has larger
3802 size than this value, Wanderlust confirms whether fetch the message or
3803 not (in the case where the value of @code{elmo-message-fetch-confirm}
3806 @item elmo-message-fetch-confirm
3807 @vindex elmo-message-fetch-confirm
3808 The initial setting is @code{t}. If the value is non-nil, do check with
3809 @code{elmo-message-fetch-threshold}.
3811 @item wl-prefetch-threshold
3812 @vindex wl-prefetch-threshold
3813 The initial setting is 30000 (bytes). If prefetching message has larger
3814 size than this value and @code{wl-prefetch-confirm} is non-nil,
3815 Wanderlust confirms whether prefetch the message or not. If
3816 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3817 without confirmation.
3819 @item wl-prefetch-confirm
3820 @vindex wl-prefetch-confirm
3821 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3822 prefetch the message or not if the message has larger size than
3823 @code{wl-prefetch-threshold}.
3825 @item elmo-imap4-use-cache
3826 @vindex elmo-imap4-use-cache
3827 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3830 @item elmo-nntp-use-cache
3831 @vindex elmo-nntp-use-cache
3832 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3835 @item elmo-pop3-use-cache
3836 @vindex elmo-pop3-use-cache
3837 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3840 @item elmo-shimbun-use-cache
3841 @vindex elmo-shimbun-use-cache
3842 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3845 @item wl-folder-process-duplicates-alist
3846 @vindex wl-folder-process-duplicates-alist
3847 The initial setting is @code{nil}.
3848 This list determines how to deal with duplicated messages in the same folder.
3849 Each item in the list is regexp of folder name and action; you can specify any
3850 one of the following in the place of action:
3853 @code{nil} : do nothing for duplicated messages.
3854 @code{hide} : hide duplicated messages from the summary.
3855 @code{read} : set duplicated messages as read.
3859 Following is an example (hide duplicated messages in multi folders)
3863 (setq wl-folder-process-duplicates-alist
3864 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3865 ("^\\*.*" . hide) (".*" . read)))
3871 @node Message, Draft, Summary, Top
3872 @chapter Message Buffer
3874 Message Buffers utilize MIME-View mode of SEMI. For operational
3875 procedures and key bindings, refer to respective documents.
3876 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3877 You can also see help by @kbd{?} in message buffer.
3879 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3880 brings you back to Summary mode. @kbd{l} toggles display of Summary
3883 @section Key Bindings
3889 @findex wl-message-toggle-disp-summary
3890 Toggles display of Summary mode buffer.
3891 (@code{wl-message-toggle-disp-summary})
3894 @findex wl-message-refer-article-or-url
3895 @kindex Button-2 (Message)
3896 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3897 corresponding message if found.
3898 (@code{wl-message-refer-article-or-url})
3900 @item Button-4 (upward movement of a wheel)
3901 @kindex Button-4 (Message)
3902 @findex wl-message-wheel-down
3903 Scrolls the message backwards. When the top of the message is hit,
3904 moves to the previous message.
3905 (@code{wl-message-wheel-down})
3907 @item Button-5 (downward movement of a wheel)
3908 @kindex Button-5 (Message)
3909 @findex wl-message-wheel-up
3910 Scrolls the message forward. When the bottom of the message is hit,
3911 moves to the next message.
3912 (@code{wl-message-wheel-up})
3915 @section Customizable Variables
3918 @item wl-message-window-size
3919 @vindex wl-message-window-size
3920 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3921 its car and cdr value corresponds to the ratio of Summary and Message
3924 @item wl-message-ignored-field-list
3925 @vindex wl-message-ignored-field-list
3926 (SEMI only) Initial setting is @code{nil}.
3927 All fields that match this list will be hidden in message buffer.
3928 Each elements are regexp of field-name.
3929 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3931 @item wl-message-visible-field-list
3932 @vindex wl-message-visible-field-list
3933 (SEMI only) Initial setting is @code{nil}.
3934 All fields that match this list will be display in message buffer.
3935 Each elements are regexp of field-name. This value precedes
3936 @code{wl-message-ignored-field-list}.
3937 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3939 @item wl-message-sort-field-list
3940 @vindex wl-message-sort-field-list
3941 (SEMI only) Initial setting is
3942 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3943 Header fields in message buffer are ordered by this value.
3944 Each elements are regexp of field-name.
3946 @item wl-message-truncate-lines
3947 @vindex wl-message-truncate-lines
3948 The initial value is the value of @code{default-truncate-lines}.
3949 If it is non-nil, truncate long lines in message buffer.
3952 @node Draft, Disconnected Operations, Message, Top
3953 @chapter Draft Buffer
3955 At Summary mode, pressing @kbd{w} and the like creates a new draft
3956 buffer. You can edit and send mail and news articles in this buffer.
3960 Basically it is Emacs-standard mail mode.
3962 @subsection Address Completion
3964 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3965 addresses. @kbd{@key{TAB}} completes them.
3967 If you want to submit a news article, add @samp{Newsgroups:} field by
3968 yourself. Field names can be completed by @kbd{@key{TAB}}.
3970 If you save the draft buffer you are editing, it is appended to the
3971 folder specified by @code{wl-draft-folder}.
3973 Using @samp{FCC:} field, you can specify the folder to which a copy of
3974 the message is saved when it is sent.
3976 @subsection Editing Messages
3978 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
3979 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
3980 a MIME user interface for GNU Emacs}.
3981 You can also see help by @kbd{C-c C-x ?} in draft buffer.
3983 @subsection Dynamic Modification of Messages
3984 @vindex wl-draft-config-alist
3985 @c @cindex Change Message
3986 @c @cindex Message, Change Dynamic
3988 You can set @code{wl-draft-config-alist} so that header and body of the
3989 message will automatically modified depending on information of header
3992 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3994 In the example below, the header is modified when
3995 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3996 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3997 before sending the message.
4001 (setq wl-draft-config-alist
4002 '(((string-match "aaa\\.example\\.com$" (system-name))
4003 ;; @r{applied if the expression is non-nil}
4004 (wl-smtp-posting-server . "mailserver-B")
4005 (wl-nntp-posting-server . "newsserver-B")
4006 ;; @r{settings of temporary variables}
4008 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4009 ;; @r{applied if it matches the header of the draft buffer}
4010 ("Organization" . (format "Go %s" my-webpage)))
4011 ;; @r{you can write elisp expressions here (eval only)}
4012 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4013 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4018 The format of @code{wl-draft-config-alist} is:
4022 '(("@var{regexp of the header}" or @var{elisp expression}
4023 ("@var{Field}" . value(@var{elisp expression}))
4024 (@var{variable} . value(@var{elisp expression}))
4025 (@var{sub-function} . value(@var{elisp expression}))
4028 ("@var{regexp of the header}" or @var{elisp expression}
4029 ("@var{Field}" . value(@var{elisp expression}))
4034 Per default, there are 10 following sub-functions.
4037 'header: Inserts the specified string at the bottom of the header.
4038 'header-top: Inserts the specified string at the top of the header.
4039 'header-file: Inserts the specified file at the bottom of the header.
4040 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4041 'top: Inserts the specified string at the top of the body.
4042 'top-file: Inserts the specified file at the top of the body.
4043 'body: Replaces the body with the specified string.
4044 Specifying @code{nil} deletes the entire body string.
4045 'body-file: Replaces the body with the content of the specified file.
4046 'bottom: Inserts the specified string at the bottom of the body.
4047 'bottom-file: Inserts the specified file at the top of the body.
4048 'part-top: Inserts the specified string at the top of the current part.
4049 'part-bottom: Inserts the specified string at the bottom of the current part.
4050 'template: Applies the specified template.
4051 (refer to the next subsection)
4054 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4055 change them or add your own functions. If you read the code, you can
4056 easily find how to write the functions.
4058 At the first of each item, @var{a regular expression of the header} or
4059 an @var{elisp expression} should be specified. In the case of an elisp
4060 expression, the item is applied when the expression is evaluated
4063 Per default, when multiple items match or are evaluated non-nil, all
4064 such items are applied, but if you set a variable
4065 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4068 At the second of the item, a cons or a list of functions should be
4069 specified. The car part of the cons should be a header field, a
4070 variable, or a sub-function. When a header field is specified, the
4071 field will be modified. If a variable is specified, the value of the
4072 variable will be modified temporarily.
4074 In the cdr part of a cons, not only a variable but also an elisp
4075 expression can be specified as is. If the car part is a header field
4076 and the cdr part is @code{nil}, the field will be deleted.
4078 If you want to use name of parent folder, you can refer the buffer local
4079 variable @code{wl-draft-parent-folder}.
4081 See the next example as well:
4085 (setq wl-draft-config-alist
4087 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4088 ;; @r{applied if it matches the header of the buffer being replied}
4089 (body . " Hello.\n")
4090 (template . "default")
4095 As in the (1) above, if a header regexp is prepended with @code{reply},
4096 it is applied when the draft is prepared by @code{wl-summary-reply} for
4097 example, and when it matches the header being replied. It is ignored
4098 when there is no buffer being replied, like after @code{wl-draft} was
4101 Note that @code{wl-draft-config-alist} is applied only once when
4102 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4103 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4104 aborting transmission, execute @kbd{C-c C-e}
4105 (@code{wl-draft-config-exec}) explicitly.
4107 If you don't want to apply @code{wl-draft-config-alist} when
4108 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4112 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4115 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4116 prepared, do the following:
4119 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4122 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4123 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4127 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4130 @subsection Inserting Templates
4132 @cindex Apply Template
4134 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4135 @kbd{M-x wl-template-select} in the draft buffer.
4137 The format of @code{wl-template-alist} is almost the same as
4138 @code{wl-draft-config-alist}.
4142 (setq wl-template-alist
4145 ("Organization" . "~/.wl sample")
4146 (body . "Hello.\n"))
4148 (template . "default") ;; @r{(a)}
4149 ("To" . "boss@@example.com")
4150 ("Subject" . "Report")
4151 (body-file . "~/work/report.txt")
4157 As you can see, the only difference is item (template) names such as
4158 @samp{default} and @samp{report}, instead of a regexp of header.
4159 Because definition of each item is the same as
4160 @code{wl-draft-config-alist}, you can call another template, like (a).
4162 Executing the command @code{wl-template-select} results in template
4163 selection, but the result differs depending on variable
4164 @code{wl-template-visible-select}.
4166 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4167 window is shown below the draft buffer. You can select a template by
4168 @kbd{n} and @kbd{p} seeing the buffer window.
4170 Press the @key{RET} key and the template is actually applied to the draft
4171 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4172 adjust the window size by @code{wl-template-buffer-lines}.
4174 If @code{wl-template-visible-select} is @code{nil}, you should type the
4175 name of the template in the mini buffer.
4177 As shown in the example in @code{wl-draft-config-alist}, you can select
4178 @samp{default} template by writing:
4181 (template . "default")
4184 @subsection Sending mail by POP-before-SMTP
4185 @cindex POP-before-SMTP
4187 You can send mail by POP-before-SMTP with this single line:
4190 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4194 Configure the following variables if you need.
4197 @item wl-pop-before-smtp-user
4198 The POP user name for POP-before-SMTP authentication.
4199 If unset, @code{elmo-pop3-default-user} is used.
4201 @item wl-pop-before-smtp-server
4202 The POP server name for POP-before-SMTP authentication.
4203 If unset, @code{elmo-pop3-default-server} is used.
4205 @item wl-pop-before-smtp-authenticate-type
4206 The POP authentication method for POP-before-SMTP authentication.
4207 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4209 @item wl-pop-before-smtp-port
4210 The POP port number for POP-before-SMTP authentication.
4211 If unset, @code{elmo-pop3-default-port} is used.
4213 @item wl-pop-before-smtp-stream-type
4214 If non-nil, POP connection is established using SSL. If
4215 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4216 unset, @code{elmo-pop3-default-stream-type} is used.
4219 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4220 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4222 Therefore, if SMTP server and POP server are actually the same, and if
4223 POP folder per default (such as @samp{&}) is available, no settings are
4226 Refer to the following URL about POP-before-SMTP.
4230 http://spam.ayamura.org/tools/smPbS.html
4231 http://www.iecc.com/pop-before-smtp.html
4235 @section Key Bindings
4236 @cindex Keybind, Draft Mode
4237 @cindex Keybind, Draft Buffer
4242 @kindex C-c C-y (Draft)
4243 @findex wl-draft-yank-original
4244 Cites the content of the current message buffer.
4245 (@code{wl-draft-yank-original})
4248 @kindex C-c C-p (Draft)
4249 @findex wl-draft-preview-message
4250 Previews the content of the current draft.
4251 This is useful for previewing MIME multi-part messages.
4252 (@code{wl-draft-preview-message})
4255 @kindex C-c C-s (Draft)
4256 @findex wl-draft-send
4257 Sends the content of the current draft. Does not erase the draft buffer.
4258 This is useful for sending multiple messages, which are a little different
4260 (@code{wl-draft-send})
4263 @kindex C-c C-c (Draft)
4264 @findex wl-draft-send-and-exit
4265 Sends the content of the current draft and erases the draft buffer.
4266 (@code{wl-draft-send-and-exit})
4269 @kindex C-x C-s (Draft)
4270 @findex wl-draft-save
4271 Save the current draft.
4272 (@code{wl-draft-save})
4275 @kindex C-c C-k (Draft)
4276 @findex wl-draft-kill
4277 Kills the current draft.
4278 (@code{wl-draft-kill})
4281 @kindex C-x k (Draft)
4282 @findex wl-draft-mimic-kill-buffer
4283 Kills the current draft.
4284 (@code{wl-draft-mimic-kill-buffer})
4287 @kindex C-c C-z (Draft)
4288 @findex wl-draft-save-and-exit
4289 Saves the current draft, and erases the draft buffer.
4290 This is useful if you want to suspend editing of the draft.
4291 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4292 the @samp{+draft} folder.
4293 (@code{wl-draft-save-and-exit})
4296 @kindex C-c C-r (Draft)
4297 @findex wl-caesar-region
4298 Encodes or decodes the specified region in Caesar cipher.
4299 (@code{wl-caesar-region})
4303 @findex wl-draft-highlight-and-recenter
4304 Recenter and rehighlight current draft.
4305 (@code{wl-draft-highlight-and-recenter})
4309 @findex wl-toggle-plugged
4310 Toggles off-line/on-line states of Wanderlust.
4311 (@code{wl-toggle-plugged})
4314 @kindex C-c C-o (Draft)
4315 @findex wl-jump-to-draft-buffer
4316 Jumps to the other draft buffer, if exists.
4317 With prefix argument, reads a file (if any) from the draft folder when
4318 there is no such buffer.
4319 (@code{wl-jump-to-draft-buffer})
4322 @kindex C-c C-e (Draft)
4323 @findex wl-draft-config-exec
4324 Applies @code{wl-draft-config-alist}.
4325 (@code{wl-draft-config-exec})
4328 @kindex C-c C-j (Draft)
4329 @findex wl-template-select
4331 (@code{wl-template-select})
4334 @kindex C-c C-a (Draft)
4336 Enter Address Manager.
4337 @xref{Address Manager}.
4341 @kindex C-c C-d (Draft)
4342 @findex wl-draft-elide-region
4343 Elide the text between point and mark (@code{wl-draft-elide-region}).
4344 The text is killed and replaced with the contents of the variable
4345 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4349 @section Customizable Variables
4352 @item wl-subscribed-mailing-list
4353 @vindex wl-subscribed-mailing-list
4354 The initial setting is @code{nil}. Mailing lists to which you
4355 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4356 field of a reply draft, removes your own address from
4357 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4358 contained in @samp{To:} or @samp{Cc:} field of a message to be
4359 automatically re-filed, the destination folder will be leaned in
4360 connection with the address.
4366 (setq wl-subscribed-mailing-list
4367 '("wl@@lists.airs.net"
4369 "emacs-mime-ja@@m17n.org"))
4373 @item wl-insert-mail-followup-to
4374 @vindex wl-insert-mail-followup-to
4375 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4376 field is automatically inserted in the draft buffer.
4378 @item wl-insert-mail-reply-to
4379 @vindex wl-insert-mail-reply-to
4380 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4381 field is automatically inserted in the draft buffer.
4383 @item wl-auto-insert-x-face
4384 @vindex wl-auto-insert-x-face
4385 The initial setting is @code{t}. If non-nil and there is an encoded
4386 X-Face string in a file @file{~/.xface} (the value of the variable
4387 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4388 draft buffer. If @code{nil}, it is not automatically inserted.
4390 @item wl-insert-message-id
4391 @vindex wl-insert-message-id
4392 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4393 is automatically inserted on the transmission.
4395 @item wl-message-id-use-wl-from
4396 @vindex wl-message-id-use-wl-from
4397 The initial setting is @code{nil}. If non-nil, the value of
4398 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4400 @item wl-local-domain
4401 @vindex wl-local-domain
4402 The initial setting is @code{nil}. If @code{nil}, the return value of
4403 the function @code{system-name} will be used as the domain part of
4406 If @code{system-name} does not return FQDN (i.e. the full name of the
4407 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4408 to the string of the local domain name without hostname (like
4409 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4410 @samp{.} @code{wl-local-domain} is used as domain part of the
4413 If your terminal does not have global IP, set the value of
4414 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4415 you use invalid @samp{Message-ID:}.)
4417 Moreover, concatenation of @code{system-name} @samp{.}
4418 @code{wl-local-domain} will be used as an argument to the HELO command
4421 @item wl-message-id-domain
4422 @vindex wl-message-id-domain
4423 The initial setting is @code{nil}. If non-nil, this value is used as a
4424 domain part of the @samp{Message-ID:}. If your terminal does not have
4425 global IP address, set unique string to this value (e.x. your e-mail
4428 @item wl-unique-id-suffix
4429 @vindex wl-unique-id-suffix
4430 The initial setting is @samp{.wl}. You can specify the string in generated
4431 Message-ID which appear just before @samp{@@}.
4433 @item wl-draft-config-alist
4434 @vindex wl-draft-config-alist
4435 The initial setting is @code{nil}. Modifies the draft message just
4436 before the transmission. The content of @code{wl-draft-config-alist}
4437 will be automatically applied only once on the transmission. If you
4438 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4441 @item wl-template-alist
4442 @vindex wl-template-alist
4443 The initial setting is @code{nil}.
4444 This variable specifies the template to be applied in the draft buffer.
4446 @item wl-draft-config-matchone
4447 @vindex wl-draft-config-matchone
4448 The initial setting is @code{nil}. If non-nil, only the first matching
4449 item is used when @code{wl-draft-config-alist} is applied. If
4450 @code{nil}, all matching items are used.
4452 @item wl-template-visible-select
4453 @vindex wl-template-visible-select
4454 The initial setting is @code{t}.
4455 If non-nil, you can preview the result of the template selection in
4458 @item wl-template-confirm
4459 @vindex wl-template-confirm
4460 The initial setting is @code{nil}.
4461 If non-nil, asks for confirmation when you press the enter key to select
4462 template while previewing.
4464 @item wl-template-buffer-lines
4465 @vindex wl-template-buffer-lines
4466 The initial setting is 7.
4467 If @code{wl-template-visible-select} is non-nil, this variable specifies
4468 the size of the preview window.
4470 @item wl-draft-reply-buffer-style
4471 @vindex wl-draft-reply-buffer-style
4472 The initial setting is @code{split}. @code{split} or @code{full} can be
4473 specified. In the case of @code{full}, the whole frame will be used for
4474 a reply draft buffer when it is prepared.
4476 @item wl-draft-use-frame
4477 @vindex wl-draft-use-frame
4478 The initial setting is @code{nil}.
4479 If non-nil, use new frame for the draft.
4481 @item wl-draft-truncate-lines
4482 @vindex wl-draft-truncate-lines
4483 The initial value is the value of @code{default-truncate-lines}.
4484 If it is non-nil, truncate long lines in draft buffer.
4488 The initial setting is the value of the variable
4489 @code{user-mail-address}. The value of this variable is inserted as a
4490 @samp{From:} field of the draft when it is prepared.
4492 @item wl-envelope-from
4493 @vindex wl-envelope-from
4494 The initial setting is @code{nil}.
4495 The value of this variable is used for envelope from (MAIL FROM).
4496 If @code{nil}, the address part of @code{wl-from} is used.
4498 @item wl-user-mail-address-list
4499 @vindex wl-user-mail-address-list
4500 The initial setting is @code{nil}.
4501 This is the User's address list. If you have multiple addresses,
4506 The initial setting is @code{nil}.
4507 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4508 the draft when it is prepared. If function is specified, its return
4513 The initial setting is @code{nil}.
4514 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4515 the draft when it is prepared.
4517 @item wl-reply-subject-prefix
4518 @vindex wl-reply-subject-prefix
4519 The initial setting is @samp{Re: }.
4520 In the @samp{Subject:} of the reply draft, this string is prepended to
4521 the @samp{Subject:} of being replied.
4523 @item wl-draft-reply-use-address-with-full-name
4524 @vindex wl-draft-reply-use-address-with-full-name
4525 The initial setting is @code{t}.
4526 If non-nil, insert her full name with address when prepare a draft for
4527 reply a message. If it is @code{nil}, insert her address only.
4529 @item wl-draft-enable-queuing
4530 @vindex wl-draft-enable-queuing
4531 The initial setting is @code{t}.
4532 This flag controls off-line transmission. If non-nil, the draft is
4535 @item wl-draft-use-cache
4536 @vindex wl-draft-use-cache
4537 The initial setting is @code{nil}. If the value is non-nil and
4538 @code{wl-insert-message-id} is nil, cache the message which is sent.
4540 @item wl-fcc-force-as-read
4541 @vindex wl-fcc-force-as-read
4542 The initial setting is @code{nil}. If the value is non-nil,
4543 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4545 @item wl-auto-flush-queue
4546 @vindex wl-auto-flush-queue
4547 The initial setting is t.
4548 This flag controls automatic transmission of the queue when Wanderlust
4549 becomes on-line. If non-nil, the queue is automatically transmitted
4550 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4551 manually, press @kbd{F} in the folder mode.
4553 @item wl-ignored-forwarded-headers
4554 @vindex wl-ignored-forwarded-headers
4555 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4556 All headers that match this regexp will be deleted when forwarding a message.
4558 @item wl-ignored-resent-headers
4559 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4560 All headers that match this regexp will be deleted when resending a message.
4562 @item wl-draft-always-delete-myself
4563 @vindex wl-draft-always-delete-myself
4564 If non-nil, always removes your own address from @samp{To:} and
4565 @samp{Cc:} when you are replying to the mail addressed to you.
4567 @item wl-draft-delete-myself-from-bcc-fcc
4568 @vindex wl-draft-delete-myself-from-bcc-fcc
4569 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4570 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4572 @item wl-smtp-posting-server
4573 @vindex wl-smtp-posting-server
4574 The initial setting is @code{nil}.
4575 This is the SMTP server name for mail transmission.
4577 @item wl-smtp-posting-user
4578 @vindex wl-smtp-posting-user
4579 The initial setting is @code{nil}.
4580 This is the user name for SMTP AUTH authentication. If @code{nil},
4581 @code{smtp-authenticate-user} is used.
4583 @item wl-smtp-authenticate-type
4584 @vindex wl-smtp-authenticate-type
4585 The initial setting is @code{nil}.
4586 This is the authentication method for SMTP AUTH authentication. If
4587 @code{nil}, @code{smtp-authenticate-type} is used. If
4588 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4591 @item wl-smtp-connection-type
4592 @vindex wl-smtp-connection-type
4593 The initial setting is @code{nil}.
4594 This variable specifies how to establish SMTP connections.
4595 If @code{nil}, @code{smtp-connection-type} is used.
4596 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4598 @item wl-nntp-posting-server
4599 @vindex wl-nntp-posting-server
4600 The initial setting is @code{nil}.
4601 This is the NNTP server name used for news submission.
4602 If @code{nil}, @code{elmo-nntp-default-server} is used.
4604 @item wl-nntp-posting-user
4605 @vindex wl-nntp-posting-user
4606 The initial setting is @code{nil}.
4607 This is the user name for AUTHINFO authentication on news submission.
4608 If @code{nil}, @code{elmo-nntp-default-user} is used.
4609 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4611 @item wl-nntp-posting-port
4612 @vindex wl-nntp-posting-port
4613 The initial setting is @code{nil}.
4614 This is the port number of the NNTP server used for news submission.
4615 If @code{nil}, @code{elmo-nntp-default-server} is used.
4617 @item wl-nntp-posting-stream-type
4618 @vindex wl-nntp-posting-stream-type
4619 The initial setting is @code{nil}.
4620 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4621 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4622 connection will be established.
4624 @item wl-pop-before-smtp-user
4625 @vindex wl-pop-before-smtp-user
4626 The initial setting is @code{nil}.
4627 This is the POP user name for POP-before-SMTP.
4628 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4630 @item wl-pop-before-smtp-server
4631 @vindex wl-pop-before-smtp-server
4632 The initial setting is @code{nil}.
4633 This is the POP server name for POP-before-SMTP.
4634 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4636 @item wl-pop-before-smtp-authenticate-type
4637 @vindex wl-pop-before-smtp-authenticate-type
4638 The initial setting is @code{nil}.
4639 This is the authentication method for POP-before-SMTP authentication.
4640 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4642 @item wl-pop-before-smtp-port
4643 @vindex wl-pop-before-smtp-port
4644 The initial setting is @code{nil}.
4645 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4646 @code{elmo-pop3-default-port} is used.
4648 @item wl-pop-before-smtp-stream-type
4649 @vindex wl-pop-before-smtp-stream-type
4650 The initial setting is @code{nil}.
4651 This flag controls the use of SSL for POP-before-SMTP. If it is
4652 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4653 STARTTLS (RFC2595) connection will be established.
4655 @item wl-draft-queue-save-variables
4656 @vindex wl-draft-queue-save-variables
4657 Specifies a list of variable to which queued messages are saved on the
4658 off-line transmission.
4660 @item wl-draft-sendlog
4661 @vindex wl-draft-sendlog
4662 The initial setting is @code{t}.
4663 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4667 @item drafts are sent by smtp or qmail
4668 @item saved into folders by fcc
4669 @item saved into folders by queuing
4672 (it is written even if the transmission fails).
4673 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4674 and left to the logging function of @command{imput}.
4677 @item wl-draft-sendlog-max-size
4678 @vindex wl-draft-sendlog-max-size
4679 The initial setting is 20000 (in bytes).
4680 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4681 beyond the size specified by this variable.
4685 The initial setting is @code{nil}.
4686 If non-nil, address completion uses LDAP.
4688 @item wl-ldap-server
4689 @vindex wl-ldap-server
4690 The initial setting is @samp{localhost}.
4691 LDAP server name for address completion.
4694 @vindex wl-ldap-port
4695 The initial setting is @code{nil}.
4696 If non-nil, the value is used as port number.
4699 @vindex wl-ldap-base
4700 The initial setting is @samp{c=US}.
4701 LDAP search starting point (base) for address completion.
4703 @item wl-draft-remove-group-list-contents
4704 @vindex wl-draft-remove-group-list-contents
4705 The initial setting is @code{t}.
4706 If non-nil, remove the group-lists' members in the recipients when
4707 sending the message (group-list means the description such as
4708 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4711 @node Disconnected Operations, Expire and Archive, Draft, Top
4712 @chapter Off-line Management
4713 @cindex Disconnected Operations
4715 Wanderlust has on-line and off-line states.
4718 * Off-line State:: Wanderlust has on-line and off-line states
4719 * Enable Operations:: Enable Disconnected Operations
4720 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4721 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4722 * Variables of Plugged Mode:: Customize Plugged Mode
4726 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4727 @section Off-line State
4729 Wanderlust has on-line and off-line states. In the off-line state, you
4730 cannot access messages via network, unless they are cached.
4732 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4733 in the mode line indicates the off-line state. In folder or summary
4734 modes, press @kbd{M-t} to switch between off- and on-line.
4736 You can invoke Wanderlust in the off-line state by setting
4737 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4739 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4740 ignores uncached messages.
4743 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4744 @section Enable Disconeected Operations
4746 Even in the off-line state, provided that relevant messages are cached,
4747 and the variable @code{elmo-enable-disconnected-operation} (described
4748 later) is non-nil, you can following operations:
4749 @xref{Plugged Mode}, @xref{Off-line State settings}.
4752 * Send Messages off-line:: Transmit Messages
4753 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4754 * Creation of Folders:: Create Folders off-line (IMAP4)
4755 * Marking:: Mark (IMAP4)
4756 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4759 As soon as Wanderlust becomes on-line, such operations invoked off-line
4760 are reflected in the servers via network.
4763 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4764 @subsection Transmission of Messages
4766 You can send mail/news messages off-line (if you are using
4767 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4768 accumulated in the queue folder, @samp{+queue}. These messages are
4769 transmitted at once when Wanderlust becomes on-line.
4771 You can visit @samp{+queue} in the off-line state and confirm content of
4772 messages in the queue. You can also remove messages. Removed messages
4773 are not transmitted even in the on-line state.
4776 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4777 @subsection Re-file and Copy (IMAP4)
4779 Re-file and copy operations to IMAP folders invoked during the off-line
4780 state are accumulated in the queue, and reflected in the server side
4781 when Wanderlust becomes on-line. If you visit destination folders after
4782 off-line re-file or copy, it looks as if messages were appended even in
4785 For the safety reasons, messages re-filed off-line are removed from
4786 source folders only if their @samp{Message-ID:} match messages on the
4787 servers. While the queue is processed, messages that failed to be
4788 re-filed or copied to the specified folders are appended to the folder
4792 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4793 @subsection Creation of Folders (IMAP4)
4795 You can create IMAP folders off-line. The creation of folders are
4796 reflected in the servers when Wanderlust becomes on-line. At that time,
4797 if folders failed to be created on the servers for any reasons, messages
4798 re-filed to such folders are appended to the folder @samp{+lost+found}.
4801 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4802 @subsection Marking (IMAP4)
4804 Off-line changes in unread/read and importance mark @samp{$} information
4805 are also reflected in the servers when Wanderlust becomes on-line.
4808 @node Pre-fetching Reservations, , Marking, Enable Operations
4809 @subsection Pre-fetching (IMAP4, NNTP)
4811 You can make reservations for pre-fetching messages in IMAP or NNTP
4812 folders. Reserved messages are marked with @samp{!} but not cached
4813 yet. When Wanderlust becomes on-line, they are pre-fetched from
4816 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4817 these off-line operations for IMAP4 and NNTP do not take place, and
4818 off-line re-file, copy or suchlike simply results in error.
4820 Because off-line operations use cache files, it is a bad idea to erase
4821 them by hand; it may cause Wanderlust to malfunction.
4823 If you want to remove caches, be sure to execute @kbd{M-x
4824 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4825 remove caches for messages relevant to off-line operations.
4828 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4829 @section Switching On-line/Off-line per Server/Port
4831 @kbd{M-t} described above switches networking states as a whole, but you
4832 can switch on-line/off-line per server/port.
4834 Pressing @kbd{C-t} in the folder or summary modes brings you in
4835 wl-plugged-mode shown below, in which you can change the plugged state
4840 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4843 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4844 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4846 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4847 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4853 The first line indicates status of the following three variables, and
4854 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4855 column modifies the values of these variables.
4859 "Queuing" @code{wl-draft-enable-queuing}
4860 "AutoFlushQueue" @code{wl-auto-flush-queue}
4861 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4865 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4868 The second and after lines indicate on-line/off-line states of servers
4869 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4870 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4871 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4873 @dfn{sending queue} means messages accumulated in the folder
4874 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4875 off-line operations when @code{elmo-enable-disconnected-operation} is
4877 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4878 @c off-line operations are enabled.
4880 They are displayed if there are any of them. In the example above, in
4881 the sending queue there are two messages (the first and the second in
4882 the queue folder) for smtp to hosta and one (the third) for nntp to
4883 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4886 If you change @samp{(wl-plugged)} in the second line, the variable
4887 @code{wl-plugged} is changed, so that the mode line indicator and
4888 plugged states of all ports are affected. If you change plugged states
4889 of any servers or ports, @samp{(wl-plugged)} in the second line is
4890 affected depending on @code{elmo-plugged-condition} settings and the
4891 plugged state of each port.
4894 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4895 @section Invoking Wanderlust in the Off-line State
4897 As described before, if you set @code{wl-plugged} to @code{nil} in
4898 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4899 off-line state. You can specify off-line state on a per server or port
4900 basis. Refer to @code{wl-reset-plugged-alist} also.
4902 Usually, when Wanderlust starts up, the plugged state of each port is
4903 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4904 @code{wl-nntp-posting-server} and so on. If you want to change the
4905 plugged state of these ports or to add other ports, configure
4906 @code{wl-make-plugged-hook} with a function.
4910 (add-hook 'wl-make-plugged-hook
4912 (elmo-set-plugged plugged-value(t/nil) server port)
4913 ;; @r{add or change plugged states of the port of the server}
4914 (elmo-set-plugged plugged-value(t/nil) server)
4915 ;; @r{if the port is omitted, all ports are affected}
4916 ;; @r{(you cannot omit the port if you newly add the server)}
4922 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4923 @section Customizable Variables
4928 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4929 mode from the beginning.
4931 @item wl-queue-folder
4932 @vindex wl-queue-folder
4933 The initial setting is @samp{+queue}.
4934 This is the folder in which messages in the transmission queue are
4937 @item wl-auto-flush-queue
4938 @vindex wl-auto-flush-queue
4939 The initial setting is @code{t}.
4940 This flag controls automatic transmission of the queue when Wanderlust
4941 becomes on-line. If non-nil, the queue is automatically transmitted
4942 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4943 manually, press @kbd{F} in the folder mode.
4945 @item elmo-enable-disconnected-operation
4946 @vindex elmo-enable-disconnected-operation
4947 The initial setting is @code{nil}. Controls off-line operations
4948 regarding IMAP4. If non-nil, off-line operations are carried out.
4950 @item elmo-lost+found-folder
4951 @vindex elmo-lost+found-folder
4952 The initial setting is @samp{+lost+found}.
4953 This is the folder to which messages are saved when they fails to be
4954 appended while the off-line re-file/copy queue is processed.
4956 @item elmo-plugged-condition
4957 @vindex elmo-plugged-condition
4958 The initial setting is @code{one}.
4959 The value of @code{wl-plugged} reflects the return value of the function
4960 @code{elmo-plugged-p} (without arguments).
4961 This variable @code{elmo-plugged-condition} specifies the condition on
4962 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4963 plugged state of each port.
4966 'one : plugged if one or more ports are plugged.
4967 'all : plugged if all ports are plugged.
4968 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4969 states of the ports.
4970 @var{function} : reflects the return value of the @var{function}
4971 functions available per default
4972 'elmo-plug-on-by-servers
4973 : reflects the plugged state of the servers specified by the
4974 variable elmo-plug-on-servers.
4975 'elmo-plug-on-by-exclude-servers
4976 : reflects the plugged state of the servers that are not
4977 in elmo-plug-on-exclude-servers.
4978 elmo-plug-on-exclude-servers defaults to
4981 (system-name)without the domain part)
4987 (setq elmo-plugged-condition 'all)
4989 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4990 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4992 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4993 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4997 @item wl-reset-plugged-alist
4998 @vindex wl-reset-plugged-alist
4999 The initial setting is @code{t}. If non-nil, plugged states are
5000 initialized on a per server or port basis when Wanderlust starts up.
5002 If @code{nil}, plugged states are retained while Emacs is running. In
5003 other words, they are initialized when Emacs is restarted even if the
5004 value is @code{nil}.
5008 @node Expire and Archive, Scoring, Disconnected Operations, Top
5009 @chapter Automatic Expiration and Archiving of Messages
5010 @cindex Expire and Archive
5013 * Expire:: Expiration and Archiving
5014 * Archive:: Archiving All Messages
5018 @node Expire, Archive, Expire and Archive, Expire and Archive
5020 @cindex Expire Message
5022 Expiration means deletion of old messages which have outlasted a
5023 certain period of time.
5025 @code{wl-expire} supports not only simple deletion, but also moving to
5026 specified archiving folders.
5030 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5031 or @kbd{M-e} in the summary mode.
5033 @subsection Configuring @code{wl-expire-alist}
5035 An example configuration of @code{wl-expire-alist} is shown below.
5036 Everything in this @code{wl-expire-alist} makes a great difference in
5037 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5038 to @code{t}, especially in the initial stage.
5042 (setq wl-expire-alist
5043 '(("^\\+trash$" (date 14) remove)
5045 ("^\\+tmp$" (date 7) trash)
5046 ;; @r{re-file to @code{wl-trash-folder}}
5047 ("^\\+outbox$" (number 300) "$outbox;lha")
5048 ;; @r{re-file to the specific folder}
5050 ;; @r{do not expire}
5051 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5052 ;; @r{archive by message number (retaining numbers)}
5053 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5054 ;; @r{archive by a fixed number (retaining numbers)}
5055 ("^\\+diary$" (date 30) wl-expire-archive-date)
5056 ;; @r{archive by year and month (numbers discarded)}
5061 Items in the list has the format of:
5064 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5068 The folder is examined if it matches @var{regexp-for-folders} from the
5069 beginning of the list. If you invoke expiration on the folder that does
5070 not match any of them, nothing will happen. And if either the second or
5071 the third element of the item is @code{nil}, expiration will not take
5074 You can use any one of the following for
5075 @var{specification-of-message-to-be-deleted}:
5078 @item (number @var{n1} [@var{n2}])
5079 deletes messages depending on the number of messages in the folder.
5081 @var{n1} is the number of messages which should survive deletion, for example
5082 if its value is 500, the newest 500 messages survive and the rests are
5085 @var{n2} is the number of messages in the folder on which expiration should
5086 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5087 folders with 510 or more messages are expired.
5088 If you configured automatic expiration, frequently used folders may
5089 expire every time it receive messages, and you may be annoyed with the
5090 long delay in reading mail.
5091 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5092 expiration would not take place until a certain number of messages
5095 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5096 with important/new/unread) are not deleted.
5097 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5098 will expire so as to have 500 messages including such ones.
5099 Otherwise, it will have 500 messages except such ones.
5101 @item (date @var{d1})
5102 deletes messages depending on the dates.
5104 Messages dated @var{d1} or more days ago are deleted, for example if its
5105 value is seven, messages seven days old or more are deleted. Note that
5106 the date is the one in the @samp{Date:} field of the message, not when
5107 the message entered the folder.
5109 Messages with no or invalid @samp{Date:} field does not expire; you
5110 might have to delete them by hand.
5113 You can use any one of the following in the place of @var{destination}:
5117 deletes the messages instantly.
5120 hide the messages from summary (messages are not deleted).
5123 moves the messages to @code{wl-trash-folder}.
5125 @item @var{string}(folder)
5126 moves the messages to the folder specified with @var{string}.
5128 It would be useful for specifying an archiving folder, but because this
5129 does not move important messages, it might be better to use the
5130 standard functions described below.
5132 @item @var{function}
5133 invokes the specified @var{function}.
5135 To the @var{function}, three arguments are passed: a folder name, a list
5136 of messages to be deleted, and msgdb information of the summary. You
5137 can specify function-specific arguments after the name of the
5138 @var{function}. Note that the list contains messages with marks in
5139 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5142 These are four standard functions; three of them move messages to an archive
5143 folder in the specified way. This means old messages can be compressed
5144 and saved in a file, being deleted from the original folder.
5145 The last one divides messages to some MH folders.
5148 @item wl-expire-archive-number1
5149 re-files to archiving folders corresponding to the message numbers of
5150 the messages being deleted. For example, a message numbered 102 will be
5151 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5152 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5153 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5155 The archiving folders to which messages are re-filed are determined by
5156 the name of the folder as follows (in this case, archiving folders are
5157 handled as if @code{elmo-archive-treat-file} were non-nil).
5160 @item If the folder type is localdir:
5161 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5163 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5164 (@file{~/Mail/ml/wl-00100.zip}).
5166 @item The folder type is other than localdir:
5167 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5169 For example, @samp{%#mh/ml/wl} corresponds to
5170 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5173 As you can see, in the case of localdir, the folder type is not included
5174 in the path name, but otherwise it is included.
5175 And you can control the prefix to the archiving folder name by
5176 @code{wl-expire-archive-folder-prefix}.
5177 Refer to @code{wl-expire-archive-folder-prefix} for details.
5179 @item wl-expire-archive-number2
5180 re-files every certain number of messages to archiving folders.
5182 This differs from @samp{wl-expire-archive-number1} in that this re-files
5183 to the folder up to the specified number regardless of message numbers.
5184 The archiving folders to which messages are re-filed are determined in the
5185 same way as @code{wl-expire-archive-number1}.
5187 @item wl-expire-archive-date
5188 re-files messages depending on its date (year and month) to archive
5191 For example, a message dated December 1998 is re-filed to
5192 @code{$folder-199812;zip}. The name of the archiving folders except the
5193 date part are determined in the same way as
5194 @code{wl-expire-archive-number1}.
5197 You can set the first argument to these three standard functions to non-nil
5198 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5199 For example, it can be specified just after the name of the function:
5202 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5205 If you omit the argument, consecutive numbers from 1 are assigned for
5206 each archiving folder.
5208 @item wl-expire-localdir-date
5209 divedes messages depending on its date (year and month) to MH folders
5210 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5214 @subsection Treatment for Important or Unread Messages
5216 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5217 standard function, messages with marks in
5218 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5219 messages} thereafter) are retained.
5221 Per default, this variable include the important, new, and unread marks,
5222 so that messages with these marks are not removed.
5223 Note that you cannot include the temporary mark (i.e. temporary marks
5224 are removed anyway), and be sure to process temporary marks before you
5227 @subsection Auto Expiration
5229 The following setup invokes expiration when you move into the summary
5230 mode. There will be no confirmation, so make sure you made no mistake
5231 in regexp and other settings before you set up this.
5235 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5239 In the folder mode, you can invoke expiration per group as well as per
5240 folder. Therefore, if you specify @samp{Desktop} group, all folders
5241 matching @code{wl-expire-alist} expire.
5245 @subsection Treating archive folders.
5246 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5247 you must set non-nil value to @code{elmo-archive-treat-file}.
5249 @subsection Confirming
5251 If you are to use @code{remove}, try @code{trash} at first and see
5252 messages move to @code{wl-trash-folder} as expected, then replace it
5253 with @code{remove}. It would be dangerous to use @code{remove} from the
5256 If you are to use @code{wl-expire-archive-number1} and the like, try to
5257 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5258 you can append messages to it. Even if settings in
5259 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5260 would not be saved anywhere and disappeared in case the archiver program
5263 After you make sure you can archive to the folder correctly, you can
5264 invoke expiration and utilize the log.
5266 If you set @code{wl-expire-use-log} to @code{t},
5267 @file{~/.elmo/expired-log} should contain the log, for example:
5271 delete +ml/wl (593 594 595 596 597 598 599)
5272 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5276 The first column indicates the operation, i.e. @samp{delete},
5277 @samp{copy}, or @samp{move}. The next is the name of the folder that
5278 expired. In the case of @samp{copy} and @samp{move}, the destination
5279 folder is recorded after @samp{->}. The last is the list of message
5280 numbers that are actually deleted or moved (in the case of @samp{copy}
5281 and @samp{move}, the number is the one in the source folder, rather than
5282 the destination folder).
5284 @subsection Re-filing Reserved Messages
5286 The three standard functions copy reserved messages to the archive
5287 folder, but do not delete them from the source folder. Because
5288 reserved messages and the like always remain, they are recorded in
5289 @file{~/.elmo/expired-alist} so that they are not copied over and over
5290 again. They are not recorded if copied by @code{wl-summary-archive}.
5292 If you enabled logging, usually @samp{move} is recorded for re-filing,
5293 but instead @samp{copy} and @samp{delete} are recorded separately if
5294 reserved messages are involved. This is because it actually copies
5295 messages including reserved, then deletes ones except reserved in that
5298 @section Customizable Variables
5301 @item wl-expire-alist
5302 @vindex wl-expire-alist
5303 The initial setting is @code{nil}.
5304 This variable specifies folders and methods to expire. For details,
5305 refer to @code{wl-expire-alist} settings above.
5307 @item wl-summary-expire-reserve-marks
5308 @vindex wl-summary-expire-reserve-marks
5309 The initial setting is the list below.
5313 (list wl-summary-important-mark
5315 wl-summary-unread-mark
5316 wl-summary-unread-uncached-mark
5317 wl-summary-unread-cached-mark)
5321 Messages with these marks are retained in the folder, even after
5323 Only permanent marks can be listed, not temporary marks.
5325 You can list marks one by one as in the default; you can use the
5326 following settings as well:
5330 All messages with permanent marks are retained,
5331 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5335 All messages are handled as usual ones that are already read, no matter
5336 what marks they have; even important messages are deleted.
5339 @item wl-expire-archive-files
5340 @vindex wl-expire-archive-files
5341 The initial setting is 100.
5342 This variable specifies the number of messages to be retained in one
5345 @item wl-expire-number-with-reserve-marks
5346 @vindex wl-expire-number-with-reserve-marks
5347 The initial setting is @code{nil}.
5348 If non-nil, if expiring messages are specified by @code{number},
5349 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5351 @item wl-expire-archive-get-folder-function
5352 @vindex wl-expire-archive-get-folder-function
5353 The initial setting is @code{wl-expire-archive-get-folder}.
5355 This variable specifies a function that returns the name of an archiving
5356 folder for standard functions in the place of @var{destination}.
5357 You can use the following three variables for simple modification of
5358 folder names; if you want more complex settings, define your own
5359 function in this variable.
5361 @code{wl-expire-archive-get-folder} can be customized by these
5364 @item @code{wl-expire-archive-folder-name-fmt}
5365 @item @code{wl-expire-archive-folder-type}
5366 @item @code{wl-expire-archive-folder-prefix}
5369 @item wl-expire-archive-folder-name-fmt
5370 @vindex wl-expire-archive-folder-name-fmt
5371 The initial setting is @samp{%s-%%05d;%s}.
5372 This is a @code{format} string for archiving folders used in
5373 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5374 Note that you must specify the message number by @samp{%%d}, because it
5375 is parsed twice by @code{format}.
5377 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5380 @item wl-expire-archive-date-folder-name-fmt
5381 @vindex wl-expire-archive-date-folder-name-fmt
5382 The initial setting is @samp{%s-%%04d%%02d;%s}.
5383 This is a @code{format} string for archiving folders used in
5384 @code{wl-expire-archive-date}. Note that you must specify the message
5385 number by @samp{%%d}, because it is parsed twice by @code{format}.
5386 There should be @samp{%%d} twice, one for the year and the other for the
5389 If you modify this, adjust
5390 @code{wl-expire-archive-date-folder-num-regexp} as well.
5392 @item wl-expire-archive-folder-type
5393 @vindex wl-expire-archive-folder-type
5394 The initial setting is @code{zip}.
5395 This variable specifies an archiver type of the archiving folders.
5397 @item wl-expire-archive-folder-prefix
5398 @vindex wl-expire-archive-folder-prefix
5399 The initial setting is @code{nil}.
5400 This variable specifies the prefix (directory structure) to archiving
5402 Exercise extreme caution in using this feature, as it has not been
5404 In the worst case, there is a fear of destructing archiving folders.
5408 There will be no prefix.
5411 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5412 @samp{$ml/wl-00000;zip;wl}.
5415 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5418 @samp{$ml/wl-00000;zip;ml/wl}.
5421 @item wl-expire-archive-folder-num-regexp
5422 @vindex wl-expire-archive-folder-num-regexp
5423 The initial setting is @samp{-\\([-0-9]+\\);}.
5424 This variable specifies the regular expression to be used for getting
5425 message numbers from multiple archiving folders specified by
5426 @code{elmo-list-folders}.
5427 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5429 @item wl-expire-archive-date-folder-num-regexp
5430 @vindex wl-expire-archive-date-folder-num-regexp
5431 The initial setting is @samp{-\\([-0-9]+\\);}.
5432 This is the regular expression to be used for getting message numbers
5433 from multiple archiving folders specified by @code{elmo-list-folders}.
5434 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5436 @item wl-expire-delete-oldmsg-confirm
5437 @vindex wl-expire-delete-oldmsg-confirm
5438 The initial setting is @code{t}.
5439 If non-nil, messages older than the one with the largest number will be
5440 deleted with confirmation.
5441 If @code{nil}, they are deleted without confirmation.
5443 This feature is valid only if non-nil is specified as a argument to the
5444 standard functions so as to retain numbers.
5446 @item wl-expire-use-log
5447 @vindex wl-expire-use-log
5448 The initial setting is @code{nil}.
5449 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5450 They are appended but not truncated or rotated automatically; you might
5451 need to remove it manually.
5453 @item wl-expire-add-seen-list
5454 @vindex wl-expire-add-seen-list
5455 The initial setting is @code{t}.
5457 If non-nil, when messages are re-filed by expiration, read/unread
5458 information is passed to the destination folder.
5460 However if you do not read the destination folder from Wanderlust,
5461 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5462 want to set this to @code{nil} if you are simply saving to some
5463 archiving folders. Even if its value is @code{nil}, messages in the
5464 archiving folders are simply treated as unread; it does not affect
5467 @item wl-expire-folder-update-msgdb
5468 @vindex wl-expire-folder-update-msgdb
5469 The initial setting is @code{t}.
5470 If @code{t}, in the folder mode, expiration is carried out after
5471 updating summary information. If you specified a list of regular
5472 expressions of folder names, summary information is updated for matching
5477 @node Archive, , Expire, Expire and Archive
5478 @section Archiving Messages
5480 @subsection Archiving Messages
5481 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5482 folders. If there are the archiving folders already, only new messages
5485 You can use @code{wl-archive-alist} in order to specify how messages are
5486 archived according to their folder names, as in @code{wl-expire-alist}.
5491 (setq wl-archive-alist
5492 '(("^\\+tmp$" wl-archive-date)
5493 ("^\\+outbox$" wl-archive-number2)
5494 (".*" wl-archive-number1)))
5498 Each item in the list has the following format:
5501 (@var{folders-regexp} @var{deleting-function})
5504 As you can see, you can only use a function after @var{folders-regexp}.
5505 Per default, there are three functions:
5508 @item @code{wl-archive-number1}
5509 @item @code{wl-archive-number2}
5510 @item @code{wl-archive-date}
5513 As inferred from their names, they work similarly to "expire" versions,
5514 other than the following points:
5517 @item No messages are deleted
5518 @item Message numbers are retained even if invoked without arguments
5521 These functions are good to archive all messages in a folder by their
5522 numbers or by their dates.
5523 These are also useful for backup or confirmation purposes before
5525 If you try to re-file them after they are archived, they are deleted but
5528 Per default, the archiving folders to which messages are copied are
5529 determined automatically by @code{wl-expire-archive-get-folder-function}.
5530 You can copy to a specific folder by invoking with a prefix argument,
5531 i.e. @kbd{C-u M-x wl-summary-archive}.
5533 Note that this feature has not been seriously tested, because you can
5534 simply copy to an archiving folder, for example by
5535 @code{wl-summary-copy-region}.
5537 The archiving folders are determined by the same logic as in
5538 @code{wl-summary-expire}; the following customizable variables are
5542 @item @code{wl-expire-archive-files}
5543 @item @code{wl-expire-archive-get-folder-function}
5544 @item @code{wl-expire-archive-folder-name-fmt}
5545 @item @code{wl-expire-archive-folder-type}
5546 @item @code{wl-expire-archive-folder-prefix}
5547 @item @code{wl-expire-archive-folder-num-regexp}
5550 @subsection Customizable Variables
5553 @item wl-archive-alist
5554 @vindex wl-archive-alist
5555 The initial setting is the list shown below:
5559 ((".*" wl-archive-number1))
5564 This variable specifies a function that copies to archiving folders.
5565 To the function, three arguments are passed: a folder name, a list of
5566 messages in the folder, and msgdb information of the summary.
5567 Needless to say, you can use your own function.
5571 @node Scoring, Address Book, Expire and Archive, Top
5572 @chapter Score of the Messages
5574 @c @cindex Kill File
5576 Scoring is the function that associates a score (value) with each
5577 message, and marks as read or deletes from the summary according to it.
5579 You can put target or important marks on essential messages, or read marks
5580 on the ones you do not want to read, for example spam articles.
5582 This scoring function has a capability and a format similar to the one
5583 that Gnus has, although there are some unsupported features and
5584 Wanderlust specifics.
5585 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5588 * Score Commands:: Score Commands
5589 * Score File Format:: Score File Format
5593 @node Score Commands, Score File Format, Scoring, Scoring
5594 @section Score Commands
5595 @cindex Score Commands
5597 @subsection Score File Specification
5599 @code{wl-score-folder-alist} specifies score files or variables in which
5600 scores are defined, corresponding to folder names.
5604 (setq wl-score-folder-alist
5613 If paths to the score files are omitted, the directory specified in the
5614 variable @code{wl-score-files-directory} is assumed.
5616 No matter what you write in @code{wl-score-folder-alist}, the default
5617 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5618 read (it does not have to exist).
5619 Therefore, in the example above, the three score files,
5620 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5621 the folders that matches @samp{^-.*}.
5623 @subsection Scored Messages
5625 Scores are attached to the messages that are specified by
5626 @code{wl-summary-score-marks} temporarily when the summary is updated;
5627 when you exit from the summary, the scores are removed and reverts to
5630 @subsection Creation of Score Files
5632 In the summary buffer, move to an appropriate message and type @kbd{L}.
5633 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5634 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5636 This makes @minus{}1000 are scored for messages with the same
5637 @samp{Subject:} as the string you entered. That is, such a score file
5638 is created automatically.
5640 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5641 The score file you just made appears.
5642 This buffer is called @dfn{score editing buffer} thereafter.
5643 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5644 as you are previously; type @kbd{a}. Then a score entry for "From"
5646 In this way, you can create a score file easily either in the summary
5647 buffer or in the score editing buffer.
5649 By the way, you might be aware the numbers of key strokes are different
5650 between @kbd{s s p} and @kbd{a}.
5651 This is determined by @code{wl-score-header-default-entry}.
5652 This variable specifies the default score entries corresponding to
5654 For example, for "subject" field, a type and a time limit are prompted,
5655 but for "from" field, they are fixed upon automatically as substring and
5656 permanent respectively.
5657 However, score values can be modified by the prefix argument.
5658 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5661 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5662 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5663 erasing contents of the buffer deletes the score file being edited.
5667 @subsubsection Selecting Score Files
5669 You can change score files to which scores are appended by
5670 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5671 @code{wl-score-change-score-file}.
5673 @subsubsection Summing Up the Score
5675 If you add the same entries by @code{wl-summary-increase-score},
5676 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5677 scores for the entry is summed up.
5679 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5680 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5681 @minus{}1200 will be created as a result.
5683 @subsubsection Creating Thread Key
5685 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5686 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5688 @subsubsection Creating Followup Key
5690 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5691 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5692 at the cursor to @samp{References} key.
5693 If @code{wl-score-auto-make-followup-entry} is non-nil,
5694 @samp{Message-ID} of all messages to be followed up within dates
5695 specified by @code{wl-score-expiry-days}.
5697 @subsection Key Bindings
5702 @findex wl-summary-increase-score
5703 Increases the score for the current message.
5704 And the score entry is appended to the score file at the same moment.
5705 You can specify the score value by a prefix argument.
5709 @findex wl-summary-lower-score
5710 Decreases the score for the current message.
5711 And the score entry is appended to the score file at the same moment.
5712 You can specify the score value by a prefix argument.
5715 @kindex h R (Summary)
5716 @findex wl-summary-rescore
5717 Re-applies the scoring.
5718 However, already scored messages are not scored anew.
5721 @kindex h c (Summary)
5722 @findex wl-score-change-score-file
5723 Changes the score file currently selected.
5726 @kindex h e (Summary)
5727 @findex wl-score-edit-current-scores
5728 Edits the score file currently selected.
5729 If there are multiple score files, the previously specified one is
5733 @kindex h f (Summary)
5734 @findex wl-score-edit-file
5735 Edits an arbitrary score file and selects it.
5738 @kindex h F (Summary)
5739 @findex wl-score-flush-cache
5740 Erases caches associated to the score files that are read.
5741 If you modified score files directly (from other than Wanderlust), you
5742 need to re-read them after erasing the cache.
5745 @kindex h m (Summary)
5746 @findex wl-score-set-mark-below
5747 Specifies the criterion for scores to be marked as read.
5748 Messages with scores less than this value are marked as read.
5751 @kindex h x (Summary)
5752 @findex wl-score-set-expunge-below
5753 Specifies the criterion for scores to be deleted from the summary.
5754 Messages with scores less than this value are deleted.
5755 "Deleted" means it is not shown; they are not removed from the summary
5756 information or the folder.
5757 The deleted messages can be shown by rescan-noscore again.
5760 @subsection Key Bindings in the Score Editing Buffer
5764 @kindex C-c C-k (Score Mode)
5765 @findex wl-score-edit-kill
5766 Abandons the file being edited.
5769 @kindex C-c C-c (Score Mode)
5770 @findex wl-score-edit-exit
5771 Saves the file being edited, and quits from the edit mode.
5774 @kindex C-c C-p (Score Mode)
5775 @findex wl-score-pretty-print
5779 @kindex C-c C-d (Score Mode)
5780 @findex wl-score-edit-insert-date
5781 Inserts the number of dates from Dec. 31, 1 B.C.
5782 It is used for creating the third factor of time-limited scores.
5785 @kindex C-c C-s (Score Mode)
5786 @findex wl-score-edit-insert-header
5787 Inserts the header of the message selected in the summary buffer.
5790 @kindex C-c C-e (Score Mode)
5791 @findex wl-score-edit-insert-entry
5792 Inserts the score entry of the message selected in the summary buffer.
5795 @subsection Customizable Variables
5798 @item wl-summary-default-score
5799 @vindex wl-summary-default-score
5800 The initial setting is 0 (zero).
5801 This variable specifies the default value of the score.
5802 The score is increased or decreased based upon this value.
5804 @item wl-summary-important-above
5805 @vindex wl-summary-important-above
5806 The initial setting is @code{nil}.
5807 Messages with scores larger than this value are attached with the
5808 important mark (@samp{$}).
5809 If @code{nil}, no important marks are attached.
5811 @item wl-summary-target-above
5812 @vindex wl-summary-target-above
5813 The initial setting is @code{nil}.
5814 Messages with scores larger than this value are attached with the target
5816 If @code{nil}, no target marks are attached.
5818 @item wl-summary-mark-below
5819 @vindex wl-summary-mark-below
5820 The initial setting is 0 (zero).
5821 Messages with scores smaller than this value are marked as read.
5823 @item wl-summary-expunge-below
5824 @vindex wl-summary-expunge-below
5825 The initial setting is @code{nil}.
5826 Messages with scores smaller than this value are deleted from the
5828 If @code{nil}, they are not deleted.
5830 @item wl-summary-score-marks
5831 @vindex wl-summary-score-marks
5832 The initial setting is the list shown below:
5836 (list wl-summary-new-mark)
5841 Messages with these marks are scored.
5843 @item wl-use-scoring
5844 @vindex wl-use-scoring
5845 The initial setting is t.
5846 If non-nil, scoring is enabled.
5848 @item wl-score-files-directory
5849 @vindex wl-score-files-directory
5850 The initial setting is @file{~/.elmo/}.
5851 The default directory for score files.
5853 @item wl-score-interactive-default-score
5854 @vindex wl-score-interactive-default-score
5855 The initial setting is 1000.
5856 This value is used as a score when a score factor is @code{nil} in the
5857 score file. It is also used in @code{wl-summary-increase-score} and
5858 @code{wl-summary-lower-score}, on condition that the value of
5859 @code{wl-score-header-default-entry} is @code{nil}.
5861 @item wl-score-expiry-days
5862 @vindex wl-score-expiry-days
5863 The initial setting is 7.
5864 This is the number of days before time-limited scores are deleted.
5866 @item wl-score-update-entry-dates
5867 @vindex wl-score-update-entry-dates
5868 The initial setting is @code{t}.
5869 If non-nil, it enables deletion of time-limited scores.
5871 @item wl-score-header-default-entry
5872 @vindex wl-score-header-default-entry
5873 Specifies the default value for each header field for score entries
5874 created by @code{wl-summary-increase-score},
5875 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5877 @item wl-score-simplify-fuzzy-regexp
5878 @vindex wl-score-simplify-fuzzy-regexp
5879 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5880 regular expression to be deleted from the string.
5881 Because this is usually used for Subject, the default is prefixes that
5882 are attached by mailing list programs.
5884 @item wl-summary-rescore-partial-threshold
5885 @vindex wl-summary-rescore-partial-threshold
5886 The initial setting is 200.
5887 When sync-all or rescan is executed, if there are messages more than
5888 this value, only the last same number of messages as this value are
5891 @item wl-summary-auto-sync-marks
5892 @vindex wl-summary-auto-sync-marks
5893 If non-nil, unread/important marks are synchronized when the summary
5895 Unread marks reflect information on the IMAP4 server.
5896 Important marks reflect information on the IMAP4 server (flagged or
5897 not), and contents of @samp{'mark} folder.
5898 The initial setting is @code{t}.
5902 @node Score File Format, , Score Commands, Scoring
5903 @section Score File Format
5904 @cindex Score File Format
5906 The format of score files are the same as Gnus, and basically you can
5907 use Gnus score files as they are. But they are not fully compatible
5908 because some keys are not supported and there are Wanderlust specifics.
5909 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5914 ("for sale" -1000 nil s)
5915 ("profit" -1000 nil s))
5917 ("spam@@spamspamspam" -10000 nil s))
5919 ("my@@address" 3001 nil s))
5921 (1000000 -10 nil >))
5931 If the key is a string, it is the name of the header to be matched.
5932 The following keys are available:
5933 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5934 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5935 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5936 @code{Chars} and @code{Lines} mean the size and the number of lines of
5937 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5938 are described later.
5939 The rest corresponds the field of the same name.
5941 Arbitrary numbers of core entries are specified after the key.
5942 Each score entry consists of these five factors:
5946 A factor that matches header. This should be a number in the cases of
5947 @code{lines} and @code{chars}, otherwise a string.
5950 A score factor. When the first item matches, the score of the message
5951 is increased or decreased by this value.
5954 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5955 of a number, the score is deleted if it does not match for days
5956 (@code{wl-score-expiry-days}) from the date specified by this.
5957 The date is since Dec. 31, 1 B.C.
5960 A type factor. This specifies the way the first factor matches.
5961 Available types depend on keys.
5964 @item From, Subject, References, Message-ID
5965 For these keys in string, @code{r} and @code{R} (regexp),
5966 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5967 as well as @code{f} and @code{F} (fuzzy) can be used.
5968 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5971 For these keys, the following five numerical relative operators can be
5972 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5975 This key matches @code{From} header, and scores all follow-ups to the
5977 For example, it would be useful for increasing scores for follow-ups to
5980 You can use the same types as @code{From} except for @code{f}.
5981 And a @samp{Followup} entry is automatically appended to the score file.
5984 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5985 A @samp{Thread} entry is automatically appended for each article that
5986 has @var{x} in the @code{References} header.
5987 You can make sure the whole thread including messages that does not have
5988 all ancestors @code{Message-ID} in @code{References} is scored.
5990 You can use the same types as @code{References} except for @code{f}.
5991 And a @samp{Thread} entry is automatically appended to the score file.
5995 A factor for extension header. This is meaningful only if the key is
5997 This specifies headers to be matched other than standard headers like
5998 @code{Subject} and @code{From}.
5999 Note that you should specify the header in
6000 @code{elmo-msgdb-extra-fields} also.
6001 Therefore it does not work in folders where extension headers cannot be
6006 The sum of these scores @emph{after all factors are applied} becomes the
6007 score of the message.
6009 @cindex Score File Atoms
6011 Messages with a score less than this value is marked as read.
6012 The default is @code{wl-summary-mark-below}.
6015 Messages with a score less than this value is deleted from the summary.
6016 The default is @code{wl-summary-expunge-below}.
6018 @item mark-and-expunge
6019 Both @code{mark} and @code{expunge} are applied,
6020 i.e. messages with a score less than this value is marked as read and
6021 deleted from the summary.
6024 Messages with a score greater than this value is attached with temp
6026 The default is @code{wl-summary-target-above}.
6029 Messages with a score greater than this value is attached with important
6031 The default is @code{wl-summary-important-above}.
6036 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6037 are used, you need to set @code{elmo-msgdb-extra-fields}.
6040 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6043 There are other restrictions as shown below:
6046 @item Because @samp{References} field in the summary information
6047 contains only the last @samp{Message-ID}, @code{references} key matches
6051 Keys that can be seen by folder of types:
6055 chars lines xref extra
6056 localdir,localnews Y E E E
6057 nntp (supporting xover) Y E E N
6063 N: cannot be seen (ignored)
6064 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6069 @node Address Book, Customization, Scoring, Top
6070 @chapter Address Book
6071 @cindex Address Book
6073 With address book, you can utilize address completion, and you have
6074 summary displayed with nicknames.
6077 * Mail Addresses:: Definition of Address Book
6078 * Address Manager:: Address Manager
6081 @node Mail Addresses, Address Manager, Address Book, Address Book
6082 @section Address book
6083 @cindex Address book Definition
6085 @cindex Alias, Address
6087 The file @file{~/.addresses} is a simple address book for Wanderlust.
6088 Make address file @file{~/.addresses}, and edit to suit your requirement.
6090 The data written in @file{~/.addresses} are used for address completion
6091 under draft editing mode. Furthermore, they are used when showing names
6092 in summary display mode. You can safely skip this section, if you don't
6093 want to customize address completion and summary display.
6094 It is possible to add/change/remove addresses from @file{~/.addresses} in
6095 summary buffer after Wanderlust is invoked. @refill
6097 The format is very simple. Like this. @refill
6102 # @r{Lines begin with @samp{#} are comment.}
6103 # @r{Empty lines are ignored}
6105 # @r{Format of each line:}
6106 # @var{email-address} "@var{nickname} "@var{realname}"
6108 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6109 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6110 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6115 One line defines one persons description.
6117 Actually, in default setup, @var{nickname} is used in summary-mode and
6118 @var{realname} is used in draft preparation mode. This behavior is
6119 better understood if you try it and confirmed the function first. You
6120 can write and try a small definition, so you will know the idea of the
6121 address book before writing a big one.
6123 And, if MH alias file is specified in variable @code{wl-alias-file},
6124 it is used as an address information in the draft preparation mode.
6126 If variable @code{wl-use-ldap} is non-nil (initial setting is
6127 @code{nil}), address completion in draft mode uses LDAP information.
6129 If you use LDAP, you have to set @code{wl-ldap-server},
6130 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6131 not have LDAP feature as built-in feature (Currently only XEmacs can
6132 have built-in LDAP feature), you have to set command exec @env{PATH} to
6133 the program @command{ldapsearch}.
6136 @node Address Manager, , Mail Addresses, Address Book
6137 @section Address Manager
6138 @cindex Address Manager
6140 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6141 the address book and insert address to draft buffer.
6143 @subsection Key Bindings
6147 @kindex t (Address Manager)
6148 @findex wl-addrmgr-set-to
6149 Add @samp{To:} mark.
6152 @kindex c (Address Manager)
6153 @findex wl-addrmgr-set-cc
6154 Add @samp{Cc:} mark.
6157 @kindex b (Address Manager)
6158 @findex wl-addrmgr-set-bcc
6159 Add @samp{Bcc:} mark.
6162 @kindex u (Address Manager)
6163 @findex wl-addrmgr-unmark
6167 @kindex x (Address Manager)
6168 @findex wl-addrmgr-apply
6170 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6171 buffer and quit address manager. When no draft buffer, make new draft
6172 with insert marked addresses.
6174 If no mark, quit address manager.
6178 @kindex q (Address Manager)
6179 @findex wl-addrmgr-quit
6180 Quit address manager.
6183 @kindex a (Address Manager)
6184 @findex wl-addrmgr-add
6188 @kindex d (Address Manager)
6189 @findex wl-addrmgr-delete
6193 @kindex e (Address Manager)
6194 @findex wl-addrmgr-edit
6199 @node Customization, Mailing List, Address Book, Top
6200 @chapter Customizing Wanderlust
6201 @cindex Customization
6204 * Living with other packages:: Cooperating with other packages
6205 * Highlights:: Highlights
6206 * Biff:: Notify Mail arrival
6207 * Advanced Settings:: Advanced Settings
6208 * Customizable Variables:: Customizable Variables
6213 @node Living with other packages, Highlights, Customization, Customization
6214 @section Living with other packages
6216 Examples with other packages.
6219 * imput:: imput (im-wl.el)
6221 * supercite:: supercite.el
6222 * mu-cite:: mu-cite.el
6223 * X-Face:: x-face,bitmap-mule
6224 * dired-dd:: dired-dd.el
6226 * Addrbook:: Addrbook
6227 * mime-w3m:: mime-w3m.el
6231 @node imput, BBDB, Living with other packages, Living with other packages
6236 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6239 If @command{imput} is on the @code{exec-path} at the installation,
6240 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6244 (autoload 'wl-draft-send-with-imput-async "im-wl")
6245 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6250 @node BBDB, supercite, imput, Living with other packages
6254 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6257 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6258 byte-compiled and installed.
6266 ;; @r{enable pop-ups}
6267 (setq bbdb-use-pop-up t)
6268 ;; @r{auto collection}
6269 (setq bbdb/mail-auto-create-p t)
6270 ;; @r{exceptional folders against auto collection}
6271 (setq bbdb-wl-ignore-folder-regexp "^@@")
6272 (setq signature-use-bbdb t)
6273 (setq bbdb-north-american-phone-numbers-p nil)
6274 ;; @r{shows the name of bbdb in the summary} :-)
6275 (setq wl-summary-from-function 'bbdb-wl-from-func)
6276 ;; @r{automatically add mailing list fields}
6277 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6278 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6282 You can complete address with BBDB by @kbd{M-@key{TAB}}
6286 @node supercite, mu-cite, BBDB, Living with other packages
6287 @subsection sc.el(supercite), sc-register.el
6291 The same setting as usual mailers should be OK. The following is an
6292 example of settings:
6296 (autoload 'sc-cite-original "supercite" nil t)
6297 (add-hook 'mail-citation-hook 'sc-cite-original)
6302 @node mu-cite, X-Face, supercite, Living with other packages
6303 @subsection mu-cite.el
6306 The same setting as usual mailers should be OK. The following is an
6307 example of settings.
6309 If you use mu-cite version 8.0 or earlier:
6313 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6314 (setq mail-citation-hook 'mu-cite/cite-original)
6318 If you use mu-cite version 8.1 or later:
6322 (autoload 'mu-cite-original "mu-cite" nil t)
6323 (add-hook 'mail-citation-hook (function mu-cite-original))
6327 @node X-Face, dired-dd, mu-cite, Living with other packages
6331 If you have installed one of the following, you can decode
6332 @samp{X-Face:} field in message buffer and you will see face image.
6335 * x-face-xmas:: XEmacs case
6336 * x-face-mule:: Emacs case
6339 If there is an encoded X-Face string in a file @file{~/.xface} (the
6340 value of the variable @code{wl-x-face-file}), it is inserted as a
6341 @samp{X-Face:} field in the draft buffer (if
6342 @code{wl-auto-insert-x-face} is non-nil).
6344 @node x-face-xmas, x-face-mule, X-Face, X-Face
6345 @subsubsection x-face-xmas (for XEmacs)
6348 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6349 1.3.6.13 or later, do the following:
6353 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6354 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6358 @node x-face-mule, , x-face-xmas, X-Face
6359 @subsubsection x-face-mule (for Emacs)
6363 If you use @file{x-face-mule.el} in bitmap-mule
6364 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6368 (autoload 'x-face-decode-message-header "x-face-mule")
6369 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6373 @subsubsection x-face-e21 (for Emacs 21.x)
6376 With Emacs 21.x, you can use @file{x-face-e21.el}
6377 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6378 to display X-Face. In this case, bitmap-mule is not required.
6383 (autoload 'x-face-decode-message-header "x-face-e21")
6384 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6389 @node dired-dd, MHC, X-Face, Living with other packages
6390 @subsection dired-dd(Dired-DragDrop)
6391 @pindex Dired-DragDrop
6393 @cindex Drag and Drop
6395 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6396 compose multi-part by simple Drag-and-Drop from dired to the draft
6397 buffer being edited in GNU Emacs (this feature is not Wanderlust
6398 specific, but general-purpose for SEMI).
6402 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6408 ;; @r{Set dired-x variables here.}
6409 ;; @r{To and flo@dots{}}
6411 (progn (require 'dired-dd)
6412 (require 'dired-dd-mime))))))
6416 @node MHC, Addrbook, dired-dd, Living with other packages
6420 Message Harmonized Calendaring system
6421 (@uref{http://www.quickhack.net/mhc/})
6423 By using MHC, you can make a calendar from the messages.
6429 (setq mhc-mailer-package 'wl)
6430 (autoload 'mhc-mode "mhc" nil t)
6431 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6432 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6440 (autoload 'mhc-wl-setup "mhc-wl")
6441 (add-hook 'wl-init-hook 'mhc-wl-setup)
6445 @node Addrbook, mime-w3m, MHC, Living with other packages
6446 @subsection wl-addrbook.el
6450 (@uref{http://www.mew.org/})
6452 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6453 @code{load-path} and do the following settings.
6457 (require 'wl-addrbook)
6462 @node mime-w3m, , Addrbook, Living with other packages
6463 @subsection mime-w3m.el
6466 You can display html part by using @file{mime-w3m.el}
6467 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6468 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6471 @node Highlights, Biff, Living with other packages, Customization
6474 @subsection Customizable Variables
6477 @item wl-summary-highlight
6478 @vindex wl-summary-highlight
6479 The initial setting is @code{t}.
6480 If non-nil, the summary is highlighted.
6482 @item wl-highlight-max-summary-lines
6483 @vindex wl-highlight-max-summary-lines
6484 The initial setting is 10000.
6485 The summary is not highlighted if it has more lines than this value.
6487 @item wl-summary-highlight-partial-threshold
6488 @vindex wl-summary-highlight-partial-threshold
6489 The initial setting is 1000.
6490 This is a threshold whether the whole summary is highlighted.
6491 If there are more lines of messages in the summary, it is partially
6494 @item wl-summary-partial-highlight-above-lines
6495 @vindex wl-summary-partial-highlight-above-lines
6496 The initial setting is 30. If there are more lines of messages than
6497 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6498 after the point that is the same number of lines as this value above the
6499 cursor line are highlighted partially. (If this value is @code{nil},
6500 the last same number of lines as the value of
6501 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6503 @item wl-highlight-body-too
6504 @vindex wl-highlight-body-too
6505 The initial setting is @code{t}.
6506 If non-nil, bodies of drafts and messages are also highlighted.
6508 @item wl-highlight-message-header-alist
6509 @vindex wl-highlight-message-header-alist
6510 When highlighting headers of drafts and messages, this variable
6511 specifies which faces are allocated to important
6512 (@code{wl-highlight-message-important-header-contents}), secondly
6513 important (@code{wl-highlight-message-important-header-contents2}), and
6514 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6516 Similarly, it can be used for allocating arbitrary faces to arbitrary
6517 regular expressions.
6519 @item wl-highlight-citation-prefix-regexp
6520 @vindex wl-highlight-citation-prefix-regexp
6521 Specifies a regular expression to which quoted lines in bodies of
6522 drafts and messages match.
6523 Bodies matching to this regular expression are highlighted by the faces
6524 specified by (@code{wl-highlight-message-cited-text-*}).
6526 @item wl-highlight-highlight-citation-too
6527 @vindex wl-highlight-highlight-citation-too
6528 The initial setting is @code{nil}.
6529 If non-nil, the quoting regular expression itself given by
6530 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6532 @item wl-highlight-citation-header-regexp
6533 @vindex wl-highlight-citation-header-regexp
6534 Specifies a regular expression that denotes beginning of quotation.
6535 Bodies matching to this regular expression are highlighted by the face
6536 specified by @code{wl-highlight-message-headers}.
6538 @item wl-highlight-max-header-size
6539 @vindex wl-highlight-max-header-size
6540 The initial setting is @code{nil}. If a header size is larger than this
6541 value, it will not be highlighted. If @code{nil}, always highlighted
6542 (ignore header size).
6544 @item wl-highlight-max-message-size
6545 @vindex wl-highlight-max-message-size
6546 The initial setting is 10000.
6547 If a message is larger than this value, it will not be highlighted.
6548 With this variable, highlight is suppressed for uuencode or huge digest
6551 @item wl-highlight-signature-separator
6552 @vindex wl-highlight-signature-separator
6553 Specifies regular expressions that denotes the boundary of a signature.
6554 It can be a regular expression, or a list of ones.
6555 Messages after the place that matches this regular expression are
6556 highlighted by the face specified by
6557 @code{wl-highlight-message-signature}.
6559 @item wl-max-signature-size
6560 @vindex wl-max-signature-size
6561 The initial setting is 400.
6562 This is the largest size for a signature to be highlighted.
6564 @item wl-use-highlight-mouse-line
6565 @vindex wl-use-highlight-mouse-line
6566 The initial setting is @code{t}.
6567 If non-nil, the line pointed by the mouse is highlighted in the folder
6568 mode, summary mode, and the like.
6571 @subsection Setting Colors and Fonts of the Characters
6573 If you want to change colors or fonts of the characters, you need to
6574 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6575 want to change fonts, and @code{set-face-foreground} for colors, and so
6576 on. You cannot write face settings in @file{.emacs}; write in
6579 For example, if you want to change the color for signatures to yellow,
6583 (set-face-foreground 'wl-highlight-message-signature "yellow")
6589 Faces defined in Wanderlust:
6592 @item wl-highlight-message-headers
6593 The face for field names of message headers.
6595 @item wl-highlight-message-header-contents
6596 The face for field bodies of message headers.
6598 @item wl-highlight-message-important-header-contents
6599 The face for important parts of message headers.
6600 Per default, this face is used for a body of @samp{Subject:} field.
6601 You can change its value by editing
6602 @code{wl-highlight-message-header-alist}.
6604 @item wl-highlight-message-important-header-contents2
6605 The face for secondly important parts of message headers.
6606 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6607 fields. You can change its value by editing
6608 @code{wl-highlight-message-header-alist}.
6610 @item wl-highlight-message-unimportant-header-contents
6611 The face for unimportant parts of message headers.
6612 Per default, this face is used for bodies of @samp{X-} fields
6613 @samp{User-Agent:} fields. You can change its value by editing
6614 @code{wl-highlight-message-header-alist}.
6616 @item wl-highlight-message-citation-header
6617 The face for headers of quoted messages.
6619 @item wl-highlight-message-cited-text-*
6620 The face for texts of quoted messages. The last @samp{*} is a
6621 @var{single figure} so that 10 different colors can be used according to
6624 @item wl-highlight-message-signature
6625 The face for signatures of messages. The initial settings are
6626 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6627 dark background colors.
6629 @item wl-highlight-header-separator-face
6630 The face for header separators of draft messages.
6632 @item wl-highlight-summary-important-face
6633 The face for message lines with important marks in the summary.
6635 @item wl-highlight-summary-new-face
6636 The face for message lines with new marks in the summary.
6638 @item wl-highlight-summary-displaying-face
6639 The face for the message line that is currently displayed.
6640 This face is overlaid.
6642 @item wl-highlight-thread-indent-face
6643 The face for the threads that is currently displayed.
6645 @item wl-highlight-summary-unread-face
6646 The face for message lines with unread marks in the summary.
6648 @item wl-highlight-summary-deleted-face
6649 The face for message lines with delete marks in the summary.
6651 @item wl-highlight-summary-refiled-face
6652 The face for message lines with re-file marks in the summary.
6654 @item wl-highlight-refile-destination-face
6655 The face for re-file information part of message lines with re-file
6656 marks in the summary.
6658 @item wl-highlight-summary-copied-face
6659 The face for message lines with copy marks in the summary.
6661 @item wl-highlight-summary-target-face
6662 The face for message lines with target marks @samp{*} in the summary.
6664 @item wl-highlight-summary-thread-top-face
6665 The face for message lines that are on the top of the thread in the
6668 @item wl-highlight-summary-normal-face
6669 The face for message lines that are not on top of the thread in the
6672 @item wl-highlight-folder-unknown-face
6673 The face for folders that are not known to have how many unsync messages
6676 @item wl-highlight-folder-zero-face
6677 The face for folders that have no unsync messages in the folder mode.
6679 @item wl-highlight-folder-few-face
6680 The face for folders that have some unsync messages in the folder mode.
6682 @item wl-highlight-folder-many-face
6683 The face for folders that have many unsync messages in the folder mode.
6684 The boundary between `some' and `many' is specified by the variable
6685 @code{wl-folder-many-unsync-threshold}.
6687 @item wl-highlight-folder-unread-face
6688 The face for folders that have no unsync but unread messages in the
6691 @item wl-highlight-folder-killed-face
6692 The face for folders that are deleted from the access group in the
6695 @item wl-highlight-folder-opened-face
6696 The face for open groups in the folder mode.
6697 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6698 @code{nil} or a @var{number}.
6700 @item wl-highlight-folder-closed-face
6701 The face for close groups in the folder mode.
6702 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6703 @code{nil} or a @var{number}.
6705 @item wl-highlight-folder-path-face
6706 The face for the path to the currently selected folder in the folder
6709 @item wl-highlight-logo-face
6710 The face for logo in the demo.
6712 @item wl-highlight-demo-face
6713 The face for strings (for example, a version number) in the demo.
6717 @node Biff, Advanced Settings, Highlights, Customization
6718 @section Notify Mail arrival
6721 Following setting is to notify mail arrival of @samp{%inbox}
6722 by the indicator on the modeline
6725 (setq wl-biff-check-folder-list '("%inbox"))
6728 @subsection Customizable Variables
6730 @item wl-biff-check-folder-list
6731 @vindex wl-biff-check-folder-list
6732 The initial setting is @code{nil}.
6733 This is the list of folders to check mail arrival.
6734 If @code{nil}, wl doesn't check mail arrival.
6736 @item wl-biff-check-interval
6737 @vindex wl-biff-check-interval
6738 The initial setting is 40 (in seconds).
6739 Check mail arrival in this period.
6741 @item wl-biff-notify-hook
6742 @vindex wl-biff-notify-hook
6743 This hook is run at the arrival of new mail.
6744 To beep with mail arrival(initial setting), set as follows.
6746 (setq wl-biff-notify-hook '(ding))
6748 For silence, set to @code{nil}.
6752 @node Advanced Settings, Customizable Variables, Biff, Customization
6753 @section Advanced Settings
6756 * Draft for Reply:: Draft for Reply
6757 * Thread Format:: Appearance of Thread
6758 * User-Agent Field:: @samp{User-Agent:} Header Field
6762 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6763 @subsection Draft for Replay
6764 @vindex wl-draft-reply-with-argument-list
6765 @vindex wl-draft-reply-without-argument-list
6766 @vindex wl-draft-reply-myself-with-argument-list
6767 @vindex wl-draft-reply-myself-without-argument-list
6769 If you want, when you replying to articles in mailing lists, the address
6770 in Reply-To field of the original message to be prepared to To field of
6771 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6776 (setq wl-draft-reply-without-argument-list
6777 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6778 ("Followup-To" . (nil nil ("Followup-To")))
6779 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6780 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6785 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6786 in the original message, @samp{Reply-To:} field in the original is
6787 copied to @samp{To:} field.)
6789 Moreover, the behavior of @kbd{a} with prefix argument can
6790 be directed by @code{wl-draft-reply-with-argument-list} as well.
6792 Note: To set the behavior when you reply to the message written by yourself, use
6793 @code{wl-draft-reply-myself-without-argument-list} and
6794 @code{wl-draft-reply-myself-with-argument-list}
6797 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6798 @subsection Appearance of Threads
6802 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6803 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6804 391 09/18(Fri)19:24 +-[ Murata-san ]
6805 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6806 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6807 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6808 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6809 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6810 412 09/22(Tue)09:28 | +-[ Teranishi ]
6811 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6812 416 09/22(Tue)12:38 | +-[ Teranishi ]
6813 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6814 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6818 Settings to make appearance of threads like shown above:
6822 (setq wl-thread-indent-level 2)
6823 (setq wl-thread-have-younger-brother-str "+")
6824 (setq wl-thread-youngest-child-str "+")
6825 (setq wl-thread-vertical-str "|")
6826 (setq wl-thread-horizontal-str "-")
6827 (setq wl-thread-space-str " ")
6831 If you do not want to see branches, do the following:
6835 (setq wl-thread-indent-level 2)
6836 (setq wl-thread-have-younger-brother-str " ")
6837 (setq wl-thread-youngest-child-str " ")
6838 (setq wl-thread-vertical-str " ")
6839 (setq wl-thread-horizontal-str " ")
6840 (setq wl-thread-space-str " ")
6845 @node User-Agent Field, , Thread Format, Advanced Settings
6846 @subsection User-Agent Field
6850 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6851 @samp{User-Agent:} fields, define a function that generate appropriate
6852 strings as you like, and set it to variable
6853 @code{wl-generate-mailer-string-function}.
6855 If you do not want verbose @samp{User-Agent:} field, do the following:
6859 (setq wl-generate-mailer-string-function
6862 (concat "User-Agent: "
6863 (wl-generate-user-agent-string-1 nil)))))
6867 The following is a example:
6871 (setq mime-edit-insert-user-agent-field nil)
6872 (setq wl-generate-mailer-string-function
6875 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6880 @node Customizable Variables, Hooks, Advanced Settings, Customization
6881 @section Customizable Variables
6883 Customizable variables that have not been described yet:
6886 @item wl-default-folder
6887 @vindex wl-default-folder
6888 The initial setting is @samp{%inbox}. This is the default value for moving to
6889 a folder and the like.
6891 @item wl-draft-folder
6892 @vindex wl-draft-folder
6893 The initial setting is @samp{+draft}. It is the folder to which drafts are
6894 saved. It must be a localdir folder.
6896 @item wl-trash-folder
6897 @vindex wl-trash-folder
6898 The initial setting is @samp{+trash}. It is the wastebasket folder.
6899 If you changed this variable, you had better restart Wanderlust.
6901 @item wl-interactive-exit
6902 @vindex wl-interactive-exit
6903 The initial setting is @code{t}.
6904 If non-nil, you are asked for confirmation when Wanderlust terminates.
6906 @item wl-interactive-send
6907 @vindex wl-interactive-send
6908 The initial setting is @code{t}.
6909 If non-nil, you are asked for confirmation when mail is sent.
6911 @item wl-folder-sync-range-alist
6912 @vindex wl-folder-sync-range-alist
6913 The initial setting is the alist shown below:
6918 ("^\\+draft$\\|^\\+queue$" . "all"))
6923 This is an associative list of regular expressions of folder names and
6924 update range of the summary. Update range is one of the @samp{all},
6925 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6926 @samp{last}. If a folder do not match, @samp{update} is used.
6929 @vindex wl-ask-range
6930 The initial setting is @code{t}.
6931 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6932 for updating the summary when you changed folders.
6934 @item wl-mime-charset
6935 @vindex wl-mime-charset
6936 The initial setting is @code{x-ctext}.
6937 This is the MIME charset for messages that are not MIME (e.g. without
6938 @samp{Content-Type:}). This value also used as default charset for
6939 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6940 this value as @code{iso-2022-jp}.)
6942 @item wl-highlight-folder-with-icon
6943 @vindex wl-highlight-folder-with-icon
6944 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6945 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6947 @item wl-strict-diff-folders
6948 @vindex wl-strict-diff-folders
6949 This is a list of regular expressions of folders.
6950 Unread messages are checked, for example when you press @kbd{s} in
6951 the folder mode, usually in a brief way (rapidly processed but not
6953 The folders matching this variable are seriously checked.
6954 You may want to set this variable so as to match conditional filter
6955 folders for IMAP4 folders.
6956 The initial setting is @code{nil}.
6958 @item wl-folder-use-server-diff
6959 @vindex wl-folder-use-server-diff
6960 When unread messages are checked, for example when you press @kbd{s} in
6961 the folder mode, usually (the number of messages on the server) @minus{}
6962 (the number of local messages) will be the number of unread messages.
6963 However, if this variable is non-nil, the number of unread messages on
6964 the server is checked. This affects IMAP4 folders only, but IMAP4
6965 folders in mail boxes matching
6966 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6967 the number of unread messages on the server, even if they matches this
6968 variable. The initial setting is @code{t}.
6970 @item wl-auto-check-folder-name
6971 @vindex wl-auto-check-folder-name
6972 The initial setting is @code{nil}.
6973 You can specify a folder or a group which is checked for unread message
6974 at the start. You can also specify a list of folders (groups) to be checked.
6975 If the value is @code{nil}, whole Desktop is checked at the start.
6976 If it is @code{none}, no folders are checked.
6978 @item wl-auto-uncheck-folder-list
6979 @vindex wl-auto-uncheck-folder-list
6980 The initial setting is the list shown below:
6989 You can set a list of regular expressions to specify folders
6990 which are not automatically checked even if they are included
6991 in some groups assigned by @code{wl-auto-check-folder-name}.
6993 @item wl-auto-check-folder-list
6994 @vindex wl-auto-check-folder-list
6995 The initial setting is @code{nil}.
6996 You can set a list of regular expressions to specify exceptions
6997 for @code{wl-auto-uncheck-folder-list}.
6999 @item wl-no-save-folder-list
7000 @vindex wl-no-save-folder-list
7001 The initial setting is the list shown below:
7010 This is a list of regular expressions of folders not to be saved.
7012 @item wl-save-folder-list
7013 @vindex wl-save-folder-list
7014 The initial setting is @code{nil}.
7015 This is a list of regular expressions of folders to be saved.
7016 This takes precedence over @code{wl-no-save-folder-list}.
7018 @item wl-folder-mime-charset-alist
7019 @vindex wl-folder-mime-charset-alist
7020 The initial setting is the alist shown below:
7024 (("^-alt\\.chinese" . big5)
7025 ("^-relcom\\." . koi8-r)
7027 ("^-han\\." . euc-kr))
7032 This is an associative list of regular expressions of folder names and
7034 If a folder do not match, @code{wl-mime-charset} is used.
7036 @item wl-folder-init-load-access-folders
7037 @vindex wl-folder-init-load-access-folders
7038 The initial setting is @code{nil}.
7039 This is a list of access groups to be loaded specifically at the start.
7040 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7042 @item wl-folder-init-no-load-access-folders
7043 @vindex wl-folder-init-no-load-access-folders
7044 The initial setting is @code{nil}.
7045 This is a list of access groups not to be loaded specifically at the
7047 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7049 @item wl-delete-folder-alist
7050 @vindex wl-delete-folder-alist
7051 The initial setting is the alist shown below:
7060 This list determines disposition of messages with delete marks.
7061 Each item in the list is a folder and destination; you can specify any
7062 one of the following in the place of destination:
7065 @code{remove} or @code{null} : deletes the messages instantly.
7066 string : moves the messages to the specific folder.
7067 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7070 @item wl-refile-policy-alist
7071 @vindex wl-refile-policy-alist
7072 The initial setting is the list shown below:
7082 This list determines whether messages with re-file marks are moved or
7083 copied. Each item in the list is a cons cell of a folder and
7084 @code{copy} or @code{move}.
7086 @item wl-x-face-file
7087 @vindex wl-x-face-file
7088 The initial setting is @file{~/.xface}.
7089 The name of the file that contains encoded X-Face strings.
7092 @item wl-demo-display-logo
7093 @vindex wl-demo-display-logo
7094 If non-nil, bitmap image is shown on the opening demo. If you set
7095 @code{xpm} or @code{xbm}, (if possible) display selected image type
7098 @item elmo-use-database
7099 @vindex elmo-use-database
7100 This is meaningful for XEmacs only. The initial setting depends on
7101 XEmacs (@code{t} for XEmacs with dbm).
7102 If non-nil, Message-ID is controlled by dbm.
7104 @item elmo-passwd-alist-file-name
7105 @vindex elmo-passwd-alist-file-name
7106 The initial setting is @file{passwd}.
7107 This is the name of the file in which passwords are saved.
7108 @code{elmo-passwd-alist-save} saves current passwords to the file.
7110 @item elmo-nntp-list-folders-use-cache
7111 @vindex elmo-nntp-list-folders-use-cache
7112 The initial setting is 600 (in seconds).
7113 This is period in seconds during which results of @samp{list} and
7114 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7117 @item elmo-nntp-max-number-precedes-list-active
7118 @vindex elmo-nntp-max-number-precedes-list-active
7119 The initial setting is @code{nil}.
7120 If non-nil, the number of article obtained by @samp{list active} in NNTP
7121 are used as the maximum article number of the folder.
7122 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7123 and if the number of read messages is not correct.
7125 @item elmo-nntp-default-use-listgroup
7126 @vindex elmo-nntp-default-use-listgroup
7127 The initial setting is @code{t}.
7128 If non-nil, @samp{listgroup} is used for checking the total number of
7129 articles. If it is @code{nil}, @samp{group} is used. In the latter
7130 case, the processing will be a little faster at the sacrifice of
7133 @item elmo-pop3-send-command-synchronously
7134 @vindex elmo-pop3-send-command-synchronously
7135 The initial setting is @code{nil}.
7136 If non-nil, POP3 commands are issued synchronously. Some implementation
7137 of POP3 server fails to get summary information without this setting.
7138 You may have to set this variable to @code{t}, if the process hangs
7139 while looking up POP3.
7141 @item elmo-dop-flush-confirm
7142 @vindex elmo-dop-flush-confirm
7143 The initial setting is @code{t}.
7144 If non-nil, you are asked for confirmation if accumulated off-line
7145 operations are executed.
7147 @item elmo-display-progress-threshold
7148 @vindex elmo-display-progress-threshold
7149 The initial setting is 20.
7150 Threshold for display of progress gauge. If number of renewal is more than
7151 this value, display progress gauge.
7155 @node Hooks, , Customizable Variables, Customization
7161 @node Mailing List, Addition, Customization, Top
7162 @chapter Wanderlust Mailing List
7167 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7170 Topics related to Wanderlust are discussed in the mailing list.
7171 The latest version is also announced there (in Japanese, sorry).
7173 A guide can be obtained automatically by sending mail to
7174 @t{wl-ctl@@lists.airs.net} with the body
7179 Please send bug reports or patches to the mailing list. You can post to
7180 the mailing list even though you are not a member of it.
7182 If you send a bug report, please attach Backtrace with it.
7183 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7186 I would like to express my thanks to the members of the mailing list for
7187 valuable advice and many pieces of code they contributed.
7190 @node Addition, Index, Mailing List, Top
7191 @chapter Additional Information
7193 @section Brief History
7196 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7197 3/10 Made a msgdb mechanism by elisp.
7198 3/26 IMAP and NNTP can be displayed in threads.
7199 4/13 Began to assemble thread display modules as elmo.
7200 5/01 Finished 0.1.0, initial version with many defects.
7201 6/12 I made a slip of the tongue and said I was writing elisp
7202 mailer supporting IMAP
7203 6/16 0.1.3 was announced at tm-ja, elisp ML.
7204 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7205 7/01 Support for mm-backend (0.3.0).
7206 8/25 multi folder added (0.5.0).
7207 8/28 filter folder added (0.5.1).
7208 9/10 You can open/close threads (0.6.0).
7209 9/11 fldmgr by Murata-san made editing folders easy.
7210 9/18 lha folders added by Okunishi-san (0.6.3).
7211 9/24 Display of branches of threads (0.6.5).
7212 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7213 10/28 Off-line operations (0.7.4).
7214 12/09 Becomes beta version.
7215 12/21 wl-expire by Murata-san.
7216 1999 2/03 auto-refile by Tsumura-san.
7217 4/28 wl-template by Murata-san.
7218 5/18 Released 1.0.0 stable.
7219 7/05 Scoring by Murata-san (2.1.0).
7220 9/26 New plugged system by Murata-san (2.2.2).
7221 12/20 Support Modified UTF7.
7222 2000 3/24 Released 1.1.0 stable.
7223 4/03 CVS development started.
7224 5/07 Thread restoration & Its speed up with Murata-san.
7225 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7226 7/11 killed message feature.
7227 7/18 Use UIDL in POP3.
7228 9/12 biff feature with Satata-san & Yamaoka-san.
7229 10/17 expire-hide by Okada-san.
7230 11/08 Released 2.4.0 stable.
7231 2001 7/04 Released 2.6.0 stable.
7232 8/21 wl-addrmgr by Kitamoto-san.
7233 12/27 Released 2.8.1 stable.
7236 See @file{ChangeLog} for details.
7240 According to a dictionary, Wanderlust has the meaning:
7244 n eager longing for or impulse towards travelling in distant lands
7245 [Ger, fr wandern to wander + lust desire, pleasure]
7249 but I had no profound intention. (if farfetched, IMAP @result{} you can
7250 read mail anywhere @result{} desire to wander ?)
7252 Elmo is the abbreviation of @samp{Elisp Library for Message
7253 Orchestration}. At first I meant the red puppet in the Sesame Street,
7254 but you may associate it with Wandering @result{} Drifting @result{}
7255 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7259 Each versions has code names (they are almost jokes).
7260 Currently they are picked up alphabetically from the top 40 hits of
7261 U.S. Billboard magazines in 1980s.
7263 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7266 @node Index, , Addition, Top
7270 * Concept Index:: Concept Index
7271 * Key Index:: Key Index
7272 * Variable Index:: Variable Index
7273 * Function Index:: Function Index
7276 @node Concept Index, Key Index, Index, Index
7277 @unnumberedsec Concept Index
7280 @node Key Index, Variable Index, Concept Index, Index
7281 @unnumberedsec Key Index
7284 @node Variable Index, Function Index, Key Index, Index
7285 @unnumberedsec Variable Index
7288 @node Function Index, , Variable Index, Index
7289 @unnumberedsec Function Index