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-euc_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}
1324 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1325 @section Namazu Folder
1327 @cindex Namazu Folder
1328 @cindex Folder, Namazu
1329 @cindex Folder, Text Search
1332 A folder to access messages found in namazu-index with some condition.
1333 It uses namazu (@uref{http://www.namazu.org/}) for search.
1339 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1343 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1349 [wanderlust] -> search messages matched with
1350 "wanderlust" from the default index
1351 [semi flim]~/Mail/semi -> search "semi flim" from the index
1352 in the directory "~/Mail/semi"
1358 @subsubsection Enter space to separate keywords
1360 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1362 @subsubsection Alias name for index
1364 You can define an alias name for index.
1369 (setq elmo-nmz-index-alias-alist
1370 '(("cache" . "~/.elmo/cache")
1371 ("docs" . "~/documents")))
1374 Above definition defines two index aliases.
1381 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1382 directory @file{~/.elmo/cache}.
1384 @subsubsection Multiple indices
1386 You can specify a list for @code{elmo-nmz-default-index-path} and
1387 @code{elmo-nmz-index-alias-alist}.
1388 When list is specified, all index contained in the list is used as the
1394 (setq elmo-nmz-index-alias-alist
1395 '(("all" . ("~/.elmo/cache" "~/documents"))
1396 ("cache" . "~/.elmo/cache")))
1399 Using above alias setting, you can specify
1405 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1406 directory @file{~/.elmo/cache} and @file{~/documents}.
1408 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1409 @section Multi Folder
1411 @cindex Multi Folder
1412 @cindex Folder, Multiple
1413 @cindex Folder, Marge
1415 A folder to access virtual folder which collects messages from
1422 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1426 After @samp{*} character, specify multiple folders you want to collect
1427 separated by @samp{,} like
1428 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1434 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1435 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1436 treated as one folder.
1438 *+inbox,-fj.rec.tv,%inbox
1439 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1444 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1445 @section Filter Folder
1447 @cindex Filter Folder
1448 @cindex Folder, Filtering
1449 @cindex Folder, Virtual
1450 @cindex Folder, Conditional
1452 A folder to access virtual folder which collects all messages that
1453 satisfy a condition.
1458 @samp{/} @var{condition} @samp{/} @var{target-folder}
1461 In the @var{condition} part, you can specify following.
1465 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1467 first: @var{number} messages are picked from top of folder.
1468 last: @var{number} messages are picked from bottom of folder.
1474 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1475 /first:20/%inbox -> First 20 messages from %inbox are picked.
1480 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1482 since: only messages arrived since @var{date} are picked.
1483 before: only messages arrived before @var{date} are picked.
1485 You can specify following as @var{date}.
1489 yesterday -> a day before today.
1490 lastweek -> same day of last week.
1491 lastmonth -> same day of last month.
1492 lastyear -> same day of last year.
1493 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1494 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1502 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1504 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1510 Field filter: @samp{@var{field}:@var{value}}
1512 All messages that have @var{field} and its value is @var{value} are picked.
1513 @var{field} and @var{value} are case insensitive.
1519 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1520 and its value includes "teranisi" string are picked.
1521 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1529 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1530 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1532 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1533 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1539 /from:teranisi&!to:teranisi/+inbox
1540 -> In +inbox, messages are picked if the message's
1541 From: field includes "teranisi" and
1542 To: field doesn't include "teranisi".
1544 /tocc:"Yuuichi Teranishi"/+inbox
1545 -> In +inbox, messages are picked if the
1546 message's To: field or Cc: field includes
1547 "Yuuichi Teranishi".
1549 /(from:yt|from:teranisi)&subject:report/+inbox
1550 -> In +inbox, messages are picked if the message's
1551 From: field includes "yt" or "teranisi", and
1552 Subject includes "report".
1558 Tip for string description:
1560 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1561 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1562 should be escaped with @samp{\} in it). You can enclose the string with
1563 @samp{"} even it does not contain these characters.
1569 *%inbox,/from:teranisi/%inbox@@server
1570 -> Messages in %inbox or
1571 message is in the %inbox@@server folder and it's From field
1572 includes "teranisi" are collected.
1574 /last:100//to:teranisi/*+inbox,%inbox
1575 -> Latest 100 messages which is in the +inbox or %inbox folder
1576 and To: field matches "teranisi".
1578 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1579 -> Pick messages which have From: field and it includes "hogehoge"
1580 from latest 20 messages in the %#mh/inbox@@localhost
1581 and To: or Cc: field includes "teranisi".
1584 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1585 @section Pipe Folder
1589 @cindex Download Message
1590 @cindex Incorporate Message
1592 In the pipe folder, messages are automatically transferred from the source
1593 folder to destination folder.
1598 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1601 When you access the pipe folder, messages are automatically transferred
1602 from @var{source-folder} to @var{destination-folder}.
1603 It is convenient if you want to download messages to local disk via POP.
1604 For example, if you specify following
1607 |&username@@popserver|+inbox
1611 and access it, messages are downloaded automatically from
1612 @samp{&username@@popserver} to @samp{+inbox}.
1614 On the other hand, if you put @samp{|:} instead of second @samp{|},
1615 then messages are copied to the destination folder (not deleted from
1616 source-folder). At the next time you access that folder, only new
1617 messages will be copied.
1620 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1623 If you want to copy messages from POP server and view them, specify the
1627 |&username@@popserver|:+inbox
1630 where messages will be kept on the server.
1636 |%inbox|%myinbox -> Download %inbox to %myinbox.
1637 |*&user@@popserver1,&user@@popserver2|+inbox
1638 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1639 |-gnu.emacs.sources|:+sources
1640 -> Copy messages from -gnu.emacs.sources to +sources.
1644 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1646 @node Internal Folder, , Pipe Folder, Folders
1647 @section Internal folder
1649 @cindex Internal Folder
1650 @cindex Folder, @samp{$} mark
1652 @c @cindex Folder, Null
1654 A folder to access internal messages of Wanderlust.
1666 A folder named @samp{'mark} is a special virtual folder which collects
1667 messages which have important mark @samp{$}.
1669 You can review important messages at once after you put important marks
1670 on the messages in the different folders.
1672 In this folder, if you delete message, important mark @samp{$} put on
1673 the message is removed. If you append messages to this folder, the
1674 message will have @samp{$} mark.
1676 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1677 folder. If you want IMAP folder's message remove from @samp{'mark}
1678 folder, remove important mark at IMAP Folder.)
1681 A folder named @samp{'sendlog} is a virtual folder which collects
1682 cached messages which are recoded on @file{~/.elmo/sendlog}.
1683 It might be useful when you forgot to add cc for yourself.
1684 To use this, you should set @code{wl-draft-use-cache} to non-nil
1685 so that sent messages are cached.
1688 You can access cached messages fetched via network by accessing
1689 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1690 the name of the subdirectories of the cache directory
1691 (@file{~/.elmo/cache}).
1694 @node Folder, Summary, Folders, Top
1695 @chapter Folder mode
1698 After you start Wanderlust, folder mode is appeared firstly.
1699 It contains folder list you subscribed.
1700 You can select and edit folders in this mode.
1703 * Selecting Folder:: Select folder you want to read
1704 * Folder Manager:: Editing folders
1708 @node Selecting Folder, Folder Manager, Folder, Folder
1709 @section Selecting Folder
1710 @cindex Selecting Folder
1712 @subsection Usage (TIPS)
1714 @subsubsection Check new, unread number
1716 Folder mode looks like this.
1717 (In XEmacs, it looks much nicer @t{;-)})
1721 [-]Desktop:14186/35580/67263
1726 [-]Emacsen:0/34/4837
1727 Wanderlust ML:0/0/558
1730 XEmacs Beta:0/29/255
1741 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1745 @kbd{s} key on the folder line updates these numbers.
1746 It changes its color if it has many new messages.
1748 The whole folder mode is a folder group named @samp{Desktop}.
1749 Folder group open/close by return key.
1750 A operation to a folder group is treated as operations on the
1752 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1753 six children folders update its unread number status.
1755 @subsubsection Select Folder
1757 To enter summary mode of the folder, type return (or space) key on
1759 If the variable @code{wl-stay-folder-window} has non-nil value,
1760 summary window appears on the right of the folder mode window.
1762 @subsection Key bindings
1764 Folder mode's key binding (related to selecting folders) is following.
1769 @kindex @key{SPC} (Folder)
1770 @kindex @key{RET} (Folder)
1771 @findex wl-folder-jump-to-current-entity
1772 Enter to the summary mode of the folder at the current cursor point.
1773 If the cursor is on the top of folder group line,
1774 the folder group is opened or closed.
1775 When the cursor is on the access group and this command is called
1776 with prefix argument, folder children list is updated to the newest one.
1777 (Children list is updated recursively if the access folder has hierarchical
1779 (@code{wl-folder-jump-to-current-entity})
1782 @kindex M-@key{RET} (Folder)
1783 @findex wl-folder-update-recursive-current-entity
1784 Folder children list of the access group at the current cursor point
1785 is updated to the newest one.
1786 (Children list is updated recursively if the access folder has hierarchical
1788 (@code{wl-folder-update-recursive-current-entity})
1793 Create a new draft message.
1798 @findex wl-folder-write-current-folder
1799 If the current cursor point is on the NNTP folder, create a new draft
1800 message which already has @samp{Newsgroups:} field. If the current
1801 cursor point is on the folder for mailing list (refile destination),
1802 create a new draft message which already has @samp{To:} field with
1803 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1805 (@code{wl-folder-write-current-folder})
1808 @kindex C-c C-o (Folder)
1809 @findex wl-jump-to-draft-buffer
1810 Move to the draft buffer if available. If multiple draft buffer exists,
1811 moved to one after another. If prefix argument is specified, load draft
1812 folder's message to the draft buffer and jump to it.
1813 (@code{wl-jump-to-draft-buffer})
1817 @findex wl-folder-check-current-entity
1818 Update new and unread number information of the folder at the current
1820 (@code{wl-folder-check-current-entity})
1824 @findex wl-folder-sync-current-entity
1825 Update summary information of the folder at the current cursor point.
1826 (@code{wl-folder-sync-current-entity})
1829 @kindex r s (Folder)
1830 @findex wl-folder-check-region
1831 Update new and unread number information of the folders in the currently
1833 (@code{wl-folder-check-region})
1836 @kindex r S (Folder)
1837 @findex wl-folder-sync-region
1838 Update summary information of the folders in the currently selected region.
1839 (@code{wl-folder-sync-region})
1843 @findex wl-status-update
1844 Sync up address book status with @file{~/.addresses}'s content.
1845 (@code{wl-status-update})
1849 @findex wl-folder-prev-unread
1850 Jump cursor to the folder which have unread messages on the upward from
1851 current cursor point.
1852 (@code{wl-folder-prev-unread})
1856 Jump cursor to the folder which have unread messages on the downward
1857 from current cursor point.
1858 (@code{wl-folder-next-unread})
1862 Move cursor to the folder on the previous line.
1863 (@code{wl-folder-prev-entity})
1867 Move cursor to the folder on the next line.
1868 (@code{wl-folder-next-entity})
1872 Jump to the folder specified by the user input.
1873 (@code{wl-folder-jump-folder})
1877 @findex wl-folder-prefetch-current-entity
1878 Prefetch new messages of the folder at the current cursor point by
1879 @code{wl-summary-incorporate}.
1880 If the cursor is on the folder group, it is executed recursively.
1881 (@code{wl-folder-prefetch-current-entity})
1885 @findex wl-folder-mark-as-read-all-current-entity
1886 Mark all unread messages of the folder at the current cursor point as read.
1887 If the cursor is on the folder group, it is executed recursively.
1888 (@code{wl-folder-mark-as-read-all-current-entity})
1892 @findex wl-folder-goto-first-unread-folder
1893 Enter summary mode of the first unread folder.
1894 (@code{wl-folder-goto-first-unread-folder})
1898 @findex wl-folder-empty-trash
1900 (@code{wl-folder-empty-trash})
1904 @findex wl-folder-open-all-unread-folder
1905 All unread folder is opened.
1906 (@code{wl-folder-open-all-unread-folder})
1910 @findex wl-folder-open-close
1911 Folder group is opened/closed.
1912 (@code{wl-thread-open-close})
1916 All folder group is opened.
1917 (@code{wl-folder-open-all})
1921 All folder group is closed.
1922 (@code{wl-folder-close-all})
1932 (@code{wl-folder-suspend})
1935 @kindex M-s (Folder)
1936 Save current folder status.
1940 @kindex M-t (Folder)
1941 Toggle Wanderlust's offline/online status.
1942 (@code{wl-toggle-plugged})
1945 @kindex C-t (Folder)
1946 Start Wanderlust's plug-status manager.
1947 (@code{wl-plugged-change})
1950 @subsection Customize variables
1953 @item wl-folders-file
1954 @vindex wl-folders-file
1955 The initial setting is @file{~/.folders}.
1956 Subscribed folders are described (saved) in this file.
1958 @item wl-folder-info-save
1959 @vindex wl-folder-info-save
1960 The initial setting is @code{t}. If non-nil, unread information is
1961 saved and used in the next Wanderlust session.
1963 @item wl-stay-folder-window
1964 @vindex wl-stay-folder-window
1965 The initial setting is @code{nil}.
1966 If non-nil, summary window is appeared on the right side of the folder buffer.
1968 @item wl-folder-window-width
1969 @vindex wl-folder-window-width
1970 The initial setting is 20.
1971 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1973 @item wl-folder-use-frame
1974 @vindex wl-folder-use-frame
1975 The initial setting is @code{nil}.
1976 If non-nil, use new frame for the folder window.
1978 @item wl-folder-many-unsync-threshold
1979 @vindex wl-folder-many-unsync-threshold
1980 The initial setting is 70.
1981 If the number of unread messages is more than this value,
1982 folder color is changed.
1984 @item wl-highlight-folder-by-numbers
1985 @vindex wl-highlight-folder-by-numbers
1986 This option controls how to highlight each line in the folder buffer.
1987 The default value is @code{t}, highlighting with various colors based on
1988 the message numbers. If it is @code{nil}, highlighting with various
1989 colors based on the folder status. In addition, if it is a number
1990 (e.g. 1), highlighting will be done based on both the message numbers
1991 and the folder status.
1993 @item wl-folder-desktop-name
1994 @vindex wl-folder-desktop-name
1995 The initial setting is @samp{Desktop}.
1996 The name of top folder group.
1998 @item wl-folder-petname-alist
1999 @vindex wl-folder-petname-alist
2000 The initial setting is @code{nil}.
2001 An alist of folder's realname and its nickname.
2003 @item wl-folder-access-subscribe-alist
2004 @vindex wl-folder-access-subscribe-alist
2005 The initial setting is @code{nil}.
2007 Control automatic subscribing and unsubscribing of the children list
2013 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2017 If @var{subscribe-flag} is non-nil, folders which have name matched to
2018 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2019 already unsubscribed folder is not displayed even when the
2020 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2027 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2028 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2029 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2030 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2034 @item wl-folder-hierarchy-access-folders
2035 @vindex wl-folder-hierarchy-access-folders
2036 The initial setting is the list shown below:
2045 A list of access groups which creates children folder list hierarchically.
2047 For example, if you specify
2048 @code{wl-folder-hierarchy-access-folders} like following,
2052 (setq wl-folder-hierarchy-access-folders
2053 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
2058 such access group hierarchy is obtained.
2064 -fj.comp.announce:0/0/2
2065 -fj.comp.dev.cdrom:0/0/0
2067 [+]-japan:238/238/1688
2070 -comp.unix.admin:0/0/0
2071 -comp.unix.dos-under-unix:0/0/0
2072 -comp.unix.programmer:0/0/0
2073 [-]-comp.unix.bsd:0/0/23
2074 -comp.unix.bsd.freebsd.announce:0/0/0
2079 If you opened @samp{-} in this example, only the direct children is created
2080 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2081 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2082 is not created until the children access group is opened.
2086 @node Folder Manager, , Selecting Folder, Folder
2087 @section Editing Folders
2088 @cindex Folder Manager
2089 @cindex Folder, Edit
2090 @cindex Folder, Subscribe
2091 @cindex Folder, Unsubscribe
2093 As described before, subscribed folder list is saved in @file{~/.folders} file.
2094 But you don't have to edit @file{~/.folders} directly.
2095 You can append, delete, edit folders from folder mode.
2097 @subsection Usage (Tips)
2099 @subsubsection Append Folder
2101 @kbd{m a} appends new folder to the folder mode.
2102 @kbd{m g} appends new folder group.
2103 To append new folder to this group, firstly open it,
2104 then execute append command in the next line.
2106 @subsubsection Edit Folder
2108 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2109 Thus, you can change folder position as if you were editing a normal file.
2111 @subsubsection Create Multi Folder.
2115 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2117 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2119 Type @kbd{m m}, then you can create multi folder.
2122 @subsubsection Delete Nickname, Filter
2124 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2125 minibuffer while appending.
2127 @subsubsection Append Folder to Empty Group
2129 To append new folder to the empty folder group
2130 (after you create folder group by typing @kbd{m g}),
2131 firstly open it, then execute append command in the next line.
2132 If it is closed, folder is appended on the same level with
2133 the above folder group. It is difficult to explain by words so try it.
2134 In other words, appended position depends on the
2135 above folder group's open/close status.
2137 @subsubsection Charset of the Folders File.
2139 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2141 @subsubsection Create Filter
2143 @kbd{m f} adds filter to the folder at the current cursor point. To
2144 create new filter folder and leave the current folder unchanged, copy it
2145 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2146 filter can be specified while appending filter. If you put
2147 ``''(@var{NULL}), filter is deleted.
2149 @subsubsection Sort Folders
2151 Sorting of the folders is executed by the function specified by
2152 @code{wl-fldmgr-sort-function}.
2153 The initial setting is @code{wl-fldmgr-sort-standard},
2154 which sorts alphabetically.
2155 Sorting affects only on the current folder group. It does not
2156 affect on the child groups.
2158 @subsubsection Hiding Folders in the Access Group
2160 Usually, access group displays all children folders, but you can set
2161 some folders hidden. Following operations are only available on access
2164 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2165 (subscribe/unsubscribe) of the folder at current cursor point. Against
2166 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2169 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2170 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2171 argument and if the argument has positive number, the unsubscribe it.
2172 If the prefix argument has negative value, folder becomes visible and if
2173 zero, folder visibility is toggled.
2175 The other commands, @code{wl-fldmgr-subscribe} and
2176 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2179 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2180 executed in the access group, they have a same effect with
2181 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2182 The difference is that cut commands deletes folders from the current
2185 @subsubsection Operations in the Access Group
2187 You can insert and delete folders in the access group like usual folder
2188 group. But insert and delete commands can be only available for the
2189 children folders of the access group and they only sets the subscribe
2190 status. In other words, insertion of the folder means subscribing,
2191 deletion means unsubscribing.
2192 @footnote{In the current implementation,
2193 it is faster to delete region than to unsubscribe region.}
2195 To update the access group when children folders are inserted or deleted
2196 by other way (other than Wanderlust),
2197 open the access group by typing @kbd{C-u @key{RET}}.
2198 @xref{Selecting Folder}.
2200 The order of children folders of access group is saved after
2201 insertion/deletion/sorting.
2202 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2203 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2204 newly created folders are inserted on the top of the access group.
2206 @subsection Key bindings
2207 @cindex Keybind, Folder Mode
2208 @cindex Keybind, Folder Buffer
2210 Key bindings on the folder mode related to folder editing are shown below.
2211 All bindings starts with @kbd{m}, and primary commands are binded to
2212 one stroke key binding.
2216 @kindex m a (Folder)
2217 @findex wl-fldmgr-add
2219 (@code{wl-fldmgr-add})
2224 @kindex m g (Folder)
2225 @findex wl-fldmgr-make-group
2226 Create a folder group.
2227 (@code{wl-fldmgr-make-group})
2230 @kindex m A (Folder)
2231 @findex wl-fldmgr-make-access-group
2232 Create an access group.
2233 (@code{wl-fldmgr-make-access-group})
2236 @kindex m d (Folder)
2237 @findex wl-fldmgr-delete
2238 Delete folder itself and msgdb.
2239 If the folder itself cannot be deleted like NNTP folder,
2240 only msgdb is deleted.
2241 (@code{wl-fldmgr-delete})
2246 @kindex m R (Folder)
2247 @findex wl-fldmgr-rename
2248 Change the name of folder or folder group.
2249 msgdb's path is also changed.
2250 (@code{wl-fldmgr-rename})
2256 @findex wl-fldmgr-make-multi
2257 Create a multi folders in the cutlist (cut, copied folders).
2258 (@code{wl-fldmgr-make-multi})
2263 @kindex m f (Folder)
2264 @findex wl-fldmgr-make-filter
2265 Create a filter folder. (Put a filter on the folder).
2266 (@code{wl-fldmgr-make-filter})
2270 @kindex M-c (Folder)
2271 @kindex m c (Folder)
2272 @findex wl-fldmgr-copy
2273 Copy folder (it is not available on folder group).
2274 (@code{wl-fldmgr-copy})
2278 @kindex M-w (Folder)
2279 @kindex m W (Folder)
2280 @findex wl-fldmgr-copy-region
2281 Copy folders in the specified region.
2282 (@code{wl-fldmgr-copy-region})
2286 @kindex C-k (Folder)
2287 @kindex m k (Folder)
2288 @findex wl-fldmgr-cut
2289 Cut folder. Folder itself is not deleted.
2290 (@code{wl-fldmgr-cut})
2294 @kindex C-w (Folder)
2295 @kindex m C-w (Folder)
2296 @findex wl-fldmgr-cut-region
2297 Cut folders in the specified region.
2298 (@code{wl-fldmgr-cut-region})
2302 @kindex C-y (Folder)
2303 @kindex m y (Folder)
2304 @findex wl-fldmgr-yank
2305 Paste folders that are copied or cut (folders in the cut-list).
2306 (@code{wl-fldmgr-yank})
2309 @kindex m p (Folder)
2310 @findex wl-fldmgr-set-petname
2311 Put nickname on the folder.
2312 (@code{wl-fldmgr-set-petname})
2315 @kindex m q (Folder)
2316 @findex wl-fldmgr-clear-cut-entity-list
2317 Clear the cut-list. (cut, copied folder information is cleared,
2318 you cannot paste after this)
2319 (@code{wl-fldmgr-clear-cut-entity-list})
2322 @kindex m s (Folder)
2323 @findex wl-fldmgr-sort
2324 Sort folders in the current folder group.
2325 (@code{wl-fldmgr-sort})
2328 @kindex m C-s (Folder)
2329 @findex wl-fldmgr-save
2330 Save current folder view to the @file{wl-folders-file}.
2331 (@code{wl-fldmgr-save})
2334 [Following commands are only available on the access groups]
2340 @kindex m u (Folder)
2341 @findex wl-fldmgr-unsubscribe
2342 Set the visibility of folder (subscribe/unsubscribe).
2343 (@code{wl-fldmgr-unsubscribe})
2348 @kindex r u (Folder)
2349 @findex wl-fldmgr-unsubscribe-region
2350 Set the visibility of the folders (subscribe/unsubscribe) in the
2352 (@code{wl-fldmgr-unsubscribe-region})
2357 @kindex m l (Folder)
2358 @findex wl-fldmgr-access-display-normal
2359 List folders that are currently available.
2360 (@code{wl-fldmgr-access-display-normal})
2365 @kindex m L (Folder)
2366 @findex wl-fldmgr-access-display-all
2367 List all folders regardless of the subscription status.
2368 (@code{wl-fldmgr-access-display-all})
2372 @subsection Customize variables
2375 @item wl-interactive-save-folders
2376 @vindex wl-interactive-save-folders
2377 The initial setting is @code{t}. If non-nil and folder view is
2378 modified, confirm saving it before Wanderlust or Emacs exits. If
2379 @code{nil}, save without confirmation.
2381 @item wl-fldmgr-make-backup
2382 @vindex wl-fldmgr-make-backup
2383 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2384 created before saving the folder status.
2386 @item wl-fldmgr-sort-function
2387 @vindex wl-fldmgr-sort-function
2388 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2389 sort folders. By default function, folders are sorted alphabetically
2390 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2393 @item wl-fldmgr-sort-group-first
2394 @vindex wl-fldmgr-sort-group-first
2395 The initial setting is @code{t}. If non-nil,
2396 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2397 does not care whether it is folder group or not.
2399 @item wl-folder-check-async
2400 @vindex wl-folder-check-async
2401 The initial setting is @code{t}. If non-nil, check folder's unread
2402 status asynchronously. It boosts newsgroup checking.
2404 @item wl-folder-check-fast
2405 @vindex wl-folder-check-fast
2406 The initial setting is @code{nil}.
2407 If non-nil, it does not update folder status while checking.
2409 @item wl-folder-notify-deleted
2410 @vindex wl-folder-notify-deleted
2411 The initial setting is @code{nil}.
2413 If non-nil, negative value is displayed when the message is deleted. If
2414 @code{sync}, folder is synchronized when the message is deleted. If
2415 @code{nil}, message deletion is ignored.
2417 @item wl-fldmgr-add-complete-with-current-folder-list
2418 @vindex wl-fldmgr-add-complete-with-current-folder-list
2419 The initial setting is @code{nil}.
2420 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2421 candidate for @code{wl-fldmgr-add}.
2424 @subsection Miscellanea
2426 Following is a note for folder editing.
2430 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2431 paste(yank) command pastes the folders on one cut or copy command
2432 (If copy command is executed by region, folders in the region are pasted
2433 by one paste command)
2436 You cannot cut @samp{Desktop} group.
2437 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2440 You cannot copy folder group.
2443 Operations on the access group are only available for the folders
2444 in the same access group.
2447 You cannot create a folder which has same name with the folders already exist.
2450 You cannot insert folders which have same name in one group.
2451 You can insert them in the different groups.
2452 You cannot put same nickname to the different folders.
2456 @node Summary, Message, Folder, Top
2457 @chapter Summary Mode
2459 After you select the folder via folder mode, you enter to the summary
2463 * Usage of Summary Mode:: TIPS
2464 * Thread Operations:: Thread operations
2465 * Cache:: File cache, Buffer cache, and Prefetch
2466 * Auto Refile:: Auto refile settings
2467 * Sticky Summary:: Summary make sticky
2468 * Key Bindings of Summary:: Key bindings
2469 * Variables of Summary:: Customize Summary Mode
2473 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2474 @section Usage (Tips)
2476 @subsection Summary Content
2478 In the summary mode, messages are displayed like following.
2482 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2483 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2484 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2485 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2492 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2496 You cannot change this in the current version.
2498 @var{Message number} is the message's unique number in the folder. In
2499 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2500 in the MH folder, it is the filename of the message.
2502 @var{Temporal mark} and @var{Persistent mark} are described later.
2504 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2505 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2506 Japanese, but if you want to display it in English, set the value of
2507 @code{wl-summary-weekday-name-lang} as @samp{en}.
2509 @var{Sender}'s indentation corresponds to the depth of the thread.
2510 Sender name is displayed as nickname if it is defined in the address
2511 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2512 displaying with nickname.
2514 If number is printed at the head of @var{Sender} part like @samp{+2},
2515 that means the message have 2 follow messages.
2517 @var{Subject} is the @samp{Subject:} header field of the message. If
2518 the message have same @samp{Subject:} with the parent message, it is not
2519 displayed. Some mailing list puts its sequence number in the
2520 @samp{Subject:} field, but it is
2521 ignored. @code{wl-summary-no-subject-message} is displayed when the
2522 message has empty subject field.
2524 @subsection Temporary Marks
2525 @cindex Mark, Temporary
2527 There are four temporary marks,
2528 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2529 Temporary marks indicates message operations.
2534 You can execute a command on the all messages that have @samp{*} mark,
2535 with the key bindings which begins with @kbd{m}.
2538 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2542 After you type @kbd{o} key, prompt appears to input refile destination.
2543 Your answer is printed in the summary line.
2547 You can put this mark by typing @kbd{O} key.
2548 The difference between this mark and refile mark is,
2549 this mark does not delete the message while latter does.
2552 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2554 @subsection Persistent Marks
2556 There are five persistent marks,
2557 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2559 The persistent mark indicates the message's status and it is saved.
2560 Each persistent mark indicates:
2566 It is unread message.
2568 It is unread but cached message.
2570 It is read but it is not cached.
2572 It is important message. You can put @samp{$} mark by typing @kbd{$}
2573 key (if already exists, the mark is deleted). It is convenient to put
2574 this mark on the messages to remember (If you want to remember to write
2575 a reply for the message, for example) because this mark remains after
2576 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2577 @samp{'mark} folder even the message itself is deleted in the actual folder.
2580 If the message is read and cached (or local message),there are no
2584 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2585 cache. Messages with the marks other than these, you can read them in
2586 the offline status even they are in the IMAP folder or netnews folder.
2588 Among messages with persistent marks, ones with marks specified by
2589 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2590 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2592 @subsection How To Read
2594 Basically, you can read messages only typing space key again and again.
2596 To update summary status to the newest status (synchronize),
2599 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2600 moves cursor to the next message.
2601 Enter message buffer by typing @kbd{j} key.
2602 To operate multipart, you have to enter to the message buffer.
2605 @subsection Pack the Message Numbers
2606 You can pack the message numbers in Summary by
2607 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2608 News Spool Folder and Maildir Folder are supported folder types.
2611 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2612 @section Thread Operations
2614 For example, the following line indicates one thread (a context of a topic).
2617 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2621 If you type @kbd{/} on this line, the thread is opened and it changes
2622 the appearance like following.
2626 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2627 388 09/17(Thu)22:34 +-[ Murata san ]
2631 (Message 388 is the replied message to the message 384.)
2632 If you type @kbd{/} key once again, the thread is closed.
2633 With prefix argument, @kbd{/} opens all children threads.
2635 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2638 Commands with the key binding that begins with @kbd{t} executes commands
2639 on the messages in the thread.
2640 @xref{Key Bindings of Summary}.
2642 @subsection reconstruct thread by hand
2644 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2645 (@code{wl-summary-save-current-message}) at the corresponding message,
2646 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2647 message then you have the reconstructed thread.
2650 @node Cache, Auto Refile, Thread Operations, Summary
2653 @subsection Cache File
2655 The messages which have to access via network (e.x. IMAP, NNTP folder)
2656 are cached as a local file. The cache file is saved under the directory
2657 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2658 elmo-cache-expire-by-size}. The command deletes cache files to the
2659 specified size by the order of last accessed time.
2661 @subsection Buffer Cache and Prefetching
2663 The messages that are read are kept in the cache buffer. It is called
2664 `buffer cache'. The number of cache buffer is specified by
2665 @code{wl-message-buffer-cache-size}.
2667 There are message prefetching mechanism in the Wanderlust that
2668 prefetches next message while you are reading.
2670 You can control the message prefetching mechanism by these two
2674 @item wl-message-buffer-prefetch-folder-type-list
2675 @vindex wl-message-buffer-prefetch-folder-type-list
2676 The initial setting is @code{t}. In this case, prefetch messages in all
2678 If it is a list of folder types, it specifies the folder types in which
2679 message prefetching is enabled.
2680 Following is an example (prefetch messages in nntp and imap4 folders)
2684 (setq wl-message-buffer-prefetch-folder-type-list
2689 In this case, multi folder that contains localdir and imap4 prefetches
2690 only imap4 messages. This variable precedes the value of
2691 @code{wl-message-buffer-prefetch-folder-list}.
2693 @item wl-message-buffer-prefetch-folder-list
2694 @vindex wl-message-buffer-prefetch-folder-list
2695 The initial setting is @code{nil}.
2696 A list of regexp of folders to enable message prefetching.
2700 @node Auto Refile, Sticky Summary, Cache, Summary
2701 @section Auto Refile
2702 @vindex elmo-msgdb-extra-fields
2703 @vindex wl-refile-rule-alist
2704 @findex wl-summary-auto-refile
2706 You can refile messages automatically, by typing @kbd{C-o}
2707 (@code{wl-summary-auto-refile}). It decides destination of refile by
2708 the content of the message header information (information in the msgdb).
2710 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2711 available. If you want to decide destination by other header fields,
2712 set the variable @code{elmo-msgdb-extra-fields} like following.
2716 (setq elmo-msgdb-extra-fields
2726 By this setting, Wanderlust saves extra fields in the msgdb. You have
2727 to type @kbd{s all} to get extra fields for the messages that are
2728 already exists in the summary.
2730 Then, specify the refile rule. The refile target folder of auto
2731 refiling is decided by the value of @code{wl-refile-rule-alist}.
2732 @code{wl-refile-rule-alist} is a list of a rule:
2736 (@var{field} (@var{regexp} . @var{target})
2737 (@var{regexp} . @var{target})
2742 Each rule means `if @var{field} value matches @var{regexp},
2743 then refile to @var{target} folder'.
2744 The rule matched first is applied.
2746 @var{field} is a string of field name. You can specify a list of field name
2747 string, too. In this case, if one of these fields is matched, then the
2748 rule is fired (i.e. OR condition).
2750 @var{regexp} is a regular expression for field value. @var{target} is a target
2751 folder string. You can specify a rule at @var{target} part, too. In this
2752 case, If the field value of the rule and the current rule is matched,
2753 then the current rule is fired (i.e. AND condition).
2755 In @var{target} part, you can refer matched substring of @var{regexp}.
2756 To refer substring, specify following in @var{target}:
2760 means substitute original matched text.
2763 means substitute what matched the @var{N}th `\(@dots{}\)'.
2764 (@var{N} is a number.)
2767 Following is an example of @code{wl-refile-rule-alist}.
2771 (setq wl-refile-rule-alist
2773 ("^Wanderlust" . "+wl")
2774 ("^Elisp" . "+elisp"))
2776 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2778 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2779 "+from-me-to-you"))))))
2783 After these settings, refile marks are automatically put on the condition
2784 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2786 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2788 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2789 with these persistent marks are not automatically refiled.
2790 It means Wanderlust does not execute auto refile on unread messages by
2791 the default setting.
2792 To execute auto refile on all messages, set following.
2795 (setq wl-summary-auto-refile-skip-marks nil)
2799 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2800 @section Sticky Summary
2801 @cindex Summary, Sticky
2802 @cindex Sticky Summary
2804 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2806 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2807 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2809 The buffer name of the sticky summary becomes like
2810 @samp{Summary:@var{folder-name}}.
2812 You can visit the sticky summary at any time by @kbd{C-x b}
2813 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2814 q}. Other operations in the sticky summary are same as normal summary.
2816 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2817 are automatically stuck.
2820 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2821 @section Key bindings
2822 @cindex Keybind, Summary Mode
2823 @cindex Keybind, Summary Buffer
2825 Key bindings of the summary mode are shown below.
2829 @kindex @key{SPC} (Summary)
2830 @findex wl-summary-read
2831 Proceed reading a message at the current cursor point.
2832 (@code{wl-summary-read})
2836 @findex wl-summary-redisplay
2837 Redisplay a message at the current cursor point.
2838 If this command is called with prefix argument,
2839 Redisplay message regardless of the message cache (message is re-loaded
2841 (@code{wl-summary-redisplay})
2845 @findex wl-summary-display-top
2846 Display the top message in the folder.
2847 (@code{wl-summary-display-top})
2851 @findex wl-summary-display-bottom
2852 Display the bottom message in the folder.
2853 (@code{wl-summary-display-bottom})
2857 @kindex @key{BS} (Summary)
2858 @kindex @key{DEL} (Summary)
2859 Display the previous page of the message at the current cursor point.
2860 @findex wl-summary-prev-page
2861 (@code{wl-summary-prev-page})
2864 @kindex @key{RET} (Summary)
2865 @findex wl-summary-next-line-content
2866 Display the next line of the message at the current cursor point.
2867 Display the message at the current cursor point if it is not displayed yet.
2868 (@code{wl-summary-next-line-content})
2873 @kindex M-@key{RET} (Summary)
2874 @findex wl-summary-prev-line-content
2875 Display the previous line of the message at the current cursor point.
2876 Display the message at the current cursor point if it is not displayed yet.
2877 (@code{wl-summary-prev-line-content})
2881 @findex wl-thread-open-close
2882 Toggle open or close the thread at the current cursor point.
2883 (@code{wl-thread-open-close})
2888 @findex wl-thread-open-all
2889 (@code{wl-thread-open-all})
2894 @findex wl-thread-close-all
2895 (@code{wl-thread-close-all})
2899 @findex wl-summary-goto-folder
2901 (@code{wl-summary-goto-folder})
2905 Mark all messages in the folder as read.
2906 @findex wl-summary-mark-as-read-all
2907 (@code{wl-summary-mark-as-read-all})
2911 @findex wl-summary-reply
2912 Prepare a draft for reply the message at the current cursor point.
2913 (@code{wl-summary-reply})
2917 @findex wl-summary-reply-with-citation
2918 Prepare a draft for reply the message at the current cursor point.
2919 (@code{wl-summary-reply-with-citation})
2923 @findex wl-summary-cancel-message
2924 If the message at current cursor point is your own netnews article,
2926 (@code{wl-summary-cancel-message})
2930 @findex wl-summary-reedit
2931 Prepare a draft for re-editing the message at current cursor point.
2932 If the message at current cursor point is your own netnews article,
2933 a draft for `supersedes message' for the message is prepared.
2934 (@code{wl-summary-reedit})
2937 @kindex M-e (Summary)
2938 @findex wl-summary-resend-bounced-mail
2939 If the message at current cursor point is a bounced message,
2940 a draft for re-sending original message is prepared.
2941 (@code{wl-summary-resend-bounced-mail})
2945 @findex wl-summary-forward
2946 A draft for forwarding the message at current cursor point is prepared.
2947 (@code{wl-summary-forward})
2951 @findex wl-summary-mark-as-important
2952 Put @samp{$} mark on the message at current cursor point.
2953 If already marked as @samp{$}, delete it.
2954 (@code{wl-summary-mark-as-important})
2960 Save the message at current cursor point.
2961 @findex wl-summary-save
2962 (@code{wl-summary-save})
2966 @findex wl-summary-next
2967 Move cursor to the next message.
2968 If message is marked with a temporal mark in
2969 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2970 In the offline mode, cursor is not moved to the messages which are not cached
2972 (@code{wl-summary-next})
2976 @findex wl-summary-prev
2977 Move cursor to the previous message.
2978 If message is marked with a temporal mark in
2979 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2980 In the offline mode, cursor is not moved to the messages which are not cached
2982 (@code{wl-summary-prev})
2986 @findex wl-summary-down
2987 Move cursor to the downward message which is unread or marked
2989 In the offline mode, cursor is not moved to the messages which are not cached
2991 If there are messages which have target mark @samp{*} in the summary,
2992 cursor is moved to the downward message which have a target mark.
2993 This behavior is changed according to the value of @code{wl-summary-move-order}.
2994 (@code{wl-summary-down})
2998 @findex wl-summary-up
2999 Move cursor to the upward message which is unread or marked
3001 In the offline mode, cursor is not moved to the messages which are not cached
3003 If there are messages which have target mark @samp{*} in the summary,
3004 cursor is moved to the downward message which have a target mark.
3005 This behavior is changed according to the value of @code{wl-summary-move-order}.
3006 (@code{wl-summary-up})
3010 @findex wl-summary-write
3011 Prepare a new draft.
3012 (@code{wl-summary-write})
3016 @findex wl-summary-write-current-folder
3017 Prepare a new draft. If the current folder is NNTP folder,
3018 @samp{Newsgroups:} field is completed. If the current folder is mailing
3019 list folder (refile destination), guess @samp{To:} field and completed
3020 (If @code{wl-subscribed-mailing-list} is valid list)
3021 (@code{wl-summary-write-current-folder})
3025 @findex wl-summary-redisplay-all-header
3026 Redisplay the message at current cursor point with all header fields.
3027 (@code{wl-summary-redisplay-all-header})
3031 @findex wl-summary-redisplay-no-mime
3032 Redisplay the message at current cursor point without MIME analysis.
3033 (@code{wl-summary-redisplay-no-mime})
3037 @findex wl-summary-burst
3038 If the message at current cursor point has
3039 encapsulates multiple messages using MIME,
3040 de-capsulate and extract them on the current folder.
3041 (@code{wl-summary-burst})
3044 @kindex @@ (Summary)
3045 @findex wl-summary-edit-addresses
3046 Append/change/delete the message's sender information to the address
3047 book @file{~/.addresses} interactively. If this command is called with
3048 prefix argument, arbitrary address can be edited.
3049 (@code{wl-summary-edit-petname})
3053 @findex wl-status-update
3054 Sync up address book status with @file{~/.addresses}'s content.
3055 (@code{wl-status-update})
3059 @findex wl-summary-pipe-message
3060 Pipe current message's content to the external process.
3061 (@code{wl-summary-pipe-message})
3065 @findex wl-summary-print-message
3066 Print out current message's content.
3067 It uses @code{ps-print} module in Emacs 20.x.
3068 If you don't use color printer, you might want to set
3069 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3072 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3075 (@code{wl-summary-print-message})
3079 @findex wl-summary-exit
3080 Exit current folder.
3081 (@code{wl-summary-exit})
3085 @findex wl-summary-jump-to-current-message
3086 Jump cursor to the currently displayed message's window.
3087 (@code{wl-summary-jump-to-current-message})
3091 Jump cursor to the other message.
3092 @findex wl-summary-jump-to-msg
3093 (@code{wl-summary-jump-to-msg})
3097 Update summary status and
3098 prefetch all messages which have marks included in the
3099 @code{wl-summary-incorporate-marks}.
3100 @findex wl-summary-incorporate
3101 (@code{wl-summary-incorporate})
3104 @kindex M-j (Summary)
3105 @findex wl-summary-jump-to-msg-by-message-id
3106 Jump cursor to the message which have specified @samp{Message-Id:}. If
3107 @code{elmo-use-database} is non-nil, other folder is also searched.
3108 (@code{wl-summary-jump-to-msg-by-message-id})
3112 Jump to parent message.
3113 @findex wl-summary-jump-to-parent-message
3114 (@code{wl-summary-jump-to-parent-message})
3118 @findex wl-summary-mark-as-unread
3119 Mark as unread the message at current cursor point.
3120 (@code{wl-summary-mark-as-unread})
3124 @findex wl-summary-sync
3125 Synchronize summary view after prompting the update range
3126 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3130 all ...Discard current summary and update all message.
3131 update ...Update the difference between summary and the folder itself.
3132 rescan ...Rescan the msgdb and display again.
3133 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3134 first, last ...Move to the filter folder(partial filter).
3139 (@code{wl-summary-sync})
3143 @findex wl-summary-sort
3145 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3146 (@code{wl-summary-sort})
3150 @findex wl-summary-toggle-thread
3151 Toggle the threading.
3152 Threading status is displayed on the modeline.
3153 @samp{@{S@}} means threading is off (Sequence) and
3154 @samp{@{T@}} means threading is on (Thread).
3155 (@code{wl-summary-toggle-thread})
3159 @findex wl-summary-toggle-disp-folder
3160 Toggle displaying of folder window.
3161 (@code{wl-summary-toggle-disp-folder})
3165 Toggle displaying of message window.
3166 @findex wl-summary-toggle-disp-msg
3167 (@code{wl-summary-toggle-disp-msg})
3171 Move to the virtual folder with the condition specified.
3172 If called with prefix argument and current folder is virtual, exit it.
3173 @findex wl-summary-virtual
3174 (@code{wl-summary-virtual})
3177 @kindex @key{TAB} (Summary)
3178 @findex wl-summary-goto-last-displayed-msg
3179 Jump to the message which is displayed last.
3180 (@code{wl-summary-goto-last-displayed-msg})
3184 Put @samp{*} mark on the messages that satisfies the specified condition.
3185 @findex wl-summary-pick
3186 (@code{wl-summary-pick})
3190 @findex wl-summary-mark-as-read
3191 Mark as read the message at the current cursor point.
3192 (@code{wl-summary-mark-as-read})
3196 Prefetch the message at the current cursor point.
3197 With prefix argument, prefetch the message even if it is cached.
3198 @findex wl-summary-prefetch
3199 (@code{wl-summary-prefetch})
3203 Execute @samp{D}, @samp{o} and @samp{O} marks.
3204 @findex wl-summary-exec
3205 (@code{wl-summary-exec})
3209 @findex wl-summary-target-mark-line
3210 Put target mark on the message at the current cursor point.
3211 (@code{wl-summary-target-mark-line})
3215 Put refile mark on the message at the current cursor point.
3216 @findex wl-summary-refile
3217 (@code{wl-summary-refile})
3220 @kindex C-o (Summary)
3221 Execute auto refile.
3222 @findex wl-summary-auto-refile
3223 (@code{wl-summary-auto-refile})
3227 Put copy mark on the message at the current cursor point.
3228 @findex wl-summary-copy
3229 (@code{wl-summary-copy})
3232 @kindex M-o (Summary)
3233 Put refile mark on the message at the current cursor point with the destination
3234 previously specified.
3235 @findex wl-summary-refile-prev-destination
3236 (@code{wl-summary-refile-prev-destination})
3240 @findex wl-summary-delete
3241 Put delete mark on the message at the current cursor point.
3242 (@code{wl-summary-delete})
3246 @findex wl-summary-unmark
3247 Unmark the temporal mark on the message at the current cursor point.
3248 (@code{wl-summary-unmark})
3252 Unmark all the temporal marks.
3253 @findex wl-summary-unmark-all
3254 (@code{wl-summary-unmark-all})
3257 @kindex r R (Summary)
3258 @findex wl-summary-mark-as-read-region
3259 Mark as read messages in the specified region.
3260 (@code{wl-summary-mark-as-read-region})
3263 @kindex r $ (Summary)
3264 @findex wl-summary-mark-as-important-region
3265 Mark as important @samp{$} messages in the specified region.
3266 If @samp{$} already exists, it is deleted.
3267 (@code{wl-summary-mark-as-important-region})
3270 @kindex r ! (Summary)
3271 @findex wl-summary-mark-as-unread-region
3272 Mark as unread messages in the specified region.
3273 (@code{wl-summary-mark-as-unread-region})
3276 @kindex r i (Summary)
3277 @findex wl-summary-prefetch-region
3278 Prefetch messages in the specified region.
3279 (@code{wl-summary-prefetch-region})
3282 @kindex r x (Summary)
3283 @findex wl-summary-exec-region
3284 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3286 (@code{wl-summary-exec-region})
3289 @kindex r * (Summary)
3290 @findex wl-summary-target-mark-region
3291 Put target mark on the messages in the specified region.
3292 (@code{wl-summary-target-mark-region})
3295 @kindex r o (Summary)
3296 @findex wl-summary-refile-region
3297 Put refile mark on the messages in the specified region.
3298 (@code{wl-summary-refile-region})
3301 @kindex r O (Summary)
3302 @findex wl-summary-copy-region
3303 Put copy mark on the messages in the specified region.
3304 (@code{wl-summary-copy-region})
3307 @kindex r d (Summary)
3308 @findex wl-summary-delete-region
3309 Put delete mark on the messages in the specified region.
3310 (@code{wl-summary-delete-region})
3313 @kindex r u (Summary)
3314 @findex wl-summary-unmark-region
3315 Delete temporal mark on the messages in the specified region.
3316 (@code{wl-summary-unmark-region})
3319 @kindex r y (Summary)
3320 Save messages in the specified region.
3321 @findex wl-summary-save-region
3322 (@code{wl-summary-save-region})
3325 @kindex t R (Summary)
3326 @findex wl-thread-mark-as-read
3327 Mark as read messages which are the descendant of the current thread.
3328 With prefix argument, it affects on the all messages in the thread tree.
3329 (@code{wl-thread-mark-as-read})
3332 @kindex t $ (Summary)
3333 @findex wl-thread-mark-as-important
3334 Put important mark @samp{$} on the messages which are the
3335 descendant of the current thread.
3336 If @samp{$} mark exists, it is deleted.
3337 With prefix argument, it affects on the all messages in the thread tree.
3338 (@code{wl-thread-mark-as-important})
3341 @kindex t ! (Summary)
3342 @findex wl-thread-mark-as-unread
3343 Mark as unread messages which are the descendant of the current thread.
3344 With prefix argument, it affects on the all messages in the thread tree.
3345 (@code{wl-thread-mark-as-unread})
3348 @kindex t i (Summary)
3349 @findex wl-thread-prefetch
3350 Prefetch messages which are the descendant of the current thread.
3351 With prefix argument, it affects on the all messages in the thread tree.
3352 (@code{wl-thread-prefetch})
3355 @kindex t x (Summary)
3356 @findex wl-thread-exec
3357 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3358 the descendant of the current thread. With prefix argument, it affects
3359 on the all messages in the thread tree.
3360 (@code{wl-thread-exec})
3363 @kindex t * (Summary)
3364 @findex wl-thread-target-mark
3365 Put target mark @samp{*} on the messages which are the descendant of the
3366 current thread. With prefix argument, it affects on the all messages in
3368 (@code{wl-thread-target-mark})
3371 @kindex t o (Summary)
3372 @findex wl-thread-refile
3373 Put refile mark on the messages which are the descendant of the current thread.
3374 With prefix argument, it affects on the all messages in the thread tree.
3375 (@code{wl-thread-refile})
3378 @kindex t O (Summary)
3379 @findex wl-thread-copy
3380 Put copy mark on the messages which are the descendant of the current thread.
3381 With prefix argument, it affects on the all messages in the thread tree.
3382 (@code{wl-thread-copy})
3385 @kindex t d (Summary)
3386 @findex wl-thread-delete
3387 Put delete mar on the messages which are the descendant of the current thread.
3388 With prefix argument, it affects on the all messages in the thread tree.
3389 (@code{wl-thread-delete})
3392 @kindex t u (Summary)
3393 @findex wl-thread-unmark
3394 Unmark temporal mark on the messages which are the descendant of the
3395 current thread. With prefix argument, it affects on the all messages in
3397 (@code{wl-thread-unmark})
3400 @kindex t y (Summary)
3401 @findex wl-thread-save
3402 Save messages which are the descendant of the current thread.
3403 With prefix argument, it affects on the all messages in the thread tree.
3404 (@code{wl-thread-save})
3407 @kindex m i (Summary)
3408 @findex wl-summary-target-mark-prefetch
3409 Prefetch all messages which have target mark @samp{*}.
3410 With prefix argument, prefetch all targets even if some of them are cached.
3411 (@code{wl-summary-target-mark-prefetch})
3414 @kindex m R (Summary)
3415 @findex wl-summary-target-mark-mark-as-read
3416 Mark as read all messages which have target mark @samp{*}.
3417 (@code{wl-summary-target-mark-mark-as-read})
3420 @kindex m $ (Summary)
3421 @findex wl-summary-target-mark-mark-as-important
3422 Mark as important all messages which have target mark @samp{*}.
3423 If already marked as @samp{$}, it is deleted.
3424 (@code{wl-summary-target-mark-mark-as-important})
3427 @kindex m ! (Summary)
3428 @findex wl-summary-target-mark-mark-as-unread
3429 Mark as unread all messages which have target mark @samp{*}.
3430 (@code{wl-summary-target-mark-mark-as-unread})
3433 @kindex m o (Summary)
3434 @findex wl-summary-target-mark-refile
3435 Put refile mark on the messages which have target mark @samp{*}.
3436 (@code{wl-summary-target-mark-refile})
3439 @kindex m O (Summary)
3440 @findex wl-summary-target-mark-copy
3441 Put copy mark on the messages which have target mark @samp{*}.
3442 (@code{wl-summary-target-mark-copy})
3445 @kindex m d (Summary)
3446 @findex wl-summary-target-mark-delete
3447 Put delete mark on the messages which have target mark @samp{*}.
3448 (@code{wl-summary-target-mark-delete})
3451 @kindex m y (Summary)
3452 @findex wl-summary-target-mark-save
3453 Save messages which have target mark @samp{*}.
3454 (@code{wl-summary-target-mark-save})
3457 @kindex m u (Summary)
3458 Unmark all temporal marks.
3459 (@code{wl-summary-delete-all-temp-marks})
3460 @findex wl-summary-delete-all-temp-marks
3463 @kindex m a (Summary)
3464 Put target mark @samp{*} on the all messages.
3465 (@code{wl-summary-target-mark-all})
3466 @findex wl-summary-target-mark-all
3469 @kindex m t (Summary)
3470 Put target mark @samp{*} on the messages in the current thread.
3471 @findex wl-summary-target-mark-thread
3472 (@code{wl-summary-target-mark-thread})
3475 @kindex m r (Summary)
3476 @findex wl-summary-target-mark-region
3477 Put target mark @samp{*} on the messages in the specified region.
3478 (@code{wl-summary-target-mark-region})
3481 @kindex m A (Summary)
3482 @findex wl-summary-target-mark-reply-with-citation
3483 Prepare a draft which cites all messages which have target mark @samp{*}.
3484 (@code{wl-summary-target-mark-reply-with-citation})
3487 @kindex m f (Summary)
3488 @findex wl-summary-target-mark-forward
3489 Prepare a draft which forwards all messages which have target mark @samp{*}.
3490 (@code{wl-summary-target-mark-forward})
3493 @kindex m U (Summary)
3494 @findex wl-summary-target-mark-uudecode
3495 Uudecode the messages which have target mark @samp{*}.
3496 (@code{wl-summary-target-mark-uudecode})
3499 @kindex m ? (Summary)
3500 @findex wl-summary-target-mark-pick
3501 Pick messages from the @samp{*} marked messages.
3502 That is, @samp{*} marks on the messages are remained
3503 if the specified condition is satisfied.
3504 (@code{wl-summary-target-mark-pick})
3507 @kindex M-t (Summary)
3508 @findex wl-toggle-plugged
3509 Toggle offline/online status of Wanderlust.
3510 (@code{wl-toggle-plugged})
3513 @kindex C-t (Summary)
3514 Start Wanderlust's plug-status manager.
3515 (@code{wl-plugged-change})
3518 @kindex C-c C-o (Summary)
3519 @findex wl-jump-to-draft-buffer
3520 Move to the draft buffer if available. If multiple draft buffer exists,
3521 moved to one after another. If prefix argument is specified, load draft
3522 folder's message to the draft buffer and jump to it.
3523 (@code{wl-jump-to-draft-buffer})
3526 @kindex M-w (Summary)
3527 @findex wl-summary-save-current-message
3528 Save the message at the current cursor point.
3529 (@code{wl-summary-save-current-message})
3532 @kindex C-y (Summary)
3533 @findex wl-summary-yank-saved-message
3534 Regard the message at the current cursor point as
3535 parent, connect the message saved by
3536 @code{wl-summary-save-current-message}
3538 (@code{wl-summary-yank-saved-message})
3542 @node Variables of Summary, , Key Bindings of Summary, Summary
3543 @section Customiziable variables
3546 @item wl-summary-move-order
3547 @vindex wl-summary-move-order
3548 The initial setting is @code{unread}. Specify cursor moving policy. If
3549 you want to precede new messages, set @code{new}. If you want to
3550 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3553 @item wl-auto-select-first
3554 @vindex wl-auto-select-first
3555 The initial setting is @code{nil}.
3556 If non-nil, first message is automatically displayed.
3558 @item wl-auto-select-next
3559 @vindex wl-auto-select-next
3560 The initial setting is @code{nil}. This controls behavior when there is
3561 no unread message in current summary.
3564 nil: asks whether you want to go back to folder mode
3565 'unread: asks whether you want to go to next unread folder
3566 If the next one comes to be possessing no unread message
3567 by treatment of cross-posted messages or Scoring, then
3568 asks whether you want to go to next to next folder.
3569 'skip-no-unread: similar as unread
3570 But does not ask before going to next to next folder.
3571 otherwise: asks whether you want to go to next unread folder
3574 It might be useful to set @code{'skip-no-unread} for people who
3575 want to continue reading by just pressing and pressing space key.
3577 @item wl-thread-insert-opened
3578 @vindex wl-thread-insert-opened
3579 The initial setting is @code{nil}.
3580 If non-nil, thread is inserted as opened.
3582 @item wl-thread-open-reading-thread
3583 @vindex wl-thread-open-reading-thread
3584 The initial setting is @code{t}. If non-nil, reading thread is
3585 automatically opened though it is closed thread.
3587 @item wl-summary-exit-next-move
3588 @vindex wl-summary-exit-next-move
3589 The initial setting is @code{t}. If non-nil, move to next folder at
3592 @item wl-folder-move-cur-folder
3593 @vindex wl-folder-move-cur-folder
3594 The initial setting is @code{nil}. If non-nil, cursor position on the
3597 @item wl-summary-weekday-name-lang
3598 @vindex wl-summary-weekday-name-lang
3599 The initial setting is @samp{ja}. Specify language of the weekday.
3600 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3601 displays Deutsch. You should rescan summary view after changing this value.
3603 @item wl-summary-fix-timezone
3604 @vindex wl-summary-fix-timezone
3605 The initial setting is @code{nil}.
3606 Time zone of the date string in summary mode is adjusted using this value.
3607 If @code{nil}, it is adjust to the default time zone information
3608 (system's default time zone or environment variable @samp{TZ}).
3610 @item wl-use-petname
3611 @vindex wl-use-petname
3612 The initial setting is @code{t}.
3613 If non-nil, sender part displays nickname.
3615 @item wl-break-pages
3616 @vindex wl-break-pages
3617 The initial setting is @code{t}.
3618 If non-nil, message is split as pages by @samp{^L}.
3620 @item wl-message-window-size
3621 @vindex wl-message-window-size
3622 The initial setting is '(1 . 4).
3623 A cons cell to specify the rate of summary and message window.
3624 car:cdr corresponds summary:message.
3626 @item wl-summary-no-from-message
3627 @vindex wl-summary-no-from-message
3628 The initial setting is @samp{nobody@@nowhere?}. A string which is
3629 displayed when there's no @samp{From:} field in the message.
3631 @item wl-summary-no-subject-message
3632 @vindex wl-summary-no-subject-message
3633 The initial setting is @samp{(WL:No Subject in original.)}. A string
3634 which is displayed when there's no @samp{Subject:} field in the message.
3636 @item wl-summary-use-frame
3637 @vindex wl-summary-use-frame
3638 The initial setting is @code{nil}.
3639 If non-nil, use new frame for the summary.
3641 @item wl-use-folder-petname
3642 @vindex wl-use-folder-petname
3643 The initial setting is the list shown below:
3652 A list of display policy (symbol) of folder nickname. Available symbols
3657 Display folder petname on modeline.
3659 Destination folder is notified as nickname if
3660 @code{wl-auto-select-next} is non-nil.
3662 You can input folder name by nickname in the function
3663 @code{wl-summary-read-folder}.
3666 @item wl-summary-move-direction-toggle
3667 @vindex wl-summary-move-direction-toggle
3668 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3669 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3670 want to aware of reading direction, set this to @code{t}.
3672 @item wl-summary-width
3673 @vindex wl-summary-width
3674 The initial setting is 80.
3675 Width of summary line. If @code{nil}, summary line's width is as is.
3677 @item wl-summary-from-width
3678 @vindex wl-summary-from-width
3679 The initial setting is 17.
3680 Width of sender part of summary line.
3682 @item wl-summary-subject-length-limit
3683 @vindex wl-summary-subject-length-limit
3684 The initial setting is @code{nil}. Specify the limit for the length of
3685 subject parts in summary. @code{nil} means unlimited.
3687 @item wl-summary-indent-length-limit
3688 @vindex wl-summary-indent-length-limit
3689 The initial setting is 46.
3690 Specify the limit of thread indent level. @code{nil} means unlimited
3692 If you set this to @code{nil} you should set @code{wl-summary-width}
3695 @item wl-summary-recenter
3696 @vindex wl-summary-recenter
3697 The initial setting is t.
3698 If non-nil, cursor point is moved to the center of the summary window.
3700 @item wl-summary-divide-thread-when-subject-changed
3701 @vindex wl-summary-divide-thread-when-subject-changed
3702 The initial setting is @code{nil}. If non-nil, thread is split if
3703 the subject is changed.
3705 @item wl-summary-search-via-nntp
3706 @vindex wl-summary-search-via-nntp
3707 The initial setting is @code{confirm}.
3709 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3710 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3711 from the NNTP server @code{elmo-nntp-default-server}. The value of
3712 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3713 @code{elmo-nntp-default-stream-type} are used.
3715 If @code{confirm}, server name can be specified. You can specify NNTP
3716 folder format like @samp{-:username@@servername:119!}.
3718 @item wl-summary-keep-cursor-command
3719 @vindex wl-summary-keep-cursor-command
3720 The initial setting is the list shown below:
3724 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3729 When you entered to summary by these commands and the target summary
3730 buffer already exists, summary status is not automatically updated and
3731 cursor position is saved.
3733 @item elmo-folder-update-threshold
3734 @vindex elmo-folder-update-threshold
3735 The initial setting is 500. If updated message number is larger than
3736 this value, confirm whether drop them or not (in the case where the value
3737 of @code{elmo-folder-update-confirm} is non-nil).
3739 @item elmo-folder-update-confirm
3740 @vindex elmo-folder-update-confirm
3741 The initial setting is @code{t}. If the value is non-nil, do check with
3742 @code{elmo-folder-update-threshold}.
3744 @item wl-summary-always-sticky-folder-list
3745 @vindex wl-summary-always-sticky-folder-list
3746 The initial setting is @code{nil}.
3747 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3748 are automatically stuck. Each element is regexp of folder name.
3750 @item wl-summary-reserve-mark-list
3751 @vindex wl-summary-reserve-mark-list
3752 The initial setting is the list shown below:
3761 If a message is already marked as temporal marks in this list, the
3762 message is not marked by any mark command.
3764 @item wl-summary-skip-mark-list
3765 @vindex wl-summary-skip-mark-list
3766 The initial setting is the list shown below:
3775 If a message is already marked as temporal marks in this list, the
3776 message is skipped at cursor move.
3778 @item elmo-message-fetch-threshold
3779 @vindex elmo-message-fetch-threshold
3780 The initial setting is 30000 (bytes). If displaying message has larger
3781 size than this value, Wanderlust confirms whether fetch the message or
3782 not (in the case where the value of @code{elmo-message-fetch-confirm}
3785 @item elmo-message-fetch-confirm
3786 @vindex elmo-message-fetch-confirm
3787 The initial setting is @code{t}. If the value is non-nil, do check with
3788 @code{elmo-message-fetch-threshold}.
3790 @item wl-prefetch-threshold
3791 @vindex wl-prefetch-threshold
3792 The initial setting is 30000 (bytes). If prefetching message has larger
3793 size than this value and @code{wl-prefetch-confirm} is non-nil,
3794 Wanderlust confirms whether prefetch the message or not. If
3795 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3796 without confirmation.
3798 @item wl-prefetch-confirm
3799 @vindex wl-prefetch-confirm
3800 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3801 prefetch the message or not if the message has larger size than
3802 @code{wl-prefetch-threshold}.
3804 @item elmo-imap4-use-cache
3805 @vindex elmo-imap4-use-cache
3806 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3809 @item elmo-nntp-use-cache
3810 @vindex elmo-nntp-use-cache
3811 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3814 @item elmo-pop3-use-cache
3815 @vindex elmo-pop3-use-cache
3816 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3819 @item elmo-shimbun-use-cache
3820 @vindex elmo-shimbun-use-cache
3821 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3824 @item wl-folder-process-duplicates-alist
3825 @vindex wl-folder-process-duplicates-alist
3826 The initial setting is @code{nil}.
3827 This list determines how to deal with duplicated messages in the same folder.
3828 Each item in the list is regexp of folder name and action; you can specify any
3829 one of the following in the place of action:
3832 @code{nil} : do nothing for duplicated messages.
3833 @code{hide} : hide duplicated messages from the summary.
3834 @code{read} : set duplicated messages as read.
3838 Following is an example (hide duplicated messages in multi folders)
3842 (setq wl-folder-process-duplicates-alist
3843 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3844 ("^\\*.*" . hide) (".*" . read)))
3850 @node Message, Draft, Summary, Top
3851 @chapter Message Buffer
3853 Message Buffers utilize MIME-View mode of SEMI. For operational
3854 procedures and key bindings, refer to respective documents.
3855 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3856 You can also see help by @kbd{?} in message buffer.
3858 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3859 brings you back to Summary mode. @kbd{l} toggles display of Summary
3862 @section Key Bindings
3868 @findex wl-message-toggle-disp-summary
3869 Toggles display of Summary mode buffer.
3870 (@code{wl-message-toggle-disp-summary})
3873 @findex wl-message-refer-article-or-url
3874 @kindex Button-2 (Message)
3875 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3876 corresponding message if found.
3877 (@code{wl-message-refer-article-or-url})
3879 @item Button-4 (upward movement of a wheel)
3880 @kindex Button-4 (Message)
3881 @findex wl-message-wheel-down
3882 Scrolls the message backwards. When the top of the message is hit,
3883 moves to the previous message.
3884 (@code{wl-message-wheel-down})
3886 @item Button-5 (downward movement of a wheel)
3887 @kindex Button-5 (Message)
3888 @findex wl-message-wheel-up
3889 Scrolls the message forward. When the bottom of the message is hit,
3890 moves to the next message.
3891 (@code{wl-message-wheel-up})
3894 @section Customizable Variables
3897 @item wl-message-window-size
3898 @vindex wl-message-window-size
3899 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3900 its car and cdr value corresponds to the ratio of Summary and Message
3903 @item wl-message-ignored-field-list
3904 @vindex wl-message-ignored-field-list
3905 (SEMI only) Initial setting is @code{nil}.
3906 All fields that match this list will be hidden in message buffer.
3907 Each elements are regexp of field-name.
3908 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3910 @item wl-message-visible-field-list
3911 @vindex wl-message-visible-field-list
3912 (SEMI only) Initial setting is @code{nil}.
3913 All fields that match this list will be display in message buffer.
3914 Each elements are regexp of field-name. This value precedes
3915 @code{wl-message-ignored-field-list}.
3916 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3918 @item wl-message-sort-field-list
3919 @vindex wl-message-sort-field-list
3920 (SEMI only) Initial setting is
3921 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3922 Header fields in message buffer are ordered by this value.
3923 Each elements are regexp of field-name.
3925 @item wl-message-truncate-lines
3926 @vindex wl-message-truncate-lines
3927 The initial value is the value of @code{default-truncate-lines}.
3928 If it is non-nil, truncate long lines in message buffer.
3931 @node Draft, Disconnected Operations, Message, Top
3932 @chapter Draft Buffer
3934 At Summary mode, pressing @kbd{w} and the like creates a new draft
3935 buffer. You can edit and send mail and news articles in this buffer.
3939 Basically it is Emacs-standard mail mode.
3941 @subsection Address Completion
3943 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3944 addresses. @kbd{@key{TAB}} completes them.
3946 If you want to submit a news article, add @samp{Newsgroups:} field by
3947 yourself. Field names can be completed by @kbd{@key{TAB}}.
3949 If you save the draft buffer you are editing, it is appended to the
3950 folder specified by @code{wl-draft-folder}.
3952 Using @samp{FCC:} field, you can specify the folder to which a copy of
3953 the message is saved when it is sent.
3955 @subsection Editing Messages
3957 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
3958 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
3959 a MIME user interface for GNU Emacs}.
3960 You can also see help by @kbd{C-c C-x ?} in draft buffer.
3962 @subsection Dynamic Modification of Messages
3963 @vindex wl-draft-config-alist
3964 @c @cindex Change Message
3965 @c @cindex Message, Change Dynamic
3967 You can set @code{wl-draft-config-alist} so that header and body of the
3968 message will automatically modified depending on information of header
3971 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3973 In the example below, the header is modified when
3974 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3975 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3976 before sending the message.
3980 (setq wl-draft-config-alist
3981 '(((string-match "aaa\\.example\\.com$" (system-name))
3982 ;; @r{applied if the expression is non-nil}
3983 (wl-smtp-posting-server . "mailserver-B")
3984 (wl-nntp-posting-server . "newsserver-B")
3985 ;; @r{settings of temporary variables}
3987 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
3988 ;; @r{applied if it matches the header of the draft buffer}
3989 ("Organization" . (format "Go %s" my-webpage)))
3990 ;; @r{you can write elisp expressions here (eval only)}
3991 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3992 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3997 The format of @code{wl-draft-config-alist} is:
4001 '(("@var{regexp of the header}" or @var{elisp expression}
4002 ("@var{Field}" . value(@var{elisp expression}))
4003 (@var{variable} . value(@var{elisp expression}))
4004 (@var{sub-function} . value(@var{elisp expression}))
4007 ("@var{regexp of the header}" or @var{elisp expression}
4008 ("@var{Field}" . value(@var{elisp expression}))
4013 Per default, there are 10 following sub-functions.
4016 'header: Inserts the specified string at the bottom of the header.
4017 'header-top: Inserts the specified string at the top of the header.
4018 'header-file: Inserts the specified file at the bottom of the header.
4019 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4020 'top: Inserts the specified string at the top of the body.
4021 'top-file: Inserts the specified file at the top of the body.
4022 'body: Replaces the body with the specified string.
4023 Specifying @code{nil} deletes the entire body string.
4024 'body-file: Replaces the body with the content of the specified file.
4025 'bottom: Inserts the specified string at the bottom of the body.
4026 'bottom-file: Inserts the specified file at the top of the body.
4027 'part-top: Inserts the specified string at the top of the current part.
4028 'part-bottom: Inserts the specified string at the bottom of the current part.
4029 'template: Applies the specified template.
4030 (refer to the next subsection)
4033 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4034 change them or add your own functions. If you read the code, you can
4035 easily find how to write the functions.
4037 At the first of each item, @var{a regular expression of the header} or
4038 an @var{elisp expression} should be specified. In the case of an elisp
4039 expression, the item is applied when the expression is evaluated
4042 Per default, when multiple items match or are evaluated non-nil, all
4043 such items are applied, but if you set a variable
4044 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4047 At the second of the item, a cons or a list of functions should be
4048 specified. The car part of the cons should be a header field, a
4049 variable, or a sub-function. When a header field is specified, the
4050 field will be modified. If a variable is specified, the value of the
4051 variable will be modified temporarily.
4053 In the cdr part of a cons, not only a variable but also an elisp
4054 expression can be specified as is. If the car part is a header field
4055 and the cdr part is @code{nil}, the field will be deleted.
4057 If you want to use name of parent folder, you can refer the buffer local
4058 variable @code{wl-draft-parent-folder}.
4060 See the next example as well:
4064 (setq wl-draft-config-alist
4066 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4067 ;; @r{applied if it matches the header of the buffer being replied}
4068 (body . " Hello.\n")
4069 (template . "default")
4074 As in the (1) above, if a header regexp is prepended with @code{reply},
4075 it is applied when the draft is prepared by @code{wl-summary-reply} for
4076 example, and when it matches the header being replied. It is ignored
4077 when there is no buffer being replied, like after @code{wl-draft} was
4080 Note that @code{wl-draft-config-alist} is applied only once when
4081 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4082 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4083 aborting transmission, execute @kbd{C-c C-e}
4084 (@code{wl-draft-config-exec}) explicitly.
4086 If you don't want to apply @code{wl-draft-config-alist} when
4087 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4091 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4094 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4095 prepared, do the following:
4098 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4101 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4102 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4106 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4109 @subsection Inserting Templates
4111 @cindex Apply Template
4113 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4114 @kbd{M-x wl-template-select} in the draft buffer.
4116 The format of @code{wl-template-alist} is almost the same as
4117 @code{wl-draft-config-alist}.
4121 (setq wl-template-alist
4124 ("Organization" . "~/.wl sample")
4125 (body . "Hello.\n"))
4127 (template . "default") ;; @r{(a)}
4128 ("To" . "boss@@example.com")
4129 ("Subject" . "Report")
4130 (body-file . "~/work/report.txt")
4136 As you can see, the only difference is item (template) names such as
4137 @samp{default} and @samp{report}, instead of a regexp of header.
4138 Because definition of each item is the same as
4139 @code{wl-draft-config-alist}, you can call another template, like (a).
4141 Executing the command @code{wl-template-select} results in template
4142 selection, but the result differs depending on variable
4143 @code{wl-template-visible-select}.
4145 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4146 window is shown below the draft buffer. You can select a template by
4147 @kbd{n} and @kbd{p} seeing the buffer window.
4149 Press the @key{RET} key and the template is actually applied to the draft
4150 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4151 adjust the window size by @code{wl-template-buffer-lines}.
4153 If @code{wl-template-visible-select} is @code{nil}, you should type the
4154 name of the template in the mini buffer.
4156 As shown in the example in @code{wl-draft-config-alist}, you can select
4157 @samp{default} template by writing:
4160 (template . "default")
4163 @subsection Sending mail by POP-before-SMTP
4164 @cindex POP-before-SMTP
4166 You can send mail by POP-before-SMTP with this single line:
4169 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4173 Configure the following variables if you need.
4176 @item wl-pop-before-smtp-user
4177 The POP user name for POP-before-SMTP authentication.
4178 If unset, @code{elmo-pop3-default-user} is used.
4180 @item wl-pop-before-smtp-server
4181 The POP server name for POP-before-SMTP authentication.
4182 If unset, @code{elmo-pop3-default-server} is used.
4184 @item wl-pop-before-smtp-authenticate-type
4185 The POP authentication method for POP-before-SMTP authentication.
4186 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4188 @item wl-pop-before-smtp-port
4189 The POP port number for POP-before-SMTP authentication.
4190 If unset, @code{elmo-pop3-default-port} is used.
4192 @item wl-pop-before-smtp-stream-type
4193 If non-nil, POP connection is established using SSL. If
4194 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4195 unset, @code{elmo-pop3-default-stream-type} is used.
4198 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4199 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4201 Therefore, if SMTP server and POP server are actually the same, and if
4202 POP folder per default (such as @samp{&}) is available, no settings are
4205 Refer to the following URL about POP-before-SMTP.
4209 http://spam.ayamura.org/tools/smPbS.html
4210 http://www.iecc.com/pop-before-smtp.html
4214 @section Key Bindings
4215 @cindex Keybind, Draft Mode
4216 @cindex Keybind, Draft Buffer
4221 @kindex C-c C-y (Draft)
4222 @findex wl-draft-yank-original
4223 Cites the content of the current message buffer.
4224 (@code{wl-draft-yank-original})
4227 @kindex C-c C-p (Draft)
4228 @findex wl-draft-preview-message
4229 Previews the content of the current draft.
4230 This is useful for previewing MIME multi-part messages.
4231 (@code{wl-draft-preview-message})
4234 @kindex C-c C-s (Draft)
4235 @findex wl-draft-send
4236 Sends the content of the current draft. Does not erase the draft buffer.
4237 This is useful for sending multiple messages, which are a little different
4239 (@code{wl-draft-send})
4242 @kindex C-c C-c (Draft)
4243 @findex wl-draft-send-and-exit
4244 Sends the content of the current draft and erases the draft buffer.
4245 (@code{wl-draft-send-and-exit})
4248 @kindex C-x C-s (Draft)
4249 @findex wl-draft-save
4250 Save the current draft.
4251 (@code{wl-draft-save})
4254 @kindex C-c C-k (Draft)
4255 @findex wl-draft-kill
4256 Kills the current draft.
4257 (@code{wl-draft-kill})
4260 @kindex C-x k (Draft)
4261 @findex wl-draft-mimic-kill-buffer
4262 Kills the current draft.
4263 (@code{wl-draft-mimic-kill-buffer})
4266 @kindex C-c C-z (Draft)
4267 @findex wl-draft-save-and-exit
4268 Saves the current draft, and erases the draft buffer.
4269 This is useful if you want to suspend editing of the draft.
4270 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4271 the @samp{+draft} folder.
4272 (@code{wl-draft-save-and-exit})
4275 @kindex C-c C-r (Draft)
4276 @findex wl-caesar-region
4277 Encodes or decodes the specified region in Caesar cipher.
4278 (@code{wl-caesar-region})
4282 @findex wl-draft-highlight-and-recenter
4283 Recenter and rehighlight current draft.
4284 (@code{wl-draft-highlight-and-recenter})
4288 @findex wl-toggle-plugged
4289 Toggles off-line/on-line states of Wanderlust.
4290 (@code{wl-toggle-plugged})
4293 @kindex C-c C-o (Draft)
4294 @findex wl-jump-to-draft-buffer
4295 Jumps to the other draft buffer, if exists.
4296 With prefix argument, reads a file (if any) from the draft folder when
4297 there is no such buffer.
4298 (@code{wl-jump-to-draft-buffer})
4301 @kindex C-c C-e (Draft)
4302 @findex wl-draft-config-exec
4303 Applies @code{wl-draft-config-alist}.
4304 (@code{wl-draft-config-exec})
4307 @kindex C-c C-j (Draft)
4308 @findex wl-template-select
4310 (@code{wl-template-select})
4313 @kindex C-c C-a (Draft)
4315 Enter Address Manager.
4316 @xref{Address Manager}.
4320 @kindex C-c C-d (Draft)
4321 @findex wl-draft-elide-region
4322 Elide the text between point and mark (@code{wl-draft-elide-region}).
4323 The text is killed and replaced with the contents of the variable
4324 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4328 @section Customizable Variables
4331 @item wl-subscribed-mailing-list
4332 @vindex wl-subscribed-mailing-list
4333 The initial setting is @code{nil}. Mailing lists to which you
4334 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4335 field of a reply draft, removes your own address from
4336 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4337 contained in @samp{To:} or @samp{Cc:} field of a message to be
4338 automatically re-filed, the destination folder will be leaned in
4339 connection with the address.
4345 (setq wl-subscribed-mailing-list
4346 '("wl@@lists.airs.net"
4348 "emacs-mime-ja@@m17n.org"))
4352 @item wl-insert-mail-followup-to
4353 @vindex wl-insert-mail-followup-to
4354 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4355 field is automatically inserted in the draft buffer.
4357 @item wl-insert-mail-reply-to
4358 @vindex wl-insert-mail-reply-to
4359 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4360 field is automatically inserted in the draft buffer.
4362 @item wl-auto-insert-x-face
4363 @vindex wl-auto-insert-x-face
4364 The initial setting is @code{t}. If non-nil and there is an encoded
4365 X-Face string in a file @file{~/.xface} (the value of the variable
4366 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4367 draft buffer. If @code{nil}, it is not automatically inserted.
4369 @item wl-insert-message-id
4370 @vindex wl-insert-message-id
4371 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4372 is automatically inserted on the transmission.
4374 @item wl-local-domain
4375 @vindex wl-local-domain
4376 The initial setting is @code{nil}. If @code{nil}, the return value of
4377 the function @code{system-name} will be used as the domain part of
4380 If @code{system-name} does not return FQDN (i.e. the full name of the
4381 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4382 to the string of the local domain name without hostname (like
4383 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4384 @samp{.} @code{wl-local-domain} is used as domain part of the
4387 If your terminal does not have global IP, set the value of
4388 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4389 you use invalid @samp{Message-ID:}.)
4391 Moreover, concatenation of @code{system-name} @samp{.}
4392 @code{wl-local-domain} will be used as an argument to the HELO command
4395 @item wl-message-id-domain
4396 @vindex wl-message-id-domain
4397 The initial setting is @code{nil}. If non-nil, this value is used as a
4398 domain part of the @samp{Message-ID:}. If your terminal does not have
4399 global IP address, set unique string to this value (e.x. your e-mail
4402 @item wl-message-id-domain
4403 @vindex wl-message-id-domain
4404 The initial setting is @code{nil}. If @code{nil}, the return value of
4405 the function @code{system-name} will be used as the domain part of
4406 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4407 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4408 @strong{must} set this variable to the string of the full name of the
4409 host. Otherwise, you might be beaten up on the Net News.
4411 @item wl-draft-config-alist
4412 @vindex wl-draft-config-alist
4413 The initial setting is @code{nil}. Modifies the draft message just
4414 before the transmission. The content of @code{wl-draft-config-alist}
4415 will be automatically applied only once on the transmission. If you
4416 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4419 @item wl-template-alist
4420 @vindex wl-template-alist
4421 The initial setting is @code{nil}.
4422 This variable specifies the template to be applied in the draft buffer.
4424 @item wl-draft-config-matchone
4425 @vindex wl-draft-config-matchone
4426 The initial setting is @code{nil}. If non-nil, only the first matching
4427 item is used when @code{wl-draft-config-alist} is applied. If
4428 @code{nil}, all matching items are used.
4430 @item wl-template-visible-select
4431 @vindex wl-template-visible-select
4432 The initial setting is @code{t}.
4433 If non-nil, you can preview the result of the template selection in
4436 @item wl-template-confirm
4437 @vindex wl-template-confirm
4438 The initial setting is @code{nil}.
4439 If non-nil, asks for confirmation when you press the enter key to select
4440 template while previewing.
4442 @item wl-template-buffer-lines
4443 @vindex wl-template-buffer-lines
4444 The initial setting is 7.
4445 If @code{wl-template-visible-select} is non-nil, this variable specifies
4446 the size of the preview window.
4448 @item wl-draft-reply-buffer-style
4449 @vindex wl-draft-reply-buffer-style
4450 The initial setting is @code{split}. @code{split} or @code{full} can be
4451 specified. In the case of @code{full}, the whole frame will be used for
4452 a reply draft buffer when it is prepared.
4454 @item wl-draft-use-frame
4455 @vindex wl-draft-use-frame
4456 The initial setting is @code{nil}.
4457 If non-nil, use new frame for the draft.
4459 @item wl-draft-truncate-lines
4460 @vindex wl-draft-truncate-lines
4461 The initial value is the value of @code{default-truncate-lines}.
4462 If it is non-nil, truncate long lines in draft buffer.
4466 The initial setting is the value of the variable
4467 @code{user-mail-address}. The value of this variable is inserted as a
4468 @samp{From:} field of the draft when it is prepared.
4470 @item wl-envelope-from
4471 @vindex wl-envelope-from
4472 The initial setting is @code{nil}.
4473 The value of this variable is used for envelope from (MAIL FROM).
4474 If @code{nil}, the address part of @code{wl-from} is used.
4476 @item wl-user-mail-address-list
4477 @vindex wl-user-mail-address-list
4478 The initial setting is @code{nil}.
4479 This is the User's address list. If you have multiple addresses,
4484 The initial setting is @code{nil}.
4485 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4486 the draft when it is prepared. If function is specified, its return
4491 The initial setting is @code{nil}.
4492 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4493 the draft when it is prepared.
4495 @item wl-reply-subject-prefix
4496 @vindex wl-reply-subject-prefix
4497 The initial setting is @samp{Re: }.
4498 In the @samp{Subject:} of the reply draft, this string is prepended to
4499 the @samp{Subject:} of being replied.
4501 @item wl-draft-reply-use-address-with-full-name
4502 @vindex wl-draft-reply-use-address-with-full-name
4503 The initial setting is @code{t}.
4504 If non-nil, insert her full name with address when prepare a draft for
4505 reply a message. If it is @code{nil}, insert her address only.
4507 @item wl-draft-enable-queuing
4508 @vindex wl-draft-enable-queuing
4509 The initial setting is @code{t}.
4510 This flag controls off-line transmission. If non-nil, the draft is
4513 @item wl-draft-use-cache
4514 @vindex wl-draft-use-cache
4515 The initial setting is @code{nil}. If the value is non-nil and
4516 @code{wl-insert-message-id} is nil, cache the message which is sent.
4518 @item wl-fcc-force-as-read
4519 @vindex wl-fcc-force-as-read
4520 The initial setting is @code{nil}. If the value is non-nil,
4521 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4523 @item wl-auto-flush-queue
4524 @vindex wl-auto-flush-queue
4525 The initial setting is t.
4526 This flag controls automatic transmission of the queue when Wanderlust
4527 becomes on-line. If non-nil, the queue is automatically transmitted
4528 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4529 manually, press @kbd{F} in the folder mode.
4531 @item wl-ignored-forwarded-headers
4532 @vindex wl-ignored-forwarded-headers
4533 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4534 All headers that match this regexp will be deleted when forwarding a message.
4536 @item wl-ignored-resent-headers
4537 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4538 All headers that match this regexp will be deleted when resending a message.
4540 @item wl-draft-always-delete-myself
4541 @vindex wl-draft-always-delete-myself
4542 If non-nil, always removes your own address from @samp{To:} and
4543 @samp{Cc:} when you are replying to the mail addressed to you.
4545 @item wl-draft-delete-myself-from-bcc-fcc
4546 @vindex wl-draft-delete-myself-from-bcc-fcc
4547 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4548 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4550 @item wl-smtp-posting-server
4551 @vindex wl-smtp-posting-server
4552 The initial setting is @code{nil}.
4553 This is the SMTP server name for mail transmission.
4555 @item wl-smtp-posting-user
4556 @vindex wl-smtp-posting-user
4557 The initial setting is @code{nil}.
4558 This is the user name for SMTP AUTH authentication. If @code{nil},
4559 @code{smtp-authenticate-user} is used.
4561 @item wl-smtp-authenticate-type
4562 @vindex wl-smtp-authenticate-type
4563 The initial setting is @code{nil}.
4564 This is the authentication method for SMTP AUTH authentication. If
4565 @code{nil}, @code{smtp-authenticate-type} is used. If
4566 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4569 @item wl-smtp-connection-type
4570 @vindex wl-smtp-connection-type
4571 The initial setting is @code{nil}.
4572 This variable specifies how to establish SMTP connections.
4573 If @code{nil}, @code{smtp-connection-type} is used.
4574 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4576 @item wl-nntp-posting-server
4577 @vindex wl-nntp-posting-server
4578 The initial setting is @code{nil}.
4579 This is the NNTP server name used for news submission.
4580 If @code{nil}, @code{elmo-nntp-default-server} is used.
4582 @item wl-nntp-posting-user
4583 @vindex wl-nntp-posting-user
4584 The initial setting is @code{nil}.
4585 This is the user name for AUTHINFO authentication on news submission.
4586 If @code{nil}, @code{elmo-nntp-default-user} is used.
4587 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4589 @item wl-nntp-posting-port
4590 @vindex wl-nntp-posting-port
4591 The initial setting is @code{nil}.
4592 This is the port number of the NNTP server used for news submission.
4593 If @code{nil}, @code{elmo-nntp-default-server} is used.
4595 @item wl-nntp-posting-stream-type
4596 @vindex wl-nntp-posting-stream-type
4597 The initial setting is @code{nil}.
4598 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4599 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4600 connection will be established.
4602 @item wl-pop-before-smtp-user
4603 @vindex wl-pop-before-smtp-user
4604 The initial setting is @code{nil}.
4605 This is the POP user name for POP-before-SMTP.
4606 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4608 @item wl-pop-before-smtp-server
4609 @vindex wl-pop-before-smtp-server
4610 The initial setting is @code{nil}.
4611 This is the POP server name for POP-before-SMTP.
4612 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4614 @item wl-pop-before-smtp-authenticate-type
4615 @vindex wl-pop-before-smtp-authenticate-type
4616 The initial setting is @code{nil}.
4617 This is the authentication method for POP-before-SMTP authentication.
4618 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4620 @item wl-pop-before-smtp-port
4621 @vindex wl-pop-before-smtp-port
4622 The initial setting is @code{nil}.
4623 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4624 @code{elmo-pop3-default-port} is used.
4626 @item wl-pop-before-smtp-stream-type
4627 @vindex wl-pop-before-smtp-stream-type
4628 The initial setting is @code{nil}.
4629 This flag controls the use of SSL for POP-before-SMTP. If it is
4630 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4631 STARTTLS (RFC2595) connection will be established.
4633 @item wl-draft-queue-save-variables
4634 @vindex wl-draft-queue-save-variables
4635 Specifies a list of variable to which queued messages are saved on the
4636 off-line transmission.
4638 @item wl-draft-sendlog
4639 @vindex wl-draft-sendlog
4640 The initial setting is @code{t}.
4641 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4645 @item drafts are sent by smtp or qmail
4646 @item saved into folders by fcc
4647 @item saved into folders by queuing
4650 (it is written even if the transmission fails).
4651 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4652 and left to the logging function of @command{imput}.
4655 @item wl-draft-sendlog-max-size
4656 @vindex wl-draft-sendlog-max-size
4657 The initial setting is 20000 (in bytes).
4658 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4659 beyond the size specified by this variable.
4663 The initial setting is @code{nil}.
4664 If non-nil, address completion uses LDAP.
4666 @item wl-ldap-server
4667 @vindex wl-ldap-server
4668 The initial setting is @samp{localhost}.
4669 LDAP server name for address completion.
4672 @vindex wl-ldap-port
4673 The initial setting is @code{nil}.
4674 If non-nil, the value is used as port number.
4677 @vindex wl-ldap-base
4678 The initial setting is @samp{c=US}.
4679 LDAP search starting point (base) for address completion.
4681 @item wl-draft-remove-group-list-contents
4682 @vindex wl-draft-remove-group-list-contents
4683 The initial setting is @code{t}.
4684 If non-nil, remove the group-lists' members in the recipients when
4685 sending the message (group-list means the description such as
4686 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4689 @node Disconnected Operations, Expire and Archive, Draft, Top
4690 @chapter Off-line Management
4691 @cindex Disconnected Operations
4693 Wanderlust has on-line and off-line states.
4696 * Off-line State:: Wanderlust has on-line and off-line states
4697 * Enable Operations:: Enable Disconnected Operations
4698 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4699 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4700 * Variables of Plugged Mode:: Customize Plugged Mode
4704 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4705 @section Off-line State
4707 Wanderlust has on-line and off-line states. In the off-line state, you
4708 cannot access messages via network, unless they are cached.
4710 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4711 in the mode line indicates the off-line state. In folder or summary
4712 modes, press @kbd{M-t} to switch between off- and on-line.
4714 You can invoke Wanderlust in the off-line state by setting
4715 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4717 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4718 ignores uncached messages.
4721 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4722 @section Enable Disconeected Operations
4724 Even in the off-line state, provided that relevant messages are cached,
4725 and the variable @code{elmo-enable-disconnected-operation} (described
4726 later) is non-nil, you can following operations:
4727 @xref{Plugged Mode}, @xref{Off-line State settings}.
4730 * Send Messages off-line:: Transmit Messages
4731 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4732 * Creation of Folders:: Create Folders off-line (IMAP4)
4733 * Marking:: Mark (IMAP4)
4734 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4737 As soon as Wanderlust becomes on-line, such operations invoked off-line
4738 are reflected in the servers via network.
4741 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4742 @subsection Transmission of Messages
4744 You can send mail/news messages off-line (if you are using
4745 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4746 accumulated in the queue folder, @samp{+queue}. These messages are
4747 transmitted at once when Wanderlust becomes on-line.
4749 You can visit @samp{+queue} in the off-line state and confirm content of
4750 messages in the queue. You can also remove messages. Removed messages
4751 are not transmitted even in the on-line state.
4754 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4755 @subsection Re-file and Copy (IMAP4)
4757 Re-file and copy operations to IMAP folders invoked during the off-line
4758 state are accumulated in the queue, and reflected in the server side
4759 when Wanderlust becomes on-line. If you visit destination folders after
4760 off-line re-file or copy, it looks as if messages were appended even in
4763 For the safety reasons, messages re-filed off-line are removed from
4764 source folders only if their @samp{Message-ID:} match messages on the
4765 servers. While the queue is processed, messages that failed to be
4766 re-filed or copied to the specified folders are appended to the folder
4770 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4771 @subsection Creation of Folders (IMAP4)
4773 You can create IMAP folders off-line. The creation of folders are
4774 reflected in the servers when Wanderlust becomes on-line. At that time,
4775 if folders failed to be created on the servers for any reasons, messages
4776 re-filed to such folders are appended to the folder @samp{+lost+found}.
4779 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4780 @subsection Marking (IMAP4)
4782 Off-line changes in unread/read and importance mark @samp{$} information
4783 are also reflected in the servers when Wanderlust becomes on-line.
4786 @node Pre-fetching Reservations, , Marking, Enable Operations
4787 @subsection Pre-fetching (IMAP4, NNTP)
4789 You can make reservations for pre-fetching messages in IMAP or NNTP
4790 folders. Reserved messages are marked with @samp{!} but not cached
4791 yet. When Wanderlust becomes on-line, they are pre-fetched from
4794 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4795 these off-line operations for IMAP4 and NNTP do not take place, and
4796 off-line re-file, copy or suchlike simply results in error.
4798 Because off-line operations use cache files, it is a bad idea to erase
4799 them by hand; it may cause Wanderlust to malfunction.
4801 If you want to remove caches, be sure to execute @kbd{M-x
4802 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4803 remove caches for messages relevant to off-line operations.
4806 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4807 @section Switching On-line/Off-line per Server/Port
4809 @kbd{M-t} described above switches networking states as a whole, but you
4810 can switch on-line/off-line per server/port.
4812 Pressing @kbd{C-t} in the folder or summary modes brings you in
4813 wl-plugged-mode shown below, in which you can change the plugged state
4818 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4821 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4822 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4824 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4825 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4831 The first line indicates status of the following three variables, and
4832 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4833 column modifies the values of these variables.
4837 "Queuing" @code{wl-draft-enable-queuing}
4838 "AutoFlushQueue" @code{wl-auto-flush-queue}
4839 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4843 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4846 The second and after lines indicate on-line/off-line states of servers
4847 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4848 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4849 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4851 @dfn{sending queue} means messages accumulated in the folder
4852 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4853 off-line operations when @code{elmo-enable-disconnected-operation} is
4855 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4856 @c off-line operations are enabled.
4858 They are displayed if there are any of them. In the example above, in
4859 the sending queue there are two messages (the first and the second in
4860 the queue folder) for smtp to hosta and one (the third) for nntp to
4861 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4864 If you change @samp{(wl-plugged)} in the second line, the variable
4865 @code{wl-plugged} is changed, so that the mode line indicator and
4866 plugged states of all ports are affected. If you change plugged states
4867 of any servers or ports, @samp{(wl-plugged)} in the second line is
4868 affected depending on @code{elmo-plugged-condition} settings and the
4869 plugged state of each port.
4872 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4873 @section Invoking Wanderlust in the Off-line State
4875 As described before, if you set @code{wl-plugged} to @code{nil} in
4876 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4877 off-line state. You can specify off-line state on a per server or port
4878 basis. Refer to @code{wl-reset-plugged-alist} also.
4880 Usually, when Wanderlust starts up, the plugged state of each port is
4881 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4882 @code{wl-nntp-posting-server} and so on. If you want to change the
4883 plugged state of these ports or to add other ports, configure
4884 @code{wl-make-plugged-hook} with a function.
4888 (add-hook 'wl-make-plugged-hook
4890 (elmo-set-plugged plugged-value(t/nil) server port)
4891 ;; @r{add or change plugged states of the port of the server}
4892 (elmo-set-plugged plugged-value(t/nil) server)
4893 ;; @r{if the port is omitted, all ports are affected}
4894 ;; @r{(you cannot omit the port if you newly add the server)}
4900 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4901 @section Customizable Variables
4906 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4907 mode from the beginning.
4909 @item wl-queue-folder
4910 @vindex wl-queue-folder
4911 The initial setting is @samp{+queue}.
4912 This is the folder in which messages in the transmission queue are
4915 @item wl-auto-flush-queue
4916 @vindex wl-auto-flush-queue
4917 The initial setting is @code{t}.
4918 This flag controls automatic transmission of the queue when Wanderlust
4919 becomes on-line. If non-nil, the queue is automatically transmitted
4920 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4921 manually, press @kbd{F} in the folder mode.
4923 @item elmo-enable-disconnected-operation
4924 @vindex elmo-enable-disconnected-operation
4925 The initial setting is @code{nil}. Controls off-line operations
4926 regarding IMAP4. If non-nil, off-line operations are carried out.
4928 @item elmo-lost+found-folder
4929 @vindex elmo-lost+found-folder
4930 The initial setting is @samp{+lost+found}.
4931 This is the folder to which messages are saved when they fails to be
4932 appended while the off-line re-file/copy queue is processed.
4934 @item elmo-plugged-condition
4935 @vindex elmo-plugged-condition
4936 The initial setting is @code{one}.
4937 The value of @code{wl-plugged} reflects the return value of the function
4938 @code{elmo-plugged-p} (without arguments).
4939 This variable @code{elmo-plugged-condition} specifies the condition on
4940 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4941 plugged state of each port.
4944 'one : plugged if one or more ports are plugged.
4945 'all : plugged if all ports are plugged.
4946 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4947 states of the ports.
4948 @var{function} : reflects the return value of the @var{function}
4949 functions available per default
4950 'elmo-plug-on-by-servers
4951 : reflects the plugged state of the servers specified by the
4952 variable elmo-plug-on-servers.
4953 'elmo-plug-on-by-exclude-servers
4954 : reflects the plugged state of the servers that are not
4955 in elmo-plug-on-exclude-servers.
4956 elmo-plug-on-exclude-servers defaults to
4959 (system-name)without the domain part)
4965 (setq elmo-plugged-condition 'all)
4967 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4968 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4970 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4971 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4975 @item wl-reset-plugged-alist
4976 @vindex wl-reset-plugged-alist
4977 The initial setting is @code{t}. If non-nil, plugged states are
4978 initialized on a per server or port basis when Wanderlust starts up.
4980 If @code{nil}, plugged states are retained while Emacs is running. In
4981 other words, they are initialized when Emacs is restarted even if the
4982 value is @code{nil}.
4986 @node Expire and Archive, Scoring, Disconnected Operations, Top
4987 @chapter Automatic Expiration and Archiving of Messages
4988 @cindex Expire and Archive
4991 * Expire:: Expiration and Archiving
4992 * Archive:: Archiving All Messages
4996 @node Expire, Archive, Expire and Archive, Expire and Archive
4998 @cindex Expire Message
5000 Expiration means deletion of old messages which have outlasted a
5001 certain period of time.
5003 @code{wl-expire} supports not only simple deletion, but also moving to
5004 specified archiving folders.
5008 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5009 or @kbd{M-e} in the summary mode.
5011 @subsection Configuring @code{wl-expire-alist}
5013 An example configuration of @code{wl-expire-alist} is shown below.
5014 Everything in this @code{wl-expire-alist} makes a great difference in
5015 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5016 to @code{t}, especially in the initial stage.
5020 (setq wl-expire-alist
5021 '(("^\\+trash$" (date 14) remove)
5023 ("^\\+tmp$" (date 7) trash)
5024 ;; @r{re-file to @code{wl-trash-folder}}
5025 ("^\\+outbox$" (number 300) "$outbox;lha")
5026 ;; @r{re-file to the specific folder}
5028 ;; @r{do not expire}
5029 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5030 ;; @r{archive by message number (retaining numbers)}
5031 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5032 ;; @r{archive by a fixed number (retaining numbers)}
5033 ("^\\+diary$" (date 30) wl-expire-archive-date)
5034 ;; @r{archive by year and month (numbers discarded)}
5039 Items in the list has the format of:
5042 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5046 The folder is examined if it matches @var{regexp-for-folders} from the
5047 beginning of the list. If you invoke expiration on the folder that does
5048 not match any of them, nothing will happen. And if either the second or
5049 the third element of the item is @code{nil}, expiration will not take
5052 You can use any one of the following for
5053 @var{specification-of-message-to-be-deleted}:
5056 @item (number @var{n1} [@var{n2}])
5057 deletes messages depending on the number of messages in the folder.
5059 @var{n1} is the number of messages which should survive deletion, for example
5060 if its value is 500, the newest 500 messages survive and the rests are
5063 @var{n2} is the number of messages in the folder on which expiration should
5064 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5065 folders with 510 or more messages are expired.
5066 If you configured automatic expiration, frequently used folders may
5067 expire every time it receive messages, and you may be annoyed with the
5068 long delay in reading mail.
5069 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5070 expiration would not take place until a certain number of messages
5073 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5074 with important/new/unread) are not deleted.
5075 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5076 will expire so as to have 500 messages including such ones.
5077 Otherwise, it will have 500 messages except such ones.
5079 @item (date @var{d1})
5080 deletes messages depending on the dates.
5082 Messages dated @var{d1} or more days ago are deleted, for example if its
5083 value is seven, messages seven days old or more are deleted. Note that
5084 the date is the one in the @samp{Date:} field of the message, not when
5085 the message entered the folder.
5087 Messages with no or invalid @samp{Date:} field does not expire; you
5088 might have to delete them by hand.
5091 You can use any one of the following in the place of @var{destination}:
5095 deletes the messages instantly.
5098 hide the messages from summary (messages are not deleted).
5101 moves the messages to @code{wl-trash-folder}.
5103 @item @var{string}(folder)
5104 moves the messages to the folder specified with @var{string}.
5106 It would be useful for specifying an archiving folder, but because this
5107 does not move important messages, it might be better to use the
5108 standard functions described below.
5110 @item @var{function}
5111 invokes the specified @var{function}.
5113 To the @var{function}, three arguments are passed: a folder name, a list
5114 of messages to be deleted, and msgdb information of the summary. You
5115 can specify function-specific arguments after the name of the
5116 @var{function}. Note that the list contains messages with marks in
5117 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5120 These are four standard functions; three of them move messages to an archive
5121 folder in the specified way. This means old messages can be compressed
5122 and saved in a file, being deleted from the original folder.
5123 The last one divides messages to some MH folders.
5126 @item wl-expire-archive-number1
5127 re-files to archiving folders corresponding to the message numbers of
5128 the messages being deleted. For example, a message numbered 102 will be
5129 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5130 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5131 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5133 The archiving folders to which messages are re-filed are determined by
5134 the name of the folder as follows (in this case, archiving folders are
5135 handled as if @code{elmo-archive-treat-file} were non-nil).
5138 @item If the folder type is localdir:
5139 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5141 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5142 (@file{~/Mail/ml/wl-00100.zip}).
5144 @item The folder type is other than localdir:
5145 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5147 For example, @samp{%#mh/ml/wl} corresponds to
5148 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5151 As you can see, in the case of localdir, the folder type is not included
5152 in the path name, but otherwise it is included.
5153 And you can control the prefix to the archiving folder name by
5154 @code{wl-expire-archive-folder-prefix}.
5155 Refer to @code{wl-expire-archive-folder-prefix} for details.
5157 @item wl-expire-archive-number2
5158 re-files every certain number of messages to archiving folders.
5160 This differs from @samp{wl-expire-archive-number1} in that this re-files
5161 to the folder up to the specified number regardless of message numbers.
5162 The archiving folders to which messages are re-filed are determined in the
5163 same way as @code{wl-expire-archive-number1}.
5165 @item wl-expire-archive-date
5166 re-files messages depending on its date (year and month) to archive
5169 For example, a message dated December 1998 is re-filed to
5170 @code{$folder-199812;zip}. The name of the archiving folders except the
5171 date part are determined in the same way as
5172 @code{wl-expire-archive-number1}.
5175 You can set the first argument to these three standard functions to non-nil
5176 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5177 For example, it can be specified just after the name of the function:
5180 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5183 If you omit the argument, consecutive numbers from 1 are assigned for
5184 each archiving folder.
5186 @item wl-expire-localdir-date
5187 divedes messages depending on its date (year and month) to MH folders
5188 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5192 @subsection Treatment for Important or Unread Messages
5194 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5195 standard function, messages with marks in
5196 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5197 messages} thereafter) are retained.
5199 Per default, this variable include the important, new, and unread marks,
5200 so that messages with these marks are not removed.
5201 Note that you cannot include the temporary mark (i.e. temporary marks
5202 are removed anyway), and be sure to process temporary marks before you
5205 @subsection Auto Expiration
5207 The following setup invokes expiration when you move into the summary
5208 mode. There will be no confirmation, so make sure you made no mistake
5209 in regexp and other settings before you set up this.
5213 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5217 In the folder mode, you can invoke expiration per group as well as per
5218 folder. Therefore, if you specify @samp{Desktop} group, all folders
5219 matching @code{wl-expire-alist} expire.
5223 @subsection Treating archive folders.
5224 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5225 you must set non-nil value to @code{elmo-archive-treat-file}.
5227 @subsection Confirming
5229 If you are to use @code{remove}, try @code{trash} at first and see
5230 messages move to @code{wl-trash-folder} as expected, then replace it
5231 with @code{remove}. It would be dangerous to use @code{remove} from the
5234 If you are to use @code{wl-expire-archive-number1} and the like, try to
5235 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5236 you can append messages to it. Even if settings in
5237 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5238 would not be saved anywhere and disappeared in case the archiver program
5241 After you make sure you can archive to the folder correctly, you can
5242 invoke expiration and utilize the log.
5244 If you set @code{wl-expire-use-log} to @code{t},
5245 @file{~/.elmo/expired-log} should contain the log, for example:
5249 delete +ml/wl (593 594 595 596 597 598 599)
5250 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5254 The first column indicates the operation, i.e. @samp{delete},
5255 @samp{copy}, or @samp{move}. The next is the name of the folder that
5256 expired. In the case of @samp{copy} and @samp{move}, the destination
5257 folder is recorded after @samp{->}. The last is the list of message
5258 numbers that are actually deleted or moved (in the case of @samp{copy}
5259 and @samp{move}, the number is the one in the source folder, rather than
5260 the destination folder).
5262 @subsection Re-filing Reserved Messages
5264 The three standard functions copy reserved messages to the archive
5265 folder, but do not delete them from the source folder. Because
5266 reserved messages and the like always remain, they are recorded in
5267 @file{~/.elmo/expired-alist} so that they are not copied over and over
5268 again. They are not recorded if copied by @code{wl-summary-archive}.
5270 If you enabled logging, usually @samp{move} is recorded for re-filing,
5271 but instead @samp{copy} and @samp{delete} are recorded separately if
5272 reserved messages are involved. This is because it actually copies
5273 messages including reserved, then deletes ones except reserved in that
5276 @section Customizable Variables
5279 @item wl-expire-alist
5280 @vindex wl-expire-alist
5281 The initial setting is @code{nil}.
5282 This variable specifies folders and methods to expire. For details,
5283 refer to @code{wl-expire-alist} settings above.
5285 @item wl-summary-expire-reserve-marks
5286 @vindex wl-summary-expire-reserve-marks
5287 The initial setting is the list below.
5291 (list wl-summary-important-mark
5293 wl-summary-unread-mark
5294 wl-summary-unread-uncached-mark
5295 wl-summary-unread-cached-mark)
5299 Messages with these marks are retained in the folder, even after
5301 Only permanent marks can be listed, not temporary marks.
5303 You can list marks one by one as in the default; you can use the
5304 following settings as well:
5308 All messages with permanent marks are retained,
5309 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5313 All messages are handled as usual ones that are already read, no matter
5314 what marks they have; even important messages are deleted.
5317 @item wl-expire-archive-files
5318 @vindex wl-expire-archive-files
5319 The initial setting is 100.
5320 This variable specifies the number of messages to be retained in one
5323 @item wl-expire-number-with-reserve-marks
5324 @vindex wl-expire-number-with-reserve-marks
5325 The initial setting is @code{nil}.
5326 If non-nil, if expiring messages are specified by @code{number},
5327 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5329 @item wl-expire-archive-get-folder-function
5330 @vindex wl-expire-archive-get-folder-function
5331 The initial setting is @code{wl-expire-archive-get-folder}.
5333 This variable specifies a function that returns the name of an archiving
5334 folder for standard functions in the place of @var{destination}.
5335 You can use the following three variables for simple modification of
5336 folder names; if you want more complex settings, define your own
5337 function in this variable.
5339 @code{wl-expire-archive-get-folder} can be customized by these
5342 @item @code{wl-expire-archive-folder-name-fmt}
5343 @item @code{wl-expire-archive-folder-type}
5344 @item @code{wl-expire-archive-folder-prefix}
5347 @item wl-expire-archive-folder-name-fmt
5348 @vindex wl-expire-archive-folder-name-fmt
5349 The initial setting is @samp{%s-%%05d;%s}.
5350 This is a @code{format} string for archiving folders used in
5351 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5352 Note that you must specify the message number by @samp{%%d}, because it
5353 is parsed twice by @code{format}.
5355 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5358 @item wl-expire-archive-date-folder-name-fmt
5359 @vindex wl-expire-archive-date-folder-name-fmt
5360 The initial setting is @samp{%s-%%04d%%02d;%s}.
5361 This is a @code{format} string for archiving folders used in
5362 @code{wl-expire-archive-date}. Note that you must specify the message
5363 number by @samp{%%d}, because it is parsed twice by @code{format}.
5364 There should be @samp{%%d} twice, one for the year and the other for the
5367 If you modify this, adjust
5368 @code{wl-expire-archive-date-folder-num-regexp} as well.
5370 @item wl-expire-archive-folder-type
5371 @vindex wl-expire-archive-folder-type
5372 The initial setting is @code{zip}.
5373 This variable specifies an archiver type of the archiving folders.
5375 @item wl-expire-archive-folder-prefix
5376 @vindex wl-expire-archive-folder-prefix
5377 The initial setting is @code{nil}.
5378 This variable specifies the prefix (directory structure) to archiving
5380 Exercise extreme caution in using this feature, as it has not been
5382 In the worst case, there is a fear of destructing archiving folders.
5386 There will be no prefix.
5389 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5390 @samp{$ml/wl-00000;zip;wl}.
5393 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5396 @samp{$ml/wl-00000;zip;ml/wl}.
5399 @item wl-expire-archive-folder-num-regexp
5400 @vindex wl-expire-archive-folder-num-regexp
5401 The initial setting is @samp{-\\([-0-9]+\\);}.
5402 This variable specifies the regular expression to be used for getting
5403 message numbers from multiple archiving folders specified by
5404 @code{elmo-list-folders}.
5405 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5407 @item wl-expire-archive-date-folder-num-regexp
5408 @vindex wl-expire-archive-date-folder-num-regexp
5409 The initial setting is @samp{-\\([-0-9]+\\);}.
5410 This is the regular expression to be used for getting message numbers
5411 from multiple archiving folders specified by @code{elmo-list-folders}.
5412 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5414 @item wl-expire-delete-oldmsg-confirm
5415 @vindex wl-expire-delete-oldmsg-confirm
5416 The initial setting is @code{t}.
5417 If non-nil, messages older than the one with the largest number will be
5418 deleted with confirmation.
5419 If @code{nil}, they are deleted without confirmation.
5421 This feature is valid only if non-nil is specified as a argument to the
5422 standard functions so as to retain numbers.
5424 @item wl-expire-use-log
5425 @vindex wl-expire-use-log
5426 The initial setting is @code{nil}.
5427 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5428 They are appended but not truncated or rotated automatically; you might
5429 need to remove it manually.
5431 @item wl-expire-add-seen-list
5432 @vindex wl-expire-add-seen-list
5433 The initial setting is @code{t}.
5435 If non-nil, when messages are re-filed by expiration, read/unread
5436 information is passed to the destination folder.
5438 However if you do not read the destination folder from Wanderlust,
5439 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5440 want to set this to @code{nil} if you are simply saving to some
5441 archiving folders. Even if its value is @code{nil}, messages in the
5442 archiving folders are simply treated as unread; it does not affect
5445 @item wl-expire-folder-update-msgdb
5446 @vindex wl-expire-folder-update-msgdb
5447 The initial setting is @code{t}.
5448 If @code{t}, in the folder mode, expiration is carried out after
5449 updating summary information. If you specified a list of regular
5450 expressions of folder names, summary information is updated for matching
5455 @node Archive, , Expire, Expire and Archive
5456 @section Archiving Messages
5458 @subsection Archiving Messages
5459 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5460 folders. If there are the archiving folders already, only new messages
5463 You can use @code{wl-archive-alist} in order to specify how messages are
5464 archived according to their folder names, as in @code{wl-expire-alist}.
5469 (setq wl-archive-alist
5470 '(("^\\+tmp$" wl-archive-date)
5471 ("^\\+outbox$" wl-archive-number2)
5472 (".*" wl-archive-number1)))
5476 Each item in the list has the following format:
5479 (@var{folders-regexp} @var{deleting-function})
5482 As you can see, you can only use a function after @var{folders-regexp}.
5483 Per default, there are three functions:
5486 @item @code{wl-archive-number1}
5487 @item @code{wl-archive-number2}
5488 @item @code{wl-archive-date}
5491 As inferred from their names, they work similarly to "expire" versions,
5492 other than the following points:
5495 @item No messages are deleted
5496 @item Message numbers are retained even if invoked without arguments
5499 These functions are good to archive all messages in a folder by their
5500 numbers or by their dates.
5501 These are also useful for backup or confirmation purposes before
5503 If you try to re-file them after they are archived, they are deleted but
5506 Per default, the archiving folders to which messages are copied are
5507 determined automatically by @code{wl-expire-archive-get-folder-function}.
5508 You can copy to a specific folder by invoking with a prefix argument,
5509 i.e. @kbd{C-u M-x wl-summary-archive}.
5511 Note that this feature has not been seriously tested, because you can
5512 simply copy to an archiving folder, for example by
5513 @code{wl-summary-copy-region}.
5515 The archiving folders are determined by the same logic as in
5516 @code{wl-summary-expire}; the following customizable variables are
5520 @item @code{wl-expire-archive-files}
5521 @item @code{wl-expire-archive-get-folder-function}
5522 @item @code{wl-expire-archive-folder-name-fmt}
5523 @item @code{wl-expire-archive-folder-type}
5524 @item @code{wl-expire-archive-folder-prefix}
5525 @item @code{wl-expire-archive-folder-num-regexp}
5528 @subsection Customizable Variables
5531 @item wl-archive-alist
5532 @vindex wl-archive-alist
5533 The initial setting is the list shown below:
5537 ((".*" wl-archive-number1))
5542 This variable specifies a function that copies to archiving folders.
5543 To the function, three arguments are passed: a folder name, a list of
5544 messages in the folder, and msgdb information of the summary.
5545 Needless to say, you can use your own function.
5549 @node Scoring, Address Book, Expire and Archive, Top
5550 @chapter Score of the Messages
5552 @c @cindex Kill File
5554 Scoring is the function that associates a score (value) with each
5555 message, and marks as read or deletes from the summary according to it.
5557 You can put target or important marks on essential messages, or read marks
5558 on the ones you do not want to read, for example spam articles.
5560 This scoring function has a capability and a format similar to the one
5561 that Gnus has, although there are some unsupported features and
5562 Wanderlust specifics.
5563 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5566 * Score Commands:: Score Commands
5567 * Score File Format:: Score File Format
5571 @node Score Commands, Score File Format, Scoring, Scoring
5572 @section Score Commands
5573 @cindex Score Commands
5575 @subsection Score File Specification
5577 @code{wl-score-folder-alist} specifies score files or variables in which
5578 scores are defined, corresponding to folder names.
5582 (setq wl-score-folder-alist
5591 If paths to the score files are omitted, the directory specified in the
5592 variable @code{wl-score-files-directory} is assumed.
5594 No matter what you write in @code{wl-score-folder-alist}, the default
5595 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5596 read (it does not have to exist).
5597 Therefore, in the example above, the three score files,
5598 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5599 the folders that matches @samp{^-.*}.
5601 @subsection Scored Messages
5603 Scores are attached to the messages that are specified by
5604 @code{wl-summary-score-marks} temporarily when the summary is updated;
5605 when you exit from the summary, the scores are removed and reverts to
5608 @subsection Creation of Score Files
5610 In the summary buffer, move to an appropriate message and type @kbd{L}.
5611 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5612 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5614 This makes @minus{}1000 are scored for messages with the same
5615 @samp{Subject:} as the string you entered. That is, such a score file
5616 is created automatically.
5618 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5619 The score file you just made appears.
5620 This buffer is called @dfn{score editing buffer} thereafter.
5621 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5622 as you are previously; type @kbd{a}. Then a score entry for "From"
5624 In this way, you can create a score file easily either in the summary
5625 buffer or in the score editing buffer.
5627 By the way, you might be aware the numbers of key strokes are different
5628 between @kbd{s s p} and @kbd{a}.
5629 This is determined by @code{wl-score-header-default-entry}.
5630 This variable specifies the default score entries corresponding to
5632 For example, for "subject" field, a type and a time limit are prompted,
5633 but for "from" field, they are fixed upon automatically as substring and
5634 permanent respectively.
5635 However, score values can be modified by the prefix argument.
5636 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5639 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5640 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5641 erasing contents of the buffer deletes the score file being edited.
5645 @subsubsection Selecting Score Files
5647 You can change score files to which scores are appended by
5648 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5649 @code{wl-score-change-score-file}.
5651 @subsubsection Summing Up the Score
5653 If you add the same entries by @code{wl-summary-increase-score},
5654 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5655 scores for the entry is summed up.
5657 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5658 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5659 @minus{}1200 will be created as a result.
5661 @subsubsection Creating Thread Key
5663 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5664 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5666 @subsubsection Creating Followup Key
5668 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5669 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5670 at the cursor to @samp{References} key.
5671 If @code{wl-score-auto-make-followup-entry} is non-nil,
5672 @samp{Message-ID} of all messages to be followed up within dates
5673 specified by @code{wl-score-expiry-days}.
5675 @subsection Key Bindings
5680 @findex wl-summary-increase-score
5681 Increases the score for the current message.
5682 And the score entry is appended to the score file at the same moment.
5683 You can specify the score value by a prefix argument.
5687 @findex wl-summary-lower-score
5688 Decreases the score for the current message.
5689 And the score entry is appended to the score file at the same moment.
5690 You can specify the score value by a prefix argument.
5693 @kindex h R (Summary)
5694 @findex wl-summary-rescore
5695 Re-applies the scoring.
5696 However, already scored messages are not scored anew.
5699 @kindex h c (Summary)
5700 @findex wl-score-change-score-file
5701 Changes the score file currently selected.
5704 @kindex h e (Summary)
5705 @findex wl-score-edit-current-scores
5706 Edits the score file currently selected.
5707 If there are multiple score files, the previously specified one is
5711 @kindex h f (Summary)
5712 @findex wl-score-edit-file
5713 Edits an arbitrary score file and selects it.
5716 @kindex h F (Summary)
5717 @findex wl-score-flush-cache
5718 Erases caches associated to the score files that are read.
5719 If you modified score files directly (from other than Wanderlust), you
5720 need to re-read them after erasing the cache.
5723 @kindex h m (Summary)
5724 @findex wl-score-set-mark-below
5725 Specifies the criterion for scores to be marked as read.
5726 Messages with scores less than this value are marked as read.
5729 @kindex h x (Summary)
5730 @findex wl-score-set-expunge-below
5731 Specifies the criterion for scores to be deleted from the summary.
5732 Messages with scores less than this value are deleted.
5733 "Deleted" means it is not shown; they are not removed from the summary
5734 information or the folder.
5735 The deleted messages can be shown by rescan-noscore again.
5738 @subsection Key Bindings in the Score Editing Buffer
5742 @kindex C-c C-k (Score Mode)
5743 @findex wl-score-edit-kill
5744 Abandons the file being edited.
5747 @kindex C-c C-c (Score Mode)
5748 @findex wl-score-edit-exit
5749 Saves the file being edited, and quits from the edit mode.
5752 @kindex C-c C-p (Score Mode)
5753 @findex wl-score-pretty-print
5757 @kindex C-c C-d (Score Mode)
5758 @findex wl-score-edit-insert-date
5759 Inserts the number of dates from Dec. 31, 1 B.C.
5760 It is used for creating the third factor of time-limited scores.
5763 @kindex C-c C-s (Score Mode)
5764 @findex wl-score-edit-insert-header
5765 Inserts the header of the message selected in the summary buffer.
5768 @kindex C-c C-e (Score Mode)
5769 @findex wl-score-edit-insert-entry
5770 Inserts the score entry of the message selected in the summary buffer.
5773 @subsection Customizable Variables
5776 @item wl-summary-default-score
5777 @vindex wl-summary-default-score
5778 The initial setting is 0 (zero).
5779 This variable specifies the default value of the score.
5780 The score is increased or decreased based upon this value.
5782 @item wl-summary-important-above
5783 @vindex wl-summary-important-above
5784 The initial setting is @code{nil}.
5785 Messages with scores larger than this value are attached with the
5786 important mark (@samp{$}).
5787 If @code{nil}, no important marks are attached.
5789 @item wl-summary-target-above
5790 @vindex wl-summary-target-above
5791 The initial setting is @code{nil}.
5792 Messages with scores larger than this value are attached with the target
5794 If @code{nil}, no target marks are attached.
5796 @item wl-summary-mark-below
5797 @vindex wl-summary-mark-below
5798 The initial setting is 0 (zero).
5799 Messages with scores smaller than this value are marked as read.
5801 @item wl-summary-expunge-below
5802 @vindex wl-summary-expunge-below
5803 The initial setting is @code{nil}.
5804 Messages with scores smaller than this value are deleted from the
5806 If @code{nil}, they are not deleted.
5808 @item wl-summary-score-marks
5809 @vindex wl-summary-score-marks
5810 The initial setting is the list shown below:
5814 (list wl-summary-new-mark)
5819 Messages with these marks are scored.
5821 @item wl-use-scoring
5822 @vindex wl-use-scoring
5823 The initial setting is t.
5824 If non-nil, scoring is enabled.
5826 @item wl-score-files-directory
5827 @vindex wl-score-files-directory
5828 The initial setting is @file{~/.elmo/}.
5829 The default directory for score files.
5831 @item wl-score-interactive-default-score
5832 @vindex wl-score-interactive-default-score
5833 The initial setting is 1000.
5834 This value is used as a score when a score factor is @code{nil} in the
5835 score file. It is also used in @code{wl-summary-increase-score} and
5836 @code{wl-summary-lower-score}, on condition that the value of
5837 @code{wl-score-header-default-entry} is @code{nil}.
5839 @item wl-score-expiry-days
5840 @vindex wl-score-expiry-days
5841 The initial setting is 7.
5842 This is the number of days before time-limited scores are deleted.
5844 @item wl-score-update-entry-dates
5845 @vindex wl-score-update-entry-dates
5846 The initial setting is @code{t}.
5847 If non-nil, it enables deletion of time-limited scores.
5849 @item wl-score-header-default-entry
5850 @vindex wl-score-header-default-entry
5851 Specifies the default value for each header field for score entries
5852 created by @code{wl-summary-increase-score},
5853 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5855 @item wl-score-simplify-fuzzy-regexp
5856 @vindex wl-score-simplify-fuzzy-regexp
5857 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5858 regular expression to be deleted from the string.
5859 Because this is usually used for Subject, the default is prefixes that
5860 are attached by mailing list programs.
5862 @item wl-summary-rescore-partial-threshold
5863 @vindex wl-summary-rescore-partial-threshold
5864 The initial setting is 200.
5865 When sync-all or rescan is executed, if there are messages more than
5866 this value, only the last same number of messages as this value are
5869 @item wl-summary-auto-sync-marks
5870 @vindex wl-summary-auto-sync-marks
5871 If non-nil, unread/important marks are synchronized when the summary
5873 Unread marks reflect information on the IMAP4 server.
5874 Important marks reflect information on the IMAP4 server (flagged or
5875 not), and contents of @samp{'mark} folder.
5876 The initial setting is @code{t}.
5880 @node Score File Format, , Score Commands, Scoring
5881 @section Score File Format
5882 @cindex Score File Format
5884 The format of score files are the same as Gnus, and basically you can
5885 use Gnus score files as they are. But they are not fully compatible
5886 because some keys are not supported and there are Wanderlust specifics.
5887 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5892 ("for sale" -1000 nil s)
5893 ("profit" -1000 nil s))
5895 ("spam@@spamspamspam" -10000 nil s))
5897 ("my@@address" 3001 nil s))
5899 (1000000 -10 nil >))
5909 If the key is a string, it is the name of the header to be matched.
5910 The following keys are available:
5911 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5912 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5913 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5914 @code{Chars} and @code{Lines} mean the size and the number of lines of
5915 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5916 are described later.
5917 The rest corresponds the field of the same name.
5919 Arbitrary numbers of core entries are specified after the key.
5920 Each score entry consists of these five factors:
5924 A factor that matches header. This should be a number in the cases of
5925 @code{lines} and @code{chars}, otherwise a string.
5928 A score factor. When the first item matches, the score of the message
5929 is increased or decreased by this value.
5932 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5933 of a number, the score is deleted if it does not match for days
5934 (@code{wl-score-expiry-days}) from the date specified by this.
5935 The date is since Dec. 31, 1 B.C.
5938 A type factor. This specifies the way the first factor matches.
5939 Available types depend on keys.
5942 @item From, Subject, References, Message-ID
5943 For these keys in string, @code{r} and @code{R} (regexp),
5944 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5945 as well as @code{f} and @code{F} (fuzzy) can be used.
5946 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5949 For these keys, the following five numerical relative operators can be
5950 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5953 This key matches @code{From} header, and scores all follow-ups to the
5955 For example, it would be useful for increasing scores for follow-ups to
5958 You can use the same types as @code{From} except for @code{f}.
5959 And a @samp{Followup} entry is automatically appended to the score file.
5962 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5963 A @samp{Thread} entry is automatically appended for each article that
5964 has @var{x} in the @code{References} header.
5965 You can make sure the whole thread including messages that does not have
5966 all ancestors @code{Message-ID} in @code{References} is scored.
5968 You can use the same types as @code{References} except for @code{f}.
5969 And a @samp{Thread} entry is automatically appended to the score file.
5973 A factor for extension header. This is meaningful only if the key is
5975 This specifies headers to be matched other than standard headers like
5976 @code{Subject} and @code{From}.
5977 Note that you should specify the header in
5978 @code{elmo-msgdb-extra-fields} also.
5979 Therefore it does not work in folders where extension headers cannot be
5984 The sum of these scores @emph{after all factors are applied} becomes the
5985 score of the message.
5987 @cindex Score File Atoms
5989 Messages with a score less than this value is marked as read.
5990 The default is @code{wl-summary-mark-below}.
5993 Messages with a score less than this value is deleted from the summary.
5994 The default is @code{wl-summary-expunge-below}.
5996 @item mark-and-expunge
5997 Both @code{mark} and @code{expunge} are applied,
5998 i.e. messages with a score less than this value is marked as read and
5999 deleted from the summary.
6002 Messages with a score greater than this value is attached with temp
6004 The default is @code{wl-summary-target-above}.
6007 Messages with a score greater than this value is attached with important
6009 The default is @code{wl-summary-important-above}.
6014 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6015 are used, you need to set @code{elmo-msgdb-extra-fields}.
6018 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6021 There are other restrictions as shown below:
6024 @item Because @samp{References} field in the summary information
6025 contains only the last @samp{Message-ID}, @code{references} key matches
6029 Keys that can be seen by folder of types:
6033 chars lines xref extra
6034 localdir,localnews Y E E E
6035 nntp (supporting xover) Y E E N
6041 N: cannot be seen (ignored)
6042 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6047 @node Address Book, Customization, Scoring, Top
6048 @chapter Address Book
6049 @cindex Address Book
6051 With address book, you can utilize address completion, and you have
6052 summary displayed with nicknames.
6055 * Mail Addresses:: Definition of Address Book
6056 * Address Manager:: Address Manager
6059 @node Mail Addresses, Address Manager, Address Book, Address Book
6060 @section Address book
6061 @cindex Address book Definition
6063 @cindex Alias, Address
6065 The file @file{~/.addresses} is a simple address book for Wanderlust.
6066 Make address file @file{~/.addresses}, and edit to suit your requirement.
6068 The data written in @file{~/.addresses} are used for address completion
6069 under draft editing mode. Furthermore, they are used when showing names
6070 in summary display mode. You can safely skip this section, if you don't
6071 want to customize address completion and summary display.
6072 It is possible to add/change/remove addresses from @file{~/.addresses} in
6073 summary buffer after Wanderlust is invoked. @refill
6075 The format is very simple. Like this. @refill
6080 # @r{Lines begin with @samp{#} are comment.}
6081 # @r{Empty lines are ignored}
6083 # @r{Format of each line:}
6084 # @var{email-address} "@var{nickname} "@var{realname}"
6086 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6087 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6088 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6093 One line defines one persons description.
6095 Actually, in default setup, @var{nickname} is used in summary-mode and
6096 @var{realname} is used in draft preparation mode. This behavior is
6097 better understood if you try it and confirmed the function first. You
6098 can write and try a small definition, so you will know the idea of the
6099 address book before writing a big one.
6101 And, if MH alias file is specified in variable @code{wl-alias-file},
6102 it is used as an address information in the draft preparation mode.
6104 If variable @code{wl-use-ldap} is non-nil (initial setting is
6105 @code{nil}), address completion in draft mode uses LDAP information.
6107 If you use LDAP, you have to set @code{wl-ldap-server},
6108 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6109 not have LDAP feature as built-in feature (Currently only XEmacs can
6110 have built-in LDAP feature), you have to set command exec @env{PATH} to
6111 the program @command{ldapsearch}.
6114 @node Address Manager, , Mail Addresses, Address Book
6115 @section Address Manager
6116 @cindex Address Manager
6118 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6119 the address book and insert address to draft buffer.
6121 @subsection Key Bindings
6125 @kindex t (Address Manager)
6126 @findex wl-addrmgr-set-to
6127 Add @samp{To:} mark.
6130 @kindex c (Address Manager)
6131 @findex wl-addrmgr-set-cc
6132 Add @samp{Cc:} mark.
6135 @kindex b (Address Manager)
6136 @findex wl-addrmgr-set-bcc
6137 Add @samp{Bcc:} mark.
6140 @kindex u (Address Manager)
6141 @findex wl-addrmgr-unmark
6145 @kindex x (Address Manager)
6146 @findex wl-addrmgr-apply
6148 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6149 buffer and quit address manager. When no draft buffer, make new draft
6150 with insert marked addresses.
6152 If no mark, quit address manager.
6156 @kindex q (Address Manager)
6157 @findex wl-addrmgr-quit
6158 Quit address manager.
6161 @kindex a (Address Manager)
6162 @findex wl-addrmgr-add
6166 @kindex d (Address Manager)
6167 @findex wl-addrmgr-delete
6171 @kindex e (Address Manager)
6172 @findex wl-addrmgr-edit
6177 @node Customization, Mailing List, Address Book, Top
6178 @chapter Customizing Wanderlust
6179 @cindex Customization
6182 * Living with other packages:: Cooperating with other packages
6183 * Highlights:: Highlights
6184 * Biff:: Notify Mail arrival
6185 * Advanced Settings:: Advanced Settings
6186 * Customizable Variables:: Customizable Variables
6191 @node Living with other packages, Highlights, Customization, Customization
6192 @section Living with other packages
6194 Examples with other packages.
6197 * imput:: imput (im-wl.el)
6199 * supercite:: supercite.el
6200 * mu-cite:: mu-cite.el
6201 * X-Face:: x-face,bitmap-mule
6202 * dired-dd:: dired-dd.el
6204 * Addrbook:: Addrbook
6205 * mime-w3m:: mime-w3m.el
6209 @node imput, BBDB, Living with other packages, Living with other packages
6214 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6217 If @command{imput} is on the @code{exec-path} at the installation,
6218 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6222 (autoload 'wl-draft-send-with-imput-async "im-wl")
6223 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6228 @node BBDB, supercite, imput, Living with other packages
6232 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6235 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6236 byte-compiled and installed.
6244 ;; @r{enable pop-ups}
6245 (setq bbdb-use-pop-up t)
6246 ;; @r{auto collection}
6247 (setq bbdb/mail-auto-create-p t)
6248 (setq signature-use-bbdb t)
6249 (setq bbdb-north-american-phone-numbers-p nil)
6250 ;; @r{shows the name of bbdb in the summary} :-)
6251 (setq wl-summary-from-function 'bbdb-wl-from-func)
6252 ;; @r{automatically add mailing list fields}
6253 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6254 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6258 You can complete address with BBDB by @kbd{M-@key{TAB}}
6262 @node supercite, mu-cite, BBDB, Living with other packages
6263 @subsection sc.el(supercite), sc-register.el
6267 The same setting as usual mailers should be OK. The following is an
6268 example of settings:
6272 (autoload 'sc-cite-original "supercite" nil t)
6273 (add-hook 'mail-citation-hook 'sc-cite-original)
6278 @node mu-cite, X-Face, supercite, Living with other packages
6279 @subsection mu-cite.el
6282 The same setting as usual mailers should be OK. The following is an
6283 example of settings.
6285 If you use mu-cite version 8.0 or earlier:
6289 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6290 (setq mail-citation-hook 'mu-cite/cite-original)
6294 If you use mu-cite version 8.1 or later:
6298 (autoload 'mu-cite-original "mu-cite" nil t)
6299 (add-hook 'mail-citation-hook (function mu-cite-original))
6303 @node X-Face, dired-dd, mu-cite, Living with other packages
6307 If you have installed one of the following, you can decode
6308 @samp{X-Face:} field in message buffer and you will see face image.
6311 * x-face-xmas:: XEmacs case
6312 * x-face-mule:: Emacs case
6315 If there is an encoded X-Face string in a file @file{~/.xface} (the
6316 value of the variable @code{wl-x-face-file}), it is inserted as a
6317 @samp{X-Face:} field in the draft buffer (if
6318 @code{wl-auto-insert-x-face} is non-nil).
6320 @node x-face-xmas, x-face-mule, X-Face, X-Face
6321 @subsubsection x-face-xmas (for XEmacs)
6324 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6325 1.3.6.13 or later, do the following:
6329 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6330 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6334 @node x-face-mule, , x-face-xmas, X-Face
6335 @subsubsection x-face-mule (for Emacs)
6339 If you use @file{x-face-mule.el} in bitmap-mule
6340 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6344 (autoload 'x-face-decode-message-header "x-face-mule")
6345 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6349 @subsubsection x-face-e21 (for Emacs 21.x)
6352 With Emacs 21.x, you can use @file{x-face-e21.el}
6353 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6354 to display X-Face. In this case, bitmap-mule is not required.
6359 (autoload 'x-face-decode-message-header "x-face-e21")
6360 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6365 @node dired-dd, MHC, X-Face, Living with other packages
6366 @subsection dired-dd(Dired-DragDrop)
6367 @pindex Dired-DragDrop
6369 @cindex Drag and Drop
6371 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6372 compose multi-part by simple Drag-and-Drop from dired to the draft
6373 buffer being edited in GNU Emacs (this feature is not Wanderlust
6374 specific, but general-purpose for SEMI).
6378 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6384 ;; @r{Set dired-x variables here.}
6385 ;; @r{To and flo@dots{}}
6387 (progn (require 'dired-dd)
6388 (require 'dired-dd-mime))))))
6392 @node MHC, Addrbook, dired-dd, Living with other packages
6396 Message Harmonized Calendaring system
6397 (@uref{http://www.quickhack.net/mhc/})
6399 By using MHC, you can make a calendar from the messages.
6405 (setq mhc-mailer-package 'wl)
6406 (autoload 'mhc-mode "mhc" nil t)
6407 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6408 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6416 (autoload 'mhc-wl-setup "mhc-wl")
6417 (add-hook 'wl-init-hook 'mhc-wl-setup)
6421 @node Addrbook, mime-w3m, MHC, Living with other packages
6422 @subsection wl-addrbook.el
6426 (@uref{http://www.mew.org/})
6428 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6429 @code{load-path} and do the following settings.
6433 (require 'wl-addrbook)
6438 @node mime-w3m, , Addrbook, Living with other packages
6439 @subsection mime-w3m.el
6442 You can display html part by using @file{mime-w3m.el}
6443 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6444 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6447 @node Highlights, Biff, Living with other packages, Customization
6450 @subsection Customizable Variables
6453 @item wl-summary-highlight
6454 @vindex wl-summary-highlight
6455 The initial setting is @code{t}.
6456 If non-nil, the summary is highlighted.
6458 @item wl-highlight-max-summary-lines
6459 @vindex wl-highlight-max-summary-lines
6460 The initial setting is 10000.
6461 The summary is not highlighted if it has more lines than this value.
6463 @item wl-summary-highlight-partial-threshold
6464 @vindex wl-summary-highlight-partial-threshold
6465 The initial setting is 1000.
6466 This is a threshold whether the whole summary is highlighted.
6467 If there are more lines of messages in the summary, it is partially
6470 @item wl-summary-partial-highlight-above-lines
6471 @vindex wl-summary-partial-highlight-above-lines
6472 The initial setting is 30. If there are more lines of messages than
6473 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6474 after the point that is the same number of lines as this value above the
6475 cursor line are highlighted partially. (If this value is @code{nil},
6476 the last same number of lines as the value of
6477 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6479 @item wl-highlight-body-too
6480 @vindex wl-highlight-body-too
6481 The initial setting is @code{t}.
6482 If non-nil, bodies of drafts and messages are also highlighted.
6484 @item wl-highlight-message-header-alist
6485 @vindex wl-highlight-message-header-alist
6486 When highlighting headers of drafts and messages, this variable
6487 specifies which faces are allocated to important
6488 (@code{wl-highlight-message-important-header-contents}), secondly
6489 important (@code{wl-highlight-message-important-header-contents2}), and
6490 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6492 Similarly, it can be used for allocating arbitrary faces to arbitrary
6493 regular expressions.
6495 @item wl-highlight-citation-prefix-regexp
6496 @vindex wl-highlight-citation-prefix-regexp
6497 Specifies a regular expression to which quoted lines in bodies of
6498 drafts and messages match.
6499 Bodies matching to this regular expression are highlighted by the faces
6500 specified by (@code{wl-highlight-message-cited-text-*}).
6502 @item wl-highlight-highlight-citation-too
6503 @vindex wl-highlight-highlight-citation-too
6504 The initial setting is @code{nil}.
6505 If non-nil, the quoting regular expression itself given by
6506 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6508 @item wl-highlight-citation-header-regexp
6509 @vindex wl-highlight-citation-header-regexp
6510 Specifies a regular expression that denotes beginning of quotation.
6511 Bodies matching to this regular expression are highlighted by the face
6512 specified by @code{wl-highlight-message-headers}.
6514 @item wl-highlight-max-header-size
6515 @vindex wl-highlight-max-header-size
6516 The initial setting is @code{nil}. If a header size is larger than this
6517 value, it will not be highlighted. If @code{nil}, always highlighted
6518 (ignore header size).
6520 @item wl-highlight-max-message-size
6521 @vindex wl-highlight-max-message-size
6522 The initial setting is 10000.
6523 If a message is larger than this value, it will not be highlighted.
6524 With this variable, highlight is suppressed for uuencode or huge digest
6527 @item wl-highlight-signature-separator
6528 @vindex wl-highlight-signature-separator
6529 Specifies regular expressions that denotes the boundary of a signature.
6530 It can be a regular expression, or a list of ones.
6531 Messages after the place that matches this regular expression are
6532 highlighted by the face specified by
6533 @code{wl-highlight-message-signature}.
6535 @item wl-max-signature-size
6536 @vindex wl-max-signature-size
6537 The initial setting is 400.
6538 This is the largest size for a signature to be highlighted.
6540 @item wl-use-highlight-mouse-line
6541 @vindex wl-use-highlight-mouse-line
6542 The initial setting is @code{t}.
6543 If non-nil, the line pointed by the mouse is highlighted in the folder
6544 mode, summary mode, and the like.
6547 @subsection Setting Colors and Fonts of the Characters
6549 If you want to change colors or fonts of the characters, you need to
6550 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6551 want to change fonts, and @code{set-face-foreground} for colors, and so
6552 on. You cannot write face settings in @file{.emacs}; write in
6555 For example, if you want to change the color for signatures to yellow,
6559 (set-face-foreground 'wl-highlight-message-signature "yellow")
6565 Faces defined in Wanderlust:
6568 @item wl-highlight-message-headers
6569 The face for field names of message headers.
6571 @item wl-highlight-message-header-contents
6572 The face for field bodies of message headers.
6574 @item wl-highlight-message-important-header-contents
6575 The face for important parts of message headers.
6576 Per default, this face is used for a body of @samp{Subject:} field.
6577 You can change its value by editing
6578 @code{wl-highlight-message-header-alist}.
6580 @item wl-highlight-message-important-header-contents2
6581 The face for secondly important parts of message headers.
6582 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6583 fields. You can change its value by editing
6584 @code{wl-highlight-message-header-alist}.
6586 @item wl-highlight-message-unimportant-header-contents
6587 The face for unimportant parts of message headers.
6588 Per default, this face is used for bodies of @samp{X-} fields
6589 @samp{User-Agent:} fields. You can change its value by editing
6590 @code{wl-highlight-message-header-alist}.
6592 @item wl-highlight-message-citation-header
6593 The face for headers of quoted messages.
6595 @item wl-highlight-message-cited-text-*
6596 The face for texts of quoted messages. The last @samp{*} is a
6597 @var{single figure} so that 10 different colors can be used according to
6600 @item wl-highlight-message-signature
6601 The face for signatures of messages. The initial settings are
6602 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6603 dark background colors.
6605 @item wl-highlight-header-separator-face
6606 The face for header separators of draft messages.
6608 @item wl-highlight-summary-important-face
6609 The face for message lines with important marks in the summary.
6611 @item wl-highlight-summary-new-face
6612 The face for message lines with new marks in the summary.
6614 @item wl-highlight-summary-displaying-face
6615 The face for the message line that is currently displayed.
6616 This face is overlaid.
6618 @item wl-highlight-thread-indent-face
6619 The face for the threads that is currently displayed.
6621 @item wl-highlight-summary-unread-face
6622 The face for message lines with unread marks in the summary.
6624 @item wl-highlight-summary-deleted-face
6625 The face for message lines with delete marks in the summary.
6627 @item wl-highlight-summary-refiled-face
6628 The face for message lines with re-file marks in the summary.
6630 @item wl-highlight-refile-destination-face
6631 The face for re-file information part of message lines with re-file
6632 marks in the summary.
6634 @item wl-highlight-summary-copied-face
6635 The face for message lines with copy marks in the summary.
6637 @item wl-highlight-summary-target-face
6638 The face for message lines with target marks @samp{*} in the summary.
6640 @item wl-highlight-summary-thread-top-face
6641 The face for message lines that are on the top of the thread in the
6644 @item wl-highlight-summary-normal-face
6645 The face for message lines that are not on top of the thread in the
6648 @item wl-highlight-folder-unknown-face
6649 The face for folders that are not known to have how many unsync messages
6652 @item wl-highlight-folder-zero-face
6653 The face for folders that have no unsync messages in the folder mode.
6655 @item wl-highlight-folder-few-face
6656 The face for folders that have some unsync messages in the folder mode.
6658 @item wl-highlight-folder-many-face
6659 The face for folders that have many unsync messages in the folder mode.
6660 The boundary between `some' and `many' is specified by the variable
6661 @code{wl-folder-many-unsync-threshold}.
6663 @item wl-highlight-folder-unread-face
6664 The face for folders that have no unsync but unread messages in the
6667 @item wl-highlight-folder-killed-face
6668 The face for folders that are deleted from the access group in the
6671 @item wl-highlight-folder-opened-face
6672 The face for open groups in the folder mode.
6673 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6674 @code{nil} or a @var{number}.
6676 @item wl-highlight-folder-closed-face
6677 The face for close groups in the folder mode.
6678 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6679 @code{nil} or a @var{number}.
6681 @item wl-highlight-folder-path-face
6682 The face for the path to the currently selected folder in the folder
6685 @item wl-highlight-logo-face
6686 The face for logo in the demo.
6688 @item wl-highlight-demo-face
6689 The face for strings (for example, a version number) in the demo.
6693 @node Biff, Advanced Settings, Highlights, Customization
6694 @section Notify Mail arrival
6697 Following setting is to notify mail arrival of @samp{%inbox}
6698 by the indicator on the modeline
6701 (setq wl-biff-check-folder-list '("%inbox"))
6704 @subsection Customizable Variables
6706 @item wl-biff-check-folder-list
6707 @vindex wl-biff-check-folder-list
6708 The initial setting is @code{nil}.
6709 This is the list of folders to check mail arrival.
6710 If @code{nil}, wl doesn't check mail arrival.
6712 @item wl-biff-check-interval
6713 @vindex wl-biff-check-interval
6714 The initial setting is 40 (in seconds).
6715 Check mail arrival in this period.
6717 @item wl-biff-notify-hook
6718 @vindex wl-biff-notify-hook
6719 This hook is run at the arrival of new mail.
6720 To beep with mail arrival(initial setting), set as follows.
6722 (setq wl-biff-notify-hook '(ding))
6724 For silence, set to @code{nil}.
6728 @node Advanced Settings, Customizable Variables, Biff, Customization
6729 @section Advanced Settings
6732 * Draft for Reply:: Draft for Reply
6733 * Thread Format:: Appearance of Thread
6734 * User-Agent Field:: @samp{User-Agent:} Header Field
6738 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6739 @subsection Draft for Replay
6740 @vindex wl-draft-reply-with-argument-list
6741 @vindex wl-draft-reply-without-argument-list
6742 @vindex wl-draft-reply-myself-with-argument-list
6743 @vindex wl-draft-reply-myself-without-argument-list
6745 If you want, when you replying to articles in mailing lists, the address
6746 in Reply-To field of the original message to be prepared to To field of
6747 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6752 (setq wl-draft-reply-without-argument-list
6753 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6754 ("Followup-To" . (nil nil ("Followup-To")))
6755 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6756 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6761 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6762 in the original message, @samp{Reply-To:} field in the original is
6763 copied to @samp{To:} field.)
6765 Moreover, the behavior of @kbd{a} with prefix argument can
6766 be directed by @code{wl-draft-reply-with-argument-list} as well.
6768 Note: To set the behavior when you reply to the message written by yourself, use
6769 @code{wl-draft-reply-myself-without-argument-list} and
6770 @code{wl-draft-reply-myself-with-argument-list}
6773 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6774 @subsection Appearance of Threads
6778 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6779 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6780 391 09/18(Fri)19:24 +-[ Murata-san ]
6781 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6782 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6783 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6784 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6785 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6786 412 09/22(Tue)09:28 | +-[ Teranishi ]
6787 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6788 416 09/22(Tue)12:38 | +-[ Teranishi ]
6789 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6790 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6794 Settings to make appearance of threads like shown above:
6798 (setq wl-thread-indent-level 2)
6799 (setq wl-thread-have-younger-brother-str "+")
6800 (setq wl-thread-youngest-child-str "+")
6801 (setq wl-thread-vertical-str "|")
6802 (setq wl-thread-horizontal-str "-")
6803 (setq wl-thread-space-str " ")
6807 If you do not want to see branches, do the following:
6811 (setq wl-thread-indent-level 2)
6812 (setq wl-thread-have-younger-brother-str " ")
6813 (setq wl-thread-youngest-child-str " ")
6814 (setq wl-thread-vertical-str " ")
6815 (setq wl-thread-horizontal-str " ")
6816 (setq wl-thread-space-str " ")
6821 @node User-Agent Field, , Thread Format, Advanced Settings
6822 @subsection User-Agent Field
6826 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6827 @samp{User-Agent:} fields, define a function that generate appropriate
6828 strings as you like, and set it to variable
6829 @code{wl-generate-mailer-string-function}.
6831 If you do not want verbose @samp{User-Agent:} field, do the following:
6835 (setq wl-generate-mailer-string-function
6838 (concat "User-Agent: "
6839 (wl-generate-user-agent-string-1 nil)))))
6843 The following is a example:
6847 (setq mime-edit-insert-user-agent-field nil)
6848 (setq wl-generate-mailer-string-function
6851 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6856 @node Customizable Variables, Hooks, Advanced Settings, Customization
6857 @section Customizable Variables
6859 Customizable variables that have not been described yet:
6862 @item wl-default-folder
6863 @vindex wl-default-folder
6864 The initial setting is @samp{%inbox}. This is the default value for moving to
6865 a folder and the like.
6867 @item wl-draft-folder
6868 @vindex wl-draft-folder
6869 The initial setting is @samp{+draft}. It is the folder to which drafts are
6870 saved. It must be a localdir folder.
6872 @item wl-trash-folder
6873 @vindex wl-trash-folder
6874 The initial setting is @samp{+trash}. It is the wastebasket folder.
6875 If you changed this variable, you had better restart Wanderlust.
6877 @item wl-interactive-exit
6878 @vindex wl-interactive-exit
6879 The initial setting is @code{t}.
6880 If non-nil, you are asked for confirmation when Wanderlust terminates.
6882 @item wl-interactive-send
6883 @vindex wl-interactive-send
6884 The initial setting is @code{t}.
6885 If non-nil, you are asked for confirmation when mail is sent.
6887 @item wl-folder-sync-range-alist
6888 @vindex wl-folder-sync-range-alist
6889 The initial setting is the alist shown below:
6894 ("^\\+draft$\\|^\\+queue$" . "all"))
6899 This is an associative list of regular expressions of folder names and
6900 update range of the summary. Update range is one of the @samp{all},
6901 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6902 @samp{last}. If a folder do not match, @samp{update} is used.
6905 @vindex wl-ask-range
6906 The initial setting is @code{t}.
6907 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6908 for updating the summary when you changed folders.
6910 @item wl-mime-charset
6911 @vindex wl-mime-charset
6912 The initial setting is @code{x-ctext}.
6913 This is the MIME charset for messages that are not MIME (e.g. without
6914 @samp{Content-Type:}). This value also used as default charset for
6915 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6916 this value as @code{iso-2022-jp}.)
6918 @item wl-highlight-folder-with-icon
6919 @vindex wl-highlight-folder-with-icon
6920 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6921 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6923 @item wl-strict-diff-folders
6924 @vindex wl-strict-diff-folders
6925 This is a list of regular expressions of folders.
6926 Unread messages are checked, for example when you press @kbd{s} in
6927 the folder mode, usually in a brief way (rapidly processed but not
6929 The folders matching this variable are seriously checked.
6930 You may want to set this variable so as to match conditional filter
6931 folders for IMAP4 folders.
6932 The initial setting is @code{nil}.
6934 @item wl-folder-use-server-diff
6935 @vindex wl-folder-use-server-diff
6936 When unread messages are checked, for example when you press @kbd{s} in
6937 the folder mode, usually (the number of messages on the server) @minus{}
6938 (the number of local messages) will be the number of unread messages.
6939 However, if this variable is non-nil, the number of unread messages on
6940 the server is checked. This affects IMAP4 folders only, but IMAP4
6941 folders in mail boxes matching
6942 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6943 the number of unread messages on the server, even if they matches this
6944 variable. The initial setting is @code{t}.
6946 @item wl-auto-check-folder-name
6947 @vindex wl-auto-check-folder-name
6948 The initial setting is @code{nil}.
6949 If non-nil, the folder with the name of the value is checked for unread
6950 messages at the start.
6951 If it is @code{none}, no folders are checked.
6952 If it is a list, all folders in the list are checked at the start.
6954 @item wl-auto-uncheck-folder-list
6955 @vindex wl-auto-uncheck-folder-list
6956 The initial setting is the list shown below:
6965 Folders with the name matching this variable are not checked for unread
6966 messages at the start, even if they are included in the groups in
6967 @code{wl-auto-check-folder-name}.
6969 @item wl-auto-check-folder-list
6970 @vindex wl-auto-check-folder-list
6971 The initial setting is @code{nil}.
6972 Folders with the name matching this variable are always checked for
6973 unread messages at the start, if they are included in the groups in
6974 @code{wl-auto-check-folder-name}.
6975 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6977 @item wl-no-save-folder-list
6978 @vindex wl-no-save-folder-list
6979 The initial setting is the list shown below:
6988 This is a list of regular expressions of folders not to be saved.
6990 @item wl-save-folder-list
6991 @vindex wl-save-folder-list
6992 The initial setting is @code{nil}.
6993 This is a list of regular expressions of folders to be saved.
6994 This takes precedence over @code{wl-no-save-folder-list}.
6996 @item wl-folder-mime-charset-alist
6997 @vindex wl-folder-mime-charset-alist
6998 The initial setting is the alist shown below:
7002 (("^-alt\\.chinese" . big5)
7003 ("^-relcom\\." . koi8-r)
7005 ("^-han\\." . euc-kr))
7010 This is an associative list of regular expressions of folder names and
7012 If a folder do not match, @code{wl-mime-charset} is used.
7014 @item wl-folder-init-load-access-folders
7015 @vindex wl-folder-init-load-access-folders
7016 The initial setting is @code{nil}.
7017 This is a list of access groups to be loaded specifically at the start.
7018 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7020 @item wl-folder-init-no-load-access-folders
7021 @vindex wl-folder-init-no-load-access-folders
7022 The initial setting is @code{nil}.
7023 This is a list of access groups not to be loaded specifically at the
7025 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7027 @item wl-delete-folder-alist
7028 @vindex wl-delete-folder-alist
7029 The initial setting is the alist shown below:
7038 This list determines disposition of messages with delete marks.
7039 Each item in the list is a folder and destination; you can specify any
7040 one of the following in the place of destination:
7043 @code{remove} or @code{null} : deletes the messages instantly.
7044 string : moves the messages to the specific folder.
7045 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7048 @item wl-refile-policy-alist
7049 @vindex wl-refile-policy-alist
7050 The initial setting is the list shown below:
7060 This list determines whether messages with re-file marks are moved or
7061 copied. Each item in the list is a cons cell of a folder and
7062 @code{copy} or @code{move}.
7064 @item wl-x-face-file
7065 @vindex wl-x-face-file
7066 The initial setting is @file{~/.xface}.
7067 The name of the file that contains encoded X-Face strings.
7070 @item wl-demo-display-logo
7071 @vindex wl-demo-display-logo
7072 If non-nil, bitmap image is shown on the opening demo. If you set
7073 @code{xpm} or @code{xbm}, (if possible) display selected image type
7076 @item elmo-use-database
7077 @vindex elmo-use-database
7078 This is meaningful for XEmacs only. The initial setting depends on
7079 XEmacs (@code{t} for XEmacs with dbm).
7080 If non-nil, Message-ID is controlled by dbm.
7082 @item elmo-passwd-alist-file-name
7083 @vindex elmo-passwd-alist-file-name
7084 The initial setting is @file{passwd}.
7085 This is the name of the file in which passwords are saved.
7086 @code{elmo-passwd-alist-save} saves current passwords to the file.
7088 @item elmo-nntp-list-folders-use-cache
7089 @vindex elmo-nntp-list-folders-use-cache
7090 The initial setting is 600 (in seconds).
7091 This is period in seconds during which results of @samp{list} and
7092 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7095 @item elmo-nntp-max-number-precedes-list-active
7096 @vindex elmo-nntp-max-number-precedes-list-active
7097 The initial setting is @code{nil}.
7098 If non-nil, the number of article obtained by @samp{list active} in NNTP
7099 are used as the maximum article number of the folder.
7100 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7101 and if the number of read messages is not correct.
7103 @item elmo-nntp-default-use-listgroup
7104 @vindex elmo-nntp-default-use-listgroup
7105 The initial setting is @code{t}.
7106 If non-nil, @samp{listgroup} is used for checking the total number of
7107 articles. If it is @code{nil}, @samp{group} is used. In the latter
7108 case, the processing will be a little faster at the sacrifice of
7111 @item elmo-pop3-send-command-synchronously
7112 @vindex elmo-pop3-send-command-synchronously
7113 The initial setting is @code{nil}.
7114 If non-nil, POP3 commands are issued synchronously. Some implementation
7115 of POP3 server fails to get summary information without this setting.
7116 You may have to set this variable to @code{t}, if the process hangs
7117 while looking up POP3.
7119 @item elmo-dop-flush-confirm
7120 @vindex elmo-dop-flush-confirm
7121 The initial setting is @code{t}.
7122 If non-nil, you are asked for confirmation if accumulated off-line
7123 operations are executed.
7125 @item elmo-display-progress-threshold
7126 @vindex elmo-display-progress-threshold
7127 The initial setting is 20.
7128 Threshold for display of progress gauge. If number of renewal is more than
7129 this value, display progress gauge.
7133 @node Hooks, , Customizable Variables, Customization
7139 @node Mailing List, Addition, Customization, Top
7140 @chapter Wanderlust Mailing List
7145 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7148 Topics related to Wanderlust are discussed in the mailing list.
7149 The latest version is also announced there (in Japanese, sorry).
7151 A guide can be obtained automatically by sending mail to
7152 @t{wl-ctl@@lists.airs.net} with the body
7157 Please send bug reports or patches to the mailing list. You can post to
7158 the mailing list even though you are not a member of it.
7160 If you send a bug report, please attach Backtrace with it.
7161 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7164 I would like to express my thanks to the members of the mailing list for
7165 valuable advice and many pieces of code they contributed.
7168 @node Addition, Index, Mailing List, Top
7169 @chapter Additional Information
7171 @section Brief History
7174 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7175 3/10 Made a msgdb mechanism by elisp.
7176 3/26 IMAP and NNTP can be displayed in threads.
7177 4/13 Began to assemble thread display modules as elmo.
7178 5/01 Finished 0.1.0, initial version with many defects.
7179 6/12 I made a slip of the tongue and said I was writing elisp
7180 mailer supporting IMAP
7181 6/16 0.1.3 was announced at tm-ja, elisp ML.
7182 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7183 7/01 Support for mm-backend (0.3.0).
7184 8/25 multi folder added (0.5.0).
7185 8/28 filter folder added (0.5.1).
7186 9/10 You can open/close threads (0.6.0).
7187 9/11 fldmgr by Murata-san made editing folders easy.
7188 9/18 lha folders added by Okunishi-san (0.6.3).
7189 9/24 Display of branches of threads (0.6.5).
7190 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7191 10/28 Off-line operations (0.7.4).
7192 12/09 Becomes beta version.
7193 12/21 wl-expire by Murata-san.
7194 1999 2/03 auto-refile by Tsumura-san.
7195 4/28 wl-template by Murata-san.
7196 5/18 Released 1.0.0 stable.
7197 7/05 Scoring by Murata-san (2.1.0).
7198 9/26 New plugged system by Murata-san (2.2.2).
7199 12/20 Support Modified UTF7.
7200 2000 3/24 Released 1.1.0 stable.
7201 4/03 CVS development started.
7202 5/07 Thread restoration & Its speed up with Murata-san.
7203 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7204 7/11 killed message feature.
7205 7/18 Use UIDL in POP3.
7206 9/12 biff feature with Satata-san & Yamaoka-san.
7207 10/17 expire-hide by Okada-san.
7208 11/08 Released 2.4.0 stable.
7209 2001 7/04 Released 2.6.0 stable.
7210 8/21 wl-addrmgr by Kitamoto-san.
7211 12/27 Released 2.8.1 stable.
7214 See @file{ChangeLog} for details.
7218 According to a dictionary, Wanderlust has the meaning:
7222 n eager longing for or impulse towards travelling in distant lands
7223 [Ger, fr wandern to wander + lust desire, pleasure]
7227 but I had no profound intention. (if farfetched, IMAP @result{} you can
7228 read mail anywhere @result{} desire to wander ?)
7230 Elmo is the abbreviation of @samp{Elisp Library for Message
7231 Orchestration}. At first I meant the red puppet in the Sesame Street,
7232 but you may associate it with Wandering @result{} Drifting @result{}
7233 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7237 Each versions has code names (they are almost jokes).
7238 Currently they are picked up alphabetically from the top 40 hits of
7239 U.S. Billboard magazines in 1980s.
7241 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7244 @node Index, , Addition, Top
7248 * Concept Index:: Concept Index
7249 * Key Index:: Key Index
7250 * Variable Index:: Variable Index
7251 * Function Index:: Function Index
7254 @node Concept Index, Key Index, Index, Index
7255 @unnumberedsec Concept Index
7258 @node Key Index, Variable Index, Concept Index, Index
7259 @unnumberedsec Key Index
7262 @node Variable Index, Function Index, Key Index, Index
7263 @unnumberedsec Variable Index
7266 @node Function Index, , Variable Index, Index
7267 @unnumberedsec Function Index