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.
2709 @item wl-message-buffer-prefetch-depth
2710 @vindex wl-message-buffer-prefetch-depth
2711 The initial setting is 5. The number of messages to prefetch.
2713 @item wl-message-buffer-prefetch-idle-time
2714 @vindex wl-message-buffer-prefetch-idle-time
2715 The initial setting is 0.2 (in seconds). The period of prefetching.
2719 @node Auto Refile, Sticky Summary, Cache, Summary
2720 @section Auto Refile
2721 @vindex elmo-msgdb-extra-fields
2722 @vindex wl-refile-rule-alist
2723 @findex wl-summary-auto-refile
2725 You can refile messages automatically, by typing @kbd{C-o}
2726 (@code{wl-summary-auto-refile}). It decides destination of refile by
2727 the content of the message header information (information in the msgdb).
2729 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2730 available. If you want to decide destination by other header fields,
2731 set the variable @code{elmo-msgdb-extra-fields} like following.
2735 (setq elmo-msgdb-extra-fields
2745 By this setting, Wanderlust saves extra fields in the msgdb. You have
2746 to type @kbd{s all} to get extra fields for the messages that are
2747 already exists in the summary.
2749 Then, specify the refile rule. The refile target folder of auto
2750 refiling is decided by the value of @code{wl-refile-rule-alist}.
2751 @code{wl-refile-rule-alist} is a list of a rule:
2755 (@var{field} (@var{regexp} . @var{target})
2756 (@var{regexp} . @var{target})
2761 Each rule means `if @var{field} value matches @var{regexp},
2762 then refile to @var{target} folder'.
2763 The rule matched first is applied.
2765 @var{field} is a string of field name. You can specify a list of field name
2766 string, too. In this case, if one of these fields is matched, then the
2767 rule is fired (i.e. OR condition).
2769 @var{regexp} is a regular expression for field value. @var{target} is a target
2770 folder string. You can specify a rule at @var{target} part, too. In this
2771 case, If the field value of the rule and the current rule is matched,
2772 then the current rule is fired (i.e. AND condition).
2774 In @var{target} part, you can refer matched substring of @var{regexp}.
2775 To refer substring, specify following in @var{target}:
2779 means substitute original matched text.
2782 means substitute what matched the @var{N}th `\(@dots{}\)'.
2783 (@var{N} is a number.)
2786 Following is an example of @code{wl-refile-rule-alist}.
2790 (setq wl-refile-rule-alist
2792 ("^Wanderlust" . "+wl")
2793 ("^Elisp" . "+elisp"))
2795 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2797 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2798 "+from-me-to-you"))))))
2802 After these settings, refile marks are automatically put on the condition
2803 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2805 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2807 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2808 with these persistent marks are not automatically refiled.
2809 It means Wanderlust does not execute auto refile on unread messages by
2810 the default setting.
2811 To execute auto refile on all messages, set following.
2814 (setq wl-summary-auto-refile-skip-marks nil)
2818 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2819 @section Sticky Summary
2820 @cindex Summary, Sticky
2821 @cindex Sticky Summary
2823 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2825 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2826 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2828 The buffer name of the sticky summary becomes like
2829 @samp{Summary:@var{folder-name}}.
2831 You can visit the sticky summary at any time by @kbd{C-x b}
2832 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2833 q}. Other operations in the sticky summary are same as normal summary.
2835 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2836 are automatically stuck.
2839 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2840 @section Key bindings
2841 @cindex Keybind, Summary Mode
2842 @cindex Keybind, Summary Buffer
2844 Key bindings of the summary mode are shown below.
2848 @kindex @key{SPC} (Summary)
2849 @findex wl-summary-read
2850 Proceed reading a message at the current cursor point.
2851 (@code{wl-summary-read})
2855 @findex wl-summary-redisplay
2856 Redisplay a message at the current cursor point.
2857 If this command is called with prefix argument,
2858 Redisplay message regardless of the message cache (message is re-loaded
2860 (@code{wl-summary-redisplay})
2864 @findex wl-summary-display-top
2865 Display the top message in the folder.
2866 (@code{wl-summary-display-top})
2870 @findex wl-summary-display-bottom
2871 Display the bottom message in the folder.
2872 (@code{wl-summary-display-bottom})
2876 @kindex @key{BS} (Summary)
2877 @kindex @key{DEL} (Summary)
2878 Display the previous page of the message at the current cursor point.
2879 @findex wl-summary-prev-page
2880 (@code{wl-summary-prev-page})
2883 @kindex @key{RET} (Summary)
2884 @findex wl-summary-next-line-content
2885 Display the next line of the message at the current cursor point.
2886 Display the message at the current cursor point if it is not displayed yet.
2887 (@code{wl-summary-next-line-content})
2892 @kindex M-@key{RET} (Summary)
2893 @findex wl-summary-prev-line-content
2894 Display the previous line of the message at the current cursor point.
2895 Display the message at the current cursor point if it is not displayed yet.
2896 (@code{wl-summary-prev-line-content})
2900 @findex wl-thread-open-close
2901 Toggle open or close the thread at the current cursor point.
2902 (@code{wl-thread-open-close})
2907 @findex wl-thread-open-all
2908 (@code{wl-thread-open-all})
2913 @findex wl-thread-close-all
2914 (@code{wl-thread-close-all})
2918 @findex wl-summary-goto-folder
2920 (@code{wl-summary-goto-folder})
2924 Mark all messages in the folder as read.
2925 @findex wl-summary-mark-as-read-all
2926 (@code{wl-summary-mark-as-read-all})
2930 @findex wl-summary-reply
2931 Prepare a draft for reply the message at the current cursor point.
2932 (@code{wl-summary-reply})
2936 @findex wl-summary-reply-with-citation
2937 Prepare a draft for reply the message at the current cursor point.
2938 (@code{wl-summary-reply-with-citation})
2942 @findex wl-summary-cancel-message
2943 If the message at current cursor point is your own netnews article,
2945 (@code{wl-summary-cancel-message})
2949 @findex wl-summary-reedit
2950 Prepare a draft for re-editing the message at current cursor point.
2951 If the message at current cursor point is your own netnews article,
2952 a draft for `supersedes message' for the message is prepared.
2953 (@code{wl-summary-reedit})
2956 @kindex M-e (Summary)
2957 @findex wl-summary-resend-bounced-mail
2958 If the message at current cursor point is a bounced message,
2959 a draft for re-sending original message is prepared.
2960 (@code{wl-summary-resend-bounced-mail})
2964 @findex wl-summary-forward
2965 A draft for forwarding the message at current cursor point is prepared.
2966 (@code{wl-summary-forward})
2970 @findex wl-summary-mark-as-important
2971 Put @samp{$} mark on the message at current cursor point.
2972 If already marked as @samp{$}, delete it.
2973 (@code{wl-summary-mark-as-important})
2979 Save the message at current cursor point.
2980 @findex wl-summary-save
2981 (@code{wl-summary-save})
2985 @findex wl-summary-next
2986 Move cursor to the next message.
2987 If message is marked with a temporal mark in
2988 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2989 In the offline mode, cursor is not moved to the messages which are not cached
2991 (@code{wl-summary-next})
2995 @findex wl-summary-prev
2996 Move cursor to the previous message.
2997 If message is marked with a temporal mark in
2998 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2999 In the offline mode, cursor is not moved to the messages which are not cached
3001 (@code{wl-summary-prev})
3005 @findex wl-summary-down
3006 Move cursor to the downward message which is unread or marked
3008 In the offline mode, cursor is not moved to the messages which are not cached
3010 If there are messages which have target mark @samp{*} in the summary,
3011 cursor is moved to the downward message which have a target mark.
3012 This behavior is changed according to the value of @code{wl-summary-move-order}.
3013 (@code{wl-summary-down})
3017 @findex wl-summary-up
3018 Move cursor to the upward message which is unread or marked
3020 In the offline mode, cursor is not moved to the messages which are not cached
3022 If there are messages which have target mark @samp{*} in the summary,
3023 cursor is moved to the downward message which have a target mark.
3024 This behavior is changed according to the value of @code{wl-summary-move-order}.
3025 (@code{wl-summary-up})
3029 @findex wl-summary-write
3030 Prepare a new draft.
3031 (@code{wl-summary-write})
3035 @findex wl-summary-write-current-folder
3036 Prepare a new draft. If the current folder is NNTP folder,
3037 @samp{Newsgroups:} field is completed. If the current folder is mailing
3038 list folder (refile destination), guess @samp{To:} field and completed
3039 (If @code{wl-subscribed-mailing-list} is valid list)
3040 (@code{wl-summary-write-current-folder})
3044 @findex wl-summary-redisplay-all-header
3045 Redisplay the message at current cursor point with all header fields.
3046 (@code{wl-summary-redisplay-all-header})
3050 @findex wl-summary-redisplay-no-mime
3051 Redisplay the message at current cursor point without MIME analysis.
3052 (@code{wl-summary-redisplay-no-mime})
3056 @findex wl-summary-burst
3057 If the message at current cursor point has
3058 encapsulates multiple messages using MIME,
3059 de-capsulate and extract them on the current folder.
3060 (@code{wl-summary-burst})
3063 @kindex @@ (Summary)
3064 @findex wl-summary-edit-addresses
3065 Append/change/delete the message's sender information to the address
3066 book @file{~/.addresses} interactively. If this command is called with
3067 prefix argument, arbitrary address can be edited.
3068 (@code{wl-summary-edit-petname})
3072 @findex wl-status-update
3073 Sync up address book status with @file{~/.addresses}'s content.
3074 (@code{wl-status-update})
3078 @findex wl-summary-pipe-message
3079 Pipe current message's content to the external process.
3080 (@code{wl-summary-pipe-message})
3084 @findex wl-summary-print-message
3085 Print out current message's content.
3086 It uses @code{ps-print} module in Emacs 20.x.
3087 If you don't use color printer, you might want to set
3088 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3091 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3094 (@code{wl-summary-print-message})
3098 @findex wl-summary-exit
3099 Exit current folder.
3100 (@code{wl-summary-exit})
3104 @findex wl-summary-jump-to-current-message
3105 Jump cursor to the currently displayed message's window.
3106 (@code{wl-summary-jump-to-current-message})
3110 Jump cursor to the other message.
3111 @findex wl-summary-jump-to-msg
3112 (@code{wl-summary-jump-to-msg})
3116 Update summary status and
3117 prefetch all messages which have marks included in the
3118 @code{wl-summary-incorporate-marks}.
3119 @findex wl-summary-incorporate
3120 (@code{wl-summary-incorporate})
3123 @kindex M-j (Summary)
3124 @findex wl-summary-jump-to-msg-by-message-id
3125 Jump cursor to the message which have specified @samp{Message-Id:}. If
3126 @code{elmo-use-database} is non-nil, other folder is also searched.
3127 (@code{wl-summary-jump-to-msg-by-message-id})
3131 Jump to parent message.
3132 @findex wl-summary-jump-to-parent-message
3133 (@code{wl-summary-jump-to-parent-message})
3137 @findex wl-summary-mark-as-unread
3138 Mark as unread the message at current cursor point.
3139 (@code{wl-summary-mark-as-unread})
3143 @findex wl-summary-sync
3144 Synchronize summary view after prompting the update range
3145 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3149 all ...Discard current summary and update all message.
3150 update ...Update the difference between summary and the folder itself.
3151 rescan ...Rescan the msgdb and display again.
3152 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3153 first, last ...Move to the filter folder(partial filter).
3158 (@code{wl-summary-sync})
3162 @findex wl-summary-sort
3164 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3165 (@code{wl-summary-sort})
3169 @findex wl-summary-toggle-thread
3170 Toggle the threading.
3171 Threading status is displayed on the modeline.
3172 @samp{@{S@}} means threading is off (Sequence) and
3173 @samp{@{T@}} means threading is on (Thread).
3174 (@code{wl-summary-toggle-thread})
3178 @findex wl-summary-toggle-disp-folder
3179 Toggle displaying of folder window.
3180 (@code{wl-summary-toggle-disp-folder})
3184 Toggle displaying of message window.
3185 @findex wl-summary-toggle-disp-msg
3186 (@code{wl-summary-toggle-disp-msg})
3190 Move to the virtual folder with the condition specified.
3191 If called with prefix argument and current folder is virtual, exit it.
3192 @findex wl-summary-virtual
3193 (@code{wl-summary-virtual})
3196 @kindex @key{TAB} (Summary)
3197 @findex wl-summary-goto-last-displayed-msg
3198 Jump to the message which is displayed last.
3199 (@code{wl-summary-goto-last-displayed-msg})
3203 Put @samp{*} mark on the messages that satisfies the specified condition.
3204 @findex wl-summary-pick
3205 (@code{wl-summary-pick})
3209 @findex wl-summary-mark-as-read
3210 Mark as read the message at the current cursor point.
3211 (@code{wl-summary-mark-as-read})
3215 Prefetch the message at the current cursor point.
3216 With prefix argument, prefetch the message even if it is cached.
3217 @findex wl-summary-prefetch
3218 (@code{wl-summary-prefetch})
3222 Execute @samp{D}, @samp{o} and @samp{O} marks.
3223 @findex wl-summary-exec
3224 (@code{wl-summary-exec})
3228 @findex wl-summary-target-mark-line
3229 Put target mark on the message at the current cursor point.
3230 (@code{wl-summary-target-mark-line})
3234 Put refile mark on the message at the current cursor point.
3235 @findex wl-summary-refile
3236 (@code{wl-summary-refile})
3239 @kindex C-o (Summary)
3240 Execute auto refile.
3241 @findex wl-summary-auto-refile
3242 (@code{wl-summary-auto-refile})
3246 Put copy mark on the message at the current cursor point.
3247 @findex wl-summary-copy
3248 (@code{wl-summary-copy})
3251 @kindex M-o (Summary)
3252 Put refile mark on the message at the current cursor point with the destination
3253 previously specified.
3254 @findex wl-summary-refile-prev-destination
3255 (@code{wl-summary-refile-prev-destination})
3259 @findex wl-summary-delete
3260 Put delete mark on the message at the current cursor point.
3261 (@code{wl-summary-delete})
3265 @findex wl-summary-unmark
3266 Unmark the temporal mark on the message at the current cursor point.
3267 (@code{wl-summary-unmark})
3271 Unmark all the temporal marks.
3272 @findex wl-summary-unmark-all
3273 (@code{wl-summary-unmark-all})
3276 @kindex r R (Summary)
3277 @findex wl-summary-mark-as-read-region
3278 Mark as read messages in the specified region.
3279 (@code{wl-summary-mark-as-read-region})
3282 @kindex r $ (Summary)
3283 @findex wl-summary-mark-as-important-region
3284 Mark as important @samp{$} messages in the specified region.
3285 If @samp{$} already exists, it is deleted.
3286 (@code{wl-summary-mark-as-important-region})
3289 @kindex r ! (Summary)
3290 @findex wl-summary-mark-as-unread-region
3291 Mark as unread messages in the specified region.
3292 (@code{wl-summary-mark-as-unread-region})
3295 @kindex r i (Summary)
3296 @findex wl-summary-prefetch-region
3297 Prefetch messages in the specified region.
3298 (@code{wl-summary-prefetch-region})
3301 @kindex r x (Summary)
3302 @findex wl-summary-exec-region
3303 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3305 (@code{wl-summary-exec-region})
3308 @kindex r * (Summary)
3309 @findex wl-summary-target-mark-region
3310 Put target mark on the messages in the specified region.
3311 (@code{wl-summary-target-mark-region})
3314 @kindex r o (Summary)
3315 @findex wl-summary-refile-region
3316 Put refile mark on the messages in the specified region.
3317 (@code{wl-summary-refile-region})
3320 @kindex r O (Summary)
3321 @findex wl-summary-copy-region
3322 Put copy mark on the messages in the specified region.
3323 (@code{wl-summary-copy-region})
3326 @kindex r d (Summary)
3327 @findex wl-summary-delete-region
3328 Put delete mark on the messages in the specified region.
3329 (@code{wl-summary-delete-region})
3332 @kindex r u (Summary)
3333 @findex wl-summary-unmark-region
3334 Delete temporal mark on the messages in the specified region.
3335 (@code{wl-summary-unmark-region})
3338 @kindex r y (Summary)
3339 Save messages in the specified region.
3340 @findex wl-summary-save-region
3341 (@code{wl-summary-save-region})
3344 @kindex t R (Summary)
3345 @findex wl-thread-mark-as-read
3346 Mark as read messages which are the descendant of the current thread.
3347 With prefix argument, it affects on the all messages in the thread tree.
3348 (@code{wl-thread-mark-as-read})
3351 @kindex t $ (Summary)
3352 @findex wl-thread-mark-as-important
3353 Put important mark @samp{$} on the messages which are the
3354 descendant of the current thread.
3355 If @samp{$} mark exists, it is deleted.
3356 With prefix argument, it affects on the all messages in the thread tree.
3357 (@code{wl-thread-mark-as-important})
3360 @kindex t ! (Summary)
3361 @findex wl-thread-mark-as-unread
3362 Mark as unread messages which are the descendant of the current thread.
3363 With prefix argument, it affects on the all messages in the thread tree.
3364 (@code{wl-thread-mark-as-unread})
3367 @kindex t i (Summary)
3368 @findex wl-thread-prefetch
3369 Prefetch messages which are the descendant of the current thread.
3370 With prefix argument, it affects on the all messages in the thread tree.
3371 (@code{wl-thread-prefetch})
3374 @kindex t x (Summary)
3375 @findex wl-thread-exec
3376 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3377 the descendant of the current thread. With prefix argument, it affects
3378 on the all messages in the thread tree.
3379 (@code{wl-thread-exec})
3382 @kindex t * (Summary)
3383 @findex wl-thread-target-mark
3384 Put target mark @samp{*} on the messages which are the descendant of the
3385 current thread. With prefix argument, it affects on the all messages in
3387 (@code{wl-thread-target-mark})
3390 @kindex t o (Summary)
3391 @findex wl-thread-refile
3392 Put refile mark on the messages which are the descendant of the current thread.
3393 With prefix argument, it affects on the all messages in the thread tree.
3394 (@code{wl-thread-refile})
3397 @kindex t O (Summary)
3398 @findex wl-thread-copy
3399 Put copy mark on the messages which are the descendant of the current thread.
3400 With prefix argument, it affects on the all messages in the thread tree.
3401 (@code{wl-thread-copy})
3404 @kindex t d (Summary)
3405 @findex wl-thread-delete
3406 Put delete mar on the messages which are the descendant of the current thread.
3407 With prefix argument, it affects on the all messages in the thread tree.
3408 (@code{wl-thread-delete})
3411 @kindex t u (Summary)
3412 @findex wl-thread-unmark
3413 Unmark temporal mark on the messages which are the descendant of the
3414 current thread. With prefix argument, it affects on the all messages in
3416 (@code{wl-thread-unmark})
3419 @kindex t y (Summary)
3420 @findex wl-thread-save
3421 Save messages which are the descendant of the current thread.
3422 With prefix argument, it affects on the all messages in the thread tree.
3423 (@code{wl-thread-save})
3426 @kindex m i (Summary)
3427 @findex wl-summary-target-mark-prefetch
3428 Prefetch all messages which have target mark @samp{*}.
3429 With prefix argument, prefetch all targets even if some of them are cached.
3430 (@code{wl-summary-target-mark-prefetch})
3433 @kindex m R (Summary)
3434 @findex wl-summary-target-mark-mark-as-read
3435 Mark as read all messages which have target mark @samp{*}.
3436 (@code{wl-summary-target-mark-mark-as-read})
3439 @kindex m $ (Summary)
3440 @findex wl-summary-target-mark-mark-as-important
3441 Mark as important all messages which have target mark @samp{*}.
3442 If already marked as @samp{$}, it is deleted.
3443 (@code{wl-summary-target-mark-mark-as-important})
3446 @kindex m ! (Summary)
3447 @findex wl-summary-target-mark-mark-as-unread
3448 Mark as unread all messages which have target mark @samp{*}.
3449 (@code{wl-summary-target-mark-mark-as-unread})
3452 @kindex m o (Summary)
3453 @findex wl-summary-target-mark-refile
3454 Put refile mark on the messages which have target mark @samp{*}.
3455 (@code{wl-summary-target-mark-refile})
3458 @kindex m O (Summary)
3459 @findex wl-summary-target-mark-copy
3460 Put copy mark on the messages which have target mark @samp{*}.
3461 (@code{wl-summary-target-mark-copy})
3464 @kindex m d (Summary)
3465 @findex wl-summary-target-mark-delete
3466 Put delete mark on the messages which have target mark @samp{*}.
3467 (@code{wl-summary-target-mark-delete})
3470 @kindex m y (Summary)
3471 @findex wl-summary-target-mark-save
3472 Save messages which have target mark @samp{*}.
3473 (@code{wl-summary-target-mark-save})
3476 @kindex m u (Summary)
3477 Unmark all temporal marks.
3478 (@code{wl-summary-delete-all-temp-marks})
3479 @findex wl-summary-delete-all-temp-marks
3482 @kindex m a (Summary)
3483 Put target mark @samp{*} on the all messages.
3484 (@code{wl-summary-target-mark-all})
3485 @findex wl-summary-target-mark-all
3488 @kindex m t (Summary)
3489 Put target mark @samp{*} on the messages in the current thread.
3490 @findex wl-summary-target-mark-thread
3491 (@code{wl-summary-target-mark-thread})
3494 @kindex m r (Summary)
3495 @findex wl-summary-target-mark-region
3496 Put target mark @samp{*} on the messages in the specified region.
3497 (@code{wl-summary-target-mark-region})
3500 @kindex m A (Summary)
3501 @findex wl-summary-target-mark-reply-with-citation
3502 Prepare a draft which cites all messages which have target mark @samp{*}.
3503 (@code{wl-summary-target-mark-reply-with-citation})
3506 @kindex m f (Summary)
3507 @findex wl-summary-target-mark-forward
3508 Prepare a draft which forwards all messages which have target mark @samp{*}.
3509 (@code{wl-summary-target-mark-forward})
3512 @kindex m U (Summary)
3513 @findex wl-summary-target-mark-uudecode
3514 Uudecode the messages which have target mark @samp{*}.
3515 (@code{wl-summary-target-mark-uudecode})
3518 @kindex m ? (Summary)
3519 @findex wl-summary-target-mark-pick
3520 Pick messages from the @samp{*} marked messages.
3521 That is, @samp{*} marks on the messages are remained
3522 if the specified condition is satisfied.
3523 (@code{wl-summary-target-mark-pick})
3526 @kindex M-t (Summary)
3527 @findex wl-toggle-plugged
3528 Toggle offline/online status of Wanderlust.
3529 (@code{wl-toggle-plugged})
3532 @kindex C-t (Summary)
3533 Start Wanderlust's plug-status manager.
3534 (@code{wl-plugged-change})
3537 @kindex C-c C-o (Summary)
3538 @findex wl-jump-to-draft-buffer
3539 Move to the draft buffer if available. If multiple draft buffer exists,
3540 moved to one after another. If prefix argument is specified, load draft
3541 folder's message to the draft buffer and jump to it.
3542 (@code{wl-jump-to-draft-buffer})
3545 @kindex M-w (Summary)
3546 @findex wl-summary-save-current-message
3547 Save the message at the current cursor point.
3548 (@code{wl-summary-save-current-message})
3551 @kindex C-y (Summary)
3552 @findex wl-summary-yank-saved-message
3553 Regard the message at the current cursor point as
3554 parent, connect the message saved by
3555 @code{wl-summary-save-current-message}
3557 (@code{wl-summary-yank-saved-message})
3561 @node Variables of Summary, , Key Bindings of Summary, Summary
3562 @section Customiziable variables
3565 @item wl-summary-move-order
3566 @vindex wl-summary-move-order
3567 The initial setting is @code{unread}. Specify cursor moving policy. If
3568 you want to precede new messages, set @code{new}. If you want to
3569 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3572 @item wl-auto-select-first
3573 @vindex wl-auto-select-first
3574 The initial setting is @code{nil}.
3575 If non-nil, first message is automatically displayed.
3577 @item wl-auto-select-next
3578 @vindex wl-auto-select-next
3579 The initial setting is @code{nil}. This controls behavior when there is
3580 no unread message in current summary.
3583 nil: asks whether you want to go back to folder mode
3584 'unread: asks whether you want to go to next unread folder
3585 If the next one comes to be possessing no unread message
3586 by treatment of cross-posted messages or Scoring, then
3587 asks whether you want to go to next to next folder.
3588 'skip-no-unread: similar as unread
3589 But does not ask before going to next to next folder.
3590 otherwise: asks whether you want to go to next unread folder
3593 It might be useful to set @code{'skip-no-unread} for people who
3594 want to continue reading by just pressing and pressing space key.
3596 @item wl-thread-insert-opened
3597 @vindex wl-thread-insert-opened
3598 The initial setting is @code{nil}.
3599 If non-nil, thread is inserted as opened.
3601 @item wl-thread-open-reading-thread
3602 @vindex wl-thread-open-reading-thread
3603 The initial setting is @code{t}. If non-nil, reading thread is
3604 automatically opened though it is closed thread.
3606 @item wl-summary-exit-next-move
3607 @vindex wl-summary-exit-next-move
3608 The initial setting is @code{t}. If non-nil, move to next folder at
3611 @item wl-folder-move-cur-folder
3612 @vindex wl-folder-move-cur-folder
3613 The initial setting is @code{nil}. If non-nil, cursor position on the
3616 @item wl-summary-weekday-name-lang
3617 @vindex wl-summary-weekday-name-lang
3618 The initial setting is @samp{ja}. Specify language of the weekday.
3619 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3620 displays Deutsch. You should rescan summary view after changing this value.
3622 @item wl-summary-fix-timezone
3623 @vindex wl-summary-fix-timezone
3624 The initial setting is @code{nil}.
3625 Time zone of the date string in summary mode is adjusted using this value.
3626 If @code{nil}, it is adjust to the default time zone information
3627 (system's default time zone or environment variable @samp{TZ}).
3629 @item wl-use-petname
3630 @vindex wl-use-petname
3631 The initial setting is @code{t}.
3632 If non-nil, sender part displays nickname.
3634 @item wl-break-pages
3635 @vindex wl-break-pages
3636 The initial setting is @code{t}.
3637 If non-nil, message is split as pages by @samp{^L}.
3639 @item wl-message-window-size
3640 @vindex wl-message-window-size
3641 The initial setting is '(1 . 4).
3642 A cons cell to specify the rate of summary and message window.
3643 car:cdr corresponds summary:message.
3645 @item wl-summary-no-from-message
3646 @vindex wl-summary-no-from-message
3647 The initial setting is @samp{nobody@@nowhere?}. A string which is
3648 displayed when there's no @samp{From:} field in the message.
3650 @item wl-summary-no-subject-message
3651 @vindex wl-summary-no-subject-message
3652 The initial setting is @samp{(WL:No Subject in original.)}. A string
3653 which is displayed when there's no @samp{Subject:} field in the message.
3655 @item wl-summary-use-frame
3656 @vindex wl-summary-use-frame
3657 The initial setting is @code{nil}.
3658 If non-nil, use new frame for the summary.
3660 @item wl-use-folder-petname
3661 @vindex wl-use-folder-petname
3662 The initial setting is the list shown below:
3671 A list of display policy (symbol) of folder nickname. Available symbols
3676 Display folder petname on modeline.
3678 Destination folder is notified as nickname if
3679 @code{wl-auto-select-next} is non-nil.
3681 You can input folder name by nickname in the function
3682 @code{wl-summary-read-folder}.
3685 @item wl-summary-move-direction-toggle
3686 @vindex wl-summary-move-direction-toggle
3687 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3688 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3689 want to aware of reading direction, set this to @code{t}.
3691 @item wl-summary-width
3692 @vindex wl-summary-width
3693 The initial setting is 80.
3694 Width of summary line. If @code{nil}, summary line's width is as is.
3696 @item wl-summary-from-width
3697 @vindex wl-summary-from-width
3698 The initial setting is 17.
3699 Width of sender part of summary line.
3701 @item wl-summary-subject-length-limit
3702 @vindex wl-summary-subject-length-limit
3703 The initial setting is @code{nil}. Specify the limit for the length of
3704 subject parts in summary. @code{nil} means unlimited.
3706 @item wl-summary-indent-length-limit
3707 @vindex wl-summary-indent-length-limit
3708 The initial setting is 46.
3709 Specify the limit of thread indent level. @code{nil} means unlimited
3711 If you set this to @code{nil} you should set @code{wl-summary-width}
3714 @item wl-summary-recenter
3715 @vindex wl-summary-recenter
3716 The initial setting is t.
3717 If non-nil, cursor point is moved to the center of the summary window.
3719 @item wl-summary-divide-thread-when-subject-changed
3720 @vindex wl-summary-divide-thread-when-subject-changed
3721 The initial setting is @code{nil}. If non-nil, thread is split if
3722 the subject is changed.
3724 @item wl-summary-search-via-nntp
3725 @vindex wl-summary-search-via-nntp
3726 The initial setting is @code{confirm}.
3728 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3729 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3730 from the NNTP server @code{elmo-nntp-default-server}. The value of
3731 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3732 @code{elmo-nntp-default-stream-type} are used.
3734 If @code{confirm}, server name can be specified. You can specify NNTP
3735 folder format like @samp{-:username@@servername:119!}.
3737 @item wl-summary-keep-cursor-command
3738 @vindex wl-summary-keep-cursor-command
3739 The initial setting is the list shown below:
3743 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3748 When you entered to summary by these commands and the target summary
3749 buffer already exists, summary status is not automatically updated and
3750 cursor position is saved.
3752 @item elmo-folder-update-threshold
3753 @vindex elmo-folder-update-threshold
3754 The initial setting is 500. If updated message number is larger than
3755 this value, confirm whether drop them or not (in the case where the value
3756 of @code{elmo-folder-update-confirm} is non-nil).
3758 @item elmo-folder-update-confirm
3759 @vindex elmo-folder-update-confirm
3760 The initial setting is @code{t}. If the value is non-nil, do check with
3761 @code{elmo-folder-update-threshold}.
3763 @item wl-summary-always-sticky-folder-list
3764 @vindex wl-summary-always-sticky-folder-list
3765 The initial setting is @code{nil}.
3766 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3767 are automatically stuck. Each element is regexp of folder name.
3769 @item wl-summary-reserve-mark-list
3770 @vindex wl-summary-reserve-mark-list
3771 The initial setting is the list shown below:
3780 If a message is already marked as temporal marks in this list, the
3781 message is not marked by any mark command.
3783 @item wl-summary-skip-mark-list
3784 @vindex wl-summary-skip-mark-list
3785 The initial setting is the list shown below:
3794 If a message is already marked as temporal marks in this list, the
3795 message is skipped at cursor move.
3797 @item elmo-message-fetch-threshold
3798 @vindex elmo-message-fetch-threshold
3799 The initial setting is 30000 (bytes). If displaying message has larger
3800 size than this value, Wanderlust confirms whether fetch the message or
3801 not (in the case where the value of @code{elmo-message-fetch-confirm}
3804 @item elmo-message-fetch-confirm
3805 @vindex elmo-message-fetch-confirm
3806 The initial setting is @code{t}. If the value is non-nil, do check with
3807 @code{elmo-message-fetch-threshold}.
3809 @item wl-prefetch-threshold
3810 @vindex wl-prefetch-threshold
3811 The initial setting is 30000 (bytes). If prefetching message has larger
3812 size than this value and @code{wl-prefetch-confirm} is non-nil,
3813 Wanderlust confirms whether prefetch the message or not. If
3814 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3815 without confirmation.
3817 @item wl-prefetch-confirm
3818 @vindex wl-prefetch-confirm
3819 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3820 prefetch the message or not if the message has larger size than
3821 @code{wl-prefetch-threshold}.
3823 @item elmo-imap4-use-cache
3824 @vindex elmo-imap4-use-cache
3825 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3828 @item elmo-nntp-use-cache
3829 @vindex elmo-nntp-use-cache
3830 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3833 @item elmo-pop3-use-cache
3834 @vindex elmo-pop3-use-cache
3835 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3838 @item elmo-shimbun-use-cache
3839 @vindex elmo-shimbun-use-cache
3840 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3843 @item wl-folder-process-duplicates-alist
3844 @vindex wl-folder-process-duplicates-alist
3845 The initial setting is @code{nil}.
3846 This list determines how to deal with duplicated messages in the same folder.
3847 Each item in the list is regexp of folder name and action; you can specify any
3848 one of the following in the place of action:
3851 @code{nil} : do nothing for duplicated messages.
3852 @code{hide} : hide duplicated messages from the summary.
3853 @code{read} : set duplicated messages as read.
3857 Following is an example (hide duplicated messages in multi folders)
3861 (setq wl-folder-process-duplicates-alist
3862 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3863 ("^\\*.*" . hide) (".*" . read)))
3869 @node Message, Draft, Summary, Top
3870 @chapter Message Buffer
3872 Message Buffers utilize MIME-View mode of SEMI. For operational
3873 procedures and key bindings, refer to respective documents.
3874 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3875 You can also see help by @kbd{?} in message buffer.
3877 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3878 brings you back to Summary mode. @kbd{l} toggles display of Summary
3881 @section Key Bindings
3887 @findex wl-message-toggle-disp-summary
3888 Toggles display of Summary mode buffer.
3889 (@code{wl-message-toggle-disp-summary})
3892 @findex wl-message-refer-article-or-url
3893 @kindex Button-2 (Message)
3894 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3895 corresponding message if found.
3896 (@code{wl-message-refer-article-or-url})
3898 @item Button-4 (upward movement of a wheel)
3899 @kindex Button-4 (Message)
3900 @findex wl-message-wheel-down
3901 Scrolls the message backwards. When the top of the message is hit,
3902 moves to the previous message.
3903 (@code{wl-message-wheel-down})
3905 @item Button-5 (downward movement of a wheel)
3906 @kindex Button-5 (Message)
3907 @findex wl-message-wheel-up
3908 Scrolls the message forward. When the bottom of the message is hit,
3909 moves to the next message.
3910 (@code{wl-message-wheel-up})
3913 @section Customizable Variables
3916 @item wl-message-window-size
3917 @vindex wl-message-window-size
3918 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3919 its car and cdr value corresponds to the ratio of Summary and Message
3922 @item wl-message-ignored-field-list
3923 @vindex wl-message-ignored-field-list
3924 (SEMI only) Initial setting is @code{nil}.
3925 All fields that match this list will be hidden in message buffer.
3926 Each elements are regexp of field-name.
3927 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3929 @item wl-message-visible-field-list
3930 @vindex wl-message-visible-field-list
3931 (SEMI only) Initial setting is @code{nil}.
3932 All fields that match this list will be display in message buffer.
3933 Each elements are regexp of field-name. This value precedes
3934 @code{wl-message-ignored-field-list}.
3935 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3937 @item wl-message-sort-field-list
3938 @vindex wl-message-sort-field-list
3939 (SEMI only) Initial setting is
3940 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3941 Header fields in message buffer are ordered by this value.
3942 Each elements are regexp of field-name.
3944 @item wl-message-truncate-lines
3945 @vindex wl-message-truncate-lines
3946 The initial value is the value of @code{default-truncate-lines}.
3947 If it is non-nil, truncate long lines in message buffer.
3950 @node Draft, Disconnected Operations, Message, Top
3951 @chapter Draft Buffer
3953 At Summary mode, pressing @kbd{w} and the like creates a new draft
3954 buffer. You can edit and send mail and news articles in this buffer.
3958 Basically it is Emacs-standard mail mode.
3960 @subsection Address Completion
3962 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3963 addresses. @kbd{@key{TAB}} completes them.
3965 If you want to submit a news article, add @samp{Newsgroups:} field by
3966 yourself. Field names can be completed by @kbd{@key{TAB}}.
3968 If you save the draft buffer you are editing, it is appended to the
3969 folder specified by @code{wl-draft-folder}.
3971 Using @samp{FCC:} field, you can specify the folder to which a copy of
3972 the message is saved when it is sent.
3974 @subsection Editing Messages
3976 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
3977 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
3978 a MIME user interface for GNU Emacs}.
3979 You can also see help by @kbd{C-c C-x ?} in draft buffer.
3981 @subsection Dynamic Modification of Messages
3982 @vindex wl-draft-config-alist
3983 @c @cindex Change Message
3984 @c @cindex Message, Change Dynamic
3986 You can set @code{wl-draft-config-alist} so that header and body of the
3987 message will automatically modified depending on information of header
3990 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3992 In the example below, the header is modified when
3993 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3994 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3995 before sending the message.
3999 (setq wl-draft-config-alist
4000 '(((string-match "aaa\\.example\\.com$" (system-name))
4001 ;; @r{applied if the expression is non-nil}
4002 (wl-smtp-posting-server . "mailserver-B")
4003 (wl-nntp-posting-server . "newsserver-B")
4004 ;; @r{settings of temporary variables}
4006 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4007 ;; @r{applied if it matches the header of the draft buffer}
4008 ("Organization" . (format "Go %s" my-webpage)))
4009 ;; @r{you can write elisp expressions here (eval only)}
4010 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4011 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4016 The format of @code{wl-draft-config-alist} is:
4020 '(("@var{regexp of the header}" or @var{elisp expression}
4021 ("@var{Field}" . value(@var{elisp expression}))
4022 (@var{variable} . value(@var{elisp expression}))
4023 (@var{sub-function} . value(@var{elisp expression}))
4026 ("@var{regexp of the header}" or @var{elisp expression}
4027 ("@var{Field}" . value(@var{elisp expression}))
4032 Per default, there are 10 following sub-functions.
4035 'header: Inserts the specified string at the bottom of the header.
4036 'header-top: Inserts the specified string at the top of the header.
4037 'header-file: Inserts the specified file at the bottom of the header.
4038 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4039 'top: Inserts the specified string at the top of the body.
4040 'top-file: Inserts the specified file at the top of the body.
4041 'body: Replaces the body with the specified string.
4042 Specifying @code{nil} deletes the entire body string.
4043 'body-file: Replaces the body with the content of the specified file.
4044 'bottom: Inserts the specified string at the bottom of the body.
4045 'bottom-file: Inserts the specified file at the top of the body.
4046 'part-top: Inserts the specified string at the top of the current part.
4047 'part-bottom: Inserts the specified string at the bottom of the current part.
4048 'template: Applies the specified template.
4049 (refer to the next subsection)
4052 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4053 change them or add your own functions. If you read the code, you can
4054 easily find how to write the functions.
4056 At the first of each item, @var{a regular expression of the header} or
4057 an @var{elisp expression} should be specified. In the case of an elisp
4058 expression, the item is applied when the expression is evaluated
4061 Per default, when multiple items match or are evaluated non-nil, all
4062 such items are applied, but if you set a variable
4063 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4066 At the second of the item, a cons or a list of functions should be
4067 specified. The car part of the cons should be a header field, a
4068 variable, or a sub-function. When a header field is specified, the
4069 field will be modified. If a variable is specified, the value of the
4070 variable will be modified temporarily.
4072 In the cdr part of a cons, not only a variable but also an elisp
4073 expression can be specified as is. If the car part is a header field
4074 and the cdr part is @code{nil}, the field will be deleted.
4076 If you want to use name of parent folder, you can refer the buffer local
4077 variable @code{wl-draft-parent-folder}.
4079 See the next example as well:
4083 (setq wl-draft-config-alist
4085 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4086 ;; @r{applied if it matches the header of the buffer being replied}
4087 (body . " Hello.\n")
4088 (template . "default")
4093 As in the (1) above, if a header regexp is prepended with @code{reply},
4094 it is applied when the draft is prepared by @code{wl-summary-reply} for
4095 example, and when it matches the header being replied. It is ignored
4096 when there is no buffer being replied, like after @code{wl-draft} was
4099 Note that @code{wl-draft-config-alist} is applied only once when
4100 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4101 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4102 aborting transmission, execute @kbd{C-c C-e}
4103 (@code{wl-draft-config-exec}) explicitly.
4105 If you don't want to apply @code{wl-draft-config-alist} when
4106 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4110 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4113 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4114 prepared, do the following:
4117 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4120 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4121 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4125 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4128 @subsection Inserting Templates
4130 @cindex Apply Template
4132 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4133 @kbd{M-x wl-template-select} in the draft buffer.
4135 The format of @code{wl-template-alist} is almost the same as
4136 @code{wl-draft-config-alist}.
4140 (setq wl-template-alist
4143 ("Organization" . "Example Co.Ltd.")
4144 (body . "Hello.\n"))
4146 (template . "default") ;; @r{(a)}
4147 ("To" . "boss@@example.com")
4148 ("Subject" . "Report")
4149 (body-file . "~/work/report.txt")
4155 As you can see, the only difference is item (template) names such as
4156 @samp{default} and @samp{report}, instead of a regexp of header.
4157 Because definition of each item is the same as
4158 @code{wl-draft-config-alist}, you can call another template, like (a).
4160 Executing the command @code{wl-template-select} results in template
4161 selection, but the result differs depending on variable
4162 @code{wl-template-visible-select}.
4164 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4165 window is shown below the draft buffer. You can select a template by
4166 @kbd{n} and @kbd{p} seeing the buffer window.
4168 Press the @key{RET} key and the template is actually applied to the draft
4169 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4170 adjust the window size by @code{wl-template-buffer-lines}.
4172 If @code{wl-template-visible-select} is @code{nil}, you should type the
4173 name of the template in the mini buffer.
4175 As shown in the example in @code{wl-draft-config-alist}, you can select
4176 @samp{default} template by writing:
4179 (template . "default")
4182 @subsection Sending mail by POP-before-SMTP
4183 @cindex POP-before-SMTP
4185 You can send mail by POP-before-SMTP with this single line:
4188 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4192 Configure the following variables if you need.
4195 @item wl-pop-before-smtp-user
4196 The POP user name for POP-before-SMTP authentication.
4197 If unset, @code{elmo-pop3-default-user} is used.
4199 @item wl-pop-before-smtp-server
4200 The POP server name for POP-before-SMTP authentication.
4201 If unset, @code{elmo-pop3-default-server} is used.
4203 @item wl-pop-before-smtp-authenticate-type
4204 The POP authentication method for POP-before-SMTP authentication.
4205 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4207 @item wl-pop-before-smtp-port
4208 The POP port number for POP-before-SMTP authentication.
4209 If unset, @code{elmo-pop3-default-port} is used.
4211 @item wl-pop-before-smtp-stream-type
4212 If non-nil, POP connection is established using SSL. If
4213 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4214 unset, @code{elmo-pop3-default-stream-type} is used.
4217 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4218 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4220 Therefore, if SMTP server and POP server are actually the same, and if
4221 POP folder per default (such as @samp{&}) is available, no settings are
4224 Refer to the following URL about POP-before-SMTP.
4228 http://spam.ayamura.org/tools/smPbS.html
4229 http://www.iecc.com/pop-before-smtp.html
4233 @section Key Bindings
4234 @cindex Keybind, Draft Mode
4235 @cindex Keybind, Draft Buffer
4240 @kindex C-c C-y (Draft)
4241 @findex wl-draft-yank-original
4242 Cites the content of the current message buffer.
4243 (@code{wl-draft-yank-original})
4246 @kindex C-c C-p (Draft)
4247 @findex wl-draft-preview-message
4248 Previews the content of the current draft.
4249 This is useful for previewing MIME multi-part messages.
4250 (@code{wl-draft-preview-message})
4253 @kindex C-c C-s (Draft)
4254 @findex wl-draft-send
4255 Sends the content of the current draft. Does not erase the draft buffer.
4256 This is useful for sending multiple messages, which are a little different
4258 (@code{wl-draft-send})
4261 @kindex C-c C-c (Draft)
4262 @findex wl-draft-send-and-exit
4263 Sends the content of the current draft and erases the draft buffer.
4264 (@code{wl-draft-send-and-exit})
4267 @kindex C-x C-s (Draft)
4268 @findex wl-draft-save
4269 Save the current draft.
4270 (@code{wl-draft-save})
4273 @kindex C-c C-k (Draft)
4274 @findex wl-draft-kill
4275 Kills the current draft.
4276 (@code{wl-draft-kill})
4279 @kindex C-x k (Draft)
4280 @findex wl-draft-mimic-kill-buffer
4281 Kills the current draft.
4282 (@code{wl-draft-mimic-kill-buffer})
4285 @kindex C-c C-z (Draft)
4286 @findex wl-draft-save-and-exit
4287 Saves the current draft, and erases the draft buffer.
4288 This is useful if you want to suspend editing of the draft.
4289 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4290 the @samp{+draft} folder.
4291 (@code{wl-draft-save-and-exit})
4294 @kindex C-c C-r (Draft)
4295 @findex wl-caesar-region
4296 Encodes or decodes the specified region in Caesar cipher.
4297 (@code{wl-caesar-region})
4301 @findex wl-draft-highlight-and-recenter
4302 Recenter and rehighlight current draft.
4303 (@code{wl-draft-highlight-and-recenter})
4307 @findex wl-toggle-plugged
4308 Toggles off-line/on-line states of Wanderlust.
4309 (@code{wl-toggle-plugged})
4312 @kindex C-c C-o (Draft)
4313 @findex wl-jump-to-draft-buffer
4314 Jumps to the other draft buffer, if exists.
4315 With prefix argument, reads a file (if any) from the draft folder when
4316 there is no such buffer.
4317 (@code{wl-jump-to-draft-buffer})
4320 @kindex C-c C-e (Draft)
4321 @findex wl-draft-config-exec
4322 Applies @code{wl-draft-config-alist}.
4323 (@code{wl-draft-config-exec})
4326 @kindex C-c C-j (Draft)
4327 @findex wl-template-select
4329 (@code{wl-template-select})
4332 @kindex C-c C-a (Draft)
4334 Enter Address Manager.
4335 @xref{Address Manager}.
4339 @kindex C-c C-d (Draft)
4340 @findex wl-draft-elide-region
4341 Elide the text between point and mark (@code{wl-draft-elide-region}).
4342 The text is killed and replaced with the contents of the variable
4343 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4347 @section Customizable Variables
4350 @item wl-subscribed-mailing-list
4351 @vindex wl-subscribed-mailing-list
4352 The initial setting is @code{nil}. Mailing lists to which you
4353 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4354 field of a reply draft, removes your own address from
4355 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4356 contained in @samp{To:} or @samp{Cc:} field of a message to be
4357 automatically re-filed, the destination folder will be leaned in
4358 connection with the address.
4364 (setq wl-subscribed-mailing-list
4365 '("wl@@lists.airs.net"
4367 "emacs-mime-ja@@m17n.org"))
4371 @item wl-insert-mail-followup-to
4372 @vindex wl-insert-mail-followup-to
4373 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4374 field is automatically inserted in the draft buffer.
4376 @item wl-insert-mail-reply-to
4377 @vindex wl-insert-mail-reply-to
4378 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4379 field is automatically inserted in the draft buffer.
4381 @item wl-auto-insert-x-face
4382 @vindex wl-auto-insert-x-face
4383 The initial setting is @code{t}. If non-nil and there is an encoded
4384 X-Face string in a file @file{~/.xface} (the value of the variable
4385 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4386 draft buffer. If @code{nil}, it is not automatically inserted.
4388 @item wl-insert-message-id
4389 @vindex wl-insert-message-id
4390 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4391 is automatically inserted on the transmission.
4393 @item wl-message-id-use-wl-from
4394 @vindex wl-message-id-use-wl-from
4395 The initial setting is @code{nil}. If non-nil, the value of
4396 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4398 @item wl-local-domain
4399 @vindex wl-local-domain
4400 The initial setting is @code{nil}. If @code{nil}, the return value of
4401 the function @code{system-name} will be used as the domain part of
4404 If @code{system-name} does not return FQDN (i.e. the full name of the
4405 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4406 to the string of the local domain name without hostname (like
4407 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4408 @samp{.} @code{wl-local-domain} is used as domain part of the
4411 If your terminal does not have global IP, set the value of
4412 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4413 you use invalid @samp{Message-ID:}.)
4415 Moreover, concatenation of @code{system-name} @samp{.}
4416 @code{wl-local-domain} will be used as an argument to the HELO command
4419 @item wl-message-id-domain
4420 @vindex wl-message-id-domain
4421 The initial setting is @code{nil}. If non-nil, this value is used as a
4422 domain part of the @samp{Message-ID:}. If your terminal does not have
4423 global IP address, set unique string to this value (e.x. your e-mail
4426 @item wl-unique-id-suffix
4427 @vindex wl-unique-id-suffix
4428 The initial setting is @samp{.wl}. You can specify the string in generated
4429 Message-ID which appear just before @samp{@@}.
4431 @item wl-draft-config-alist
4432 @vindex wl-draft-config-alist
4433 The initial setting is @code{nil}. Modifies the draft message just
4434 before the transmission. The content of @code{wl-draft-config-alist}
4435 will be automatically applied only once on the transmission. If you
4436 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4439 @item wl-template-alist
4440 @vindex wl-template-alist
4441 The initial setting is @code{nil}.
4442 This variable specifies the template to be applied in the draft buffer.
4444 @item wl-draft-config-matchone
4445 @vindex wl-draft-config-matchone
4446 The initial setting is @code{nil}. If non-nil, only the first matching
4447 item is used when @code{wl-draft-config-alist} is applied. If
4448 @code{nil}, all matching items are used.
4450 @item wl-template-visible-select
4451 @vindex wl-template-visible-select
4452 The initial setting is @code{t}.
4453 If non-nil, you can preview the result of the template selection in
4456 @item wl-template-confirm
4457 @vindex wl-template-confirm
4458 The initial setting is @code{nil}.
4459 If non-nil, asks for confirmation when you press the enter key to select
4460 template while previewing.
4462 @item wl-template-buffer-lines
4463 @vindex wl-template-buffer-lines
4464 The initial setting is 7.
4465 If @code{wl-template-visible-select} is non-nil, this variable specifies
4466 the size of the preview window.
4468 @item wl-draft-reply-buffer-style
4469 @vindex wl-draft-reply-buffer-style
4470 The initial setting is @code{split}. @code{split} or @code{full} can be
4471 specified. In the case of @code{full}, the whole frame will be used for
4472 a reply draft buffer when it is prepared.
4474 @item wl-draft-use-frame
4475 @vindex wl-draft-use-frame
4476 The initial setting is @code{nil}.
4477 If non-nil, use new frame for the draft.
4479 @item wl-draft-truncate-lines
4480 @vindex wl-draft-truncate-lines
4481 The initial value is the value of @code{default-truncate-lines}.
4482 If it is non-nil, truncate long lines in draft buffer.
4486 The initial setting is the value of the variable
4487 @code{user-mail-address}. The value of this variable is inserted as a
4488 @samp{From:} field of the draft when it is prepared.
4490 @item wl-envelope-from
4491 @vindex wl-envelope-from
4492 The initial setting is @code{nil}.
4493 The value of this variable is used for envelope from (MAIL FROM).
4494 If @code{nil}, the address part of @code{wl-from} is used.
4496 @item wl-user-mail-address-list
4497 @vindex wl-user-mail-address-list
4498 The initial setting is @code{nil}.
4499 This is the User's address list. If you have multiple addresses,
4504 The initial setting is @code{nil}.
4505 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4506 the draft when it is prepared. If function is specified, its return
4511 The initial setting is @code{nil}.
4512 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4513 the draft when it is prepared.
4515 @item wl-reply-subject-prefix
4516 @vindex wl-reply-subject-prefix
4517 The initial setting is @samp{Re: }.
4518 In the @samp{Subject:} of the reply draft, this string is prepended to
4519 the @samp{Subject:} of being replied.
4521 @item wl-draft-reply-use-address-with-full-name
4522 @vindex wl-draft-reply-use-address-with-full-name
4523 The initial setting is @code{t}.
4524 If non-nil, insert her full name with address when prepare a draft for
4525 reply a message. If it is @code{nil}, insert her address only.
4527 @item wl-draft-enable-queuing
4528 @vindex wl-draft-enable-queuing
4529 The initial setting is @code{t}.
4530 This flag controls off-line transmission. If non-nil, the draft is
4533 @item wl-draft-use-cache
4534 @vindex wl-draft-use-cache
4535 The initial setting is @code{nil}. If the value is non-nil and
4536 @code{wl-insert-message-id} is nil, cache the message which is sent.
4538 @item wl-fcc-force-as-read
4539 @vindex wl-fcc-force-as-read
4540 The initial setting is @code{nil}. If the value is non-nil,
4541 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4543 @item wl-auto-flush-queue
4544 @vindex wl-auto-flush-queue
4545 The initial setting is t.
4546 This flag controls automatic transmission of the queue when Wanderlust
4547 becomes on-line. If non-nil, the queue is automatically transmitted
4548 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4549 manually, press @kbd{F} in the folder mode.
4551 @item wl-ignored-forwarded-headers
4552 @vindex wl-ignored-forwarded-headers
4553 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4554 All headers that match this regexp will be deleted when forwarding a message.
4556 @item wl-ignored-resent-headers
4557 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4558 All headers that match this regexp will be deleted when resending a message.
4560 @item wl-draft-always-delete-myself
4561 @vindex wl-draft-always-delete-myself
4562 If non-nil, always removes your own address from @samp{To:} and
4563 @samp{Cc:} when you are replying to the mail addressed to you.
4565 @item wl-draft-delete-myself-from-bcc-fcc
4566 @vindex wl-draft-delete-myself-from-bcc-fcc
4567 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4568 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4570 @item wl-smtp-posting-server
4571 @vindex wl-smtp-posting-server
4572 The initial setting is @code{nil}.
4573 This is the SMTP server name for mail transmission.
4575 @item wl-smtp-posting-user
4576 @vindex wl-smtp-posting-user
4577 The initial setting is @code{nil}.
4578 This is the user name for SMTP AUTH authentication. If @code{nil},
4579 @code{smtp-authenticate-user} is used.
4581 @item wl-smtp-authenticate-type
4582 @vindex wl-smtp-authenticate-type
4583 The initial setting is @code{nil}.
4584 This is the authentication method for SMTP AUTH authentication. If
4585 @code{nil}, @code{smtp-authenticate-type} is used. If
4586 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4589 @item wl-smtp-connection-type
4590 @vindex wl-smtp-connection-type
4591 The initial setting is @code{nil}.
4592 This variable specifies how to establish SMTP connections.
4593 If @code{nil}, @code{smtp-connection-type} is used.
4594 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4596 @item wl-nntp-posting-server
4597 @vindex wl-nntp-posting-server
4598 The initial setting is @code{nil}.
4599 This is the NNTP server name used for news submission.
4600 If @code{nil}, @code{elmo-nntp-default-server} is used.
4602 @item wl-nntp-posting-user
4603 @vindex wl-nntp-posting-user
4604 The initial setting is @code{nil}.
4605 This is the user name for AUTHINFO authentication on news submission.
4606 If @code{nil}, @code{elmo-nntp-default-user} is used.
4607 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4609 @item wl-nntp-posting-port
4610 @vindex wl-nntp-posting-port
4611 The initial setting is @code{nil}.
4612 This is the port number of the NNTP server used for news submission.
4613 If @code{nil}, @code{elmo-nntp-default-server} is used.
4615 @item wl-nntp-posting-stream-type
4616 @vindex wl-nntp-posting-stream-type
4617 The initial setting is @code{nil}.
4618 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4619 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4620 connection will be established.
4622 @item wl-pop-before-smtp-user
4623 @vindex wl-pop-before-smtp-user
4624 The initial setting is @code{nil}.
4625 This is the POP user name for POP-before-SMTP.
4626 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4628 @item wl-pop-before-smtp-server
4629 @vindex wl-pop-before-smtp-server
4630 The initial setting is @code{nil}.
4631 This is the POP server name for POP-before-SMTP.
4632 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4634 @item wl-pop-before-smtp-authenticate-type
4635 @vindex wl-pop-before-smtp-authenticate-type
4636 The initial setting is @code{nil}.
4637 This is the authentication method for POP-before-SMTP authentication.
4638 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4640 @item wl-pop-before-smtp-port
4641 @vindex wl-pop-before-smtp-port
4642 The initial setting is @code{nil}.
4643 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4644 @code{elmo-pop3-default-port} is used.
4646 @item wl-pop-before-smtp-stream-type
4647 @vindex wl-pop-before-smtp-stream-type
4648 The initial setting is @code{nil}.
4649 This flag controls the use of SSL for POP-before-SMTP. If it is
4650 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4651 STARTTLS (RFC2595) connection will be established.
4653 @item wl-draft-queue-save-variables
4654 @vindex wl-draft-queue-save-variables
4655 Specifies a list of variable to which queued messages are saved on the
4656 off-line transmission.
4658 @item wl-draft-sendlog
4659 @vindex wl-draft-sendlog
4660 The initial setting is @code{t}.
4661 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4665 @item drafts are sent by smtp or qmail
4666 @item saved into folders by fcc
4667 @item saved into folders by queuing
4670 (it is written even if the transmission fails).
4671 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4672 and left to the logging function of @command{imput}.
4675 @item wl-draft-sendlog-max-size
4676 @vindex wl-draft-sendlog-max-size
4677 The initial setting is 20000 (in bytes).
4678 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4679 beyond the size specified by this variable.
4683 The initial setting is @code{nil}.
4684 If non-nil, address completion uses LDAP.
4686 @item wl-ldap-server
4687 @vindex wl-ldap-server
4688 The initial setting is @samp{localhost}.
4689 LDAP server name for address completion.
4692 @vindex wl-ldap-port
4693 The initial setting is @code{nil}.
4694 If non-nil, the value is used as port number.
4697 @vindex wl-ldap-base
4698 The initial setting is @samp{c=US}.
4699 LDAP search starting point (base) for address completion.
4701 @item wl-draft-remove-group-list-contents
4702 @vindex wl-draft-remove-group-list-contents
4703 The initial setting is @code{t}.
4704 If non-nil, remove the group-lists' members in the recipients when
4705 sending the message (group-list means the description such as
4706 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4709 @node Disconnected Operations, Expire and Archive, Draft, Top
4710 @chapter Off-line Management
4711 @cindex Disconnected Operations
4713 Wanderlust has on-line and off-line states.
4716 * Off-line State:: Wanderlust has on-line and off-line states
4717 * Enable Operations:: Enable Disconnected Operations
4718 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4719 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4720 * Variables of Plugged Mode:: Customize Plugged Mode
4724 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4725 @section Off-line State
4727 Wanderlust has on-line and off-line states. In the off-line state, you
4728 cannot access messages via network, unless they are cached.
4730 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4731 in the mode line indicates the off-line state. In folder or summary
4732 modes, press @kbd{M-t} to switch between off- and on-line.
4734 You can invoke Wanderlust in the off-line state by setting
4735 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4737 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4738 ignores uncached messages.
4741 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4742 @section Enable Disconeected Operations
4744 Even in the off-line state, provided that relevant messages are cached,
4745 and the variable @code{elmo-enable-disconnected-operation} (described
4746 later) is non-nil, you can following operations:
4747 @xref{Plugged Mode}, @xref{Off-line State settings}.
4750 * Send Messages off-line:: Transmit Messages
4751 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4752 * Creation of Folders:: Create Folders off-line (IMAP4)
4753 * Marking:: Mark (IMAP4)
4754 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4757 As soon as Wanderlust becomes on-line, such operations invoked off-line
4758 are reflected in the servers via network.
4761 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4762 @subsection Transmission of Messages
4764 You can send mail/news messages off-line (if you are using
4765 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4766 accumulated in the queue folder, @samp{+queue}. These messages are
4767 transmitted at once when Wanderlust becomes on-line.
4769 You can visit @samp{+queue} in the off-line state and confirm content of
4770 messages in the queue. You can also remove messages. Removed messages
4771 are not transmitted even in the on-line state.
4774 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4775 @subsection Re-file and Copy (IMAP4)
4777 Re-file and copy operations to IMAP folders invoked during the off-line
4778 state are accumulated in the queue, and reflected in the server side
4779 when Wanderlust becomes on-line. If you visit destination folders after
4780 off-line re-file or copy, it looks as if messages were appended even in
4783 For the safety reasons, messages re-filed off-line are removed from
4784 source folders only if their @samp{Message-ID:} match messages on the
4785 servers. While the queue is processed, messages that failed to be
4786 re-filed or copied to the specified folders are appended to the folder
4790 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4791 @subsection Creation of Folders (IMAP4)
4793 You can create IMAP folders off-line. The creation of folders are
4794 reflected in the servers when Wanderlust becomes on-line. At that time,
4795 if folders failed to be created on the servers for any reasons, messages
4796 re-filed to such folders are appended to the folder @samp{+lost+found}.
4799 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4800 @subsection Marking (IMAP4)
4802 Off-line changes in unread/read and importance mark @samp{$} information
4803 are also reflected in the servers when Wanderlust becomes on-line.
4806 @node Pre-fetching Reservations, , Marking, Enable Operations
4807 @subsection Pre-fetching (IMAP4, NNTP)
4809 You can make reservations for pre-fetching messages in IMAP or NNTP
4810 folders. Reserved messages are marked with @samp{!} but not cached
4811 yet. When Wanderlust becomes on-line, they are pre-fetched from
4814 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4815 these off-line operations for IMAP4 and NNTP do not take place, and
4816 off-line re-file, copy or suchlike simply results in error.
4818 Because off-line operations use cache files, it is a bad idea to erase
4819 them by hand; it may cause Wanderlust to malfunction.
4821 If you want to remove caches, be sure to execute @kbd{M-x
4822 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4823 remove caches for messages relevant to off-line operations.
4826 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4827 @section Switching On-line/Off-line per Server/Port
4829 @kbd{M-t} described above switches networking states as a whole, but you
4830 can switch on-line/off-line per server/port.
4832 Pressing @kbd{C-t} in the folder or summary modes brings you in
4833 wl-plugged-mode shown below, in which you can change the plugged state
4838 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4841 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4842 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4844 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4845 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4851 The first line indicates status of the following three variables, and
4852 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4853 column modifies the values of these variables.
4857 "Queuing" @code{wl-draft-enable-queuing}
4858 "AutoFlushQueue" @code{wl-auto-flush-queue}
4859 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4863 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4866 The second and after lines indicate on-line/off-line states of servers
4867 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4868 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4869 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4871 @dfn{sending queue} means messages accumulated in the folder
4872 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4873 off-line operations when @code{elmo-enable-disconnected-operation} is
4875 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4876 @c off-line operations are enabled.
4878 They are displayed if there are any of them. In the example above, in
4879 the sending queue there are two messages (the first and the second in
4880 the queue folder) for smtp to hosta and one (the third) for nntp to
4881 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4884 If you change @samp{(wl-plugged)} in the second line, the variable
4885 @code{wl-plugged} is changed, so that the mode line indicator and
4886 plugged states of all ports are affected. If you change plugged states
4887 of any servers or ports, @samp{(wl-plugged)} in the second line is
4888 affected depending on @code{elmo-plugged-condition} settings and the
4889 plugged state of each port.
4892 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4893 @section Invoking Wanderlust in the Off-line State
4895 As described before, if you set @code{wl-plugged} to @code{nil} in
4896 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4897 off-line state. You can specify off-line state on a per server or port
4898 basis. Refer to @code{wl-reset-plugged-alist} also.
4900 Usually, when Wanderlust starts up, the plugged state of each port is
4901 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4902 @code{wl-nntp-posting-server} and so on. If you want to change the
4903 plugged state of these ports or to add other ports, configure
4904 @code{wl-make-plugged-hook} with a function.
4908 (add-hook 'wl-make-plugged-hook
4910 (elmo-set-plugged plugged-value(t/nil) server port)
4911 ;; @r{add or change plugged states of the port of the server}
4912 (elmo-set-plugged plugged-value(t/nil) server)
4913 ;; @r{if the port is omitted, all ports are affected}
4914 ;; @r{(you cannot omit the port if you newly add the server)}
4920 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4921 @section Customizable Variables
4926 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4927 mode from the beginning.
4929 @item wl-queue-folder
4930 @vindex wl-queue-folder
4931 The initial setting is @samp{+queue}.
4932 This is the folder in which messages in the transmission queue are
4935 @item wl-auto-flush-queue
4936 @vindex wl-auto-flush-queue
4937 The initial setting is @code{t}.
4938 This flag controls automatic transmission of the queue when Wanderlust
4939 becomes on-line. If non-nil, the queue is automatically transmitted
4940 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4941 manually, press @kbd{F} in the folder mode.
4943 @item elmo-enable-disconnected-operation
4944 @vindex elmo-enable-disconnected-operation
4945 The initial setting is @code{nil}. Controls off-line operations
4946 regarding IMAP4. If non-nil, off-line operations are carried out.
4948 @item elmo-lost+found-folder
4949 @vindex elmo-lost+found-folder
4950 The initial setting is @samp{+lost+found}.
4951 This is the folder to which messages are saved when they fails to be
4952 appended while the off-line re-file/copy queue is processed.
4954 @item elmo-plugged-condition
4955 @vindex elmo-plugged-condition
4956 The initial setting is @code{one}.
4957 The value of @code{wl-plugged} reflects the return value of the function
4958 @code{elmo-plugged-p} (without arguments).
4959 This variable @code{elmo-plugged-condition} specifies the condition on
4960 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4961 plugged state of each port.
4964 'one : plugged if one or more ports are plugged.
4965 'all : plugged if all ports are plugged.
4966 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4967 states of the ports.
4968 @var{function} : reflects the return value of the @var{function}
4969 functions available per default
4970 'elmo-plug-on-by-servers
4971 : reflects the plugged state of the servers specified by the
4972 variable elmo-plug-on-servers.
4973 'elmo-plug-on-by-exclude-servers
4974 : reflects the plugged state of the servers that are not
4975 in elmo-plug-on-exclude-servers.
4976 elmo-plug-on-exclude-servers defaults to
4979 (system-name)without the domain part)
4985 (setq elmo-plugged-condition 'all)
4987 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4988 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4990 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4991 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4995 @item wl-reset-plugged-alist
4996 @vindex wl-reset-plugged-alist
4997 The initial setting is @code{t}. If non-nil, plugged states are
4998 initialized on a per server or port basis when Wanderlust starts up.
5000 If @code{nil}, plugged states are retained while Emacs is running. In
5001 other words, they are initialized when Emacs is restarted even if the
5002 value is @code{nil}.
5006 @node Expire and Archive, Scoring, Disconnected Operations, Top
5007 @chapter Automatic Expiration and Archiving of Messages
5008 @cindex Expire and Archive
5011 * Expire:: Expiration and Archiving
5012 * Archive:: Archiving All Messages
5016 @node Expire, Archive, Expire and Archive, Expire and Archive
5018 @cindex Expire Message
5020 Expiration means deletion of old messages which have outlasted a
5021 certain period of time.
5023 @code{wl-expire} supports not only simple deletion, but also moving to
5024 specified archiving folders.
5028 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5029 or @kbd{M-e} in the summary mode.
5031 @subsection Configuring @code{wl-expire-alist}
5033 An example configuration of @code{wl-expire-alist} is shown below.
5034 Everything in this @code{wl-expire-alist} makes a great difference in
5035 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5036 to @code{t}, especially in the initial stage.
5040 (setq wl-expire-alist
5041 '(("^\\+trash$" (date 14) remove)
5043 ("^\\+tmp$" (date 7) trash)
5044 ;; @r{re-file to @code{wl-trash-folder}}
5045 ("^\\+outbox$" (number 300) "$outbox;lha")
5046 ;; @r{re-file to the specific folder}
5048 ;; @r{do not expire}
5049 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5050 ;; @r{archive by message number (retaining numbers)}
5051 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5052 ;; @r{archive by a fixed number (retaining numbers)}
5053 ("^\\+diary$" (date 30) wl-expire-archive-date)
5054 ;; @r{archive by year and month (numbers discarded)}
5059 Items in the list has the format of:
5062 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5066 The folder is examined if it matches @var{regexp-for-folders} from the
5067 beginning of the list. If you invoke expiration on the folder that does
5068 not match any of them, nothing will happen. And if either the second or
5069 the third element of the item is @code{nil}, expiration will not take
5072 You can use any one of the following for
5073 @var{specification-of-message-to-be-deleted}:
5076 @item (number @var{n1} [@var{n2}])
5077 deletes messages depending on the number of messages in the folder.
5079 @var{n1} is the number of messages which should survive deletion, for example
5080 if its value is 500, the newest 500 messages survive and the rests are
5083 @var{n2} is the number of messages in the folder on which expiration should
5084 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5085 folders with 510 or more messages are expired.
5086 If you configured automatic expiration, frequently used folders may
5087 expire every time it receive messages, and you may be annoyed with the
5088 long delay in reading mail.
5089 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5090 expiration would not take place until a certain number of messages
5093 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5094 with important/new/unread) are not deleted.
5095 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5096 will expire so as to have 500 messages including such ones.
5097 Otherwise, it will have 500 messages except such ones.
5099 @item (date @var{d1})
5100 deletes messages depending on the dates.
5102 Messages dated @var{d1} or more days ago are deleted, for example if its
5103 value is seven, messages seven days old or more are deleted. Note that
5104 the date is the one in the @samp{Date:} field of the message, not when
5105 the message entered the folder.
5107 Messages with no or invalid @samp{Date:} field does not expire; you
5108 might have to delete them by hand.
5111 You can use any one of the following in the place of @var{destination}:
5115 deletes the messages instantly.
5118 hide the messages from summary (messages are not deleted).
5121 moves the messages to @code{wl-trash-folder}.
5123 @item @var{string}(folder)
5124 moves the messages to the folder specified with @var{string}.
5126 It would be useful for specifying an archiving folder, but because this
5127 does not move important messages, it might be better to use the
5128 standard functions described below.
5130 @item @var{function}
5131 invokes the specified @var{function}.
5133 To the @var{function}, three arguments are passed: a folder name, a list
5134 of messages to be deleted, and msgdb information of the summary. You
5135 can specify function-specific arguments after the name of the
5136 @var{function}. Note that the list contains messages with marks in
5137 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5140 These are four standard functions; three of them move messages to an archive
5141 folder in the specified way. This means old messages can be compressed
5142 and saved in a file, being deleted from the original folder.
5143 The last one divides messages to some MH folders.
5146 @item wl-expire-archive-number1
5147 re-files to archiving folders corresponding to the message numbers of
5148 the messages being deleted. For example, a message numbered 102 will be
5149 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5150 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5151 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5153 The archiving folders to which messages are re-filed are determined by
5154 the name of the folder as follows (in this case, archiving folders are
5155 handled as if @code{elmo-archive-treat-file} were non-nil).
5158 @item If the folder type is localdir:
5159 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5161 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5162 (@file{~/Mail/ml/wl-00100.zip}).
5164 @item The folder type is other than localdir:
5165 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5167 For example, @samp{%#mh/ml/wl} corresponds to
5168 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5171 As you can see, in the case of localdir, the folder type is not included
5172 in the path name, but otherwise it is included.
5173 And you can control the prefix to the archiving folder name by
5174 @code{wl-expire-archive-folder-prefix}.
5175 Refer to @code{wl-expire-archive-folder-prefix} for details.
5177 @item wl-expire-archive-number2
5178 re-files every certain number of messages to archiving folders.
5180 This differs from @samp{wl-expire-archive-number1} in that this re-files
5181 to the folder up to the specified number regardless of message numbers.
5182 The archiving folders to which messages are re-filed are determined in the
5183 same way as @code{wl-expire-archive-number1}.
5185 @item wl-expire-archive-date
5186 re-files messages depending on its date (year and month) to archive
5189 For example, a message dated December 1998 is re-filed to
5190 @code{$folder-199812;zip}. The name of the archiving folders except the
5191 date part are determined in the same way as
5192 @code{wl-expire-archive-number1}.
5195 You can set the first argument to these three standard functions to non-nil
5196 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5197 For example, it can be specified just after the name of the function:
5200 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5203 If you omit the argument, consecutive numbers from 1 are assigned for
5204 each archiving folder.
5206 @item wl-expire-localdir-date
5207 divedes messages depending on its date (year and month) to MH folders
5208 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5212 @subsection Treatment for Important or Unread Messages
5214 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5215 standard function, messages with marks in
5216 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5217 messages} thereafter) are retained.
5219 Per default, this variable include the important, new, and unread marks,
5220 so that messages with these marks are not removed.
5221 Note that you cannot include the temporary mark (i.e. temporary marks
5222 are removed anyway), and be sure to process temporary marks before you
5225 @subsection Auto Expiration
5227 The following setup invokes expiration when you move into the summary
5228 mode. There will be no confirmation, so make sure you made no mistake
5229 in regexp and other settings before you set up this.
5233 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5237 In the folder mode, you can invoke expiration per group as well as per
5238 folder. Therefore, if you specify @samp{Desktop} group, all folders
5239 matching @code{wl-expire-alist} expire.
5243 @subsection Treating archive folders.
5244 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5245 you must set non-nil value to @code{elmo-archive-treat-file}.
5247 @subsection Confirming
5249 If you are to use @code{remove}, try @code{trash} at first and see
5250 messages move to @code{wl-trash-folder} as expected, then replace it
5251 with @code{remove}. It would be dangerous to use @code{remove} from the
5254 If you are to use @code{wl-expire-archive-number1} and the like, try to
5255 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5256 you can append messages to it. Even if settings in
5257 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5258 would not be saved anywhere and disappeared in case the archiver program
5261 After you make sure you can archive to the folder correctly, you can
5262 invoke expiration and utilize the log.
5264 If you set @code{wl-expire-use-log} to @code{t},
5265 @file{~/.elmo/expired-log} should contain the log, for example:
5269 delete +ml/wl (593 594 595 596 597 598 599)
5270 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5274 The first column indicates the operation, i.e. @samp{delete},
5275 @samp{copy}, or @samp{move}. The next is the name of the folder that
5276 expired. In the case of @samp{copy} and @samp{move}, the destination
5277 folder is recorded after @samp{->}. The last is the list of message
5278 numbers that are actually deleted or moved (in the case of @samp{copy}
5279 and @samp{move}, the number is the one in the source folder, rather than
5280 the destination folder).
5282 @subsection Re-filing Reserved Messages
5284 The three standard functions copy reserved messages to the archive
5285 folder, but do not delete them from the source folder. Because
5286 reserved messages and the like always remain, they are recorded in
5287 @file{~/.elmo/expired-alist} so that they are not copied over and over
5288 again. They are not recorded if copied by @code{wl-summary-archive}.
5290 If you enabled logging, usually @samp{move} is recorded for re-filing,
5291 but instead @samp{copy} and @samp{delete} are recorded separately if
5292 reserved messages are involved. This is because it actually copies
5293 messages including reserved, then deletes ones except reserved in that
5296 @section Customizable Variables
5299 @item wl-expire-alist
5300 @vindex wl-expire-alist
5301 The initial setting is @code{nil}.
5302 This variable specifies folders and methods to expire. For details,
5303 refer to @code{wl-expire-alist} settings above.
5305 @item wl-summary-expire-reserve-marks
5306 @vindex wl-summary-expire-reserve-marks
5307 The initial setting is the list below.
5311 (list wl-summary-important-mark
5313 wl-summary-unread-mark
5314 wl-summary-unread-uncached-mark
5315 wl-summary-unread-cached-mark)
5319 Messages with these marks are retained in the folder, even after
5321 Only permanent marks can be listed, not temporary marks.
5323 You can list marks one by one as in the default; you can use the
5324 following settings as well:
5328 All messages with permanent marks are retained,
5329 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5333 All messages are handled as usual ones that are already read, no matter
5334 what marks they have; even important messages are deleted.
5337 @item wl-expire-archive-files
5338 @vindex wl-expire-archive-files
5339 The initial setting is 100.
5340 This variable specifies the number of messages to be retained in one
5343 @item wl-expire-number-with-reserve-marks
5344 @vindex wl-expire-number-with-reserve-marks
5345 The initial setting is @code{nil}.
5346 If non-nil, if expiring messages are specified by @code{number},
5347 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5349 @item wl-expire-archive-get-folder-function
5350 @vindex wl-expire-archive-get-folder-function
5351 The initial setting is @code{wl-expire-archive-get-folder}.
5353 This variable specifies a function that returns the name of an archiving
5354 folder for standard functions in the place of @var{destination}.
5355 You can use the following three variables for simple modification of
5356 folder names; if you want more complex settings, define your own
5357 function in this variable.
5359 @code{wl-expire-archive-get-folder} can be customized by these
5362 @item @code{wl-expire-archive-folder-name-fmt}
5363 @item @code{wl-expire-archive-folder-type}
5364 @item @code{wl-expire-archive-folder-prefix}
5367 @item wl-expire-archive-folder-name-fmt
5368 @vindex wl-expire-archive-folder-name-fmt
5369 The initial setting is @samp{%s-%%05d;%s}.
5370 This is a @code{format} string for archiving folders used in
5371 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5372 Note that you must specify the message number by @samp{%%d}, because it
5373 is parsed twice by @code{format}.
5375 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5378 @item wl-expire-archive-date-folder-name-fmt
5379 @vindex wl-expire-archive-date-folder-name-fmt
5380 The initial setting is @samp{%s-%%04d%%02d;%s}.
5381 This is a @code{format} string for archiving folders used in
5382 @code{wl-expire-archive-date}. Note that you must specify the message
5383 number by @samp{%%d}, because it is parsed twice by @code{format}.
5384 There should be @samp{%%d} twice, one for the year and the other for the
5387 If you modify this, adjust
5388 @code{wl-expire-archive-date-folder-num-regexp} as well.
5390 @item wl-expire-archive-folder-type
5391 @vindex wl-expire-archive-folder-type
5392 The initial setting is @code{zip}.
5393 This variable specifies an archiver type of the archiving folders.
5395 @item wl-expire-archive-folder-prefix
5396 @vindex wl-expire-archive-folder-prefix
5397 The initial setting is @code{nil}.
5398 This variable specifies the prefix (directory structure) to archiving
5400 Exercise extreme caution in using this feature, as it has not been
5402 In the worst case, there is a fear of destructing archiving folders.
5406 There will be no prefix.
5409 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5410 @samp{$ml/wl-00000;zip;wl}.
5413 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5416 @samp{$ml/wl-00000;zip;ml/wl}.
5419 @item wl-expire-archive-folder-num-regexp
5420 @vindex wl-expire-archive-folder-num-regexp
5421 The initial setting is @samp{-\\([-0-9]+\\);}.
5422 This variable specifies the regular expression to be used for getting
5423 message numbers from multiple archiving folders specified by
5424 @code{elmo-list-folders}.
5425 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5427 @item wl-expire-archive-date-folder-num-regexp
5428 @vindex wl-expire-archive-date-folder-num-regexp
5429 The initial setting is @samp{-\\([-0-9]+\\);}.
5430 This is the regular expression to be used for getting message numbers
5431 from multiple archiving folders specified by @code{elmo-list-folders}.
5432 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5434 @item wl-expire-delete-oldmsg-confirm
5435 @vindex wl-expire-delete-oldmsg-confirm
5436 The initial setting is @code{t}.
5437 If non-nil, messages older than the one with the largest number will be
5438 deleted with confirmation.
5439 If @code{nil}, they are deleted without confirmation.
5441 This feature is valid only if non-nil is specified as a argument to the
5442 standard functions so as to retain numbers.
5444 @item wl-expire-use-log
5445 @vindex wl-expire-use-log
5446 The initial setting is @code{nil}.
5447 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5448 They are appended but not truncated or rotated automatically; you might
5449 need to remove it manually.
5451 @item wl-expire-add-seen-list
5452 @vindex wl-expire-add-seen-list
5453 The initial setting is @code{t}.
5455 If non-nil, when messages are re-filed by expiration, read/unread
5456 information is passed to the destination folder.
5458 However if you do not read the destination folder from Wanderlust,
5459 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5460 want to set this to @code{nil} if you are simply saving to some
5461 archiving folders. Even if its value is @code{nil}, messages in the
5462 archiving folders are simply treated as unread; it does not affect
5465 @item wl-expire-folder-update-msgdb
5466 @vindex wl-expire-folder-update-msgdb
5467 The initial setting is @code{t}.
5468 If @code{t}, in the folder mode, expiration is carried out after
5469 updating summary information. If you specified a list of regular
5470 expressions of folder names, summary information is updated for matching
5475 @node Archive, , Expire, Expire and Archive
5476 @section Archiving Messages
5478 @subsection Archiving Messages
5479 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5480 folders. If there are the archiving folders already, only new messages
5483 You can use @code{wl-archive-alist} in order to specify how messages are
5484 archived according to their folder names, as in @code{wl-expire-alist}.
5489 (setq wl-archive-alist
5490 '(("^\\+tmp$" wl-archive-date)
5491 ("^\\+outbox$" wl-archive-number2)
5492 (".*" wl-archive-number1)))
5496 Each item in the list has the following format:
5499 (@var{folders-regexp} @var{deleting-function})
5502 As you can see, you can only use a function after @var{folders-regexp}.
5503 Per default, there are three functions:
5506 @item @code{wl-archive-number1}
5507 @item @code{wl-archive-number2}
5508 @item @code{wl-archive-date}
5511 As inferred from their names, they work similarly to "expire" versions,
5512 other than the following points:
5515 @item No messages are deleted
5516 @item Message numbers are retained even if invoked without arguments
5519 These functions are good to archive all messages in a folder by their
5520 numbers or by their dates.
5521 These are also useful for backup or confirmation purposes before
5523 If you try to re-file them after they are archived, they are deleted but
5526 Per default, the archiving folders to which messages are copied are
5527 determined automatically by @code{wl-expire-archive-get-folder-function}.
5528 You can copy to a specific folder by invoking with a prefix argument,
5529 i.e. @kbd{C-u M-x wl-summary-archive}.
5531 Note that this feature has not been seriously tested, because you can
5532 simply copy to an archiving folder, for example by
5533 @code{wl-summary-copy-region}.
5535 The archiving folders are determined by the same logic as in
5536 @code{wl-summary-expire}; the following customizable variables are
5540 @item @code{wl-expire-archive-files}
5541 @item @code{wl-expire-archive-get-folder-function}
5542 @item @code{wl-expire-archive-folder-name-fmt}
5543 @item @code{wl-expire-archive-folder-type}
5544 @item @code{wl-expire-archive-folder-prefix}
5545 @item @code{wl-expire-archive-folder-num-regexp}
5548 @subsection Customizable Variables
5551 @item wl-archive-alist
5552 @vindex wl-archive-alist
5553 The initial setting is the list shown below:
5557 ((".*" wl-archive-number1))
5562 This variable specifies a function that copies to archiving folders.
5563 To the function, three arguments are passed: a folder name, a list of
5564 messages in the folder, and msgdb information of the summary.
5565 Needless to say, you can use your own function.
5569 @node Scoring, Address Book, Expire and Archive, Top
5570 @chapter Score of the Messages
5572 @c @cindex Kill File
5574 Scoring is the function that associates a score (value) with each
5575 message, and marks as read or deletes from the summary according to it.
5577 You can put target or important marks on essential messages, or read marks
5578 on the ones you do not want to read, for example spam articles.
5580 This scoring function has a capability and a format similar to the one
5581 that Gnus has, although there are some unsupported features and
5582 Wanderlust specifics.
5583 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5586 * Score Commands:: Score Commands
5587 * Score File Format:: Score File Format
5591 @node Score Commands, Score File Format, Scoring, Scoring
5592 @section Score Commands
5593 @cindex Score Commands
5595 @subsection Score File Specification
5597 @code{wl-score-folder-alist} specifies score files or variables in which
5598 scores are defined, corresponding to folder names.
5602 (setq wl-score-folder-alist
5611 If paths to the score files are omitted, the directory specified in the
5612 variable @code{wl-score-files-directory} is assumed.
5614 No matter what you write in @code{wl-score-folder-alist}, the default
5615 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5616 read (it does not have to exist).
5617 Therefore, in the example above, the three score files,
5618 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5619 the folders that matches @samp{^-.*}.
5621 @subsection Scored Messages
5623 Scores are attached to the messages that are specified by
5624 @code{wl-summary-score-marks} temporarily when the summary is updated;
5625 when you exit from the summary, the scores are removed and reverts to
5628 @subsection Creation of Score Files
5630 In the summary buffer, move to an appropriate message and type @kbd{L}.
5631 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5632 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5634 This makes @minus{}1000 are scored for messages with the same
5635 @samp{Subject:} as the string you entered. That is, such a score file
5636 is created automatically.
5638 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5639 The score file you just made appears.
5640 This buffer is called @dfn{score editing buffer} thereafter.
5641 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5642 as you are previously; type @kbd{a}. Then a score entry for "From"
5644 In this way, you can create a score file easily either in the summary
5645 buffer or in the score editing buffer.
5647 By the way, you might be aware the numbers of key strokes are different
5648 between @kbd{s s p} and @kbd{a}.
5649 This is determined by @code{wl-score-header-default-entry}.
5650 This variable specifies the default score entries corresponding to
5652 For example, for "subject" field, a type and a time limit are prompted,
5653 but for "from" field, they are fixed upon automatically as substring and
5654 permanent respectively.
5655 However, score values can be modified by the prefix argument.
5656 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5659 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5660 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5661 erasing contents of the buffer deletes the score file being edited.
5665 @subsubsection Selecting Score Files
5667 You can change score files to which scores are appended by
5668 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5669 @code{wl-score-change-score-file}.
5671 @subsubsection Summing Up the Score
5673 If you add the same entries by @code{wl-summary-increase-score},
5674 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5675 scores for the entry is summed up.
5677 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5678 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5679 @minus{}1200 will be created as a result.
5681 @subsubsection Creating Thread Key
5683 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5684 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5686 @subsubsection Creating Followup Key
5688 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5689 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5690 at the cursor to @samp{References} key.
5691 If @code{wl-score-auto-make-followup-entry} is non-nil,
5692 @samp{Message-ID} of all messages to be followed up within dates
5693 specified by @code{wl-score-expiry-days}.
5695 @subsection Key Bindings
5700 @findex wl-summary-increase-score
5701 Increases the score for the current message.
5702 And the score entry is appended to the score file at the same moment.
5703 You can specify the score value by a prefix argument.
5707 @findex wl-summary-lower-score
5708 Decreases the score for the current message.
5709 And the score entry is appended to the score file at the same moment.
5710 You can specify the score value by a prefix argument.
5713 @kindex h R (Summary)
5714 @findex wl-summary-rescore
5715 Re-applies the scoring.
5716 However, already scored messages are not scored anew.
5719 @kindex h c (Summary)
5720 @findex wl-score-change-score-file
5721 Changes the score file currently selected.
5724 @kindex h e (Summary)
5725 @findex wl-score-edit-current-scores
5726 Edits the score file currently selected.
5727 If there are multiple score files, the previously specified one is
5731 @kindex h f (Summary)
5732 @findex wl-score-edit-file
5733 Edits an arbitrary score file and selects it.
5736 @kindex h F (Summary)
5737 @findex wl-score-flush-cache
5738 Erases caches associated to the score files that are read.
5739 If you modified score files directly (from other than Wanderlust), you
5740 need to re-read them after erasing the cache.
5743 @kindex h m (Summary)
5744 @findex wl-score-set-mark-below
5745 Specifies the criterion for scores to be marked as read.
5746 Messages with scores less than this value are marked as read.
5749 @kindex h x (Summary)
5750 @findex wl-score-set-expunge-below
5751 Specifies the criterion for scores to be deleted from the summary.
5752 Messages with scores less than this value are deleted.
5753 "Deleted" means it is not shown; they are not removed from the summary
5754 information or the folder.
5755 The deleted messages can be shown by rescan-noscore again.
5758 @subsection Key Bindings in the Score Editing Buffer
5762 @kindex C-c C-k (Score Mode)
5763 @findex wl-score-edit-kill
5764 Abandons the file being edited.
5767 @kindex C-c C-c (Score Mode)
5768 @findex wl-score-edit-exit
5769 Saves the file being edited, and quits from the edit mode.
5772 @kindex C-c C-p (Score Mode)
5773 @findex wl-score-pretty-print
5777 @kindex C-c C-d (Score Mode)
5778 @findex wl-score-edit-insert-date
5779 Inserts the number of dates from Dec. 31, 1 B.C.
5780 It is used for creating the third factor of time-limited scores.
5783 @kindex C-c C-s (Score Mode)
5784 @findex wl-score-edit-insert-header
5785 Inserts the header of the message selected in the summary buffer.
5788 @kindex C-c C-e (Score Mode)
5789 @findex wl-score-edit-insert-entry
5790 Inserts the score entry of the message selected in the summary buffer.
5793 @subsection Customizable Variables
5796 @item wl-summary-default-score
5797 @vindex wl-summary-default-score
5798 The initial setting is 0 (zero).
5799 This variable specifies the default value of the score.
5800 The score is increased or decreased based upon this value.
5802 @item wl-summary-important-above
5803 @vindex wl-summary-important-above
5804 The initial setting is @code{nil}.
5805 Messages with scores larger than this value are attached with the
5806 important mark (@samp{$}).
5807 If @code{nil}, no important marks are attached.
5809 @item wl-summary-target-above
5810 @vindex wl-summary-target-above
5811 The initial setting is @code{nil}.
5812 Messages with scores larger than this value are attached with the target
5814 If @code{nil}, no target marks are attached.
5816 @item wl-summary-mark-below
5817 @vindex wl-summary-mark-below
5818 The initial setting is 0 (zero).
5819 Messages with scores smaller than this value are marked as read.
5821 @item wl-summary-expunge-below
5822 @vindex wl-summary-expunge-below
5823 The initial setting is @code{nil}.
5824 Messages with scores smaller than this value are deleted from the
5826 If @code{nil}, they are not deleted.
5828 @item wl-summary-score-marks
5829 @vindex wl-summary-score-marks
5830 The initial setting is the list shown below:
5834 (list wl-summary-new-mark)
5839 Messages with these marks are scored.
5841 @item wl-use-scoring
5842 @vindex wl-use-scoring
5843 The initial setting is t.
5844 If non-nil, scoring is enabled.
5846 @item wl-score-files-directory
5847 @vindex wl-score-files-directory
5848 The initial setting is @file{~/.elmo/}.
5849 The default directory for score files.
5851 @item wl-score-interactive-default-score
5852 @vindex wl-score-interactive-default-score
5853 The initial setting is 1000.
5854 This value is used as a score when a score factor is @code{nil} in the
5855 score file. It is also used in @code{wl-summary-increase-score} and
5856 @code{wl-summary-lower-score}, on condition that the value of
5857 @code{wl-score-header-default-entry} is @code{nil}.
5859 @item wl-score-expiry-days
5860 @vindex wl-score-expiry-days
5861 The initial setting is 7.
5862 This is the number of days before time-limited scores are deleted.
5864 @item wl-score-update-entry-dates
5865 @vindex wl-score-update-entry-dates
5866 The initial setting is @code{t}.
5867 If non-nil, it enables deletion of time-limited scores.
5869 @item wl-score-header-default-entry
5870 @vindex wl-score-header-default-entry
5871 Specifies the default value for each header field for score entries
5872 created by @code{wl-summary-increase-score},
5873 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5875 @item wl-score-simplify-fuzzy-regexp
5876 @vindex wl-score-simplify-fuzzy-regexp
5877 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5878 regular expression to be deleted from the string.
5879 Because this is usually used for Subject, the default is prefixes that
5880 are attached by mailing list programs.
5882 @item wl-summary-rescore-partial-threshold
5883 @vindex wl-summary-rescore-partial-threshold
5884 The initial setting is 200.
5885 When sync-all or rescan is executed, if there are messages more than
5886 this value, only the last same number of messages as this value are
5889 @item wl-summary-auto-sync-marks
5890 @vindex wl-summary-auto-sync-marks
5891 If non-nil, unread/important marks are synchronized when the summary
5893 Unread marks reflect information on the IMAP4 server.
5894 Important marks reflect information on the IMAP4 server (flagged or
5895 not), and contents of @samp{'mark} folder.
5896 The initial setting is @code{t}.
5900 @node Score File Format, , Score Commands, Scoring
5901 @section Score File Format
5902 @cindex Score File Format
5904 The format of score files are the same as Gnus, and basically you can
5905 use Gnus score files as they are. But they are not fully compatible
5906 because some keys are not supported and there are Wanderlust specifics.
5907 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5912 ("for sale" -1000 nil s)
5913 ("profit" -1000 nil s))
5915 ("spam@@spamspamspam" -10000 nil s))
5917 ("my@@address" 3001 nil s))
5919 (1000000 -10 nil >))
5929 If the key is a string, it is the name of the header to be matched.
5930 The following keys are available:
5931 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5932 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5933 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5934 @code{Chars} and @code{Lines} mean the size and the number of lines of
5935 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5936 are described later.
5937 The rest corresponds the field of the same name.
5939 Arbitrary numbers of core entries are specified after the key.
5940 Each score entry consists of these five factors:
5944 A factor that matches header. This should be a number in the cases of
5945 @code{lines} and @code{chars}, otherwise a string.
5948 A score factor. When the first item matches, the score of the message
5949 is increased or decreased by this value.
5952 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5953 of a number, the score is deleted if it does not match for days
5954 (@code{wl-score-expiry-days}) from the date specified by this.
5955 The date is since Dec. 31, 1 B.C.
5958 A type factor. This specifies the way the first factor matches.
5959 Available types depend on keys.
5962 @item From, Subject, References, Message-ID
5963 For these keys in string, @code{r} and @code{R} (regexp),
5964 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5965 as well as @code{f} and @code{F} (fuzzy) can be used.
5966 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5969 For these keys, the following five numerical relative operators can be
5970 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5973 This key matches @code{From} header, and scores all follow-ups to the
5975 For example, it would be useful for increasing scores for follow-ups to
5978 You can use the same types as @code{From} except for @code{f}.
5979 And a @samp{Followup} entry is automatically appended to the score file.
5982 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5983 A @samp{Thread} entry is automatically appended for each article that
5984 has @var{x} in the @code{References} header.
5985 You can make sure the whole thread including messages that does not have
5986 all ancestors @code{Message-ID} in @code{References} is scored.
5988 You can use the same types as @code{References} except for @code{f}.
5989 And a @samp{Thread} entry is automatically appended to the score file.
5993 A factor for extension header. This is meaningful only if the key is
5995 This specifies headers to be matched other than standard headers like
5996 @code{Subject} and @code{From}.
5997 Note that you should specify the header in
5998 @code{elmo-msgdb-extra-fields} also.
5999 Therefore it does not work in folders where extension headers cannot be
6004 The sum of these scores @emph{after all factors are applied} becomes the
6005 score of the message.
6007 @cindex Score File Atoms
6009 Messages with a score less than this value is marked as read.
6010 The default is @code{wl-summary-mark-below}.
6013 Messages with a score less than this value is deleted from the summary.
6014 The default is @code{wl-summary-expunge-below}.
6016 @item mark-and-expunge
6017 Both @code{mark} and @code{expunge} are applied,
6018 i.e. messages with a score less than this value is marked as read and
6019 deleted from the summary.
6022 Messages with a score greater than this value is attached with temp
6024 The default is @code{wl-summary-target-above}.
6027 Messages with a score greater than this value is attached with important
6029 The default is @code{wl-summary-important-above}.
6034 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6035 are used, you need to set @code{elmo-msgdb-extra-fields}.
6038 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6041 There are other restrictions as shown below:
6044 @item Because @samp{References} field in the summary information
6045 contains only the last @samp{Message-ID}, @code{references} key matches
6049 Keys that can be seen by folder of types:
6053 chars lines xref extra
6054 localdir,localnews Y E E E
6055 nntp (supporting xover) Y E E N
6061 N: cannot be seen (ignored)
6062 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6067 @node Address Book, Customization, Scoring, Top
6068 @chapter Address Book
6069 @cindex Address Book
6071 With address book, you can utilize address completion, and you have
6072 summary displayed with nicknames.
6075 * Mail Addresses:: Definition of Address Book
6076 * Address Manager:: Address Manager
6079 @node Mail Addresses, Address Manager, Address Book, Address Book
6080 @section Address book
6081 @cindex Address book Definition
6083 @cindex Alias, Address
6085 The file @file{~/.addresses} is a simple address book for Wanderlust.
6086 Make address file @file{~/.addresses}, and edit to suit your requirement.
6088 The data written in @file{~/.addresses} are used for address completion
6089 under draft editing mode. Furthermore, they are used when showing names
6090 in summary display mode. You can safely skip this section, if you don't
6091 want to customize address completion and summary display.
6092 It is possible to add/change/remove addresses from @file{~/.addresses} in
6093 summary buffer after Wanderlust is invoked. @refill
6095 The format is very simple. Like this. @refill
6100 # @r{Lines begin with @samp{#} are comment.}
6101 # @r{Empty lines are ignored}
6103 # @r{Format of each line:}
6104 # @var{email-address} "@var{nickname} "@var{realname}"
6106 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6107 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6108 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6113 One line defines one persons description.
6115 Actually, in default setup, @var{nickname} is used in summary-mode and
6116 @var{realname} is used in draft preparation mode. This behavior is
6117 better understood if you try it and confirmed the function first. You
6118 can write and try a small definition, so you will know the idea of the
6119 address book before writing a big one.
6121 And, if MH alias file is specified in variable @code{wl-alias-file},
6122 it is used as an address information in the draft preparation mode.
6124 If variable @code{wl-use-ldap} is non-nil (initial setting is
6125 @code{nil}), address completion in draft mode uses LDAP information.
6127 If you use LDAP, you have to set @code{wl-ldap-server},
6128 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6129 not have LDAP feature as built-in feature (Currently only XEmacs can
6130 have built-in LDAP feature), you have to set command exec @env{PATH} to
6131 the program @command{ldapsearch}.
6134 @node Address Manager, , Mail Addresses, Address Book
6135 @section Address Manager
6136 @cindex Address Manager
6138 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6139 the address book and insert address to draft buffer.
6141 @subsection Key Bindings
6145 @kindex t (Address Manager)
6146 @findex wl-addrmgr-set-to
6147 Add @samp{To:} mark.
6150 @kindex c (Address Manager)
6151 @findex wl-addrmgr-set-cc
6152 Add @samp{Cc:} mark.
6155 @kindex b (Address Manager)
6156 @findex wl-addrmgr-set-bcc
6157 Add @samp{Bcc:} mark.
6160 @kindex u (Address Manager)
6161 @findex wl-addrmgr-unmark
6165 @kindex x (Address Manager)
6166 @findex wl-addrmgr-apply
6168 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6169 buffer and quit address manager. When no draft buffer, make new draft
6170 with insert marked addresses.
6172 If no mark, quit address manager.
6176 @kindex q (Address Manager)
6177 @findex wl-addrmgr-quit
6178 Quit address manager.
6181 @kindex a (Address Manager)
6182 @findex wl-addrmgr-add
6186 @kindex d (Address Manager)
6187 @findex wl-addrmgr-delete
6191 @kindex e (Address Manager)
6192 @findex wl-addrmgr-edit
6197 @node Customization, Mailing List, Address Book, Top
6198 @chapter Customizing Wanderlust
6199 @cindex Customization
6202 * Living with other packages:: Cooperating with other packages
6203 * Highlights:: Highlights
6204 * Biff:: Notify Mail arrival
6205 * Advanced Settings:: Advanced Settings
6206 * Customizable Variables:: Customizable Variables
6211 @node Living with other packages, Highlights, Customization, Customization
6212 @section Living with other packages
6214 Examples with other packages.
6217 * imput:: imput (im-wl.el)
6219 * supercite:: supercite.el
6220 * mu-cite:: mu-cite.el
6221 * X-Face:: x-face,bitmap-mule
6222 * dired-dd:: dired-dd.el
6224 * Addrbook:: Addrbook
6225 * mime-w3m:: mime-w3m.el
6229 @node imput, BBDB, Living with other packages, Living with other packages
6234 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6237 If @command{imput} is on the @code{exec-path} at the installation,
6238 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6242 (autoload 'wl-draft-send-with-imput-async "im-wl")
6243 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6248 @node BBDB, supercite, imput, Living with other packages
6252 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6255 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6256 byte-compiled and installed.
6264 ;; @r{enable pop-ups}
6265 (setq bbdb-use-pop-up t)
6266 ;; @r{auto collection}
6267 (setq bbdb/mail-auto-create-p t)
6268 ;; @r{exceptional folders against auto collection}
6269 (setq bbdb-wl-ignore-folder-regexp "^@@")
6270 (setq signature-use-bbdb t)
6271 (setq bbdb-north-american-phone-numbers-p nil)
6272 ;; @r{shows the name of bbdb in the summary} :-)
6273 (setq wl-summary-from-function 'bbdb-wl-from-func)
6274 ;; @r{automatically add mailing list fields}
6275 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6276 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6280 You can complete address with BBDB by @kbd{M-@key{TAB}}
6284 @node supercite, mu-cite, BBDB, Living with other packages
6285 @subsection sc.el(supercite), sc-register.el
6289 The same setting as usual mailers should be OK. The following is an
6290 example of settings:
6294 (autoload 'sc-cite-original "supercite" nil t)
6295 (add-hook 'mail-citation-hook 'sc-cite-original)
6300 @node mu-cite, X-Face, supercite, Living with other packages
6301 @subsection mu-cite.el
6304 The same setting as usual mailers should be OK. The following is an
6305 example of settings.
6307 If you use mu-cite version 8.0 or earlier:
6311 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6312 (setq mail-citation-hook 'mu-cite/cite-original)
6316 If you use mu-cite version 8.1 or later:
6320 (autoload 'mu-cite-original "mu-cite" nil t)
6321 (add-hook 'mail-citation-hook (function mu-cite-original))
6325 @node X-Face, dired-dd, mu-cite, Living with other packages
6329 If you have installed one of the following, you can decode
6330 @samp{X-Face:} field in message buffer and you will see face image.
6333 * x-face-xmas:: XEmacs case
6334 * x-face-mule:: Emacs case
6337 If there is an encoded X-Face string in a file @file{~/.xface} (the
6338 value of the variable @code{wl-x-face-file}), it is inserted as a
6339 @samp{X-Face:} field in the draft buffer (if
6340 @code{wl-auto-insert-x-face} is non-nil).
6342 @node x-face-xmas, x-face-mule, X-Face, X-Face
6343 @subsubsection x-face-xmas (for XEmacs)
6346 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6347 1.3.6.13 or later, do the following:
6351 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6352 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6356 @node x-face-mule, , x-face-xmas, X-Face
6357 @subsubsection x-face-mule (for Emacs)
6361 If you use @file{x-face-mule.el} in bitmap-mule
6362 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6366 (autoload 'x-face-decode-message-header "x-face-mule")
6367 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6371 @subsubsection x-face-e21 (for Emacs 21.x)
6374 With Emacs 21.x, you can use @file{x-face-e21.el}
6375 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6376 to display X-Face. In this case, bitmap-mule is not required.
6381 (autoload 'x-face-decode-message-header "x-face-e21")
6382 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6387 @node dired-dd, MHC, X-Face, Living with other packages
6388 @subsection dired-dd(Dired-DragDrop)
6389 @pindex Dired-DragDrop
6391 @cindex Drag and Drop
6393 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6394 compose multi-part by simple Drag-and-Drop from dired to the draft
6395 buffer being edited in GNU Emacs (this feature is not Wanderlust
6396 specific, but general-purpose for SEMI).
6400 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6406 ;; @r{Set dired-x variables here.}
6407 ;; @r{To and flo@dots{}}
6409 (progn (require 'dired-dd)
6410 (require 'dired-dd-mime))))))
6414 @node MHC, Addrbook, dired-dd, Living with other packages
6418 Message Harmonized Calendaring system
6419 (@uref{http://www.quickhack.net/mhc/})
6421 By using MHC, you can make a calendar from the messages.
6427 (setq mhc-mailer-package 'wl)
6428 (autoload 'mhc-mode "mhc" nil t)
6429 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6430 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6438 (autoload 'mhc-wl-setup "mhc-wl")
6439 (add-hook 'wl-init-hook 'mhc-wl-setup)
6443 @node Addrbook, mime-w3m, MHC, Living with other packages
6444 @subsection wl-addrbook.el
6448 (@uref{http://www.mew.org/})
6450 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6451 @code{load-path} and do the following settings.
6455 (require 'wl-addrbook)
6460 @node mime-w3m, , Addrbook, Living with other packages
6461 @subsection mime-w3m.el
6464 You can display html part by using @file{mime-w3m.el}
6465 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6466 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6469 @node Highlights, Biff, Living with other packages, Customization
6472 @subsection Customizable Variables
6475 @item wl-summary-highlight
6476 @vindex wl-summary-highlight
6477 The initial setting is @code{t}.
6478 If non-nil, the summary is highlighted.
6480 @item wl-highlight-max-summary-lines
6481 @vindex wl-highlight-max-summary-lines
6482 The initial setting is 10000.
6483 The summary is not highlighted if it has more lines than this value.
6485 @item wl-summary-highlight-partial-threshold
6486 @vindex wl-summary-highlight-partial-threshold
6487 The initial setting is 1000.
6488 This is a threshold whether the whole summary is highlighted.
6489 If there are more lines of messages in the summary, it is partially
6492 @item wl-summary-partial-highlight-above-lines
6493 @vindex wl-summary-partial-highlight-above-lines
6494 The initial setting is 30. If there are more lines of messages than
6495 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6496 after the point that is the same number of lines as this value above the
6497 cursor line are highlighted partially. (If this value is @code{nil},
6498 the last same number of lines as the value of
6499 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6501 @item wl-highlight-body-too
6502 @vindex wl-highlight-body-too
6503 The initial setting is @code{t}.
6504 If non-nil, bodies of drafts and messages are also highlighted.
6506 @item wl-highlight-message-header-alist
6507 @vindex wl-highlight-message-header-alist
6508 When highlighting headers of drafts and messages, this variable
6509 specifies which faces are allocated to important
6510 (@code{wl-highlight-message-important-header-contents}), secondly
6511 important (@code{wl-highlight-message-important-header-contents2}), and
6512 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6514 Similarly, it can be used for allocating arbitrary faces to arbitrary
6515 regular expressions.
6517 @item wl-highlight-citation-prefix-regexp
6518 @vindex wl-highlight-citation-prefix-regexp
6519 Specifies a regular expression to which quoted lines in bodies of
6520 drafts and messages match.
6521 Bodies matching to this regular expression are highlighted by the faces
6522 specified by (@code{wl-highlight-message-cited-text-*}).
6524 @item wl-highlight-highlight-citation-too
6525 @vindex wl-highlight-highlight-citation-too
6526 The initial setting is @code{nil}.
6527 If non-nil, the quoting regular expression itself given by
6528 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6530 @item wl-highlight-citation-header-regexp
6531 @vindex wl-highlight-citation-header-regexp
6532 Specifies a regular expression that denotes beginning of quotation.
6533 Bodies matching to this regular expression are highlighted by the face
6534 specified by @code{wl-highlight-message-headers}.
6536 @item wl-highlight-max-header-size
6537 @vindex wl-highlight-max-header-size
6538 The initial setting is @code{nil}. If a header size is larger than this
6539 value, it will not be highlighted. If @code{nil}, always highlighted
6540 (ignore header size).
6542 @item wl-highlight-max-message-size
6543 @vindex wl-highlight-max-message-size
6544 The initial setting is 10000.
6545 If a message is larger than this value, it will not be highlighted.
6546 With this variable, highlight is suppressed for uuencode or huge digest
6549 @item wl-highlight-signature-separator
6550 @vindex wl-highlight-signature-separator
6551 Specifies regular expressions that denotes the boundary of a signature.
6552 It can be a regular expression, or a list of ones.
6553 Messages after the place that matches this regular expression are
6554 highlighted by the face specified by
6555 @code{wl-highlight-message-signature}.
6557 @item wl-max-signature-size
6558 @vindex wl-max-signature-size
6559 The initial setting is 400.
6560 This is the largest size for a signature to be highlighted.
6562 @item wl-use-highlight-mouse-line
6563 @vindex wl-use-highlight-mouse-line
6564 The initial setting is @code{t}.
6565 If non-nil, the line pointed by the mouse is highlighted in the folder
6566 mode, summary mode, and the like.
6569 @subsection Setting Colors and Fonts of the Characters
6571 If you want to change colors or fonts of the characters, you need to
6572 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6573 want to change fonts, and @code{set-face-foreground} for colors, and so
6574 on. You cannot write face settings in @file{.emacs}; write in
6577 For example, if you want to change the color for signatures to yellow,
6581 (set-face-foreground 'wl-highlight-message-signature "yellow")
6587 Faces defined in Wanderlust:
6590 @item wl-highlight-message-headers
6591 The face for field names of message headers.
6593 @item wl-highlight-message-header-contents
6594 The face for field bodies of message headers.
6596 @item wl-highlight-message-important-header-contents
6597 The face for important parts of message headers.
6598 Per default, this face is used for a body of @samp{Subject:} field.
6599 You can change its value by editing
6600 @code{wl-highlight-message-header-alist}.
6602 @item wl-highlight-message-important-header-contents2
6603 The face for secondly important parts of message headers.
6604 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6605 fields. You can change its value by editing
6606 @code{wl-highlight-message-header-alist}.
6608 @item wl-highlight-message-unimportant-header-contents
6609 The face for unimportant parts of message headers.
6610 Per default, this face is used for bodies of @samp{X-} fields
6611 @samp{User-Agent:} fields. You can change its value by editing
6612 @code{wl-highlight-message-header-alist}.
6614 @item wl-highlight-message-citation-header
6615 The face for headers of quoted messages.
6617 @item wl-highlight-message-cited-text-*
6618 The face for texts of quoted messages. The last @samp{*} is a
6619 @var{single figure} so that 10 different colors can be used according to
6622 @item wl-highlight-message-signature
6623 The face for signatures of messages. The initial settings are
6624 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6625 dark background colors.
6627 @item wl-highlight-header-separator-face
6628 The face for header separators of draft messages.
6630 @item wl-highlight-summary-important-face
6631 The face for message lines with important marks in the summary.
6633 @item wl-highlight-summary-new-face
6634 The face for message lines with new marks in the summary.
6636 @item wl-highlight-summary-displaying-face
6637 The face for the message line that is currently displayed.
6638 This face is overlaid.
6640 @item wl-highlight-thread-indent-face
6641 The face for the threads that is currently displayed.
6643 @item wl-highlight-summary-unread-face
6644 The face for message lines with unread marks in the summary.
6646 @item wl-highlight-summary-deleted-face
6647 The face for message lines with delete marks in the summary.
6649 @item wl-highlight-summary-refiled-face
6650 The face for message lines with re-file marks in the summary.
6652 @item wl-highlight-refile-destination-face
6653 The face for re-file information part of message lines with re-file
6654 marks in the summary.
6656 @item wl-highlight-summary-copied-face
6657 The face for message lines with copy marks in the summary.
6659 @item wl-highlight-summary-target-face
6660 The face for message lines with target marks @samp{*} in the summary.
6662 @item wl-highlight-summary-thread-top-face
6663 The face for message lines that are on the top of the thread in the
6666 @item wl-highlight-summary-normal-face
6667 The face for message lines that are not on top of the thread in the
6670 @item wl-highlight-folder-unknown-face
6671 The face for folders that are not known to have how many unsync messages
6674 @item wl-highlight-folder-zero-face
6675 The face for folders that have no unsync messages in the folder mode.
6677 @item wl-highlight-folder-few-face
6678 The face for folders that have some unsync messages in the folder mode.
6680 @item wl-highlight-folder-many-face
6681 The face for folders that have many unsync messages in the folder mode.
6682 The boundary between `some' and `many' is specified by the variable
6683 @code{wl-folder-many-unsync-threshold}.
6685 @item wl-highlight-folder-unread-face
6686 The face for folders that have no unsync but unread messages in the
6689 @item wl-highlight-folder-killed-face
6690 The face for folders that are deleted from the access group in the
6693 @item wl-highlight-folder-opened-face
6694 The face for open groups in the folder mode.
6695 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6696 @code{nil} or a @var{number}.
6698 @item wl-highlight-folder-closed-face
6699 The face for close groups in the folder mode.
6700 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6701 @code{nil} or a @var{number}.
6703 @item wl-highlight-folder-path-face
6704 The face for the path to the currently selected folder in the folder
6707 @item wl-highlight-logo-face
6708 The face for logo in the demo.
6710 @item wl-highlight-demo-face
6711 The face for strings (for example, a version number) in the demo.
6715 @node Biff, Advanced Settings, Highlights, Customization
6716 @section Notify Mail arrival
6719 Following setting is to notify mail arrival of @samp{%inbox}
6720 by the indicator on the modeline
6723 (setq wl-biff-check-folder-list '("%inbox"))
6726 @subsection Customizable Variables
6728 @item wl-biff-check-folder-list
6729 @vindex wl-biff-check-folder-list
6730 The initial setting is @code{nil}.
6731 This is the list of folders to check mail arrival.
6732 If @code{nil}, wl doesn't check mail arrival.
6734 @item wl-biff-check-interval
6735 @vindex wl-biff-check-interval
6736 The initial setting is 40 (in seconds).
6737 Check mail arrival in this period.
6739 @item wl-biff-notify-hook
6740 @vindex wl-biff-notify-hook
6741 This hook is run at the arrival of new mail.
6742 To beep with mail arrival(initial setting), set as follows.
6744 (setq wl-biff-notify-hook '(ding))
6746 For silence, set to @code{nil}.
6750 @node Advanced Settings, Customizable Variables, Biff, Customization
6751 @section Advanced Settings
6754 * Draft for Reply:: Draft for Reply
6755 * Thread Format:: Appearance of Thread
6756 * User-Agent Field:: @samp{User-Agent:} Header Field
6760 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6761 @subsection Draft for Replay
6762 @vindex wl-draft-reply-with-argument-list
6763 @vindex wl-draft-reply-without-argument-list
6764 @vindex wl-draft-reply-myself-with-argument-list
6765 @vindex wl-draft-reply-myself-without-argument-list
6767 If you want, when you replying to articles in mailing lists, the address
6768 in Reply-To field of the original message to be prepared to To field of
6769 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6774 (setq wl-draft-reply-without-argument-list
6775 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6776 ("Followup-To" . (nil nil ("Followup-To")))
6777 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6778 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6783 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6784 in the original message, @samp{Reply-To:} field in the original is
6785 copied to @samp{To:} field.)
6787 Moreover, the behavior of @kbd{a} with prefix argument can
6788 be directed by @code{wl-draft-reply-with-argument-list} as well.
6790 Note: To set the behavior when you reply to the message written by yourself, use
6791 @code{wl-draft-reply-myself-without-argument-list} and
6792 @code{wl-draft-reply-myself-with-argument-list}
6795 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6796 @subsection Appearance of Threads
6800 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6801 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6802 391 09/18(Fri)19:24 +-[ Murata-san ]
6803 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6804 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6805 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6806 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6807 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6808 412 09/22(Tue)09:28 | +-[ Teranishi ]
6809 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6810 416 09/22(Tue)12:38 | +-[ Teranishi ]
6811 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6812 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6816 Settings to make appearance of threads like shown above:
6820 (setq wl-thread-indent-level 2)
6821 (setq wl-thread-have-younger-brother-str "+")
6822 (setq wl-thread-youngest-child-str "+")
6823 (setq wl-thread-vertical-str "|")
6824 (setq wl-thread-horizontal-str "-")
6825 (setq wl-thread-space-str " ")
6829 If you do not want to see branches, do the following:
6833 (setq wl-thread-indent-level 2)
6834 (setq wl-thread-have-younger-brother-str " ")
6835 (setq wl-thread-youngest-child-str " ")
6836 (setq wl-thread-vertical-str " ")
6837 (setq wl-thread-horizontal-str " ")
6838 (setq wl-thread-space-str " ")
6843 @node User-Agent Field, , Thread Format, Advanced Settings
6844 @subsection User-Agent Field
6848 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6849 @samp{User-Agent:} fields, define a function that generate appropriate
6850 strings as you like, and set it to variable
6851 @code{wl-generate-mailer-string-function}.
6853 If you do not want verbose @samp{User-Agent:} field, do the following:
6857 (setq wl-generate-mailer-string-function
6860 (concat "User-Agent: "
6861 (wl-generate-user-agent-string-1 nil)))))
6865 The following is a example:
6869 (setq mime-edit-insert-user-agent-field nil)
6870 (setq wl-generate-mailer-string-function
6873 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6878 @node Customizable Variables, Hooks, Advanced Settings, Customization
6879 @section Customizable Variables
6881 Customizable variables that have not been described yet:
6884 @item wl-default-folder
6885 @vindex wl-default-folder
6886 The initial setting is @samp{%inbox}. This is the default value for moving to
6887 a folder and the like.
6889 @item wl-draft-folder
6890 @vindex wl-draft-folder
6891 The initial setting is @samp{+draft}. It is the folder to which drafts are
6892 saved. It must be a localdir folder.
6894 @item wl-trash-folder
6895 @vindex wl-trash-folder
6896 The initial setting is @samp{+trash}. It is the wastebasket folder.
6897 If you changed this variable, you had better restart Wanderlust.
6899 @item wl-interactive-exit
6900 @vindex wl-interactive-exit
6901 The initial setting is @code{t}.
6902 If non-nil, you are asked for confirmation when Wanderlust terminates.
6904 @item wl-interactive-send
6905 @vindex wl-interactive-send
6906 The initial setting is @code{t}.
6907 If non-nil, you are asked for confirmation when mail is sent.
6909 @item wl-folder-sync-range-alist
6910 @vindex wl-folder-sync-range-alist
6911 The initial setting is the alist shown below:
6916 ("^\\+draft$\\|^\\+queue$" . "all"))
6921 This is an associative list of regular expressions of folder names and
6922 update range of the summary. Update range is one of the @samp{all},
6923 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6924 @samp{last}. If a folder do not match, @samp{update} is used.
6927 @vindex wl-ask-range
6928 The initial setting is @code{t}.
6929 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6930 for updating the summary when you changed folders.
6932 @item wl-mime-charset
6933 @vindex wl-mime-charset
6934 The initial setting is @code{x-ctext}.
6935 This is the MIME charset for messages that are not MIME (e.g. without
6936 @samp{Content-Type:}). This value also used as default charset for
6937 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6938 this value as @code{iso-2022-jp}.)
6940 @item wl-highlight-folder-with-icon
6941 @vindex wl-highlight-folder-with-icon
6942 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6943 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6945 @item wl-strict-diff-folders
6946 @vindex wl-strict-diff-folders
6947 This is a list of regular expressions of folders.
6948 Unread messages are checked, for example when you press @kbd{s} in
6949 the folder mode, usually in a brief way (rapidly processed but not
6951 The folders matching this variable are seriously checked.
6952 You may want to set this variable so as to match conditional filter
6953 folders for IMAP4 folders.
6954 The initial setting is @code{nil}.
6956 @item wl-folder-use-server-diff
6957 @vindex wl-folder-use-server-diff
6958 When unread messages are checked, for example when you press @kbd{s} in
6959 the folder mode, usually (the number of messages on the server) @minus{}
6960 (the number of local messages) will be the number of unread messages.
6961 However, if this variable is non-nil, the number of unread messages on
6962 the server is checked. This affects IMAP4 folders only, but IMAP4
6963 folders in mail boxes matching
6964 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6965 the number of unread messages on the server, even if they matches this
6966 variable. The initial setting is @code{t}.
6968 @item wl-auto-check-folder-name
6969 @vindex wl-auto-check-folder-name
6970 The initial setting is @code{nil}.
6971 You can specify a folder or a group which is checked for unread message
6972 at the start. You can also specify a list of folders (groups) to be checked.
6973 If the value is @code{nil}, whole Desktop is checked at the start.
6974 If it is @code{none}, no folders are checked.
6976 @item wl-auto-uncheck-folder-list
6977 @vindex wl-auto-uncheck-folder-list
6978 The initial setting is the list shown below:
6987 You can set a list of regular expressions to specify folders
6988 which are not automatically checked even if they are included
6989 in some groups assigned by @code{wl-auto-check-folder-name}.
6991 @item wl-auto-check-folder-list
6992 @vindex wl-auto-check-folder-list
6993 The initial setting is @code{nil}.
6994 You can set a list of regular expressions to specify exceptions
6995 for @code{wl-auto-uncheck-folder-list}.
6997 @item wl-no-save-folder-list
6998 @vindex wl-no-save-folder-list
6999 The initial setting is the list shown below:
7008 This is a list of regular expressions of folders not to be saved.
7010 @item wl-save-folder-list
7011 @vindex wl-save-folder-list
7012 The initial setting is @code{nil}.
7013 This is a list of regular expressions of folders to be saved.
7014 This takes precedence over @code{wl-no-save-folder-list}.
7016 @item wl-folder-mime-charset-alist
7017 @vindex wl-folder-mime-charset-alist
7018 The initial setting is the alist shown below:
7022 (("^-alt\\.chinese" . big5)
7023 ("^-relcom\\." . koi8-r)
7025 ("^-han\\." . euc-kr))
7030 This is an associative list of regular expressions of folder names and
7032 If a folder do not match, @code{wl-mime-charset} is used.
7034 @item wl-folder-init-load-access-folders
7035 @vindex wl-folder-init-load-access-folders
7036 The initial setting is @code{nil}.
7037 This is a list of access groups to be loaded specifically at the start.
7038 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7040 @item wl-folder-init-no-load-access-folders
7041 @vindex wl-folder-init-no-load-access-folders
7042 The initial setting is @code{nil}.
7043 This is a list of access groups not to be loaded specifically at the
7045 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7047 @item wl-delete-folder-alist
7048 @vindex wl-delete-folder-alist
7049 The initial setting is the alist shown below:
7058 This list determines disposition of messages with delete marks.
7059 Each item in the list is a folder and destination; you can specify any
7060 one of the following in the place of destination:
7063 @code{remove} or @code{null} : deletes the messages instantly.
7064 string : moves the messages to the specific folder.
7065 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7068 @item wl-refile-policy-alist
7069 @vindex wl-refile-policy-alist
7070 The initial setting is the list shown below:
7080 This list determines whether messages with re-file marks are moved or
7081 copied. Each item in the list is a cons cell of a folder and
7082 @code{copy} or @code{move}.
7084 @item wl-x-face-file
7085 @vindex wl-x-face-file
7086 The initial setting is @file{~/.xface}.
7087 The name of the file that contains encoded X-Face strings.
7090 @item wl-demo-display-logo
7091 @vindex wl-demo-display-logo
7092 If non-nil, bitmap image is shown on the opening demo. If you set
7093 @code{xpm} or @code{xbm}, (if possible) display selected image type
7096 @item elmo-use-database
7097 @vindex elmo-use-database
7098 This is meaningful for XEmacs only. The initial setting depends on
7099 XEmacs (@code{t} for XEmacs with dbm).
7100 If non-nil, Message-ID is controlled by dbm.
7102 @item elmo-passwd-alist-file-name
7103 @vindex elmo-passwd-alist-file-name
7104 The initial setting is @file{passwd}.
7105 This is the name of the file in which passwords are saved.
7106 @code{elmo-passwd-alist-save} saves current passwords to the file.
7108 @item elmo-nntp-list-folders-use-cache
7109 @vindex elmo-nntp-list-folders-use-cache
7110 The initial setting is 600 (in seconds).
7111 This is period in seconds during which results of @samp{list} and
7112 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7115 @item elmo-nntp-max-number-precedes-list-active
7116 @vindex elmo-nntp-max-number-precedes-list-active
7117 The initial setting is @code{nil}.
7118 If non-nil, the number of article obtained by @samp{list active} in NNTP
7119 are used as the maximum article number of the folder.
7120 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7121 and if the number of read messages is not correct.
7123 @item elmo-nntp-default-use-listgroup
7124 @vindex elmo-nntp-default-use-listgroup
7125 The initial setting is @code{t}.
7126 If non-nil, @samp{listgroup} is used for checking the total number of
7127 articles. If it is @code{nil}, @samp{group} is used. In the latter
7128 case, the processing will be a little faster at the sacrifice of
7131 @item elmo-pop3-send-command-synchronously
7132 @vindex elmo-pop3-send-command-synchronously
7133 The initial setting is @code{nil}.
7134 If non-nil, POP3 commands are issued synchronously. Some implementation
7135 of POP3 server fails to get summary information without this setting.
7136 You may have to set this variable to @code{t}, if the process hangs
7137 while looking up POP3.
7139 @item elmo-dop-flush-confirm
7140 @vindex elmo-dop-flush-confirm
7141 The initial setting is @code{t}.
7142 If non-nil, you are asked for confirmation if accumulated off-line
7143 operations are executed.
7145 @item elmo-display-progress-threshold
7146 @vindex elmo-display-progress-threshold
7147 The initial setting is 20.
7148 Threshold for display of progress gauge. If number of renewal is more than
7149 this value, display progress gauge.
7153 @node Hooks, , Customizable Variables, Customization
7159 @node Mailing List, Addition, Customization, Top
7160 @chapter Wanderlust Mailing List
7165 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7168 Topics related to Wanderlust are discussed in the mailing list.
7169 The latest version is also announced there (in Japanese, sorry).
7171 A guide can be obtained automatically by sending mail to
7172 @t{wl-ctl@@lists.airs.net} with the body
7177 Please send bug reports or patches to the mailing list. You can post to
7178 the mailing list even though you are not a member of it.
7180 If you send a bug report, please attach Backtrace with it.
7181 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7184 I would like to express my thanks to the members of the mailing list for
7185 valuable advice and many pieces of code they contributed.
7188 @node Addition, Index, Mailing List, Top
7189 @chapter Additional Information
7191 @section Brief History
7194 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7195 3/10 Made a msgdb mechanism by elisp.
7196 3/26 IMAP and NNTP can be displayed in threads.
7197 4/13 Began to assemble thread display modules as elmo.
7198 5/01 Finished 0.1.0, initial version with many defects.
7199 6/12 I made a slip of the tongue and said I was writing elisp
7200 mailer supporting IMAP
7201 6/16 0.1.3 was announced at tm-ja, elisp ML.
7202 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7203 7/01 Support for mm-backend (0.3.0).
7204 8/25 multi folder added (0.5.0).
7205 8/28 filter folder added (0.5.1).
7206 9/10 You can open/close threads (0.6.0).
7207 9/11 fldmgr by Murata-san made editing folders easy.
7208 9/18 lha folders added by Okunishi-san (0.6.3).
7209 9/24 Display of branches of threads (0.6.5).
7210 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7211 10/28 Off-line operations (0.7.4).
7212 12/09 Becomes beta version.
7213 12/21 wl-expire by Murata-san.
7214 1999 2/03 auto-refile by Tsumura-san.
7215 4/28 wl-template by Murata-san.
7216 5/18 Released 1.0.0 stable.
7217 7/05 Scoring by Murata-san (2.1.0).
7218 9/26 New plugged system by Murata-san (2.2.2).
7219 12/20 Support Modified UTF7.
7220 2000 3/24 Released 1.1.0 stable.
7221 4/03 CVS development started.
7222 5/07 Thread restoration & Its speed up with Murata-san.
7223 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7224 7/11 killed message feature.
7225 7/18 Use UIDL in POP3.
7226 9/12 biff feature with Satata-san & Yamaoka-san.
7227 10/17 expire-hide by Okada-san.
7228 11/08 Released 2.4.0 stable.
7229 2001 7/04 Released 2.6.0 stable.
7230 8/21 wl-addrmgr by Kitamoto-san.
7231 12/27 Released 2.8.1 stable.
7234 See @file{ChangeLog} for details.
7238 According to a dictionary, Wanderlust has the meaning:
7242 n eager longing for or impulse towards travelling in distant lands
7243 [Ger, fr wandern to wander + lust desire, pleasure]
7247 but I had no profound intention. (if farfetched, IMAP @result{} you can
7248 read mail anywhere @result{} desire to wander ?)
7250 Elmo is the abbreviation of @samp{Elisp Library for Message
7251 Orchestration}. At first I meant the red puppet in the Sesame Street,
7252 but you may associate it with Wandering @result{} Drifting @result{}
7253 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7257 Each versions has code names (they are almost jokes).
7258 Currently they are picked up alphabetically from the top 40 hits of
7259 U.S. Billboard magazines in 1980s.
7261 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7264 @node Index, , Addition, Top
7268 * Concept Index:: Concept Index
7269 * Key Index:: Key Index
7270 * Variable Index:: Variable Index
7271 * Function Index:: Function Index
7274 @node Concept Index, Key Index, Index, Index
7275 @unnumberedsec Concept Index
7278 @node Key Index, Variable Index, Concept Index, Index
7279 @unnumberedsec Key Index
7282 @node Variable Index, Function Index, Key Index, Index
7283 @unnumberedsec Variable Index
7286 @node Function Index, , Variable Index, Index
7287 @unnumberedsec Function Index