1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
25 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
27 This edition is for Wanderlust version @value{VERSION}.
29 Permission is granted to make and distribute verbatim copies of this
30 manual provided the copyright notice and this permission notice are
31 preserved on all copies.
34 Permission is granted to process this file through TeX and print the
35 results, provided the printed document carries copying permission notice
36 identical to this one except for the removal of this paragraph (this
37 paragraph not being relevant to the printed manual).
40 Permission is granted to copy and distribute modified versions of this
41 manual under the conditions for verbatim copying, provided that the
42 entire resulting derived work is distributed under the terms of a
43 permission notice identical to this one.
45 Permission is granted to copy and distribute translations of this manual
46 into another language, under the above conditions for modified versions.
52 @title Wanderlust User's Manual
53 @subtitle Yet another message interface on Emacsen
54 @subtitle for Wanderlust version @value{VERSION}
55 @author Yuuichi Teranishi
56 @author Fujikazu Okunishi
57 @author Masahiro Murata
59 @author Kaoru Takahashi
61 @author Masayuki Osada
62 @author Katsumi Yamaoka
64 @author Yoichi Nakayama
67 @vskip 0pt plus 1filll
68 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
69 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
70 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
71 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
73 This manual is for Wanderlust version @value{VERSION}.
75 Permission is granted to make and distribute verbatim copies of this
76 manual provided the copyright notice and this permission notice are
77 preserved on all copies.
79 Permission is granted to copy and distribute modified versions of this
80 manual under the conditions for verbatim copying, provided that the
81 entire resulting derived work is distributed under the terms of a
82 permission notice identical to this one.
84 Permission is granted to copy and distribute translations of this manual
85 into another language, under the above conditions for modified versions.
91 @node Top, Introduction, (dir), (dir)
92 @top Wanderlust User's Manual
107 This manual is for Wanderlust @value{VERSION}.
112 * Introduction:: Read this first
113 * Start Me Up:: Invoking Wanderlust
114 * Folders:: How to specify folders
115 * Folder:: Selecting and editing folders
116 * Summary:: Reading and refiling messages
117 * Message:: Saving and playing MIME multipart entities
118 * Draft:: Draft buffer, sending mail and news
119 * Disconnected Operations:: Off-Line management
120 * Expire and Archive:: Automatic expiration and archiving of messages
121 * Scoring:: Score of the messages
122 * Address Book:: Management of Address Book
123 * Customization:: Customizing Wanderlust
124 * Mailing List:: Wanderlust mailing list
125 * Addition:: Additional Information
130 @node Introduction, Start Me Up, Top, Top
131 @chapter Introduction of Wanderlust
134 Wanderlust is an mail/news management system on Emacsen.
135 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
137 The main features of Wanderlust:
140 @item Pure elisp implementation.
141 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
142 @item Unified access method to messages based on Mew-like Folder Specification.
143 @item Mew-like Key-bind and mark handling.
144 @item Manages unread messages.
145 @item Interactive thread display.
146 @item Folder Mode shows the list of subscribed folders.
147 @item Message Cache, Disconnected Operation (Read Only).
148 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
149 @item MIME compliant (by SEMI).
150 @item Transmission of news and mail are unified by Message transmitting draft.
151 @item Graphical list of folders (XEmacs and Emacs 21).
152 @item View a part of message without retrieving the whole message (IMAP4).
153 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
154 @item Virtual Folders.
155 @item Supports compressed folder using common archiving utilities.
156 @item Old articles in folders are automatically removed/archived (Expiration).
157 @item Automatic re-file.
158 @item Template function makes it convenient to send fixed form messages.
164 Wanderlust is supposed to run on following Emacsen:
167 @item Mule 2.3 based on Emacs 19.34
168 @item Emacs 20.2 or later
169 @item XEmacs 20.4 or later
170 @item Meadow 1.00 or later
171 @item NTEmacs 20.4 or later
175 IMAP4 connectivity with following imapd are confirmed to work with
179 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
180 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
181 @item Courier-IMAP 1.3.2 or later
182 @item AIR MAIL (AIRC imapd release 2.00)
184 @item Microsoft Exchange Server 5.5
185 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
188 LDAP connectivity with following LDAPd are confirmed to work with
192 @item OpenLDAP 2.0.6 or later
196 @node Start Me Up, Folders, Introduction, Top
197 @chapter Start up Wanderlust
200 The necessary procedure for starting Wanderlust is explained in steps
203 (Of course, you need a mail/news readable environment in advance)
206 * MIME Modules:: Installing the MIME modules
207 * Download:: Download and extract the packages
208 * Install:: Byte-compile and install
209 * Minimal Settings:: @file{.emacs} setup
210 * Folder Definition:: Folder definition
211 * Start Wanderlust:: Starting Wanderlust
215 @node MIME Modules, Download, Start Me Up, Start Me Up
216 @section Installing MIME modules
222 SEMI must be installed to make Wanderlust work correctly.
224 SEMI can be downloaded from these sites:
228 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
232 You need packages named APEL and FLIM to use SEMI.
233 You can download APEL and FLIM from following URLs:
237 APEL: ftp://ftp.m17n.org/pub/mule/apel/
238 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
242 You have to install APEL, FLIM and SEMI in this order. Generally,
243 @samp{make install} will do the job. (In XEmacs 21, @samp{make
246 Refer to the documents of each package for detailed installation
247 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
248 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
252 Recommended combination of APEL, FLIM and SEMI are following:
255 @item APEL 10.3, FLIM 1.14.3 and SEMI 1.14.3
258 You can also use many other FLIM/SEMI variants. Combination of the
259 latest versions should work. For example, the following combination are
263 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
264 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
267 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
270 @node Download, Install, MIME Modules, Start Me Up
271 @section Download and Extract the Package
274 You can download Wanderlust package from following sites:
278 ftp://ftp.gohome.org/wl/
281 Mirrored ftp/http sites:
285 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
286 http://www.jpl.org/elips/wl/
287 http://www.ring.gr.jp/archives/text/elisp/wl/
288 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
289 ftp://opaopa.org/pub/mirror/elisp/wl/
290 @c ftp://roguelife.org/pub/tsumura/wl/
294 Extract the obtained package to your working directory:
299 % tar zxvf wl-@var{version}.tar.gz
300 % cd wl-@var{version}
304 @subsection To use SSL (Secure Socket Layer)
309 SSL (Secure Socket Layer) can be used for
310 SMTP, IMAP, NNTP and POP connections in Wanderlust.
312 There are two ways to use SSL. One is to start SSL negotiation just
313 after the connection establishment (generic way). The other one is to
314 start SSL negotiation by invoking STARTTLS command in the each session.
316 To use the formal SSL (generic SSL), you must set @env{PATH} to the
317 directory that OpenSSL commands are installed.
319 To use the latter SSL(STARTTLS), you must install starttls package in
321 You can download starttls package from the following site.
324 ftp://opaopa.org/pub/elisp/
327 @node Install, Minimal Settings, Download, Start Me Up
328 @section Byte-compile and install
335 @subsection Installation
337 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
338 Set the Emacs's command name to @code{EMACS}.
339 Set package installation directory to @code{LISPDIR}.
340 Then, please execute following commands.
349 Destination directory is auto-probed if you leave @code{LISPDIR}
350 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
352 If you are using an Emacs variant which does not merge specified directory
353 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
354 then you will see the error message:
357 Cannot open load file: mime-setup
361 In this case, either add destination directories of custom, APEL, FLIM
362 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
363 @code{load-path} in @file{WL-CFG} in extracted directory.
365 If you want to use BBDB, then the necessary modules are byte-compiled
366 and installed when BBDB directory is added to @code{load-path}.
369 @subsection @file{WL-CFG}
371 Contents of the file @file{WL-CFG} is loaded under installation if a file
372 with that name exists in extracted directory. You can use @file{WL-CFG} to
373 configure @code{load-path} to extra packages such as SEMI if needed.
375 If you want to specify the install directory of Wanderlust related
376 files, then set following variables in @file{WL-CFG}
380 A directory to install WL modules.
381 This directory is relative directory from @code{LISPDIR}.
382 WL modules include @file{wl*.el}, @file{wl*.elc} files.
383 @c Modules under the directory @file{util/} are also installed if
384 @c it detected as necessary.
387 A directory to install ELMO modules.
388 This directory is relative directory from @code{LISPDIR}.
389 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
390 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
394 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
396 If you want to install ELMO related files under a sub-directory
397 such as "elmo" then add following to @file{WL-CFG}:
400 (setq ELMO_PREFIX "elmo")
403 @subsection Install as a XEmacs package
404 @cindex XEmacs package
405 @cindex XEmacs package install
406 @cindex Package, XEmacs
407 @cindex Package install, XEmacs
408 @c @cindex install-package
410 It is possible to install Wanderlust as one of packages of XEmacs (21.0
411 or later). Configuration for autoload and icon-path in local
412 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
415 Follow the next example to install Wanderlust as an XEmacs package.
421 % make install-package
425 package directory is auto-probed, if SEMI is installed.
426 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
428 @subsection Run in place
430 If wl and elmo directories are defined in @code{load-path}, then
431 byte-compilation and installation are not necessary to start Wanderlust.
432 For example, if package is extracted in @file{~/work}, Wanderlust can be
433 invoked with following setting in @file{~/.emacs}.
437 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
438 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
444 Manual is described in Info format. Please do following.
453 If you install Wanderlust as a XEmacs package, Info file is already
454 installed too, so there are no need of these commands.
456 Manual directory is automatically detected. Of course, it can be
457 configured by @code{INFODIR} in @file{Makefile}.
459 You can read manual at the following URL:
462 http://www.gohome.org/wl/doc/wl_toc.html
465 @node Minimal Settings, Folder Definition, Install, Start Me Up
466 @section Set up .emacs
467 @cindex Minimal Settings
469 @cindex Configuration
473 The Wanderlust package contains two module groups.
476 @item ELMO (elmo-*.el)
477 These modules show everything as folders. This is the back-end for WL.
479 These modules controls the behavior of main body of Wanderlust.
480 They are also the front-end for ELMO.
483 You can customize the behavior of Wanderlust by changing the value
484 of environmental variables which begins with @code{elmo-} and @code{wl-}.
486 The minimal requirement for settings is as the following.
490 ;; @r{The setting to use SEMI}
491 (require 'mime-setup)
493 ;; @r{autoload configuration}
494 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
495 (autoload 'wl "wl" "Wanderlust" t)
496 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
497 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
499 ;; @r{Directory where icons are placed.}
500 ;; @r{Default: the peculiar value to the running version of Emacs.}
501 ;; @r{(This is not required if the default value has been set properly)}
502 (setq wl-icon-directory "~/work/wl/etc")
504 ;; @r{SMTP server for mail posting. Default: @code{nil}}
505 (setq wl-smtp-posting-server "your.smtp.example.com")
506 ;; @r{NNTP server for news posting. Default: @code{nil}}
507 (setq wl-nntp-posting-server "your.nntp.example.com")
511 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
512 file exists). So it is convenient to gather Wanderlust specific settings
513 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
514 because you can't write them in @file{.emacs}
515 (if you write it to @file{.emacs}, you'll get an error).
518 All above described settings except @samp{(require 'mime-setup)} and autoload
519 configuration can be written in
522 @subsection @code{mail-user-agent}
523 @cindex Default Mailer
524 @cindex Mailer, Default
525 @vindex mail-user-agent
528 If you write following setting in you @file{.emacs}, you can
529 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
530 This means it enables you to run Wanderlust as a default mail composer
533 It is effective only when your Emacs can define @code{mail-user-agent}.
534 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
538 (autoload 'wl-user-agent-compose "wl-draft" nil t)
539 (if (boundp 'mail-user-agent)
540 (setq mail-user-agent 'wl-user-agent))
541 (if (fboundp 'define-mail-user-agent)
542 (define-mail-user-agent
544 'wl-user-agent-compose
553 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
554 @section Folder Definition
555 @cindex Folder Definition
558 You can skip this section because it is possible to add/edit the
559 subscribe folders from the buffer for list of folders.
560 @xref{Folder Manager}.
562 Define the folders you want to subscribe in file @file{~/.folders}. The
563 contents written in @file{~/.folders} become the folders which you
564 subscribe to as it is.
566 Format for @file{~/.folders} is very simple. Here is an example:
571 # @r{Lines begin with @samp{#} are comment.}
572 # @r{Empty lines are ignored}
574 # @var{folder name} "@var{folder nickname}"
575 # @r{(nicknames are not necessary)}
580 %#mh/Backup@@my.imap.example.com "Sent"
583 %#mh/spool/wl "Wanderlust ML"
584 %#mh/spool/elips "ELIPS ML"
585 %#mh/spool/apel-ja "APEL Japanese ML"
586 %#mh/spool/xemacs-beta "XEmacs beta"
587 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
588 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
591 # @r{If folder name ends with @samp{/}, that means an `access group',}
592 # @r{all subfolders automatically included in one folder group.}
594 %#mh/expire@@localhost /
595 # @r{All MH folders are included in one folder group.}
600 Each line contains one folder you want to read. The definition of
601 folders will be explained in detail in the next section.
603 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
604 become one folder group. One folder group is treated as a directory
605 which can be opened and closed in folder mode. It is convenient for
606 collecting some folders and putting them in order.
608 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
609 line and you have to write it that way (It is because the parser sucks).
611 There are two types of groups. One is like @samp{Emacsen} from above
612 example which the user chooses his favorite folders as a group.
614 The other one is @dfn{access group} like @samp{+ /} from above example.
615 It makes all the sub-folders in a folder to a group. (It differs from
616 the type of the folder. For example, @samp{+} followed by @samp{/}
617 makes entire MH sub-directories to one group)
619 This behavior is better understood if you try it and confirmed the
620 function first. You can write and try a small folder definition, so you
621 will know the idea of the folder function before writing the real one.
623 @node Start Wanderlust, , Folder Definition, Start Me Up
624 @section Start Wanderlust
625 @cindex Start Wanderlust
627 If installation and configuration worked well, you can invoke Wanderlust by
628 typing following command in Emacs.
635 After initialization, Folder Mode which shows the list of folders will appear.
636 That means the folders you defined in the @file{~/.folders} are listed
637 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
638 can skip folder checking.
640 Basically, you will handle messages in wanderlust while you come and go
641 from/to each of the following buffers.
645 You can see the list of folders. You can select some folder and go into the summary
646 of it. You can subscribe new folder or edit subscription list.
648 You can see the list of messages in the folder. You can select message and view its
649 contents, and reply to some message. You can delete ones or move ones to another
652 You can see the contents of the message. You can save part to disk or open in external
655 You can edit message.
658 Details of each ones are explained later.
661 @node Folders, Folder, Start Me Up, Top
662 @chapter Wanderlust's folders
665 This chapter describes the folder types which Wanderlust is able to handle.
667 Wanderlust uses ELMO as it's interface, so every folder types supported
668 by ELMO is usable in Wanderlust.
670 As of version @value{VERSION}, 11 types of folders are predefined. These are
671 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
672 Pipe and Internal folder types.
675 * IMAP Folder:: @samp{%} -- IMAP folder
676 * NNTP Folder:: @samp{-} -- NNTP folder
677 * MH Folder:: @samp{+} -- MH folder
678 * Maildir Folder:: @samp{.} -- Maildir folder
679 * News Spool Folder:: @samp{=} -- News spool folder
680 * Archive Folder:: @samp{$} -- Archive folder
681 * POP Folder:: @samp{&} -- POP folder
682 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
683 * Namazu Folder:: @samp{[} -- Namazu Folder
684 * Multi Folder:: @samp{*} -- Multi folder
685 * Filter Folder:: @samp{/} -- Filter folder
686 * Pipe Folder:: @samp{|} -- Pipe folder
687 * Internal Folder:: @samp{'} -- Internal folder
691 @node IMAP Folder, NNTP Folder, Folders, Folders
699 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
705 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
709 You can specify @code{login} (encoded password transmission),
710 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
711 authentication) or @code{clear} (or @code{nil}, plain password
712 transmission) as @var{authenticate-type}.
717 @var{username} -> The value of @code{elmo-imap4-default-user}.
718 Initial setting is @env{USER} environment variable or
719 @env{LOGNAME} environment variable or return value of
720 @code{(user-login-name)}.
721 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
722 Initial setting is "auth".
723 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
724 Initial setting is "localhost".
725 @var{port} -> The value of @code{elmo-imap4-default-port}.
726 Initial setting is 143.
729 You can omit the @var{hostname} from folder names if you set
730 @code{elmo-imap4-default-server} as your main IMAP server.
731 For example, you can specify a folder as @samp{foo%imap@@gateway} even
732 if you have to go through a firewall.
736 ;; @r{Example: imap4.exaple.org as main IMAP server}
737 (setq elmo-imap4-default-server "imap4.example.org")
741 SSL (Secure Socket Layer) connection will be used if a folder name ends
742 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
743 is @code{ssl}, SSL will be the default connection. If a folder name
744 ends with @samp{!!}, STARTTLS connection will be established. If the
745 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
746 STARTTLS will be the default connection.
750 ;; @r{Example: Use SSL connection}
751 (setq elmo-imap4-default-stream-type 'ssl)
755 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
756 authentication method, the password is sent in encoded form. But, if
757 your server is unable to receive an encoded password, authentication
758 will fall back to @code{clear} (that is, sending password in raw format)
759 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
760 authentication will fall back to @code{clear} without confirmation
761 (default value is @code{nil}).
765 ;; @r{Example: password in raw format}
766 (setq elmo-imap4-default-authenticate-type 'clear)
774 %inbox -> IMAP mailbox "inbox"
775 %#mh/inbox -> IMAP mailbox "#mh/inbox"
777 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
778 %inbox:hoge/clear@@server1
779 -> server1's IMAP mailbox "inbox"
780 of user "hoge", with plain password authentication
785 @subsection International mailbox names (Modified UTF7)
786 @cindex Modified UTF7
793 You can use international mailbox names in @var{mailbox} part, if you
794 are using Emacs which can treat unicode and
795 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
796 value is @code{nil}).
798 Currently, following Emacsen can treat unicode.
801 @item Emacs 20.3 or later + Mule-UCS
803 If you installed Mule-UCS package, Emacs can treat unicode.
804 You can obtain Mule-UCS package from following URL.
807 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
810 @item XEmacs 21.2.13 or later + ucs-conv package
812 By default, XEmacs 21 cannot treat unicodes, but if you installed
813 ucs-conv package, it can.
814 You can obtain ucs-conv package from following anonymous CVS.
818 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
819 Password: @var{NULL} (Just enter return key)
820 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
824 You also need utf7 conversion programs, @command{u7tou8} and
825 @command{u8tou7} to use international mailbox name in the current
826 XEmacs. These programs are included in the UTF7 package which can be
827 obtained from following URL.
830 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
835 @node NNTP Folder, MH Folder, IMAP Folder, Folders
846 A folder to access USENET news via NNTP protocol (RFC 977).
847 One newsgroup is treated as a folder.
853 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
859 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
860 Initial setting is @samp{localhost}.
861 @var{username} -> The value of @code{elmo-nntp-default-user}.
862 Initial setting is @code{nil}.
863 @var{port} -> The value of @code{elmo-nntp-default-port}.
864 Initial setting is 119.
867 AUTHINFO is used as authentication method if the @var{username} is
868 non-nil. SSL will be default method if
869 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
870 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
871 STARTTLS connection will be established. if the value of
872 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
873 be the default connection.
879 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
880 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
885 @node MH Folder, Maildir Folder, NNTP Folder, Folders
892 A folder to access MH format mail (1 file is 1 mail).
897 @samp{+} @var{directory-name}
900 Normally, @var{directory-name} is an relative path to the variable
901 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
902 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
903 (this is also true for drive-letters).
905 Message number is used for the name of the message file.
911 +inbox -> @file{~/Mail/inbox}
912 +from/teranisi -> @file{~/Mail/from/teranisi}
913 +~/test -> @file{~/test}
918 @node Maildir Folder, News Spool Folder, MH Folder, Folders
919 @section Maildir Folder
921 @cindex Maildir Folder
925 A folder to access Maildir format (1 file is 1 mail).
930 @samp{.} [@var{directory-name}]
933 Normally, @var{directory-name} is a relative path to the variable
934 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
935 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
936 (this is also true for drive-letters).
938 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
939 Messages are contained in the @file{cur} directory. All message files
940 in the @file{new} directory are moved to @file{cur} directory when you
941 access the folder. All message files contained in the @file{tmp}
942 directory and not accessed for 36 hours are deleted.
944 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
950 . -> @file{~/Maildir}
951 .inbox -> @file{~/Maildir/inbox}
952 .from/teranisi -> @file{~/Maildir/from/teranisi}
953 .~/test -> @file{~/test}
958 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
959 @section News Spool Folder
961 @cindex News spool Folder
964 This folder handles locally saved news articles which are proposed by
965 Mew/IM. You can also read articles directly from a spool-file which is
966 retrieved by an utility like @command{gnspool}.
971 @samp{=} @var{directory-name}
974 @var{directory-name} is a sub-directory to the directory defined by
975 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
976 You can use @samp{.} as directory delimiter as well as @samp{/}.
982 =fj/os/os2 -> @file{~/News/fj/os/os2}
983 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
988 @node Archive Folder, POP Folder, News Spool Folder, Folders
989 @section Archive Folder
991 @cindex Archive Folder
994 This method can handle archive files, which are compressed by utilities
995 such as Info-ZIP or LHA, as one folder.
1001 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1005 @var{path-name} is the relative path from
1006 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1007 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1008 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1009 also permitted under the environment of ange-ftp, efs.
1011 The actual file name of the archive folder is
1012 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1013 under the @var{path-name}. If a file named @var{path-name} exists, it is
1014 treated as folder. The suffix is automatically decided for
1015 @var{archiver-type}.
1017 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1018 (Initial setting is @code{zip}) is referred.
1020 @var{prefix} specifies the internal directory structure of the archive.
1021 For example, if the ML server is fml, @file{msend.tar.gz} has a
1022 structure like @file{spool/1}, so you have to specify @samp{spool} as
1029 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1030 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1031 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1032 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1037 * Archiver:: Supported Archivers
1038 * Archive Tips:: TIPS
1039 * Archive Vars:: Customization
1043 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1044 @subsection Supported Archives
1054 By default, following archives are supported.
1058 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1059 GNU TAR('tgz, 'tar) ;; read-only
1063 If your archiver can include multiple files in one archive, you have a
1064 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1065 of the candidate. TAR is supported read-only because it cannot delete
1066 file in the archive (@code{mv})).
1068 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1069 archiver of Wanderlust because they cannot include multiple
1070 files. Archivers that cannot extract files to standard output are also
1073 @subsection OS specific information about archiver.
1075 Behaviors of the following archivers are confirmed by further experiences.
1076 (@samp{*} mark means recommended archiver).
1079 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1080 LHA OS/2 version Rel.2.06b Feb 18, 1998
1081 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1082 *Zip 2.2 (November 3rd 1997).
1083 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1084 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1085 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1087 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1088 LHa for UNIX V 1.14c
1089 UnZip 5.32 of 3 November 1997
1090 Zip 2.2 (November 3rd 1997)
1091 GNU tar 1.12 (1.11.x is no good)
1092 gzip 1.2.4 (18 Aug 93)
1094 [Win32] Win.98/Meadow
1098 GNU tar 1.11.8 + 1.5(WIN32)
1105 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1106 Hiramatsu version of LHA is only supported.
1107 In Win32, LHa32 is only supported (DOS version is no good).
1109 * Caution about GNU tar
1111 You have to take care about GNU tar's version because many version has
1112 problem on deleting file from archive.
1114 Please test @option{--delete} @option{-f} options work. Otherwise, your
1115 archive will be destroyed. No problem is reported on above versions of
1119 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1121 @cindex Archive Tips
1123 For comfortable migration, usage of @code{wl-summary-archive}
1124 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1125 archive folders created by expiration, you must set non-nil value to
1126 @code{elmo-archive-treat-file}.
1128 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1129 in processing speed. For comfortable use, Emacs20 is recommended.
1130 (If re-search's performance is the problem, 19.3x or later may be okay.)
1132 If many files are included in one archive,
1133 it takes long time to access the archive folder because
1134 archiver starting overhead is increased (especially LHA).
1135 150-200 messages in one archive is recommended.
1137 Of course, following is possible @t{:-)}
1138 (meanings of these variables are described later.)
1142 (setq wl-fcc "$backup")
1143 (setq wl-trash-folder "$trash;lha")
1147 @node Archive Vars, , Archive Tips, Archive Folder
1148 @subsection Variables About Archive Folder
1149 @cindex Archive variables
1152 @item elmo-archive-default-type
1153 @vindex elmo-archive-default-type
1154 The initial setting is @code{zip}.
1155 Set archiver type by symbol.
1157 @item elmo-archive-@var{type}-method-alist
1158 @vindex elmo-archive-TYPE-method-alist
1159 Define archiver @var{type}'s methods.
1160 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1161 Each element of the alist is following.
1165 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1166 (@var{action} . @var{function}) ;; function
1170 Currently available actions are following.
1174 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1175 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1182 actions enclosed with braces are optional (They are used for better
1185 @item elmo-archive-suffix-alist
1186 @vindex elmo-archive-suffix-alist
1187 An alist of archiver-type (symbol) and suffix.
1189 @item elmo-archive-file-regexp-alist
1190 @vindex elmo-archive-file-regexp-alist
1191 An alist of a regexp to get file number from list output of archiver
1192 and archiver-type (symbol).
1194 @item elmo-archive-method-list
1195 @vindex elmo-archive-method-list
1196 A list of elmo-archive-@var{type}-method-alist
1197 (@var{type} is a symbol of archiver-type).
1199 @item elmo-archive-lha-dos-compatible
1200 @vindex elmo-archive-lha-dos-compatible
1201 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1202 DOS (Mr. Yoshizaki original) compatible.
1204 @item elmo-archive-cmdstr-max-length
1205 @vindex elmo-archive-cmdstr-max-length
1206 The initial setting is 8000.
1208 Max length of command line argument for external archiver program.
1209 Emacs does not have a limit of command line byte length, but some OS
1210 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1211 this limit because it calls external archiver program directly (not
1212 called via shell). For example, you cannot delete messages if archiver
1213 program must receive larger bytes of arguments to delete. OS/2 have a
1214 command line argument limit of 8190 bytes, so we defined default as 8000
1217 However, you don't have an influence of command line argument limit
1218 if the archiver has `actions' to receive target file information from
1219 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1223 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1231 A folder to access e-mails via POP3 protocol (RFC 1939).
1237 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1242 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1243 as @var{authenticate-type}.
1245 You can specify @samp{uidl} (use UIDL command for message numbering) or
1246 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1250 @var{username} -> The value of @code{elmo-pop3-default-user}.
1251 Initial setting is @env{USER} environment variable or
1252 @env{LOGNAME} environment variable or return value of
1253 @code{(user-login-name)}.
1254 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1255 Initial setting is @samp{user}.
1256 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1257 If t, use UIDL for numbering. Initial setting is t.
1258 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1259 Initial setting is @samp{localhost}.
1260 @var{port} -> The value of @code{elmo-pop3-default-port}.
1261 Initial setting is 110.
1268 &hoge@@localhost -> access localhost as user @samp{hoge}.
1269 &hoge@@popserver:109 -> access the server "popserver" on port 109
1270 as user @samp{hoge}.
1274 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1275 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1276 @file{utils/sasl/lisp/} or Emacs/W3 package
1277 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1280 If the last character of the folder name is @samp{!}, Wanderlust
1281 connects to the POP server via SSL (Secure Socket Layer). If you set
1282 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1283 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1284 with @samp{!!}, STARTTLS connection will be established. if the value
1285 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1289 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1290 @section Shimbun Folder
1292 @cindex Shimbun Folder
1293 @cindex Folder, Shimbun
1298 A folder for watching "shimbun" (means "newspaper" in Japanese),
1299 news site and mailing list archives on WWW by using emacs-w3m
1300 (@uref{http://emacs-w3m.namazu.org/}).
1302 You should possess w3m and emacs-w3m to use this.
1308 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1312 Admissible values of @var{module-name} and @var{folder-name} are
1313 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1319 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1320 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1324 @subsection Variables About Shimbun Folder
1327 @item elmo-shimbun-update-overview-folder-list
1328 @vindex elmo-shimbun-update-overview-folder-list
1329 The initial setting is @code{nil}. You can specify a list of regular
1330 expressions of shimbun folder names. The overview of matched shimbun
1331 folder is updated when messages are fetched.
1332 You should @kbd{s rescan} after fetching to update summary.
1336 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1337 @section Namazu Folder
1339 @cindex Namazu Folder
1340 @cindex Folder, Namazu
1341 @cindex Folder, Text Search
1344 A folder to access messages found in namazu-index with some condition.
1345 It uses namazu (@uref{http://www.namazu.org/}) for search.
1351 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1355 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1361 [wanderlust] -> search messages matched with
1362 "wanderlust" from the default index
1363 [semi flim]~/Mail/semi -> search "semi flim" from the index
1364 in the directory "~/Mail/semi"
1370 @subsubsection Enter space to separate keywords
1372 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1374 @subsubsection Alias name for index
1376 You can define an alias name for index.
1381 (setq elmo-nmz-index-alias-alist
1382 '(("cache" . "~/.elmo/cache")
1383 ("docs" . "~/documents")))
1386 Above definition defines two index aliases.
1393 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1394 directory @file{~/.elmo/cache}.
1396 @subsubsection Multiple indices
1398 You can specify a list for @code{elmo-nmz-default-index-path} and
1399 @code{elmo-nmz-index-alias-alist}.
1400 When list is specified, all index contained in the list is used as the
1406 (setq elmo-nmz-index-alias-alist
1407 '(("all" . ("~/.elmo/cache" "~/documents"))
1408 ("cache" . "~/.elmo/cache")))
1411 Using above alias setting, you can specify
1417 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1418 directory @file{~/.elmo/cache} and @file{~/documents}.
1420 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1421 @section Multi Folder
1423 @cindex Multi Folder
1424 @cindex Folder, Multiple
1425 @cindex Folder, Marge
1427 A folder to access virtual folder which collects messages from
1434 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1438 After @samp{*} character, specify multiple folders you want to collect
1439 separated by @samp{,} like
1440 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1446 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1447 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1448 treated as one folder.
1450 *+inbox,-fj.rec.tv,%inbox
1451 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1456 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1457 @section Filter Folder
1459 @cindex Filter Folder
1460 @cindex Folder, Filtering
1461 @cindex Folder, Virtual
1462 @cindex Folder, Conditional
1464 A folder to access virtual folder which collects all messages that
1465 satisfy a condition.
1470 @samp{/} @var{condition} @samp{/} @var{target-folder}
1473 In the @var{condition} part, you can specify following.
1477 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1479 first: @var{number} messages are picked from top of folder.
1480 last: @var{number} messages are picked from bottom of folder.
1486 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1487 /first:20/%inbox -> First 20 messages from %inbox are picked.
1492 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1494 since: only messages arrived since @var{date} are picked.
1495 before: only messages arrived before @var{date} are picked.
1497 You can specify following as @var{date}.
1501 yesterday -> a day before today.
1502 lastweek -> same day of last week.
1503 lastmonth -> same day of last month.
1504 lastyear -> same day of last year.
1505 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1506 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1514 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1516 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1522 Field filter: @samp{@var{field}:@var{value}}
1524 All messages that have @var{field} and its value is @var{value} are picked.
1525 @var{field} and @var{value} are case insensitive.
1531 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1532 and its value includes "teranisi" string are picked.
1533 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1541 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1542 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1544 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1545 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1551 /from:teranisi&!to:teranisi/+inbox
1552 -> In +inbox, messages are picked if the message's
1553 From: field includes "teranisi" and
1554 To: field doesn't include "teranisi".
1556 /tocc:"Yuuichi Teranishi"/+inbox
1557 -> In +inbox, messages are picked if the
1558 message's To: field or Cc: field includes
1559 "Yuuichi Teranishi".
1561 /(from:yt|from:teranisi)&subject:report/+inbox
1562 -> In +inbox, messages are picked if the message's
1563 From: field includes "yt" or "teranisi", and
1564 Subject includes "report".
1570 Tip for string description:
1572 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1573 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1574 should be escaped with @samp{\} in it). You can enclose the string with
1575 @samp{"} even it does not contain these characters.
1581 *%inbox,/from:teranisi/%inbox@@server
1582 -> Messages in %inbox or
1583 message is in the %inbox@@server folder and it's From field
1584 includes "teranisi" are collected.
1586 /last:100//to:teranisi/*+inbox,%inbox
1587 -> Latest 100 messages which is in the +inbox or %inbox folder
1588 and To: field matches "teranisi".
1590 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1591 -> Pick messages which have From: field and it includes "hogehoge"
1592 from latest 20 messages in the %#mh/inbox@@localhost
1593 and To: or Cc: field includes "teranisi".
1596 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1597 @section Pipe Folder
1601 @cindex Download Message
1602 @cindex Incorporate Message
1604 In the pipe folder, messages are automatically transferred from the source
1605 folder to destination folder.
1610 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1613 When you access the pipe folder, messages are automatically transferred
1614 from @var{source-folder} to @var{destination-folder}.
1615 It is convenient if you want to download messages to local disk via POP.
1616 For example, if you specify following
1619 |&username@@popserver|+inbox
1623 and access it, messages are downloaded automatically from
1624 @samp{&username@@popserver} to @samp{+inbox}.
1626 On the other hand, if you put @samp{|:} instead of second @samp{|},
1627 then messages are copied to the destination folder (not deleted from
1628 source-folder). At the next time you access that folder, only new
1629 messages will be copied.
1632 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1635 If you want to copy messages from POP server and view them, specify the
1639 |&username@@popserver|:+inbox
1642 where messages will be kept on the server.
1648 |%inbox|%myinbox -> Download %inbox to %myinbox.
1649 |*&user@@popserver1,&user@@popserver2|+inbox
1650 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1651 |-gnu.emacs.sources|:+sources
1652 -> Copy messages from -gnu.emacs.sources to +sources.
1656 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1658 @node Internal Folder, , Pipe Folder, Folders
1659 @section Internal folder
1661 @cindex Internal Folder
1662 @cindex Folder, @samp{$} mark
1664 @c @cindex Folder, Null
1666 A folder to access internal messages of Wanderlust.
1678 A folder named @samp{'mark} is a special virtual folder which collects
1679 messages which have important mark @samp{$}.
1681 You can review important messages at once after you put important marks
1682 on the messages in the different folders.
1684 In this folder, if you delete message, important mark @samp{$} put on
1685 the message is removed. If you append messages to this folder, the
1686 message will have @samp{$} mark.
1688 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1689 folder. If you want IMAP folder's message remove from @samp{'mark}
1690 folder, remove important mark at IMAP Folder.)
1693 A folder named @samp{'sendlog} is a virtual folder which collects
1694 cached messages which are recoded on @file{~/.elmo/sendlog}.
1695 It might be useful when you forgot to add cc for yourself.
1696 To use this, you should set @code{wl-draft-use-cache} to non-nil
1697 so that sent messages are cached.
1700 You can access cached messages fetched via network by accessing
1701 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1702 the name of the subdirectories of the cache directory
1703 (@file{~/.elmo/cache}).
1706 @node Folder, Summary, Folders, Top
1707 @chapter Folder mode
1710 After you start Wanderlust, folder mode is appeared firstly.
1711 It contains folder list you subscribed.
1712 You can select and edit folders in this mode.
1715 * Selecting Folder:: Select folder you want to read
1716 * Folder Manager:: Editing folders
1720 @node Selecting Folder, Folder Manager, Folder, Folder
1721 @section Selecting Folder
1722 @cindex Selecting Folder
1724 @subsection Usage (TIPS)
1726 @subsubsection Check new, unread number
1728 Folder mode looks like this.
1729 (In XEmacs, it looks much nicer @t{;-)})
1733 [-]Desktop:14186/35580/67263
1738 [-]Emacsen:0/34/4837
1739 Wanderlust ML:0/0/558
1742 XEmacs Beta:0/29/255
1753 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1757 @kbd{s} key on the folder line updates these numbers.
1758 It changes its color if it has many new messages.
1760 The whole folder mode is a folder group named @samp{Desktop}.
1761 Folder group open/close by return key.
1762 A operation to a folder group is treated as operations on the
1764 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1765 six children folders update its unread number status.
1767 @subsubsection Select Folder
1769 To enter summary mode of the folder, type return (or space) key on
1771 If the variable @code{wl-stay-folder-window} has non-nil value,
1772 summary window appears on the right of the folder mode window.
1774 @subsection Key bindings
1776 Folder mode's key binding (related to selecting folders) is following.
1781 @kindex @key{SPC} (Folder)
1782 @kindex @key{RET} (Folder)
1783 @findex wl-folder-jump-to-current-entity
1784 Enter to the summary mode of the folder at the current cursor point.
1785 If the cursor is on the top of folder group line,
1786 the folder group is opened or closed.
1787 When the cursor is on the access group and this command is called
1788 with prefix argument, folder children list is updated to the newest one.
1789 (Children list is updated recursively if the access folder has hierarchical
1791 (@code{wl-folder-jump-to-current-entity})
1794 @kindex M-@key{RET} (Folder)
1795 @findex wl-folder-update-recursive-current-entity
1796 Folder children list of the access group at the current cursor point
1797 is updated to the newest one.
1798 (Children list is updated recursively if the access folder has hierarchical
1800 (@code{wl-folder-update-recursive-current-entity})
1805 Create a new draft message.
1810 @findex wl-folder-write-current-folder
1811 If the current cursor point is on the NNTP folder, create a new draft
1812 message which already has @samp{Newsgroups:} field. If the current
1813 cursor point is on the folder for mailing list (refile destination),
1814 create a new draft message which already has @samp{To:} field with
1815 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1817 (@code{wl-folder-write-current-folder})
1820 @kindex C-c C-o (Folder)
1821 @findex wl-jump-to-draft-buffer
1822 Move to the draft buffer if available. If multiple draft buffer exists,
1823 moved to one after another. If prefix argument is specified, load draft
1824 folder's message to the draft buffer and jump to it.
1825 (@code{wl-jump-to-draft-buffer})
1829 @findex wl-folder-check-current-entity
1830 Update new and unread number information of the folder at the current
1832 (@code{wl-folder-check-current-entity})
1836 @findex wl-folder-sync-current-entity
1837 Update summary information of the folder at the current cursor point.
1838 (@code{wl-folder-sync-current-entity})
1841 @kindex r s (Folder)
1842 @findex wl-folder-check-region
1843 Update new and unread number information of the folders in the currently
1845 (@code{wl-folder-check-region})
1848 @kindex r S (Folder)
1849 @findex wl-folder-sync-region
1850 Update summary information of the folders in the currently selected region.
1851 (@code{wl-folder-sync-region})
1855 @findex wl-status-update
1856 Sync up address book status with @file{~/.addresses}'s content.
1857 (@code{wl-status-update})
1861 @findex wl-folder-prev-unread
1862 Jump cursor to the folder which have unread messages on the upward from
1863 current cursor point.
1864 (@code{wl-folder-prev-unread})
1868 Jump cursor to the folder which have unread messages on the downward
1869 from current cursor point.
1870 (@code{wl-folder-next-unread})
1874 Move cursor to the folder on the previous line.
1875 (@code{wl-folder-prev-entity})
1879 Move cursor to the folder on the next line.
1880 (@code{wl-folder-next-entity})
1884 Jump to the folder specified by the user input.
1885 (@code{wl-folder-jump-folder})
1889 @findex wl-folder-prefetch-current-entity
1890 Prefetch new messages of the folder at the current cursor point by
1891 @code{wl-summary-incorporate}.
1892 If the cursor is on the folder group, it is executed recursively.
1893 (@code{wl-folder-prefetch-current-entity})
1897 @findex wl-folder-mark-as-read-all-current-entity
1898 Mark all unread messages of the folder at the current cursor point as read.
1899 If the cursor is on the folder group, it is executed recursively.
1900 (@code{wl-folder-mark-as-read-all-current-entity})
1904 @findex wl-folder-goto-first-unread-folder
1905 Enter summary mode of the first unread folder.
1906 (@code{wl-folder-goto-first-unread-folder})
1910 @findex wl-folder-empty-trash
1912 (@code{wl-folder-empty-trash})
1916 @findex wl-folder-flush-queue
1918 (@code{wl-folder-flush-queue})
1922 @findex wl-folder-virtual
1923 Move to the virtual folder with the condition specified.
1924 (@code{wl-folder-virtual})
1928 @findex wl-folder-open-all-unread-folder
1929 All unread folder is opened.
1930 (@code{wl-folder-open-all-unread-folder})
1934 @findex wl-folder-open-close
1935 Folder group is opened/closed.
1936 (@code{wl-thread-open-close})
1940 All folder group is opened.
1941 (@code{wl-folder-open-all})
1945 All folder group is closed.
1946 (@code{wl-folder-close-all})
1956 (@code{wl-folder-suspend})
1959 @kindex M-s (Folder)
1960 Save current folder status.
1964 @kindex M-t (Folder)
1965 Toggle Wanderlust's offline/online status.
1966 (@code{wl-toggle-plugged})
1969 @kindex C-t (Folder)
1970 Start Wanderlust's plug-status manager.
1971 (@code{wl-plugged-change})
1974 @subsection Customize variables
1977 @item wl-folders-file
1978 @vindex wl-folders-file
1979 The initial setting is @file{~/.folders}.
1980 Subscribed folders are described (saved) in this file.
1982 @item wl-folder-info-save
1983 @vindex wl-folder-info-save
1984 The initial setting is @code{t}. If non-nil, unread information is
1985 saved and used in the next Wanderlust session.
1987 @item wl-stay-folder-window
1988 @vindex wl-stay-folder-window
1989 The initial setting is @code{nil}.
1990 If non-nil, summary window is appeared on the right side of the folder buffer.
1992 @item wl-folder-window-width
1993 @vindex wl-folder-window-width
1994 The initial setting is 20.
1995 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1997 @item wl-folder-use-frame
1998 @vindex wl-folder-use-frame
1999 The initial setting is @code{nil}.
2000 If non-nil, use new frame for the folder window.
2002 @item wl-folder-many-unsync-threshold
2003 @vindex wl-folder-many-unsync-threshold
2004 The initial setting is 70.
2005 If the number of unread messages is more than this value,
2006 folder color is changed.
2008 @item wl-highlight-folder-by-numbers
2009 @vindex wl-highlight-folder-by-numbers
2010 This option controls how to highlight each line in the folder buffer.
2011 The default value is @code{t}, highlighting with various colors based on
2012 the message numbers. If it is @code{nil}, highlighting with various
2013 colors based on the folder status. In addition, if it is a number
2014 (e.g. 1), highlighting will be done based on both the message numbers
2015 and the folder status.
2017 @item wl-folder-desktop-name
2018 @vindex wl-folder-desktop-name
2019 The initial setting is @samp{Desktop}.
2020 The name of top folder group.
2022 @item wl-folder-petname-alist
2023 @vindex wl-folder-petname-alist
2024 The initial setting is @code{nil}.
2025 An alist of folder's realname and its nickname.
2027 @item wl-folder-access-subscribe-alist
2028 @vindex wl-folder-access-subscribe-alist
2029 The initial setting is @code{nil}.
2031 Control automatic subscribing and unsubscribing of the children list
2037 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2041 If @var{subscribe-flag} is non-nil, folders which have name matched to
2042 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2043 already unsubscribed folder is not displayed even when the
2044 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2051 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2052 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2053 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2054 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2058 @item wl-folder-hierarchy-access-folders
2059 @vindex wl-folder-hierarchy-access-folders
2060 The initial setting is the list shown below:
2069 A list of access groups which creates children folder list hierarchically.
2071 For example, if you specify
2072 @code{wl-folder-hierarchy-access-folders} like following,
2076 (setq wl-folder-hierarchy-access-folders
2077 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
2082 such access group hierarchy is obtained.
2088 -fj.comp.announce:0/0/2
2089 -fj.comp.dev.cdrom:0/0/0
2091 [+]-japan:238/238/1688
2094 -comp.unix.admin:0/0/0
2095 -comp.unix.dos-under-unix:0/0/0
2096 -comp.unix.programmer:0/0/0
2097 [-]-comp.unix.bsd:0/0/23
2098 -comp.unix.bsd.freebsd.announce:0/0/0
2103 If you opened @samp{-} in this example, only the direct children is created
2104 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2105 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2106 is not created until the children access group is opened.
2110 @node Folder Manager, , Selecting Folder, Folder
2111 @section Editing Folders
2112 @cindex Folder Manager
2113 @cindex Folder, Edit
2114 @cindex Folder, Subscribe
2115 @cindex Folder, Unsubscribe
2117 As described before, subscribed folder list is saved in @file{~/.folders} file.
2118 But you don't have to edit @file{~/.folders} directly.
2119 You can append, delete, edit folders from folder mode.
2121 @subsection Usage (Tips)
2123 @subsubsection Append Folder
2125 @kbd{m a} appends new folder to the folder mode.
2126 @kbd{m g} appends new folder group.
2127 To append new folder to this group, firstly open it,
2128 then execute append command in the next line.
2130 @subsubsection Edit Folder
2132 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2133 Thus, you can change folder position as if you were editing a normal file.
2135 @subsubsection Create Multi Folder.
2139 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2141 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2143 Type @kbd{m m}, then you can create multi folder.
2146 @subsubsection Delete Nickname, Filter
2148 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2149 minibuffer while appending.
2151 @subsubsection Append Folder to Empty Group
2153 To append new folder to the empty folder group
2154 (after you create folder group by typing @kbd{m g}),
2155 firstly open it, then execute append command in the next line.
2156 If it is closed, folder is appended on the same level with
2157 the above folder group. It is difficult to explain by words so try it.
2158 In other words, appended position depends on the
2159 above folder group's open/close status.
2161 @subsubsection Charset of the Folders File.
2163 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2165 @subsubsection Create Filter
2167 @kbd{m f} adds filter to the folder at the current cursor point. To
2168 create new filter folder and leave the current folder unchanged, copy it
2169 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2170 filter can be specified while appending filter. If you put
2171 ``''(@var{NULL}), filter is deleted.
2173 @subsubsection Sort Folders
2175 Sorting of the folders is executed by the function specified by
2176 @code{wl-fldmgr-sort-function}.
2177 The initial setting is @code{wl-fldmgr-sort-standard},
2178 which sorts alphabetically.
2179 Sorting affects only on the current folder group. It does not
2180 affect on the child groups.
2182 @subsubsection Hiding Folders in the Access Group
2184 Usually, access group displays all children folders, but you can set
2185 some folders hidden. Following operations are only available on access
2188 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2189 (subscribe/unsubscribe) of the folder at current cursor point. Against
2190 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2193 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2194 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2195 argument and if the argument has positive number, the unsubscribe it.
2196 If the prefix argument has negative value, folder becomes visible and if
2197 zero, folder visibility is toggled.
2199 The other commands, @code{wl-fldmgr-subscribe} and
2200 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2203 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2204 executed in the access group, they have a same effect with
2205 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2206 The difference is that cut commands deletes folders from the current
2209 @subsubsection Operations in the Access Group
2211 You can insert and delete folders in the access group like usual folder
2212 group. But insert and delete commands can be only available for the
2213 children folders of the access group and they only sets the subscribe
2214 status. In other words, insertion of the folder means subscribing,
2215 deletion means unsubscribing.
2216 @footnote{In the current implementation,
2217 it is faster to delete region than to unsubscribe region.}
2219 To update the access group when children folders are inserted or deleted
2220 by other way (other than Wanderlust),
2221 open the access group by typing @kbd{C-u @key{RET}}.
2222 @xref{Selecting Folder}.
2224 The order of children folders of access group is saved after
2225 insertion/deletion/sorting.
2226 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2227 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2228 newly created folders are inserted on the top of the access group.
2230 @subsection Key bindings
2231 @cindex Keybind, Folder Mode
2232 @cindex Keybind, Folder Buffer
2234 Key bindings on the folder mode related to folder editing are shown below.
2235 All bindings starts with @kbd{m}, and primary commands are binded to
2236 one stroke key binding.
2240 @kindex m a (Folder)
2241 @findex wl-fldmgr-add
2243 (@code{wl-fldmgr-add})
2248 @kindex m g (Folder)
2249 @findex wl-fldmgr-make-group
2250 Create a folder group.
2251 (@code{wl-fldmgr-make-group})
2254 @kindex m A (Folder)
2255 @findex wl-fldmgr-make-access-group
2256 Create an access group.
2257 (@code{wl-fldmgr-make-access-group})
2260 @kindex m d (Folder)
2261 @findex wl-fldmgr-delete
2262 Delete folder itself and msgdb.
2263 If the folder itself cannot be deleted like NNTP folder,
2264 only msgdb is deleted.
2265 (@code{wl-fldmgr-delete})
2270 @kindex m R (Folder)
2271 @findex wl-fldmgr-rename
2272 Change the name of folder or folder group.
2273 msgdb's path is also changed.
2274 (@code{wl-fldmgr-rename})
2280 @findex wl-fldmgr-make-multi
2281 Create a multi folders in the cutlist (cut, copied folders).
2282 (@code{wl-fldmgr-make-multi})
2287 @kindex m f (Folder)
2288 @findex wl-fldmgr-make-filter
2289 Create a filter folder. (Put a filter on the folder).
2290 (@code{wl-fldmgr-make-filter})
2294 @kindex M-c (Folder)
2295 @kindex m c (Folder)
2296 @findex wl-fldmgr-copy
2297 Copy folder (it is not available on folder group).
2298 (@code{wl-fldmgr-copy})
2302 @kindex M-w (Folder)
2303 @kindex m W (Folder)
2304 @findex wl-fldmgr-copy-region
2305 Copy folders in the specified region.
2306 (@code{wl-fldmgr-copy-region})
2310 @kindex C-k (Folder)
2311 @kindex m k (Folder)
2312 @findex wl-fldmgr-cut
2313 Cut folder. Folder itself is not deleted.
2314 (@code{wl-fldmgr-cut})
2318 @kindex C-w (Folder)
2319 @kindex m C-w (Folder)
2320 @findex wl-fldmgr-cut-region
2321 Cut folders in the specified region.
2322 (@code{wl-fldmgr-cut-region})
2326 @kindex C-y (Folder)
2327 @kindex m y (Folder)
2328 @findex wl-fldmgr-yank
2329 Paste folders that are copied or cut (folders in the cut-list).
2330 (@code{wl-fldmgr-yank})
2333 @kindex m p (Folder)
2334 @findex wl-fldmgr-set-petname
2335 Put nickname on the folder.
2336 (@code{wl-fldmgr-set-petname})
2339 @kindex m q (Folder)
2340 @findex wl-fldmgr-clear-cut-entity-list
2341 Clear the cut-list. (cut, copied folder information is cleared,
2342 you cannot paste after this)
2343 (@code{wl-fldmgr-clear-cut-entity-list})
2346 @kindex m s (Folder)
2347 @findex wl-fldmgr-sort
2348 Sort folders in the current folder group.
2349 (@code{wl-fldmgr-sort})
2352 @kindex m C-s (Folder)
2353 @findex wl-fldmgr-save
2354 Save current folder view to the @file{wl-folders-file}.
2355 (@code{wl-fldmgr-save})
2358 [Following commands are only available on the access groups]
2364 @kindex m u (Folder)
2365 @findex wl-fldmgr-unsubscribe
2366 Set the visibility of folder (subscribe/unsubscribe).
2367 (@code{wl-fldmgr-unsubscribe})
2372 @kindex r u (Folder)
2373 @findex wl-fldmgr-unsubscribe-region
2374 Set the visibility of the folders (subscribe/unsubscribe) in the
2376 (@code{wl-fldmgr-unsubscribe-region})
2381 @kindex m l (Folder)
2382 @findex wl-fldmgr-access-display-normal
2383 List folders that are currently available.
2384 (@code{wl-fldmgr-access-display-normal})
2389 @kindex m L (Folder)
2390 @findex wl-fldmgr-access-display-all
2391 List all folders regardless of the subscription status.
2392 (@code{wl-fldmgr-access-display-all})
2396 @subsection Customize variables
2399 @item wl-interactive-save-folders
2400 @vindex wl-interactive-save-folders
2401 The initial setting is @code{t}. If non-nil and folder view is
2402 modified, confirm saving it before Wanderlust or Emacs exits. If
2403 @code{nil}, save without confirmation.
2405 @item wl-fldmgr-make-backup
2406 @vindex wl-fldmgr-make-backup
2407 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2408 created before saving the folder status.
2410 @item wl-fldmgr-sort-function
2411 @vindex wl-fldmgr-sort-function
2412 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2413 sort folders. By default function, folders are sorted alphabetically
2414 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2417 @item wl-fldmgr-sort-group-first
2418 @vindex wl-fldmgr-sort-group-first
2419 The initial setting is @code{t}. If non-nil,
2420 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2421 does not care whether it is folder group or not.
2423 @item wl-folder-check-async
2424 @vindex wl-folder-check-async
2425 The initial setting is @code{t}. If non-nil, check folder's unread
2426 status asynchronously. It boosts newsgroup checking.
2428 @item wl-folder-check-fast
2429 @vindex wl-folder-check-fast
2430 The initial setting is @code{nil}.
2431 If non-nil, it does not update folder status while checking.
2433 @item wl-folder-notify-deleted
2434 @vindex wl-folder-notify-deleted
2435 The initial setting is @code{nil}.
2437 If non-nil, negative value is displayed when the message is deleted. If
2438 @code{sync}, folder is synchronized when the message is deleted. If
2439 @code{nil}, message deletion is ignored.
2441 @item wl-fldmgr-add-complete-with-current-folder-list
2442 @vindex wl-fldmgr-add-complete-with-current-folder-list
2443 The initial setting is @code{nil}.
2444 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2445 candidate for @code{wl-fldmgr-add}.
2448 @subsection Miscellanea
2450 Following is a note for folder editing.
2454 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2455 paste(yank) command pastes the folders on one cut or copy command
2456 (If copy command is executed by region, folders in the region are pasted
2457 by one paste command)
2460 You cannot cut @samp{Desktop} group.
2461 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2464 You cannot copy folder group.
2467 Operations on the access group are only available for the folders
2468 in the same access group.
2471 You cannot create a folder which has same name with the folders already exist.
2474 You cannot insert folders which have same name in one group.
2475 You can insert them in the different groups.
2476 You cannot put same nickname to the different folders.
2480 @node Summary, Message, Folder, Top
2481 @chapter Summary Mode
2483 After you select the folder via folder mode, you enter to the summary
2487 * Usage of Summary Mode:: TIPS
2488 * Thread Operations:: Thread operations
2489 * Cache:: File cache, Buffer cache, and Prefetch
2490 * Auto Refile:: Auto refile settings
2491 * Sticky Summary:: Summary make sticky
2492 * Key Bindings of Summary:: Key bindings
2493 * Variables of Summary:: Customize Summary Mode
2497 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2498 @section Usage (Tips)
2500 @subsection Summary Content
2502 In the summary mode, messages are displayed like following.
2506 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2507 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2508 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2509 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2516 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2520 You cannot change this in the current version.
2522 @var{Message number} is the message's unique number in the folder. In
2523 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2524 in the MH folder, it is the filename of the message.
2526 @var{Temporal mark} and @var{Persistent mark} are described later.
2528 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2529 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2530 Japanese, but if you want to display it in English, set the value of
2531 @code{wl-summary-weekday-name-lang} as @samp{en}.
2533 @var{Sender}'s indentation corresponds to the depth of the thread.
2534 Sender name is displayed as nickname if it is defined in the address
2535 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2536 displaying with nickname.
2538 If number is printed at the head of @var{Sender} part like @samp{+2},
2539 that means the message have 2 follow messages.
2541 @var{Subject} is the @samp{Subject:} header field of the message. If
2542 the message have same @samp{Subject:} with the parent message, it is not
2543 displayed. Some mailing list puts its sequence number in the
2544 @samp{Subject:} field, but it is
2545 ignored. @code{wl-summary-no-subject-message} is displayed when the
2546 message has empty subject field.
2548 @subsection Temporary Marks
2549 @cindex Mark, Temporary
2551 There are four temporary marks,
2552 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2553 Temporary marks indicates message operations.
2558 You can execute a command on the all messages that have @samp{*} mark,
2559 with the key bindings which begins with @kbd{m}.
2562 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2566 After you type @kbd{o} key, prompt appears to input refile destination.
2567 Your answer is printed in the summary line.
2571 You can put this mark by typing @kbd{O} key.
2572 The difference between this mark and refile mark is,
2573 this mark does not delete the message while latter does.
2576 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2578 @subsection Persistent Marks
2580 There are five persistent marks,
2581 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2583 The persistent mark indicates the message's status and it is saved.
2584 Each persistent mark indicates:
2590 It is unread message.
2592 It is unread but cached message.
2594 It is read but it is not cached.
2596 It is important message. You can put @samp{$} mark by typing @kbd{$}
2597 key (if already exists, the mark is deleted). It is convenient to put
2598 this mark on the messages to remember (If you want to remember to write
2599 a reply for the message, for example) because this mark remains after
2600 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2601 @samp{'mark} folder even the message itself is deleted in the actual folder.
2604 If the message is read and cached (or local message),there are no
2608 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2609 cache. Messages with the marks other than these, you can read them in
2610 the offline status even they are in the IMAP folder or netnews folder.
2612 Among messages with persistent marks, ones with marks specified by
2613 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2614 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2616 @subsection How To Read
2618 Basically, you can read messages only typing space key again and again.
2620 To update summary status to the newest status (synchronize),
2623 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2624 moves cursor to the next message.
2625 Enter message buffer by typing @kbd{j} key.
2626 To operate multipart, you have to enter to the message buffer.
2629 @subsection Pack the Message Numbers
2630 You can pack the message numbers in Summary by
2631 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2632 News Spool Folder and Maildir Folder are supported folder types.
2635 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2636 @section Thread Operations
2638 For example, the following line indicates one thread (a context of a topic).
2641 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2645 If you type @kbd{/} on this line, the thread is opened and it changes
2646 the appearance like following.
2650 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2651 388 09/17(Thu)22:34 +-[ Murata san ]
2655 (Message 388 is the replied message to the message 384.)
2656 If you type @kbd{/} key once again, the thread is closed.
2657 With prefix argument, @kbd{/} opens all children threads.
2659 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2662 Commands with the key binding that begins with @kbd{t} executes commands
2663 on the messages in the thread.
2664 @xref{Key Bindings of Summary}.
2666 @subsection reconstruct thread by hand
2668 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2669 (@code{wl-summary-save-current-message}) at the corresponding message,
2670 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2671 message then you have the reconstructed thread.
2674 @node Cache, Auto Refile, Thread Operations, Summary
2677 @subsection Cache File
2679 The messages which have to access via network (e.x. IMAP, NNTP folder)
2680 are cached as a local file. The cache file is saved under the directory
2681 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2682 elmo-cache-expire-by-size}. The command deletes cache files to the
2683 specified size by the order of last accessed time.
2685 @subsection Buffer Cache and Prefetching
2687 The messages that are read are kept in the cache buffer. It is called
2688 `buffer cache'. The number of cache buffer is specified by
2689 @code{wl-message-buffer-cache-size}.
2691 There are message prefetching mechanism in the Wanderlust that
2692 prefetches next message while you are reading.
2694 You can control the message prefetching mechanism by these two
2698 @item wl-message-buffer-prefetch-folder-type-list
2699 @vindex wl-message-buffer-prefetch-folder-type-list
2700 The initial setting is @code{t}. In this case, prefetch messages in all
2702 If it is a list of folder types, it specifies the folder types in which
2703 message prefetching is enabled.
2704 Following is an example (prefetch messages in nntp and imap4 folders)
2708 (setq wl-message-buffer-prefetch-folder-type-list
2713 In this case, multi folder that contains localdir and imap4 prefetches
2714 only imap4 messages. This variable precedes the value of
2715 @code{wl-message-buffer-prefetch-folder-list}.
2717 @item wl-message-buffer-prefetch-folder-list
2718 @vindex wl-message-buffer-prefetch-folder-list
2719 The initial setting is @code{nil}.
2720 A list of regexp of folders to enable message prefetching.
2722 @item wl-message-buffer-prefetch-depth
2723 @vindex wl-message-buffer-prefetch-depth
2724 The initial setting is 3. The number of messages for automatical prefetch.
2726 @item wl-message-buffer-prefetch-idle-time
2727 @vindex wl-message-buffer-prefetch-idle-time
2728 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2730 @item wl-message-buffer-prefetch-threshold
2731 @vindex wl-message-buffer-prefetch-threshold
2732 The initial setting is 30000 (bytes). If prefetching message has larger
2733 size than this value, Wanderlust does not prefetch automatically.
2734 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2735 the message is not checked for the size.
2739 @node Auto Refile, Sticky Summary, Cache, Summary
2740 @section Auto Refile
2741 @vindex elmo-msgdb-extra-fields
2742 @vindex wl-refile-rule-alist
2743 @findex wl-summary-auto-refile
2745 You can refile messages automatically, by typing @kbd{C-o}
2746 (@code{wl-summary-auto-refile}). It decides destination of refile by
2747 the content of the message header information (information in the msgdb).
2749 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2750 available. If you want to decide destination by other header fields,
2751 set the variable @code{elmo-msgdb-extra-fields} like following.
2755 (setq elmo-msgdb-extra-fields
2765 By this setting, Wanderlust saves extra fields in the msgdb. You have
2766 to type @kbd{s all} to get extra fields for the messages that are
2767 already exists in the summary.
2769 Then, specify the refile rule. The refile target folder of auto
2770 refiling is decided by the value of @code{wl-refile-rule-alist}.
2771 @code{wl-refile-rule-alist} is a list of a rule:
2775 (@var{field} (@var{regexp} . @var{target})
2776 (@var{regexp} . @var{target})
2781 Each rule means `if @var{field} value matches @var{regexp},
2782 then refile to @var{target} folder'.
2783 The rule matched first is applied.
2785 @var{field} is a string of field name. You can specify a list of field name
2786 string, too. In this case, if one of these fields is matched, then the
2787 rule is fired (i.e. OR condition).
2789 @var{regexp} is a regular expression for field value. @var{target} is a target
2790 folder string. You can specify a rule at @var{target} part, too. In this
2791 case, If the field value of the rule and the current rule is matched,
2792 then the current rule is fired (i.e. AND condition).
2794 In @var{target} part, you can refer matched substring of @var{regexp}.
2795 To refer substring, specify following in @var{target}:
2799 means substitute original matched text.
2802 means substitute what matched the @var{N}th `\(@dots{}\)'.
2803 (@var{N} is a number.)
2806 Following is an example of @code{wl-refile-rule-alist}.
2810 (setq wl-refile-rule-alist
2812 ("^Wanderlust" . "+wl")
2813 ("^Elisp" . "+elisp"))
2815 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2817 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2818 "+from-me-to-you"))))))
2822 After these settings, refile marks are automatically put on the condition
2823 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2825 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2827 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2828 with these persistent marks are not automatically refiled.
2829 It means Wanderlust does not execute auto refile on unread messages by
2830 the default setting.
2831 To execute auto refile on all messages, set following.
2834 (setq wl-summary-auto-refile-skip-marks nil)
2838 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2839 @section Sticky Summary
2840 @cindex Summary, Sticky
2841 @cindex Sticky Summary
2843 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2845 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2846 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2848 The buffer name of the sticky summary becomes like
2849 @samp{Summary:@var{folder-name}}.
2851 You can visit the sticky summary at any time by @kbd{C-x b}
2852 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2853 q}. Other operations in the sticky summary are same as normal summary.
2855 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2856 are automatically stuck.
2859 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2860 @section Key bindings
2861 @cindex Keybind, Summary Mode
2862 @cindex Keybind, Summary Buffer
2864 Key bindings of the summary mode are shown below.
2868 @kindex @key{SPC} (Summary)
2869 @findex wl-summary-read
2870 Proceed reading a message at the current cursor point.
2871 (@code{wl-summary-read})
2875 @findex wl-summary-redisplay
2876 Redisplay a message at the current cursor point.
2877 If this command is called with prefix argument,
2878 Redisplay message regardless of the message cache (message is re-loaded
2880 (@code{wl-summary-redisplay})
2884 @findex wl-summary-display-top
2885 Display the top message in the folder.
2886 (@code{wl-summary-display-top})
2890 @findex wl-summary-display-bottom
2891 Display the bottom message in the folder.
2892 (@code{wl-summary-display-bottom})
2896 @kindex @key{BS} (Summary)
2897 @kindex @key{DEL} (Summary)
2898 Display the previous page of the message at the current cursor point.
2899 @findex wl-summary-prev-page
2900 (@code{wl-summary-prev-page})
2903 @kindex @key{RET} (Summary)
2904 @findex wl-summary-next-line-content
2905 Display the next line of the message at the current cursor point.
2906 Display the message at the current cursor point if it is not displayed yet.
2907 (@code{wl-summary-next-line-content})
2912 @kindex M-@key{RET} (Summary)
2913 @findex wl-summary-prev-line-content
2914 Display the previous line of the message at the current cursor point.
2915 Display the message at the current cursor point if it is not displayed yet.
2916 (@code{wl-summary-prev-line-content})
2920 @findex wl-thread-open-close
2921 Toggle open or close the thread at the current cursor point.
2922 (@code{wl-thread-open-close})
2927 @findex wl-thread-open-all
2928 (@code{wl-thread-open-all})
2933 @findex wl-thread-close-all
2934 (@code{wl-thread-close-all})
2938 @findex wl-summary-goto-folder
2940 (@code{wl-summary-goto-folder})
2944 Mark all messages in the folder as read.
2945 @findex wl-summary-mark-as-read-all
2946 (@code{wl-summary-mark-as-read-all})
2950 @findex wl-summary-reply
2951 Prepare a draft for reply the message at the current cursor point.
2952 (@code{wl-summary-reply})
2956 @findex wl-summary-reply-with-citation
2957 Prepare a draft for reply the message at the current cursor point.
2958 (@code{wl-summary-reply-with-citation})
2962 @findex wl-summary-cancel-message
2963 If the message at current cursor point is your own netnews article,
2965 (@code{wl-summary-cancel-message})
2969 @findex wl-summary-reedit
2970 Prepare a draft for re-editing the message at current cursor point.
2971 If the message at current cursor point is your own netnews article,
2972 a draft for `supersedes message' for the message is prepared.
2973 (@code{wl-summary-reedit})
2976 @kindex M-e (Summary)
2977 @findex wl-summary-resend-bounced-mail
2978 If the message at current cursor point is a bounced message,
2979 a draft for re-sending original message is prepared.
2980 (@code{wl-summary-resend-bounced-mail})
2984 @findex wl-summary-forward
2985 A draft for forwarding the message at current cursor point is prepared.
2986 (@code{wl-summary-forward})
2990 @findex wl-summary-mark-as-important
2991 Put @samp{$} mark on the message at current cursor point.
2992 If already marked as @samp{$}, delete it.
2993 (@code{wl-summary-mark-as-important})
2999 Save the message at current cursor point.
3000 @findex wl-summary-save
3001 (@code{wl-summary-save})
3005 @findex wl-summary-next
3006 Move cursor to the next message.
3007 If message is marked with a temporal mark in
3008 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3009 In the offline mode, cursor is not moved to the messages which are not cached
3011 (@code{wl-summary-next})
3015 @findex wl-summary-prev
3016 Move cursor to the previous message.
3017 If message is marked with a temporal mark in
3018 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3019 In the offline mode, cursor is not moved to the messages which are not cached
3021 (@code{wl-summary-prev})
3025 @findex wl-summary-down
3026 Move cursor to the downward message which is unread or marked
3028 In the offline mode, cursor is not moved to the messages which are not cached
3030 If there are messages which have target mark @samp{*} in the summary,
3031 cursor is moved to the downward message which have a target mark.
3032 This behavior is changed according to the value of @code{wl-summary-move-order}.
3033 (@code{wl-summary-down})
3037 @findex wl-summary-up
3038 Move cursor to the upward message which is unread or marked
3040 In the offline mode, cursor is not moved to the messages which are not cached
3042 If there are messages which have target mark @samp{*} in the summary,
3043 cursor is moved to the downward message which have a target mark.
3044 This behavior is changed according to the value of @code{wl-summary-move-order}.
3045 (@code{wl-summary-up})
3049 @findex wl-summary-write
3050 Prepare a new draft.
3051 (@code{wl-summary-write})
3055 @findex wl-summary-write-current-folder
3056 Prepare a new draft. If the current folder is NNTP folder,
3057 @samp{Newsgroups:} field is completed. If the current folder is mailing
3058 list folder (refile destination), guess @samp{To:} field and completed
3059 (If @code{wl-subscribed-mailing-list} is valid list)
3060 (@code{wl-summary-write-current-folder})
3064 @findex wl-summary-redisplay-all-header
3065 Redisplay the message at current cursor point with all header fields.
3066 (@code{wl-summary-redisplay-all-header})
3070 @findex wl-summary-redisplay-no-mime
3071 Redisplay the message at current cursor point without MIME analysis.
3072 (@code{wl-summary-redisplay-no-mime})
3076 @findex wl-summary-burst
3077 If the message at current cursor point has
3078 encapsulates multiple messages using MIME,
3079 de-capsulate and extract them on the current folder.
3080 (@code{wl-summary-burst})
3083 @kindex @@ (Summary)
3084 @findex wl-summary-edit-addresses
3085 Append/change/delete the message's sender information to the address
3086 book @file{~/.addresses} interactively. If this command is called with
3087 prefix argument, arbitrary address can be edited.
3088 (@code{wl-summary-edit-petname})
3092 @findex wl-status-update
3093 Sync up address book status with @file{~/.addresses}'s content.
3094 (@code{wl-status-update})
3098 @findex wl-summary-pipe-message
3099 Pipe current message's content to the external process.
3100 (@code{wl-summary-pipe-message})
3104 @findex wl-summary-print-message
3105 Print out current message's content.
3106 It uses @code{ps-print} module in Emacs 20.x.
3107 If you don't use color printer, you might want to set
3108 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3111 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3114 (@code{wl-summary-print-message})
3118 @findex wl-summary-exit
3119 Exit current folder.
3120 (@code{wl-summary-exit})
3124 @findex wl-summary-jump-to-current-message
3125 Jump cursor to the currently displayed message's window.
3126 (@code{wl-summary-jump-to-current-message})
3130 Jump cursor to the other message.
3131 @findex wl-summary-jump-to-msg
3132 (@code{wl-summary-jump-to-msg})
3136 Update summary status and
3137 prefetch all messages which have marks included in the
3138 @code{wl-summary-incorporate-marks}.
3139 @findex wl-summary-incorporate
3140 (@code{wl-summary-incorporate})
3143 @kindex M-j (Summary)
3144 @findex wl-summary-jump-to-msg-by-message-id
3145 Jump cursor to the message which have specified @samp{Message-Id:}. If
3146 @code{elmo-use-database} is non-nil, other folder is also searched.
3147 (@code{wl-summary-jump-to-msg-by-message-id})
3151 Jump to parent message.
3152 @findex wl-summary-jump-to-parent-message
3153 (@code{wl-summary-jump-to-parent-message})
3157 @findex wl-summary-mark-as-unread
3158 Mark as unread the message at current cursor point.
3159 (@code{wl-summary-mark-as-unread})
3163 @findex wl-summary-sync
3164 Synchronize summary view after prompting the update range
3165 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3169 all ...Discard current summary and update all message.
3170 all-visible ...Discard current summary and update all visible message.
3171 update ...Update the difference between summary and the folder itself.
3172 rescan ...Rescan the msgdb and display again.
3173 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3174 cache-status ...Sync the all marks with the real status of cache.
3175 first, last ...Move to the filter folder(partial filter).
3180 (@code{wl-summary-sync})
3184 @findex wl-summary-sort
3186 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3187 (@code{wl-summary-sort})
3191 @findex wl-summary-toggle-thread
3192 Toggle the threading.
3193 Threading status is displayed on the modeline.
3194 @samp{@{S@}} means threading is off (Sequence) and
3195 @samp{@{T@}} means threading is on (Thread).
3196 (@code{wl-summary-toggle-thread})
3200 @findex wl-summary-toggle-disp-folder
3201 Toggle displaying of folder window.
3202 (@code{wl-summary-toggle-disp-folder})
3206 Toggle displaying of message window.
3207 @findex wl-summary-toggle-disp-msg
3208 (@code{wl-summary-toggle-disp-msg})
3212 Move to the virtual folder with the condition specified.
3213 If called with prefix argument and current folder is virtual, exit it.
3214 @findex wl-summary-virtual
3215 (@code{wl-summary-virtual})
3218 @kindex @key{TAB} (Summary)
3219 @findex wl-summary-goto-last-displayed-msg
3220 Jump to the message which is displayed last.
3221 (@code{wl-summary-goto-last-displayed-msg})
3225 Put @samp{*} mark on the messages that satisfies the specified condition.
3226 @findex wl-summary-pick
3227 (@code{wl-summary-pick})
3231 @findex wl-summary-mark-as-read
3232 Mark as read the message at the current cursor point.
3233 (@code{wl-summary-mark-as-read})
3237 Prefetch the message at the current cursor point.
3238 With prefix argument, prefetch the message even if it is cached.
3239 @findex wl-summary-prefetch
3240 (@code{wl-summary-prefetch})
3244 Execute @samp{D}, @samp{o} and @samp{O} marks.
3245 @findex wl-summary-exec
3246 (@code{wl-summary-exec})
3250 @findex wl-summary-target-mark-line
3251 Put target mark on the message at the current cursor point.
3252 (@code{wl-summary-target-mark-line})
3256 Put refile mark on the message at the current cursor point.
3257 @findex wl-summary-refile
3258 (@code{wl-summary-refile})
3261 @kindex C-o (Summary)
3262 Execute auto refile.
3263 @findex wl-summary-auto-refile
3264 (@code{wl-summary-auto-refile})
3268 Put copy mark on the message at the current cursor point.
3269 @findex wl-summary-copy
3270 (@code{wl-summary-copy})
3273 @kindex M-o (Summary)
3274 Put refile mark on the message at the current cursor point with the destination
3275 previously specified.
3276 @findex wl-summary-refile-prev-destination
3277 (@code{wl-summary-refile-prev-destination})
3281 @findex wl-summary-delete
3282 Put delete mark on the message at the current cursor point.
3283 (@code{wl-summary-delete})
3287 @findex wl-summary-unmark
3288 Unmark the temporal mark on the message at the current cursor point.
3289 (@code{wl-summary-unmark})
3293 Unmark all the temporal marks.
3294 @findex wl-summary-unmark-all
3295 (@code{wl-summary-unmark-all})
3298 @kindex r R (Summary)
3299 @findex wl-summary-mark-as-read-region
3300 Mark as read messages in the specified region.
3301 (@code{wl-summary-mark-as-read-region})
3304 @kindex r $ (Summary)
3305 @findex wl-summary-mark-as-important-region
3306 Mark as important @samp{$} messages in the specified region.
3307 If @samp{$} already exists, it is deleted.
3308 (@code{wl-summary-mark-as-important-region})
3311 @kindex r ! (Summary)
3312 @findex wl-summary-mark-as-unread-region
3313 Mark as unread messages in the specified region.
3314 (@code{wl-summary-mark-as-unread-region})
3317 @kindex r i (Summary)
3318 @findex wl-summary-prefetch-region
3319 Prefetch messages in the specified region.
3320 (@code{wl-summary-prefetch-region})
3323 @kindex r x (Summary)
3324 @findex wl-summary-exec-region
3325 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3327 (@code{wl-summary-exec-region})
3330 @kindex r * (Summary)
3331 @findex wl-summary-target-mark-region
3332 Put target mark on the messages in the specified region.
3333 (@code{wl-summary-target-mark-region})
3336 @kindex r o (Summary)
3337 @findex wl-summary-refile-region
3338 Put refile mark on the messages in the specified region.
3339 (@code{wl-summary-refile-region})
3342 @kindex r O (Summary)
3343 @findex wl-summary-copy-region
3344 Put copy mark on the messages in the specified region.
3345 (@code{wl-summary-copy-region})
3348 @kindex r d (Summary)
3349 @findex wl-summary-delete-region
3350 Put delete mark on the messages in the specified region.
3351 (@code{wl-summary-delete-region})
3354 @kindex r u (Summary)
3355 @findex wl-summary-unmark-region
3356 Delete temporal mark on the messages in the specified region.
3357 (@code{wl-summary-unmark-region})
3360 @kindex r y (Summary)
3361 Save messages in the specified region.
3362 @findex wl-summary-save-region
3363 (@code{wl-summary-save-region})
3366 @kindex t R (Summary)
3367 @findex wl-thread-mark-as-read
3368 Mark as read messages which are the descendant of the current thread.
3369 With prefix argument, it affects on the all messages in the thread tree.
3370 (@code{wl-thread-mark-as-read})
3373 @kindex t $ (Summary)
3374 @findex wl-thread-mark-as-important
3375 Put important mark @samp{$} on the messages which are the
3376 descendant of the current thread.
3377 If @samp{$} mark exists, it is deleted.
3378 With prefix argument, it affects on the all messages in the thread tree.
3379 (@code{wl-thread-mark-as-important})
3382 @kindex t ! (Summary)
3383 @findex wl-thread-mark-as-unread
3384 Mark as unread messages which are the descendant of the current thread.
3385 With prefix argument, it affects on the all messages in the thread tree.
3386 (@code{wl-thread-mark-as-unread})
3389 @kindex t i (Summary)
3390 @findex wl-thread-prefetch
3391 Prefetch messages which are the descendant of the current thread.
3392 With prefix argument, it affects on the all messages in the thread tree.
3393 (@code{wl-thread-prefetch})
3396 @kindex t x (Summary)
3397 @findex wl-thread-exec
3398 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3399 the descendant of the current thread. With prefix argument, it affects
3400 on the all messages in the thread tree.
3401 (@code{wl-thread-exec})
3404 @kindex t * (Summary)
3405 @findex wl-thread-target-mark
3406 Put target mark @samp{*} on the messages which are the descendant of the
3407 current thread. With prefix argument, it affects on the all messages in
3409 (@code{wl-thread-target-mark})
3412 @kindex t o (Summary)
3413 @findex wl-thread-refile
3414 Put refile mark on the messages which are the descendant of the current thread.
3415 With prefix argument, it affects on the all messages in the thread tree.
3416 (@code{wl-thread-refile})
3419 @kindex t O (Summary)
3420 @findex wl-thread-copy
3421 Put copy mark on the messages which are the descendant of the current thread.
3422 With prefix argument, it affects on the all messages in the thread tree.
3423 (@code{wl-thread-copy})
3426 @kindex t d (Summary)
3427 @findex wl-thread-delete
3428 Put delete mar on the messages which are the descendant of the current thread.
3429 With prefix argument, it affects on the all messages in the thread tree.
3430 (@code{wl-thread-delete})
3433 @kindex t u (Summary)
3434 @findex wl-thread-unmark
3435 Unmark temporal mark on the messages which are the descendant of the
3436 current thread. With prefix argument, it affects on the all messages in
3438 (@code{wl-thread-unmark})
3441 @kindex t y (Summary)
3442 @findex wl-thread-save
3443 Save messages which are the descendant of the current thread.
3444 With prefix argument, it affects on the all messages in the thread tree.
3445 (@code{wl-thread-save})
3448 @kindex m i (Summary)
3449 @findex wl-summary-target-mark-prefetch
3450 Prefetch all messages which have target mark @samp{*}.
3451 With prefix argument, prefetch all targets even if some of them are cached.
3452 (@code{wl-summary-target-mark-prefetch})
3455 @kindex m R (Summary)
3456 @findex wl-summary-target-mark-mark-as-read
3457 Mark as read all messages which have target mark @samp{*}.
3458 (@code{wl-summary-target-mark-mark-as-read})
3461 @kindex m $ (Summary)
3462 @findex wl-summary-target-mark-mark-as-important
3463 Mark as important all messages which have target mark @samp{*}.
3464 If already marked as @samp{$}, it is deleted.
3465 (@code{wl-summary-target-mark-mark-as-important})
3468 @kindex m ! (Summary)
3469 @findex wl-summary-target-mark-mark-as-unread
3470 Mark as unread all messages which have target mark @samp{*}.
3471 (@code{wl-summary-target-mark-mark-as-unread})
3474 @kindex m o (Summary)
3475 @findex wl-summary-target-mark-refile
3476 Put refile mark on the messages which have target mark @samp{*}.
3477 (@code{wl-summary-target-mark-refile})
3480 @kindex m O (Summary)
3481 @findex wl-summary-target-mark-copy
3482 Put copy mark on the messages which have target mark @samp{*}.
3483 (@code{wl-summary-target-mark-copy})
3486 @kindex m d (Summary)
3487 @findex wl-summary-target-mark-delete
3488 Put delete mark on the messages which have target mark @samp{*}.
3489 (@code{wl-summary-target-mark-delete})
3492 @kindex m y (Summary)
3493 @findex wl-summary-target-mark-save
3494 Save messages which have target mark @samp{*}.
3495 (@code{wl-summary-target-mark-save})
3498 @kindex m u (Summary)
3499 Unmark all temporal marks.
3500 (@code{wl-summary-delete-all-temp-marks})
3501 @findex wl-summary-delete-all-temp-marks
3504 @kindex m a (Summary)
3505 Put target mark @samp{*} on the all messages.
3506 (@code{wl-summary-target-mark-all})
3507 @findex wl-summary-target-mark-all
3510 @kindex m t (Summary)
3511 Put target mark @samp{*} on the messages in the current thread.
3512 @findex wl-summary-target-mark-thread
3513 (@code{wl-summary-target-mark-thread})
3516 @kindex m r (Summary)
3517 @findex wl-summary-target-mark-region
3518 Put target mark @samp{*} on the messages in the specified region.
3519 (@code{wl-summary-target-mark-region})
3522 @kindex m A (Summary)
3523 @findex wl-summary-target-mark-reply-with-citation
3524 Prepare a draft which cites all messages which have target mark @samp{*}.
3525 (@code{wl-summary-target-mark-reply-with-citation})
3528 @kindex m f (Summary)
3529 @findex wl-summary-target-mark-forward
3530 Prepare a draft which forwards all messages which have target mark @samp{*}.
3531 (@code{wl-summary-target-mark-forward})
3534 @kindex m U (Summary)
3535 @findex wl-summary-target-mark-uudecode
3536 Uudecode the messages which have target mark @samp{*}.
3537 (@code{wl-summary-target-mark-uudecode})
3540 @kindex m ? (Summary)
3541 @findex wl-summary-target-mark-pick
3542 Pick messages from the @samp{*} marked messages.
3543 That is, @samp{*} marks on the messages are remained
3544 if the specified condition is satisfied.
3545 (@code{wl-summary-target-mark-pick})
3548 @kindex M-t (Summary)
3549 @findex wl-toggle-plugged
3550 Toggle offline/online status of Wanderlust.
3551 (@code{wl-toggle-plugged})
3554 @kindex C-t (Summary)
3555 Start Wanderlust's plug-status manager.
3556 (@code{wl-plugged-change})
3559 @kindex C-c C-o (Summary)
3560 @findex wl-jump-to-draft-buffer
3561 Move to the draft buffer if available. If multiple draft buffer exists,
3562 moved to one after another. If prefix argument is specified, load draft
3563 folder's message to the draft buffer and jump to it.
3564 (@code{wl-jump-to-draft-buffer})
3567 @kindex M-w (Summary)
3568 @findex wl-summary-save-current-message
3569 Save the message at the current cursor point.
3570 (@code{wl-summary-save-current-message})
3573 @kindex C-y (Summary)
3574 @findex wl-summary-yank-saved-message
3575 Regard the message at the current cursor point as
3576 parent, connect the message saved by
3577 @code{wl-summary-save-current-message}
3579 (@code{wl-summary-yank-saved-message})
3583 @node Variables of Summary, , Key Bindings of Summary, Summary
3584 @section Customiziable variables
3587 @item wl-summary-move-order
3588 @vindex wl-summary-move-order
3589 The initial setting is @code{unread}. Specify cursor moving policy. If
3590 you want to precede new messages, set @code{new}. If you want to
3591 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3594 @item wl-auto-select-first
3595 @vindex wl-auto-select-first
3596 The initial setting is @code{nil}.
3597 If non-nil, first message is automatically displayed.
3599 @item wl-auto-select-next
3600 @vindex wl-auto-select-next
3601 The initial setting is @code{nil}. This controls behavior when there is
3602 no unread message in current summary.
3605 nil: asks whether you want to go back to folder mode
3606 'unread: asks whether you want to go to next unread folder
3607 If the next one comes to be possessing no unread message
3608 by treatment of cross-posted messages or Scoring, then
3609 asks whether you want to go to next to next folder.
3610 'skip-no-unread: similar as unread
3611 But does not ask before going to next to next folder.
3612 otherwise: asks whether you want to go to next unread folder
3615 It might be useful to set @code{'skip-no-unread} for people who
3616 want to continue reading by just pressing and pressing space key.
3618 @item wl-thread-insert-opened
3619 @vindex wl-thread-insert-opened
3620 The initial setting is @code{nil}.
3621 If non-nil, thread is inserted as opened.
3623 @item wl-thread-open-reading-thread
3624 @vindex wl-thread-open-reading-thread
3625 The initial setting is @code{t}. If non-nil, reading thread is
3626 automatically opened though it is closed thread.
3628 @item wl-summary-exit-next-move
3629 @vindex wl-summary-exit-next-move
3630 The initial setting is @code{t}. If non-nil, move to next folder at
3633 @item wl-folder-move-cur-folder
3634 @vindex wl-folder-move-cur-folder
3635 The initial setting is @code{nil}. If non-nil, cursor position on the
3638 @item wl-summary-weekday-name-lang
3639 @vindex wl-summary-weekday-name-lang
3640 The initial setting is @samp{ja}. Specify language of the weekday.
3641 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3642 displays Deutsch. You should rescan summary view after changing this value.
3644 @item wl-summary-fix-timezone
3645 @vindex wl-summary-fix-timezone
3646 The initial setting is @code{nil}.
3647 Time zone of the date string in summary mode is adjusted using this value.
3648 If @code{nil}, it is adjust to the default time zone information
3649 (system's default time zone or environment variable @samp{TZ}).
3651 @item wl-use-petname
3652 @vindex wl-use-petname
3653 The initial setting is @code{t}.
3654 If non-nil, sender part displays nickname.
3656 @item wl-break-pages
3657 @vindex wl-break-pages
3658 The initial setting is @code{t}.
3659 If non-nil, message is split as pages by @samp{^L}.
3661 @item wl-message-window-size
3662 @vindex wl-message-window-size
3663 The initial setting is '(1 . 4).
3664 A cons cell to specify the rate of summary and message window.
3665 car:cdr corresponds summary:message.
3667 @item wl-summary-no-from-message
3668 @vindex wl-summary-no-from-message
3669 The initial setting is @samp{nobody@@nowhere?}. A string which is
3670 displayed when there's no @samp{From:} field in the message.
3672 @item wl-summary-no-subject-message
3673 @vindex wl-summary-no-subject-message
3674 The initial setting is @samp{(WL:No Subject in original.)}. A string
3675 which is displayed when there's no @samp{Subject:} field in the message.
3677 @item wl-summary-use-frame
3678 @vindex wl-summary-use-frame
3679 The initial setting is @code{nil}.
3680 If non-nil, use new frame for the summary.
3682 @item wl-use-folder-petname
3683 @vindex wl-use-folder-petname
3684 The initial setting is the list shown below:
3693 A list of display policy (symbol) of folder nickname. Available symbols
3698 Display folder petname on modeline.
3700 Destination folder is notified as nickname if
3701 @code{wl-auto-select-next} is non-nil.
3703 You can input folder name by nickname in the function
3704 @code{wl-summary-read-folder}.
3707 @item wl-summary-move-direction-toggle
3708 @vindex wl-summary-move-direction-toggle
3709 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3710 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3711 want to aware of reading direction, set this to @code{t}.
3713 @item wl-summary-width
3714 @vindex wl-summary-width
3715 The initial setting is 80.
3716 Width of summary line. If @code{nil}, summary line's width is as is.
3718 @item wl-summary-from-width
3719 @vindex wl-summary-from-width
3720 The initial setting is 17.
3721 Width of sender part of summary line.
3723 @item wl-summary-subject-length-limit
3724 @vindex wl-summary-subject-length-limit
3725 The initial setting is @code{nil}. Specify the limit for the length of
3726 subject parts in summary. @code{nil} means unlimited.
3728 @item wl-summary-indent-length-limit
3729 @vindex wl-summary-indent-length-limit
3730 The initial setting is 46.
3731 Specify the limit of thread indent level. @code{nil} means unlimited
3733 If you set this to @code{nil} you should set @code{wl-summary-width}
3736 @item wl-summary-recenter
3737 @vindex wl-summary-recenter
3738 The initial setting is t.
3739 If non-nil, cursor point is moved to the center of the summary window.
3741 @item wl-summary-divide-thread-when-subject-changed
3742 @vindex wl-summary-divide-thread-when-subject-changed
3743 The initial setting is @code{nil}. If non-nil, thread is split if
3744 the subject is changed.
3746 @item wl-summary-search-via-nntp
3747 @vindex wl-summary-search-via-nntp
3748 The initial setting is @code{confirm}.
3750 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3751 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3752 from the NNTP server @code{elmo-nntp-default-server}. The value of
3753 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3754 @code{elmo-nntp-default-stream-type} are used.
3756 If @code{confirm}, server name can be specified. You can specify NNTP
3757 folder format like @samp{-:username@@servername:119!}.
3759 @item wl-summary-keep-cursor-command
3760 @vindex wl-summary-keep-cursor-command
3761 The initial setting is the list shown below:
3765 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3770 When you entered to summary by these commands and the target summary
3771 buffer already exists, summary status is not automatically updated and
3772 cursor position is saved.
3774 @item elmo-folder-update-threshold
3775 @vindex elmo-folder-update-threshold
3776 The initial setting is 500. If updated message number is larger than
3777 this value, confirm whether drop them or not (in the case where the value
3778 of @code{elmo-folder-update-confirm} is non-nil).
3780 @item elmo-folder-update-confirm
3781 @vindex elmo-folder-update-confirm
3782 The initial setting is @code{t}. If the value is non-nil, do check with
3783 @code{elmo-folder-update-threshold}.
3785 @item wl-summary-always-sticky-folder-list
3786 @vindex wl-summary-always-sticky-folder-list
3787 The initial setting is @code{nil}.
3788 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3789 are automatically stuck. Each element is regexp of folder name.
3791 @item wl-summary-reserve-mark-list
3792 @vindex wl-summary-reserve-mark-list
3793 The initial setting is the list shown below:
3802 If a message is already marked as temporal marks in this list, the
3803 message is not marked by any mark command.
3805 @item wl-summary-skip-mark-list
3806 @vindex wl-summary-skip-mark-list
3807 The initial setting is the list shown below:
3816 If a message is already marked as temporal marks in this list, the
3817 message is skipped at cursor move.
3819 @item elmo-message-fetch-threshold
3820 @vindex elmo-message-fetch-threshold
3821 The initial setting is 30000 (bytes). If displaying message has larger
3822 size than this value, Wanderlust confirms whether fetch the message or
3823 not (in the case where the value of @code{elmo-message-fetch-confirm}
3826 @item elmo-message-fetch-confirm
3827 @vindex elmo-message-fetch-confirm
3828 The initial setting is @code{t}. If the value is non-nil, do check with
3829 @code{elmo-message-fetch-threshold}.
3831 @item wl-prefetch-threshold
3832 @vindex wl-prefetch-threshold
3833 The initial setting is 30000 (bytes). If prefetching message has larger
3834 size than this value and @code{wl-prefetch-confirm} is non-nil,
3835 Wanderlust confirms whether prefetch the message or not. If
3836 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3837 without confirmation.
3839 @item wl-prefetch-confirm
3840 @vindex wl-prefetch-confirm
3841 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3842 prefetch the message or not if the message has larger size than
3843 @code{wl-prefetch-threshold}.
3845 @item elmo-imap4-use-cache
3846 @vindex elmo-imap4-use-cache
3847 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3850 @item elmo-nntp-use-cache
3851 @vindex elmo-nntp-use-cache
3852 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3855 @item elmo-pop3-use-cache
3856 @vindex elmo-pop3-use-cache
3857 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3860 @item elmo-shimbun-use-cache
3861 @vindex elmo-shimbun-use-cache
3862 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3865 @item wl-folder-process-duplicates-alist
3866 @vindex wl-folder-process-duplicates-alist
3867 The initial setting is @code{nil}.
3868 This list determines how to deal with duplicated messages in the same folder.
3869 Each item in the list is regexp of folder name and action; you can specify any
3870 one of the following in the place of action:
3873 @code{nil} : do nothing for duplicated messages.
3874 @code{hide} : hide duplicated messages from the summary.
3875 @code{read} : set duplicated messages as read.
3879 Following is an example (hide duplicated messages in multi folders)
3883 (setq wl-folder-process-duplicates-alist
3884 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3885 ("^\\*.*" . hide) (".*" . read)))
3891 @node Message, Draft, Summary, Top
3892 @chapter Message Buffer
3894 Message Buffers utilize MIME-View mode of SEMI. For operational
3895 procedures and key bindings, refer to respective documents.
3896 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3897 You can also see help by @kbd{?} in message buffer.
3899 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3900 brings you back to Summary mode. @kbd{l} toggles display of Summary
3903 @section Key Bindings
3909 @findex wl-message-toggle-disp-summary
3910 Toggles display of Summary mode buffer.
3911 (@code{wl-message-toggle-disp-summary})
3914 @findex wl-message-refer-article-or-url
3915 @kindex Button-2 (Message)
3916 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3917 corresponding message if found.
3918 (@code{wl-message-refer-article-or-url})
3920 @item Button-4 (upward movement of a wheel)
3921 @kindex Button-4 (Message)
3922 @findex wl-message-wheel-down
3923 Scrolls the message backwards. When the top of the message is hit,
3924 moves to the previous message.
3925 (@code{wl-message-wheel-down})
3927 @item Button-5 (downward movement of a wheel)
3928 @kindex Button-5 (Message)
3929 @findex wl-message-wheel-up
3930 Scrolls the message forward. When the bottom of the message is hit,
3931 moves to the next message.
3932 (@code{wl-message-wheel-up})
3935 @section Customizable Variables
3938 @item wl-message-window-size
3939 @vindex wl-message-window-size
3940 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3941 its car and cdr value corresponds to the ratio of Summary and Message
3944 @item wl-message-ignored-field-list
3945 @vindex wl-message-ignored-field-list
3946 (SEMI only) Initial setting is @code{nil}.
3947 All fields that match this list will be hidden in message buffer.
3948 Each elements are regexp of field-name.
3949 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3951 @item wl-message-visible-field-list
3952 @vindex wl-message-visible-field-list
3953 (SEMI only) Initial setting is @code{nil}.
3954 All fields that match this list will be display in message buffer.
3955 Each elements are regexp of field-name. This value precedes
3956 @code{wl-message-ignored-field-list}.
3957 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3959 @item wl-message-sort-field-list
3960 @vindex wl-message-sort-field-list
3961 (SEMI only) Initial setting is
3962 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3963 Header fields in message buffer are ordered by this value.
3964 Each elements are regexp of field-name.
3966 @item wl-message-truncate-lines
3967 @vindex wl-message-truncate-lines
3968 The initial value is the value of @code{default-truncate-lines}.
3969 If it is non-nil, truncate long lines in message buffer.
3972 @node Draft, Disconnected Operations, Message, Top
3973 @chapter Draft Buffer
3975 At Summary mode, pressing @kbd{w} and the like creates a new draft
3976 buffer. You can edit and send mail and news articles in this buffer.
3980 Basically it is Emacs-standard mail mode.
3982 @subsection Address Completion
3984 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3985 addresses. @kbd{@key{TAB}} completes them.
3987 If you want to submit a news article, add @samp{Newsgroups:} field by
3988 yourself. Field names can be completed by @kbd{@key{TAB}}.
3990 If you save the draft buffer you are editing, it is appended to the
3991 folder specified by @code{wl-draft-folder}.
3993 Using @samp{FCC:} field, you can specify the folder to which a copy of
3994 the message is saved when it is sent.
3996 @subsection Editing Messages
3998 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
3999 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4000 a MIME user interface for GNU Emacs}.
4001 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4003 @subsection Dynamic Modification of Messages
4004 @vindex wl-draft-config-alist
4005 @c @cindex Change Message
4006 @c @cindex Message, Change Dynamic
4008 You can set @code{wl-draft-config-alist} so that header and body of the
4009 message will automatically modified depending on information of header
4012 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4014 In the example below, the header is modified when
4015 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4016 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4017 before sending the message.
4021 (setq wl-draft-config-alist
4022 '(((string-match "aaa\\.example\\.com$" (system-name))
4023 ;; @r{applied if the expression is non-nil}
4024 (wl-smtp-posting-server . "mailserver-B")
4025 (wl-nntp-posting-server . "newsserver-B")
4026 ;; @r{settings of temporary variables}
4028 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4029 ;; @r{applied if it matches the header of the draft buffer}
4030 ("Organization" . (format "Go %s" my-webpage)))
4031 ;; @r{you can write elisp expressions here (eval only)}
4032 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4033 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4038 The format of @code{wl-draft-config-alist} is:
4042 '(("@var{regexp of the header}" or @var{elisp expression}
4043 ("@var{Field}" . value(@var{elisp expression}))
4044 (@var{variable} . value(@var{elisp expression}))
4045 (@var{sub-function} . value(@var{elisp expression}))
4048 ("@var{regexp of the header}" or @var{elisp expression}
4049 ("@var{Field}" . value(@var{elisp expression}))
4054 Per default, there are 10 following sub-functions.
4057 'header: Inserts the specified string at the bottom of the header.
4058 'header-top: Inserts the specified string at the top of the header.
4059 'header-file: Inserts the specified file at the bottom of the header.
4060 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4061 'top: Inserts the specified string at the top of the body.
4062 'top-file: Inserts the specified file at the top of the body.
4063 'body: Replaces the body with the specified string.
4064 Specifying @code{nil} deletes the entire body string.
4065 'body-file: Replaces the body with the content of the specified file.
4066 'bottom: Inserts the specified string at the bottom of the body.
4067 'bottom-file: Inserts the specified file at the top of the body.
4068 'part-top: Inserts the specified string at the top of the current part.
4069 'part-bottom: Inserts the specified string at the bottom of the current part.
4070 'template: Applies the specified template.
4071 (refer to the next subsection)
4074 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4075 change them or add your own functions. If you read the code, you can
4076 easily find how to write the functions.
4078 At the first of each item, @var{a regular expression of the header} or
4079 an @var{elisp expression} should be specified. In the case of an elisp
4080 expression, the item is applied when the expression is evaluated
4083 Per default, when multiple items match or are evaluated non-nil, all
4084 such items are applied, but if you set a variable
4085 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4088 At the second of the item, a cons or a list of functions should be
4089 specified. The car part of the cons should be a header field, a
4090 variable, or a sub-function. When a header field is specified, the
4091 field will be modified. If a variable is specified, the value of the
4092 variable will be modified temporarily.
4094 In the cdr part of a cons, not only a variable but also an elisp
4095 expression can be specified as is. If the car part is a header field
4096 and the cdr part is @code{nil}, the field will be deleted.
4098 If you want to use name of parent folder, you can refer the buffer local
4099 variable @code{wl-draft-parent-folder}.
4101 See the next example as well:
4105 (setq wl-draft-config-alist
4107 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4108 ;; @r{applied if it matches the header of the buffer being replied}
4109 (body . " Hello.\n")
4110 (template . "default")
4115 As in the (1) above, if a header regexp is prepended with @code{reply},
4116 it is applied when the draft is prepared by @code{wl-summary-reply} for
4117 example, and when it matches the header being replied. It is ignored
4118 when there is no buffer being replied, like after @code{wl-draft} was
4121 Note that @code{wl-draft-config-alist} is applied only once when
4122 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4123 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4124 aborting transmission, execute @kbd{C-c C-e}
4125 (@code{wl-draft-config-exec}) explicitly.
4127 If you don't want to apply @code{wl-draft-config-alist} when
4128 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4132 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4135 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4136 prepared, do the following:
4139 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4142 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4143 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4147 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4150 @subsection Inserting Templates
4152 @cindex Apply Template
4154 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4155 @kbd{M-x wl-template-select} in the draft buffer.
4157 The format of @code{wl-template-alist} is almost the same as
4158 @code{wl-draft-config-alist}.
4162 (setq wl-template-alist
4165 ("Organization" . "Example Co.Ltd.")
4166 (body . "Hello.\n"))
4168 (template . "default") ;; @r{(a)}
4169 ("To" . "boss@@example.com")
4170 ("Subject" . "Report")
4171 (body-file . "~/work/report.txt")
4177 As you can see, the only difference is item (template) names such as
4178 @samp{default} and @samp{report}, instead of a regexp of header.
4179 Because definition of each item is the same as
4180 @code{wl-draft-config-alist}, you can call another template, like (a).
4182 Executing the command @code{wl-template-select} results in template
4183 selection, but the result differs depending on variable
4184 @code{wl-template-visible-select}.
4186 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4187 window is shown below the draft buffer. You can select a template by
4188 @kbd{n} and @kbd{p} seeing the buffer window.
4190 Press the @key{RET} key and the template is actually applied to the draft
4191 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4192 adjust the window size by @code{wl-template-buffer-lines}.
4194 If @code{wl-template-visible-select} is @code{nil}, you should type the
4195 name of the template in the mini buffer.
4197 As shown in the example in @code{wl-draft-config-alist}, you can select
4198 @samp{default} template by writing:
4201 (template . "default")
4204 @subsection Sending mail by POP-before-SMTP
4205 @cindex POP-before-SMTP
4207 You can send mail by POP-before-SMTP with this single line:
4210 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4214 Configure the following variables if you need.
4217 @item wl-pop-before-smtp-user
4218 The POP user name for POP-before-SMTP authentication.
4219 If unset, @code{elmo-pop3-default-user} is used.
4221 @item wl-pop-before-smtp-server
4222 The POP server name for POP-before-SMTP authentication.
4223 If unset, @code{elmo-pop3-default-server} is used.
4225 @item wl-pop-before-smtp-authenticate-type
4226 The POP authentication method for POP-before-SMTP authentication.
4227 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4229 @item wl-pop-before-smtp-port
4230 The POP port number for POP-before-SMTP authentication.
4231 If unset, @code{elmo-pop3-default-port} is used.
4233 @item wl-pop-before-smtp-stream-type
4234 If non-nil, POP connection is established using SSL. If
4235 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4236 unset, @code{elmo-pop3-default-stream-type} is used.
4239 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4240 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4242 Therefore, if SMTP server and POP server are actually the same, and if
4243 POP folder per default (such as @samp{&}) is available, no settings are
4246 Refer to the following URL about POP-before-SMTP.
4250 http://spam.ayamura.org/tools/smPbS.html
4251 http://www.iecc.com/pop-before-smtp.html
4255 @section Key Bindings
4256 @cindex Keybind, Draft Mode
4257 @cindex Keybind, Draft Buffer
4262 @kindex C-c C-y (Draft)
4263 @findex wl-draft-yank-original
4264 Cites the content of the current message buffer.
4265 (@code{wl-draft-yank-original})
4268 @kindex C-c C-p (Draft)
4269 @findex wl-draft-preview-message
4270 Previews the content of the current draft.
4271 This is useful for previewing MIME multi-part messages.
4272 (@code{wl-draft-preview-message})
4275 @kindex C-c C-s (Draft)
4276 @findex wl-draft-send
4277 Sends the content of the current draft. Does not erase the draft buffer.
4278 This is useful for sending multiple messages, which are a little different
4280 (@code{wl-draft-send})
4283 @kindex C-c C-c (Draft)
4284 @findex wl-draft-send-and-exit
4285 Sends the content of the current draft and erases the draft buffer.
4286 (@code{wl-draft-send-and-exit})
4289 @kindex C-x C-s (Draft)
4290 @findex wl-draft-save
4291 Save the current draft.
4292 (@code{wl-draft-save})
4295 @kindex C-c C-k (Draft)
4296 @findex wl-draft-kill
4297 Kills the current draft.
4298 (@code{wl-draft-kill})
4301 @kindex C-x k (Draft)
4302 @findex wl-draft-mimic-kill-buffer
4303 Kills the current draft.
4304 (@code{wl-draft-mimic-kill-buffer})
4307 @kindex C-c C-z (Draft)
4308 @findex wl-draft-save-and-exit
4309 Saves the current draft, and erases the draft buffer.
4310 This is useful if you want to suspend editing of the draft.
4311 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4312 the @samp{+draft} folder.
4313 (@code{wl-draft-save-and-exit})
4316 @kindex C-c C-r (Draft)
4317 @findex wl-caesar-region
4318 Encodes or decodes the specified region in Caesar cipher.
4319 (@code{wl-caesar-region})
4323 @findex wl-draft-highlight-and-recenter
4324 Recenter and rehighlight current draft.
4325 (@code{wl-draft-highlight-and-recenter})
4329 @findex wl-toggle-plugged
4330 Toggles off-line/on-line states of Wanderlust.
4331 (@code{wl-toggle-plugged})
4334 @kindex C-c C-o (Draft)
4335 @findex wl-jump-to-draft-buffer
4336 Jumps to the other draft buffer, if exists.
4337 With prefix argument, reads a file (if any) from the draft folder when
4338 there is no such buffer.
4339 (@code{wl-jump-to-draft-buffer})
4342 @kindex C-c C-e (Draft)
4343 @findex wl-draft-config-exec
4344 Applies @code{wl-draft-config-alist}.
4345 (@code{wl-draft-config-exec})
4348 @kindex C-c C-j (Draft)
4349 @findex wl-template-select
4351 (@code{wl-template-select})
4354 @kindex C-c C-a (Draft)
4356 Enter Address Manager.
4357 @xref{Address Manager}.
4361 @kindex C-c C-d (Draft)
4362 @findex wl-draft-elide-region
4363 Elide the text between point and mark (@code{wl-draft-elide-region}).
4364 The text is killed and replaced with the contents of the variable
4365 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4369 @section Customizable Variables
4372 @item wl-subscribed-mailing-list
4373 @vindex wl-subscribed-mailing-list
4374 The initial setting is @code{nil}. Mailing lists to which you
4375 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4376 field of a reply draft, removes your own address from
4377 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4378 contained in @samp{To:} or @samp{Cc:} field of a message to be
4379 automatically re-filed, the destination folder will be leaned in
4380 connection with the address.
4386 (setq wl-subscribed-mailing-list
4387 '("wl@@lists.airs.net"
4389 "emacs-mime-ja@@m17n.org"))
4393 @item wl-insert-mail-followup-to
4394 @vindex wl-insert-mail-followup-to
4395 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4396 field is automatically inserted in the draft buffer.
4398 @item wl-insert-mail-reply-to
4399 @vindex wl-insert-mail-reply-to
4400 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4401 field is automatically inserted in the draft buffer.
4403 @item wl-auto-insert-x-face
4404 @vindex wl-auto-insert-x-face
4405 The initial setting is @code{t}. If non-nil and there is an encoded
4406 X-Face string in a file @file{~/.xface} (the value of the variable
4407 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4408 draft buffer. If @code{nil}, it is not automatically inserted.
4410 @item wl-insert-message-id
4411 @vindex wl-insert-message-id
4412 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4413 is automatically inserted on the transmission.
4415 @item wl-message-id-use-wl-from
4416 @vindex wl-message-id-use-wl-from
4417 The initial setting is @code{nil}. If non-nil, the value of
4418 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4420 @item wl-local-domain
4421 @vindex wl-local-domain
4422 The initial setting is @code{nil}. If @code{nil}, the return value of
4423 the function @code{system-name} will be used as the domain part of
4426 If @code{system-name} does not return FQDN (i.e. the full name of the
4427 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4428 to the string of the local domain name without hostname (like
4429 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4430 @samp{.} @code{wl-local-domain} is used as domain part of the
4433 If your terminal does not have global IP, set the value of
4434 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4435 you use invalid @samp{Message-ID:}.)
4437 Moreover, concatenation of @code{system-name} @samp{.}
4438 @code{wl-local-domain} will be used as an argument to the HELO command
4441 @item wl-message-id-domain
4442 @vindex wl-message-id-domain
4443 The initial setting is @code{nil}. If non-nil, this value is used as a
4444 domain part of the @samp{Message-ID:}. If your terminal does not have
4445 global IP address, set unique string to this value (e.x. your e-mail
4448 @item wl-unique-id-suffix
4449 @vindex wl-unique-id-suffix
4450 The initial setting is @samp{.wl}. You can specify the string in generated
4451 Message-ID which appear just before @samp{@@}.
4453 @item wl-draft-config-alist
4454 @vindex wl-draft-config-alist
4455 The initial setting is @code{nil}. Modifies the draft message just
4456 before the transmission. The content of @code{wl-draft-config-alist}
4457 will be automatically applied only once on the transmission. If you
4458 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4461 @item wl-template-alist
4462 @vindex wl-template-alist
4463 The initial setting is @code{nil}.
4464 This variable specifies the template to be applied in the draft buffer.
4466 @item wl-draft-config-matchone
4467 @vindex wl-draft-config-matchone
4468 The initial setting is @code{nil}. If non-nil, only the first matching
4469 item is used when @code{wl-draft-config-alist} is applied. If
4470 @code{nil}, all matching items are used.
4472 @item wl-template-visible-select
4473 @vindex wl-template-visible-select
4474 The initial setting is @code{t}.
4475 If non-nil, you can preview the result of the template selection in
4478 @item wl-template-confirm
4479 @vindex wl-template-confirm
4480 The initial setting is @code{nil}.
4481 If non-nil, asks for confirmation when you press the enter key to select
4482 template while previewing.
4484 @item wl-template-buffer-lines
4485 @vindex wl-template-buffer-lines
4486 The initial setting is 7.
4487 If @code{wl-template-visible-select} is non-nil, this variable specifies
4488 the size of the preview window.
4490 @item wl-draft-reply-buffer-style
4491 @vindex wl-draft-reply-buffer-style
4492 The initial setting is @code{split}. @code{split} or @code{full} can be
4493 specified. In the case of @code{full}, the whole frame will be used for
4494 a reply draft buffer when it is prepared.
4496 @item wl-draft-use-frame
4497 @vindex wl-draft-use-frame
4498 The initial setting is @code{nil}.
4499 If non-nil, use new frame for the draft.
4501 @item wl-draft-truncate-lines
4502 @vindex wl-draft-truncate-lines
4503 The initial value is the value of @code{default-truncate-lines}.
4504 If it is non-nil, truncate long lines in draft buffer.
4508 The initial setting is the value of the variable
4509 @code{user-mail-address}. The value of this variable is inserted as a
4510 @samp{From:} field of the draft when it is prepared.
4512 @item wl-envelope-from
4513 @vindex wl-envelope-from
4514 The initial setting is @code{nil}.
4515 The value of this variable is used for envelope from (MAIL FROM).
4516 If @code{nil}, the address part of @code{wl-from} is used.
4518 @item wl-user-mail-address-list
4519 @vindex wl-user-mail-address-list
4520 The initial setting is @code{nil}.
4521 This is the User's address list. If you have multiple addresses,
4526 The initial setting is @code{nil}.
4527 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4528 the draft when it is prepared. If function is specified, its return
4533 The initial setting is @code{nil}.
4534 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4535 the draft when it is prepared.
4537 @item wl-reply-subject-prefix
4538 @vindex wl-reply-subject-prefix
4539 The initial setting is @samp{Re: }.
4540 In the @samp{Subject:} of the reply draft, this string is prepended to
4541 the @samp{Subject:} of being replied.
4543 @item wl-draft-reply-use-address-with-full-name
4544 @vindex wl-draft-reply-use-address-with-full-name
4545 The initial setting is @code{t}.
4546 If non-nil, insert her full name with address when prepare a draft for
4547 reply a message. If it is @code{nil}, insert her address only.
4549 @item wl-draft-enable-queuing
4550 @vindex wl-draft-enable-queuing
4551 The initial setting is @code{t}.
4552 This flag controls off-line transmission. If non-nil, the draft is
4555 @item wl-draft-use-cache
4556 @vindex wl-draft-use-cache
4557 The initial setting is @code{nil}. If the value is non-nil and
4558 @code{wl-insert-message-id} is nil, cache the message which is sent.
4560 @item wl-fcc-force-as-read
4561 @vindex wl-fcc-force-as-read
4562 The initial setting is @code{nil}. If the value is non-nil,
4563 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4565 @item wl-auto-flush-queue
4566 @vindex wl-auto-flush-queue
4567 The initial setting is t.
4568 This flag controls automatic transmission of the queue when Wanderlust
4569 becomes on-line. If non-nil, the queue is automatically transmitted
4570 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4571 manually, press @kbd{F} in the folder mode.
4573 @item wl-ignored-forwarded-headers
4574 @vindex wl-ignored-forwarded-headers
4575 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4576 All headers that match this regexp will be deleted when forwarding a message.
4578 @item wl-ignored-resent-headers
4579 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4580 All headers that match this regexp will be deleted when resending a message.
4582 @item wl-draft-always-delete-myself
4583 @vindex wl-draft-always-delete-myself
4584 If non-nil, always removes your own address from @samp{To:} and
4585 @samp{Cc:} when you are replying to the mail addressed to you.
4587 @item wl-draft-delete-myself-from-bcc-fcc
4588 @vindex wl-draft-delete-myself-from-bcc-fcc
4589 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4590 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4592 @item wl-smtp-posting-server
4593 @vindex wl-smtp-posting-server
4594 The initial setting is @code{nil}.
4595 This is the SMTP server name for mail transmission.
4597 @item wl-smtp-posting-user
4598 @vindex wl-smtp-posting-user
4599 The initial setting is @code{nil}.
4600 This is the user name for SMTP AUTH authentication. If @code{nil},
4601 @code{smtp-authenticate-user} is used.
4603 @item wl-smtp-authenticate-type
4604 @vindex wl-smtp-authenticate-type
4605 The initial setting is @code{nil}.
4606 This is the authentication method for SMTP AUTH authentication. If
4607 @code{nil}, @code{smtp-authenticate-type} is used. If
4608 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4611 @item wl-smtp-connection-type
4612 @vindex wl-smtp-connection-type
4613 The initial setting is @code{nil}.
4614 This variable specifies how to establish SMTP connections.
4615 If @code{nil}, @code{smtp-connection-type} is used.
4616 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4618 @item wl-nntp-posting-server
4619 @vindex wl-nntp-posting-server
4620 The initial setting is @code{nil}.
4621 This is the NNTP server name used for news submission.
4622 If @code{nil}, @code{elmo-nntp-default-server} is used.
4624 @item wl-nntp-posting-user
4625 @vindex wl-nntp-posting-user
4626 The initial setting is @code{nil}.
4627 This is the user name for AUTHINFO authentication on news submission.
4628 If @code{nil}, @code{elmo-nntp-default-user} is used.
4629 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4631 @item wl-nntp-posting-port
4632 @vindex wl-nntp-posting-port
4633 The initial setting is @code{nil}.
4634 This is the port number of the NNTP server used for news submission.
4635 If @code{nil}, @code{elmo-nntp-default-server} is used.
4637 @item wl-nntp-posting-stream-type
4638 @vindex wl-nntp-posting-stream-type
4639 The initial setting is @code{nil}.
4640 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4641 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4642 connection will be established.
4644 @item wl-pop-before-smtp-user
4645 @vindex wl-pop-before-smtp-user
4646 The initial setting is @code{nil}.
4647 This is the POP user name for POP-before-SMTP.
4648 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4650 @item wl-pop-before-smtp-server
4651 @vindex wl-pop-before-smtp-server
4652 The initial setting is @code{nil}.
4653 This is the POP server name for POP-before-SMTP.
4654 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4656 @item wl-pop-before-smtp-authenticate-type
4657 @vindex wl-pop-before-smtp-authenticate-type
4658 The initial setting is @code{nil}.
4659 This is the authentication method for POP-before-SMTP authentication.
4660 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4662 @item wl-pop-before-smtp-port
4663 @vindex wl-pop-before-smtp-port
4664 The initial setting is @code{nil}.
4665 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4666 @code{elmo-pop3-default-port} is used.
4668 @item wl-pop-before-smtp-stream-type
4669 @vindex wl-pop-before-smtp-stream-type
4670 The initial setting is @code{nil}.
4671 This flag controls the use of SSL for POP-before-SMTP. If it is
4672 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4673 STARTTLS (RFC2595) connection will be established.
4675 @item wl-draft-queue-save-variables
4676 @vindex wl-draft-queue-save-variables
4677 Specifies a list of variable to which queued messages are saved on the
4678 off-line transmission.
4680 @item wl-draft-sendlog
4681 @vindex wl-draft-sendlog
4682 The initial setting is @code{t}.
4683 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4687 @item drafts are sent by smtp or qmail
4688 @item saved into folders by fcc
4689 @item saved into folders by queuing
4692 (it is written even if the transmission fails).
4693 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4694 and left to the logging function of @command{imput}.
4697 @item wl-draft-sendlog-max-size
4698 @vindex wl-draft-sendlog-max-size
4699 The initial setting is 20000 (in bytes).
4700 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4701 beyond the size specified by this variable.
4705 The initial setting is @code{nil}.
4706 If non-nil, address completion uses LDAP.
4708 @item wl-ldap-server
4709 @vindex wl-ldap-server
4710 The initial setting is @samp{localhost}.
4711 LDAP server name for address completion.
4714 @vindex wl-ldap-port
4715 The initial setting is @code{nil}.
4716 If non-nil, the value is used as port number.
4719 @vindex wl-ldap-base
4720 The initial setting is @samp{c=US}.
4721 LDAP search starting point (base) for address completion.
4723 @item wl-draft-remove-group-list-contents
4724 @vindex wl-draft-remove-group-list-contents
4725 The initial setting is @code{t}.
4726 If non-nil, remove the group-lists' members in the recipients when
4727 sending the message (group-list means the description such as
4728 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4731 @node Disconnected Operations, Expire and Archive, Draft, Top
4732 @chapter Off-line Management
4733 @cindex Disconnected Operations
4735 Wanderlust has on-line and off-line states.
4738 * Off-line State:: Wanderlust has on-line and off-line states
4739 * Enable Operations:: Enable Disconnected Operations
4740 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4741 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4742 * Variables of Plugged Mode:: Customize Plugged Mode
4746 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4747 @section Off-line State
4749 Wanderlust has on-line and off-line states. In the off-line state, you
4750 cannot access messages via network, unless they are cached.
4752 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4753 in the mode line indicates the off-line state. In folder or summary
4754 modes, press @kbd{M-t} to switch between off- and on-line.
4756 You can invoke Wanderlust in the off-line state by setting
4757 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4759 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4760 ignores uncached messages.
4763 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4764 @section Enable Disconeected Operations
4766 Even in the off-line state, provided that relevant messages are cached,
4767 and the variable @code{elmo-enable-disconnected-operation} (described
4768 later) is non-nil, you can following operations:
4769 @xref{Plugged Mode}, @xref{Off-line State settings}.
4772 * Send Messages off-line:: Transmit Messages
4773 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4774 * Creation of Folders:: Create Folders off-line (IMAP4)
4775 * Marking:: Mark (IMAP4)
4776 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4779 As soon as Wanderlust becomes on-line, such operations invoked off-line
4780 are reflected in the servers via network.
4783 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4784 @subsection Transmission of Messages
4786 You can send mail/news messages off-line (if you are using
4787 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4788 accumulated in the queue folder, @samp{+queue}. These messages are
4789 transmitted at once when Wanderlust becomes on-line.
4791 You can visit @samp{+queue} in the off-line state and confirm content of
4792 messages in the queue. You can also remove messages. Removed messages
4793 are not transmitted even in the on-line state.
4796 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4797 @subsection Re-file and Copy (IMAP4)
4799 Re-file and copy operations to IMAP folders invoked during the off-line
4800 state are accumulated in the queue, and reflected in the server side
4801 when Wanderlust becomes on-line. If you visit destination folders after
4802 off-line re-file or copy, it looks as if messages were appended even in
4805 For the safety reasons, messages re-filed off-line are removed from
4806 source folders only if their @samp{Message-ID:} match messages on the
4807 servers. While the queue is processed, messages that failed to be
4808 re-filed or copied to the specified folders are appended to the folder
4812 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4813 @subsection Creation of Folders (IMAP4)
4815 You can create IMAP folders off-line. The creation of folders are
4816 reflected in the servers when Wanderlust becomes on-line. At that time,
4817 if folders failed to be created on the servers for any reasons, messages
4818 re-filed to such folders are appended to the folder @samp{+lost+found}.
4821 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4822 @subsection Marking (IMAP4)
4824 Off-line changes in unread/read and importance mark @samp{$} information
4825 are also reflected in the servers when Wanderlust becomes on-line.
4828 @node Pre-fetching Reservations, , Marking, Enable Operations
4829 @subsection Pre-fetching (IMAP4, NNTP)
4831 You can make reservations for pre-fetching messages in IMAP or NNTP
4832 folders. Reserved messages are marked with @samp{!} but not cached
4833 yet. When Wanderlust becomes on-line, they are pre-fetched from
4836 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4837 these off-line operations for IMAP4 and NNTP do not take place, and
4838 off-line re-file, copy or suchlike simply results in error.
4840 Because off-line operations use cache files, it is a bad idea to erase
4841 them by hand; it may cause Wanderlust to malfunction.
4843 If you want to remove caches, be sure to execute @kbd{M-x
4844 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4845 remove caches for messages relevant to off-line operations.
4848 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4849 @section Switching On-line/Off-line per Server/Port
4851 @kbd{M-t} described above switches networking states as a whole, but you
4852 can switch on-line/off-line per server/port.
4854 Pressing @kbd{C-t} in the folder or summary modes brings you in
4855 wl-plugged-mode shown below, in which you can change the plugged state
4860 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4863 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4864 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4866 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4867 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4873 The first line indicates status of the following three variables, and
4874 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4875 column modifies the values of these variables.
4879 "Queuing" @code{wl-draft-enable-queuing}
4880 "AutoFlushQueue" @code{wl-auto-flush-queue}
4881 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4885 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4888 The second and after lines indicate on-line/off-line states of servers
4889 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4890 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4891 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4893 @dfn{sending queue} means messages accumulated in the folder
4894 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4895 off-line operations when @code{elmo-enable-disconnected-operation} is
4897 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4898 @c off-line operations are enabled.
4900 They are displayed if there are any of them. In the example above, in
4901 the sending queue there are two messages (the first and the second in
4902 the queue folder) for smtp to hosta and one (the third) for nntp to
4903 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4906 If you change @samp{(wl-plugged)} in the second line, the variable
4907 @code{wl-plugged} is changed, so that the mode line indicator and
4908 plugged states of all ports are affected. If you change plugged states
4909 of any servers or ports, @samp{(wl-plugged)} in the second line is
4910 affected depending on @code{elmo-plugged-condition} settings and the
4911 plugged state of each port.
4914 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4915 @section Invoking Wanderlust in the Off-line State
4917 As described before, if you set @code{wl-plugged} to @code{nil} in
4918 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4919 off-line state. You can specify off-line state on a per server or port
4920 basis. Refer to @code{wl-reset-plugged-alist} also.
4922 Usually, when Wanderlust starts up, the plugged state of each port is
4923 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4924 @code{wl-nntp-posting-server} and so on. If you want to change the
4925 plugged state of these ports or to add other ports, configure
4926 @code{wl-make-plugged-hook} with a function.
4930 (add-hook 'wl-make-plugged-hook
4932 (elmo-set-plugged plugged-value(t/nil) server port)
4933 ;; @r{add or change plugged states of the port of the server}
4934 (elmo-set-plugged plugged-value(t/nil) server)
4935 ;; @r{if the port is omitted, all ports are affected}
4936 ;; @r{(you cannot omit the port if you newly add the server)}
4942 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4943 @section Customizable Variables
4948 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4949 mode from the beginning.
4951 @item wl-queue-folder
4952 @vindex wl-queue-folder
4953 The initial setting is @samp{+queue}.
4954 This is the folder in which messages in the transmission queue are
4957 @item wl-auto-flush-queue
4958 @vindex wl-auto-flush-queue
4959 The initial setting is @code{t}.
4960 This flag controls automatic transmission of the queue when Wanderlust
4961 becomes on-line. If non-nil, the queue is automatically transmitted
4962 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4963 manually, press @kbd{F} in the folder mode.
4965 @item elmo-enable-disconnected-operation
4966 @vindex elmo-enable-disconnected-operation
4967 The initial setting is @code{nil}. Controls off-line operations
4968 regarding IMAP4. If non-nil, off-line operations are carried out.
4970 @item elmo-lost+found-folder
4971 @vindex elmo-lost+found-folder
4972 The initial setting is @samp{+lost+found}.
4973 This is the folder to which messages are saved when they fails to be
4974 appended while the off-line re-file/copy queue is processed.
4976 @item elmo-plugged-condition
4977 @vindex elmo-plugged-condition
4978 The initial setting is @code{one}.
4979 The value of @code{wl-plugged} reflects the return value of the function
4980 @code{elmo-plugged-p} (without arguments).
4981 This variable @code{elmo-plugged-condition} specifies the condition on
4982 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4983 plugged state of each port.
4986 'one : plugged if one or more ports are plugged.
4987 'all : plugged if all ports are plugged.
4988 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4989 states of the ports.
4990 @var{function} : reflects the return value of the @var{function}
4991 functions available per default
4992 'elmo-plug-on-by-servers
4993 : reflects the plugged state of the servers specified by the
4994 variable elmo-plug-on-servers.
4995 'elmo-plug-on-by-exclude-servers
4996 : reflects the plugged state of the servers that are not
4997 in elmo-plug-on-exclude-servers.
4998 elmo-plug-on-exclude-servers defaults to
5001 (system-name)without the domain part)
5007 (setq elmo-plugged-condition 'all)
5009 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5010 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5012 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5013 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5017 @item wl-reset-plugged-alist
5018 @vindex wl-reset-plugged-alist
5019 The initial setting is @code{t}. If non-nil, plugged states are
5020 initialized on a per server or port basis when Wanderlust starts up.
5022 If @code{nil}, plugged states are retained while Emacs is running. In
5023 other words, they are initialized when Emacs is restarted even if the
5024 value is @code{nil}.
5028 @node Expire and Archive, Scoring, Disconnected Operations, Top
5029 @chapter Automatic Expiration and Archiving of Messages
5030 @cindex Expire and Archive
5033 * Expire:: Expiration and Archiving
5034 * Archive:: Archiving All Messages
5038 @node Expire, Archive, Expire and Archive, Expire and Archive
5040 @cindex Expire Message
5042 Expiration means deletion of old messages which have outlasted a
5043 certain period of time.
5045 @code{wl-expire} supports not only simple deletion, but also moving to
5046 specified archiving folders.
5050 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5051 or @kbd{M-e} in the summary mode.
5053 @subsection Configuring @code{wl-expire-alist}
5055 An example configuration of @code{wl-expire-alist} is shown below.
5056 Everything in this @code{wl-expire-alist} makes a great difference in
5057 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5058 to @code{t}, especially in the initial stage.
5062 (setq wl-expire-alist
5063 '(("^\\+trash$" (date 14) remove)
5065 ("^\\+tmp$" (date 7) trash)
5066 ;; @r{re-file to @code{wl-trash-folder}}
5067 ("^\\+outbox$" (number 300) "$outbox;lha")
5068 ;; @r{re-file to the specific folder}
5070 ;; @r{do not expire}
5071 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5072 ;; @r{archive by message number (retaining numbers)}
5073 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5074 ;; @r{archive by a fixed number (retaining numbers)}
5075 ("^\\+diary$" (date 30) wl-expire-archive-date)
5076 ;; @r{archive by year and month (numbers discarded)}
5081 Items in the list has the format of:
5084 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5088 The folder is examined if it matches @var{regexp-for-folders} from the
5089 beginning of the list. If you invoke expiration on the folder that does
5090 not match any of them, nothing will happen. And if either the second or
5091 the third element of the item is @code{nil}, expiration will not take
5094 You can use any one of the following for
5095 @var{specification-of-message-to-be-deleted}:
5098 @item (number @var{n1} [@var{n2}])
5099 deletes messages depending on the number of messages in the folder.
5101 @var{n1} is the number of messages which should survive deletion, for example
5102 if its value is 500, the newest 500 messages survive and the rests are
5105 @var{n2} is the number of messages in the folder on which expiration should
5106 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5107 folders with 510 or more messages are expired.
5108 If you configured automatic expiration, frequently used folders may
5109 expire every time it receive messages, and you may be annoyed with the
5110 long delay in reading mail.
5111 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5112 expiration would not take place until a certain number of messages
5115 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5116 with important/new/unread) are not deleted.
5117 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5118 will expire so as to have 500 messages including such ones.
5119 Otherwise, it will have 500 messages except such ones.
5121 @item (date @var{d1})
5122 deletes messages depending on the dates.
5124 Messages dated @var{d1} or more days ago are deleted, for example if its
5125 value is seven, messages seven days old or more are deleted. Note that
5126 the date is the one in the @samp{Date:} field of the message, not when
5127 the message entered the folder.
5129 Messages with no or invalid @samp{Date:} field does not expire; you
5130 might have to delete them by hand.
5133 You can use any one of the following in the place of @var{destination}:
5137 deletes the messages instantly.
5140 hide the messages from summary (messages are not deleted).
5143 moves the messages to @code{wl-trash-folder}.
5145 @item @var{string}(folder)
5146 moves the messages to the folder specified with @var{string}.
5148 It would be useful for specifying an archiving folder, but because this
5149 does not move important messages, it might be better to use the
5150 standard functions described below.
5152 @item @var{function}
5153 invokes the specified @var{function}.
5155 To the @var{function}, three arguments are passed: a folder name, a list
5156 of messages to be deleted, and msgdb information of the summary. You
5157 can specify function-specific arguments after the name of the
5158 @var{function}. Note that the list contains messages with marks in
5159 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5162 These are four standard functions; three of them move messages to an archive
5163 folder in the specified way. This means old messages can be compressed
5164 and saved in a file, being deleted from the original folder.
5165 The last one divides messages to some MH folders.
5168 @item wl-expire-archive-number1
5169 re-files to archiving folders corresponding to the message numbers of
5170 the messages being deleted. For example, a message numbered 102 will be
5171 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5172 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5173 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5175 The archiving folders to which messages are re-filed are determined by
5176 the name of the folder as follows (in this case, archiving folders are
5177 handled as if @code{elmo-archive-treat-file} were non-nil).
5180 @item If the folder type is localdir:
5181 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5183 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5184 (@file{~/Mail/ml/wl-00100.zip}).
5186 @item The folder type is other than localdir:
5187 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5189 For example, @samp{%#mh/ml/wl} corresponds to
5190 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5193 As you can see, in the case of localdir, the folder type is not included
5194 in the path name, but otherwise it is included.
5195 And you can control the prefix to the archiving folder name by
5196 @code{wl-expire-archive-folder-prefix}.
5197 Refer to @code{wl-expire-archive-folder-prefix} for details.
5199 @item wl-expire-archive-number2
5200 re-files every certain number of messages to archiving folders.
5202 This differs from @samp{wl-expire-archive-number1} in that this re-files
5203 to the folder up to the specified number regardless of message numbers.
5204 The archiving folders to which messages are re-filed are determined in the
5205 same way as @code{wl-expire-archive-number1}.
5207 @item wl-expire-archive-date
5208 re-files messages depending on its date (year and month) to archive
5211 For example, a message dated December 1998 is re-filed to
5212 @code{$folder-199812;zip}. The name of the archiving folders except the
5213 date part are determined in the same way as
5214 @code{wl-expire-archive-number1}.
5217 You can set the first argument to these three standard functions to non-nil
5218 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5219 For example, it can be specified just after the name of the function:
5222 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5225 If you omit the argument, consecutive numbers from 1 are assigned for
5226 each archiving folder.
5228 @item wl-expire-localdir-date
5229 divedes messages depending on its date (year and month) to MH folders
5230 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5234 @subsection Treatment for Important or Unread Messages
5236 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5237 standard function, messages with marks in
5238 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5239 messages} thereafter) are retained.
5241 Per default, this variable include the important, new, and unread marks,
5242 so that messages with these marks are not removed.
5243 Note that you cannot include the temporary mark (i.e. temporary marks
5244 are removed anyway), and be sure to process temporary marks before you
5247 @subsection Auto Expiration
5249 The following setup invokes expiration when you move into the summary
5250 mode. There will be no confirmation, so make sure you made no mistake
5251 in regexp and other settings before you set up this.
5255 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5259 In the folder mode, you can invoke expiration per group as well as per
5260 folder. Therefore, if you specify @samp{Desktop} group, all folders
5261 matching @code{wl-expire-alist} expire.
5265 @subsection Treating archive folders.
5266 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5267 you must set non-nil value to @code{elmo-archive-treat-file}.
5269 @subsection Confirming
5271 If you are to use @code{remove}, try @code{trash} at first and see
5272 messages move to @code{wl-trash-folder} as expected, then replace it
5273 with @code{remove}. It would be dangerous to use @code{remove} from the
5276 If you are to use @code{wl-expire-archive-number1} and the like, try to
5277 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5278 you can append messages to it. Even if settings in
5279 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5280 would not be saved anywhere and disappeared in case the archiver program
5283 After you make sure you can archive to the folder correctly, you can
5284 invoke expiration and utilize the log.
5286 If you set @code{wl-expire-use-log} to @code{t},
5287 @file{~/.elmo/expired-log} should contain the log, for example:
5291 delete +ml/wl (593 594 595 596 597 598 599)
5292 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5296 The first column indicates the operation, i.e. @samp{delete},
5297 @samp{copy}, or @samp{move}. The next is the name of the folder that
5298 expired. In the case of @samp{copy} and @samp{move}, the destination
5299 folder is recorded after @samp{->}. The last is the list of message
5300 numbers that are actually deleted or moved (in the case of @samp{copy}
5301 and @samp{move}, the number is the one in the source folder, rather than
5302 the destination folder).
5304 @subsection Re-filing Reserved Messages
5306 The three standard functions copy reserved messages to the archive
5307 folder, but do not delete them from the source folder. Because
5308 reserved messages and the like always remain, they are recorded in
5309 @file{~/.elmo/expired-alist} so that they are not copied over and over
5310 again. They are not recorded if copied by @code{wl-summary-archive}.
5312 If you enabled logging, usually @samp{move} is recorded for re-filing,
5313 but instead @samp{copy} and @samp{delete} are recorded separately if
5314 reserved messages are involved. This is because it actually copies
5315 messages including reserved, then deletes ones except reserved in that
5318 @section Customizable Variables
5321 @item wl-expire-alist
5322 @vindex wl-expire-alist
5323 The initial setting is @code{nil}.
5324 This variable specifies folders and methods to expire. For details,
5325 refer to @code{wl-expire-alist} settings above.
5327 @item wl-summary-expire-reserve-marks
5328 @vindex wl-summary-expire-reserve-marks
5329 The initial setting is the list below.
5333 (list wl-summary-important-mark
5335 wl-summary-unread-mark
5336 wl-summary-unread-uncached-mark
5337 wl-summary-unread-cached-mark)
5341 Messages with these marks are retained in the folder, even after
5343 Only permanent marks can be listed, not temporary marks.
5345 You can list marks one by one as in the default; you can use the
5346 following settings as well:
5350 All messages with permanent marks are retained,
5351 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5355 All messages are handled as usual ones that are already read, no matter
5356 what marks they have; even important messages are deleted.
5359 @item wl-expire-archive-files
5360 @vindex wl-expire-archive-files
5361 The initial setting is 100.
5362 This variable specifies the number of messages to be retained in one
5365 @item wl-expire-number-with-reserve-marks
5366 @vindex wl-expire-number-with-reserve-marks
5367 The initial setting is @code{nil}.
5368 If non-nil, if expiring messages are specified by @code{number},
5369 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5371 @item wl-expire-archive-get-folder-function
5372 @vindex wl-expire-archive-get-folder-function
5373 The initial setting is @code{wl-expire-archive-get-folder}.
5375 This variable specifies a function that returns the name of an archiving
5376 folder for standard functions in the place of @var{destination}.
5377 You can use the following three variables for simple modification of
5378 folder names; if you want more complex settings, define your own
5379 function in this variable.
5381 @code{wl-expire-archive-get-folder} can be customized by these
5384 @item @code{wl-expire-archive-folder-name-fmt}
5385 @item @code{wl-expire-archive-folder-type}
5386 @item @code{wl-expire-archive-folder-prefix}
5389 @item wl-expire-archive-folder-name-fmt
5390 @vindex wl-expire-archive-folder-name-fmt
5391 The initial setting is @samp{%s-%%05d;%s}.
5392 This is a @code{format} string for archiving folders used in
5393 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5394 Note that you must specify the message number by @samp{%%d}, because it
5395 is parsed twice by @code{format}.
5397 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5400 @item wl-expire-archive-date-folder-name-fmt
5401 @vindex wl-expire-archive-date-folder-name-fmt
5402 The initial setting is @samp{%s-%%04d%%02d;%s}.
5403 This is a @code{format} string for archiving folders used in
5404 @code{wl-expire-archive-date}. Note that you must specify the message
5405 number by @samp{%%d}, because it is parsed twice by @code{format}.
5406 There should be @samp{%%d} twice, one for the year and the other for the
5409 If you modify this, adjust
5410 @code{wl-expire-archive-date-folder-num-regexp} as well.
5412 @item wl-expire-archive-folder-type
5413 @vindex wl-expire-archive-folder-type
5414 The initial setting is @code{zip}.
5415 This variable specifies an archiver type of the archiving folders.
5417 @item wl-expire-archive-folder-prefix
5418 @vindex wl-expire-archive-folder-prefix
5419 The initial setting is @code{nil}.
5420 This variable specifies the prefix (directory structure) to archiving
5422 Exercise extreme caution in using this feature, as it has not been
5424 In the worst case, there is a fear of destructing archiving folders.
5428 There will be no prefix.
5431 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5432 @samp{$ml/wl-00000;zip;wl}.
5435 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5438 @samp{$ml/wl-00000;zip;ml/wl}.
5441 @item wl-expire-archive-folder-num-regexp
5442 @vindex wl-expire-archive-folder-num-regexp
5443 The initial setting is @samp{-\\([-0-9]+\\);}.
5444 This variable specifies the regular expression to be used for getting
5445 message numbers from multiple archiving folders specified by
5446 @code{elmo-list-folders}.
5447 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5449 @item wl-expire-archive-date-folder-num-regexp
5450 @vindex wl-expire-archive-date-folder-num-regexp
5451 The initial setting is @samp{-\\([-0-9]+\\);}.
5452 This is the regular expression to be used for getting message numbers
5453 from multiple archiving folders specified by @code{elmo-list-folders}.
5454 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5456 @item wl-expire-delete-oldmsg-confirm
5457 @vindex wl-expire-delete-oldmsg-confirm
5458 The initial setting is @code{t}.
5459 If non-nil, messages older than the one with the largest number will be
5460 deleted with confirmation.
5461 If @code{nil}, they are deleted without confirmation.
5463 This feature is valid only if non-nil is specified as a argument to the
5464 standard functions so as to retain numbers.
5466 @item wl-expire-use-log
5467 @vindex wl-expire-use-log
5468 The initial setting is @code{nil}.
5469 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5470 They are appended but not truncated or rotated automatically; you might
5471 need to remove it manually.
5473 @item wl-expire-add-seen-list
5474 @vindex wl-expire-add-seen-list
5475 The initial setting is @code{t}.
5477 If non-nil, when messages are re-filed by expiration, read/unread
5478 information is passed to the destination folder.
5480 However if you do not read the destination folder from Wanderlust,
5481 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5482 want to set this to @code{nil} if you are simply saving to some
5483 archiving folders. Even if its value is @code{nil}, messages in the
5484 archiving folders are simply treated as unread; it does not affect
5487 @item wl-expire-folder-update-msgdb
5488 @vindex wl-expire-folder-update-msgdb
5489 The initial setting is @code{t}.
5490 If @code{t}, in the folder mode, expiration is carried out after
5491 updating summary information. If you specified a list of regular
5492 expressions of folder names, summary information is updated for matching
5497 @node Archive, , Expire, Expire and Archive
5498 @section Archiving Messages
5500 @subsection Archiving Messages
5501 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5502 folders. If there are the archiving folders already, only new messages
5505 You can use @code{wl-archive-alist} in order to specify how messages are
5506 archived according to their folder names, as in @code{wl-expire-alist}.
5511 (setq wl-archive-alist
5512 '(("^\\+tmp$" wl-archive-date)
5513 ("^\\+outbox$" wl-archive-number2)
5514 (".*" wl-archive-number1)))
5518 Each item in the list has the following format:
5521 (@var{folders-regexp} @var{deleting-function})
5524 As you can see, you can only use a function after @var{folders-regexp}.
5525 Per default, there are three functions:
5528 @item @code{wl-archive-number1}
5529 @item @code{wl-archive-number2}
5530 @item @code{wl-archive-date}
5533 As inferred from their names, they work similarly to "expire" versions,
5534 other than the following points:
5537 @item No messages are deleted
5538 @item Message numbers are retained even if invoked without arguments
5541 These functions are good to archive all messages in a folder by their
5542 numbers or by their dates.
5543 These are also useful for backup or confirmation purposes before
5545 If you try to re-file them after they are archived, they are deleted but
5548 Per default, the archiving folders to which messages are copied are
5549 determined automatically by @code{wl-expire-archive-get-folder-function}.
5550 You can copy to a specific folder by invoking with a prefix argument,
5551 i.e. @kbd{C-u M-x wl-summary-archive}.
5553 Note that this feature has not been seriously tested, because you can
5554 simply copy to an archiving folder, for example by
5555 @code{wl-summary-copy-region}.
5557 The archiving folders are determined by the same logic as in
5558 @code{wl-summary-expire}; the following customizable variables are
5562 @item @code{wl-expire-archive-files}
5563 @item @code{wl-expire-archive-get-folder-function}
5564 @item @code{wl-expire-archive-folder-name-fmt}
5565 @item @code{wl-expire-archive-folder-type}
5566 @item @code{wl-expire-archive-folder-prefix}
5567 @item @code{wl-expire-archive-folder-num-regexp}
5570 @subsection Customizable Variables
5573 @item wl-archive-alist
5574 @vindex wl-archive-alist
5575 The initial setting is the list shown below:
5579 ((".*" wl-archive-number1))
5584 This variable specifies a function that copies to archiving folders.
5585 To the function, three arguments are passed: a folder name, a list of
5586 messages in the folder, and msgdb information of the summary.
5587 Needless to say, you can use your own function.
5591 @node Scoring, Address Book, Expire and Archive, Top
5592 @chapter Score of the Messages
5594 @c @cindex Kill File
5596 Scoring is the function that associates a score (value) with each
5597 message, and marks as read or deletes from the summary according to it.
5599 You can put target or important marks on essential messages, or read marks
5600 on the ones you do not want to read, for example spam articles.
5602 This scoring function has a capability and a format similar to the one
5603 that Gnus has, although there are some unsupported features and
5604 Wanderlust specifics.
5605 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5608 * Score Commands:: Score Commands
5609 * Score File Format:: Score File Format
5613 @node Score Commands, Score File Format, Scoring, Scoring
5614 @section Score Commands
5615 @cindex Score Commands
5617 @subsection Score File Specification
5619 @code{wl-score-folder-alist} specifies score files or variables in which
5620 scores are defined, corresponding to folder names.
5624 (setq wl-score-folder-alist
5633 If paths to the score files are omitted, the directory specified in the
5634 variable @code{wl-score-files-directory} is assumed.
5636 No matter what you write in @code{wl-score-folder-alist}, the default
5637 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5638 read (it does not have to exist).
5639 Therefore, in the example above, the three score files,
5640 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5641 the folders that matches @samp{^-.*}.
5643 @subsection Scored Messages
5645 Scores are attached to the messages that are specified by
5646 @code{wl-summary-score-marks} temporarily when the summary is updated;
5647 when you exit from the summary, the scores are removed and reverts to
5650 @subsection Creation of Score Files
5652 In the summary buffer, move to an appropriate message and type @kbd{L}.
5653 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5654 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5656 This makes @minus{}1000 are scored for messages with the same
5657 @samp{Subject:} as the string you entered. That is, such a score file
5658 is created automatically.
5660 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5661 The score file you just made appears.
5662 This buffer is called @dfn{score editing buffer} thereafter.
5663 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5664 as you are previously; type @kbd{a}. Then a score entry for "From"
5666 In this way, you can create a score file easily either in the summary
5667 buffer or in the score editing buffer.
5669 By the way, you might be aware the numbers of key strokes are different
5670 between @kbd{s s p} and @kbd{a}.
5671 This is determined by @code{wl-score-header-default-entry}.
5672 This variable specifies the default score entries corresponding to
5674 For example, for "subject" field, a type and a time limit are prompted,
5675 but for "from" field, they are fixed upon automatically as substring and
5676 permanent respectively.
5677 However, score values can be modified by the prefix argument.
5678 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5681 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5682 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5683 erasing contents of the buffer deletes the score file being edited.
5687 @subsubsection Selecting Score Files
5689 You can change score files to which scores are appended by
5690 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5691 @code{wl-score-change-score-file}.
5693 @subsubsection Summing Up the Score
5695 If you add the same entries by @code{wl-summary-increase-score},
5696 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5697 scores for the entry is summed up.
5699 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5700 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5701 @minus{}1200 will be created as a result.
5703 @subsubsection Creating Thread Key
5705 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5706 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5708 @subsubsection Creating Followup Key
5710 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5711 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5712 at the cursor to @samp{References} key.
5713 If @code{wl-score-auto-make-followup-entry} is non-nil,
5714 @samp{Message-ID} of all messages to be followed up within dates
5715 specified by @code{wl-score-expiry-days}.
5717 @subsection Key Bindings
5722 @findex wl-summary-increase-score
5723 Increases the score for the current message.
5724 And the score entry is appended to the score file at the same moment.
5725 You can specify the score value by a prefix argument.
5729 @findex wl-summary-lower-score
5730 Decreases the score for the current message.
5731 And the score entry is appended to the score file at the same moment.
5732 You can specify the score value by a prefix argument.
5735 @kindex h R (Summary)
5736 @findex wl-summary-rescore
5737 Re-applies the scoring.
5738 However, already scored messages are not scored anew.
5741 @kindex h c (Summary)
5742 @findex wl-score-change-score-file
5743 Changes the score file currently selected.
5746 @kindex h e (Summary)
5747 @findex wl-score-edit-current-scores
5748 Edits the score file currently selected.
5749 If there are multiple score files, the previously specified one is
5753 @kindex h f (Summary)
5754 @findex wl-score-edit-file
5755 Edits an arbitrary score file and selects it.
5758 @kindex h F (Summary)
5759 @findex wl-score-flush-cache
5760 Erases caches associated to the score files that are read.
5761 If you modified score files directly (from other than Wanderlust), you
5762 need to re-read them after erasing the cache.
5765 @kindex h m (Summary)
5766 @findex wl-score-set-mark-below
5767 Specifies the criterion for scores to be marked as read.
5768 Messages with scores less than this value are marked as read.
5771 @kindex h x (Summary)
5772 @findex wl-score-set-expunge-below
5773 Specifies the criterion for scores to be deleted from the summary.
5774 Messages with scores less than this value are deleted.
5775 "Deleted" means it is not shown; they are not removed from the summary
5776 information or the folder.
5777 The deleted messages can be shown by rescan-noscore again.
5780 @subsection Key Bindings in the Score Editing Buffer
5784 @kindex C-c C-k (Score Mode)
5785 @findex wl-score-edit-kill
5786 Abandons the file being edited.
5789 @kindex C-c C-c (Score Mode)
5790 @findex wl-score-edit-exit
5791 Saves the file being edited, and quits from the edit mode.
5794 @kindex C-c C-p (Score Mode)
5795 @findex wl-score-pretty-print
5799 @kindex C-c C-d (Score Mode)
5800 @findex wl-score-edit-insert-date
5801 Inserts the number of dates from Dec. 31, 1 B.C.
5802 It is used for creating the third factor of time-limited scores.
5805 @kindex C-c C-s (Score Mode)
5806 @findex wl-score-edit-insert-header
5807 Inserts the header of the message selected in the summary buffer.
5810 @kindex C-c C-e (Score Mode)
5811 @findex wl-score-edit-insert-entry
5812 Inserts the score entry of the message selected in the summary buffer.
5815 @subsection Customizable Variables
5818 @item wl-summary-default-score
5819 @vindex wl-summary-default-score
5820 The initial setting is 0 (zero).
5821 This variable specifies the default value of the score.
5822 The score is increased or decreased based upon this value.
5824 @item wl-summary-important-above
5825 @vindex wl-summary-important-above
5826 The initial setting is @code{nil}.
5827 Messages with scores larger than this value are attached with the
5828 important mark (@samp{$}).
5829 If @code{nil}, no important marks are attached.
5831 @item wl-summary-target-above
5832 @vindex wl-summary-target-above
5833 The initial setting is @code{nil}.
5834 Messages with scores larger than this value are attached with the target
5836 If @code{nil}, no target marks are attached.
5838 @item wl-summary-mark-below
5839 @vindex wl-summary-mark-below
5840 The initial setting is 0 (zero).
5841 Messages with scores smaller than this value are marked as read.
5843 @item wl-summary-expunge-below
5844 @vindex wl-summary-expunge-below
5845 The initial setting is @code{nil}.
5846 Messages with scores smaller than this value are deleted from the
5848 If @code{nil}, they are not deleted.
5850 @item wl-summary-score-marks
5851 @vindex wl-summary-score-marks
5852 The initial setting is the list shown below:
5856 (list wl-summary-new-mark)
5861 Messages with these marks are scored.
5863 @item wl-use-scoring
5864 @vindex wl-use-scoring
5865 The initial setting is t.
5866 If non-nil, scoring is enabled.
5868 @item wl-score-files-directory
5869 @vindex wl-score-files-directory
5870 The initial setting is @file{~/.elmo/}.
5871 The default directory for score files.
5873 @item wl-score-interactive-default-score
5874 @vindex wl-score-interactive-default-score
5875 The initial setting is 1000.
5876 This value is used as a score when a score factor is @code{nil} in the
5877 score file. It is also used in @code{wl-summary-increase-score} and
5878 @code{wl-summary-lower-score}, on condition that the value of
5879 @code{wl-score-header-default-entry} is @code{nil}.
5881 @item wl-score-expiry-days
5882 @vindex wl-score-expiry-days
5883 The initial setting is 7.
5884 This is the number of days before time-limited scores are deleted.
5886 @item wl-score-update-entry-dates
5887 @vindex wl-score-update-entry-dates
5888 The initial setting is @code{t}.
5889 If non-nil, it enables deletion of time-limited scores.
5891 @item wl-score-header-default-entry
5892 @vindex wl-score-header-default-entry
5893 Specifies the default value for each header field for score entries
5894 created by @code{wl-summary-increase-score},
5895 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5897 @item wl-score-simplify-fuzzy-regexp
5898 @vindex wl-score-simplify-fuzzy-regexp
5899 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5900 regular expression to be deleted from the string.
5901 Because this is usually used for Subject, the default is prefixes that
5902 are attached by mailing list programs.
5904 @item wl-summary-rescore-partial-threshold
5905 @vindex wl-summary-rescore-partial-threshold
5906 The initial setting is 200.
5907 When sync-all or rescan is executed, if there are messages more than
5908 this value, only the last same number of messages as this value are
5911 @item wl-summary-auto-sync-marks
5912 @vindex wl-summary-auto-sync-marks
5913 If non-nil, unread/important marks are synchronized when the summary
5915 Unread marks reflect information on the IMAP4 server.
5916 Important marks reflect information on the IMAP4 server (flagged or
5917 not), and contents of @samp{'mark} folder.
5918 The initial setting is @code{t}.
5922 @node Score File Format, , Score Commands, Scoring
5923 @section Score File Format
5924 @cindex Score File Format
5926 The format of score files are the same as Gnus, and basically you can
5927 use Gnus score files as they are. But they are not fully compatible
5928 because some keys are not supported and there are Wanderlust specifics.
5929 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5934 ("for sale" -1000 nil s)
5935 ("profit" -1000 nil s))
5937 ("spam@@spamspamspam" -10000 nil s))
5939 ("my@@address" 3001 nil s))
5941 (1000000 -10 nil >))
5951 If the key is a string, it is the name of the header to be matched.
5952 The following keys are available:
5953 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5954 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5955 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5956 @code{Chars} and @code{Lines} mean the size and the number of lines of
5957 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5958 are described later.
5959 The rest corresponds the field of the same name.
5961 Arbitrary numbers of core entries are specified after the key.
5962 Each score entry consists of these five factors:
5966 A factor that matches header. This should be a number in the cases of
5967 @code{lines} and @code{chars}, otherwise a string.
5970 A score factor. When the first item matches, the score of the message
5971 is increased or decreased by this value.
5974 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5975 of a number, the score is deleted if it does not match for days
5976 (@code{wl-score-expiry-days}) from the date specified by this.
5977 The date is since Dec. 31, 1 B.C.
5980 A type factor. This specifies the way the first factor matches.
5981 Available types depend on keys.
5984 @item From, Subject, References, Message-ID
5985 For these keys in string, @code{r} and @code{R} (regexp),
5986 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5987 as well as @code{f} and @code{F} (fuzzy) can be used.
5988 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5991 For these keys, the following five numerical relative operators can be
5992 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5995 This key matches @code{From} header, and scores all follow-ups to the
5997 For example, it would be useful for increasing scores for follow-ups to
6000 You can use the same types as @code{From} except for @code{f}.
6001 And a @samp{Followup} entry is automatically appended to the score file.
6004 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6005 A @samp{Thread} entry is automatically appended for each article that
6006 has @var{x} in the @code{References} header.
6007 You can make sure the whole thread including messages that does not have
6008 all ancestors @code{Message-ID} in @code{References} is scored.
6010 You can use the same types as @code{References} except for @code{f}.
6011 And a @samp{Thread} entry is automatically appended to the score file.
6015 A factor for extension header. This is meaningful only if the key is
6017 This specifies headers to be matched other than standard headers like
6018 @code{Subject} and @code{From}.
6019 Note that you should specify the header in
6020 @code{elmo-msgdb-extra-fields} also.
6021 Therefore it does not work in folders where extension headers cannot be
6026 The sum of these scores @emph{after all factors are applied} becomes the
6027 score of the message.
6029 @cindex Score File Atoms
6031 Messages with a score less than this value is marked as read.
6032 The default is @code{wl-summary-mark-below}.
6035 Messages with a score less than this value is deleted from the summary.
6036 The default is @code{wl-summary-expunge-below}.
6038 @item mark-and-expunge
6039 Both @code{mark} and @code{expunge} are applied,
6040 i.e. messages with a score less than this value is marked as read and
6041 deleted from the summary.
6044 Messages with a score greater than this value is attached with temp
6046 The default is @code{wl-summary-target-above}.
6049 Messages with a score greater than this value is attached with important
6051 The default is @code{wl-summary-important-above}.
6056 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6057 are used, you need to set @code{elmo-msgdb-extra-fields}.
6060 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6063 There are other restrictions as shown below:
6066 @item Because @samp{References} field in the summary information
6067 contains only the last @samp{Message-ID}, @code{references} key matches
6071 Keys that can be seen by folder of types:
6075 chars lines xref extra
6076 localdir,localnews Y E E E
6077 nntp (supporting xover) Y E E N
6083 N: cannot be seen (ignored)
6084 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6089 @node Address Book, Customization, Scoring, Top
6090 @chapter Address Book
6091 @cindex Address Book
6093 With address book, you can utilize address completion, and you have
6094 summary displayed with nicknames.
6097 * Mail Addresses:: Definition of Address Book
6098 * Address Manager:: Address Manager
6101 @node Mail Addresses, Address Manager, Address Book, Address Book
6102 @section Address book
6103 @cindex Address book Definition
6105 @cindex Alias, Address
6107 The file @file{~/.addresses} is a simple address book for Wanderlust.
6108 Make address file @file{~/.addresses}, and edit to suit your requirement.
6110 The data written in @file{~/.addresses} are used for address completion
6111 under draft editing mode. Furthermore, they are used when showing names
6112 in summary display mode. You can safely skip this section, if you don't
6113 want to customize address completion and summary display.
6114 It is possible to add/change/remove addresses from @file{~/.addresses} in
6115 summary buffer after Wanderlust is invoked. @refill
6117 The format is very simple. Like this. @refill
6122 # @r{Lines begin with @samp{#} are comment.}
6123 # @r{Empty lines are ignored}
6125 # @r{Format of each line:}
6126 # @var{email-address} "@var{nickname} "@var{realname}"
6128 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6129 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6130 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6135 One line defines one persons description.
6137 Actually, in default setup, @var{nickname} is used in summary-mode and
6138 @var{realname} is used in draft preparation mode. This behavior is
6139 better understood if you try it and confirmed the function first. You
6140 can write and try a small definition, so you will know the idea of the
6141 address book before writing a big one.
6143 And, if MH alias file is specified in variable @code{wl-alias-file},
6144 it is used as an address information in the draft preparation mode.
6146 If variable @code{wl-use-ldap} is non-nil (initial setting is
6147 @code{nil}), address completion in draft mode uses LDAP information.
6149 If you use LDAP, you have to set @code{wl-ldap-server},
6150 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6151 not have LDAP feature as built-in feature (Currently only XEmacs can
6152 have built-in LDAP feature), you have to set command exec @env{PATH} to
6153 the program @command{ldapsearch}.
6156 @node Address Manager, , Mail Addresses, Address Book
6157 @section Address Manager
6158 @cindex Address Manager
6160 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6161 the address book and insert address to draft buffer.
6163 @subsection Key Bindings
6167 @kindex t (Address Manager)
6168 @findex wl-addrmgr-set-to
6169 Add @samp{To:} mark.
6172 @kindex c (Address Manager)
6173 @findex wl-addrmgr-set-cc
6174 Add @samp{Cc:} mark.
6177 @kindex b (Address Manager)
6178 @findex wl-addrmgr-set-bcc
6179 Add @samp{Bcc:} mark.
6182 @kindex u (Address Manager)
6183 @findex wl-addrmgr-unmark
6187 @kindex x (Address Manager)
6188 @findex wl-addrmgr-apply
6190 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6191 buffer and quit address manager. When no draft buffer, make new draft
6192 with insert marked addresses.
6194 If no mark, quit address manager.
6198 @kindex q (Address Manager)
6199 @findex wl-addrmgr-quit
6200 Quit address manager.
6203 @kindex a (Address Manager)
6204 @findex wl-addrmgr-add
6208 @kindex d (Address Manager)
6209 @findex wl-addrmgr-delete
6213 @kindex e (Address Manager)
6214 @findex wl-addrmgr-edit
6219 @node Customization, Mailing List, Address Book, Top
6220 @chapter Customizing Wanderlust
6221 @cindex Customization
6224 * Living with other packages:: Cooperating with other packages
6225 * Highlights:: Highlights
6226 * Biff:: Notify Mail arrival
6227 * Advanced Settings:: Advanced Settings
6228 * Customizable Variables:: Customizable Variables
6233 @node Living with other packages, Highlights, Customization, Customization
6234 @section Living with other packages
6236 Examples with other packages.
6239 * imput:: imput (im-wl.el)
6241 * supercite:: supercite.el
6242 * mu-cite:: mu-cite.el
6243 * X-Face:: x-face,bitmap-mule
6244 * dired-dd:: dired-dd.el
6246 * Addrbook:: Addrbook
6247 * mime-w3m:: mime-w3m.el
6251 @node imput, BBDB, Living with other packages, Living with other packages
6256 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6259 If @command{imput} is on the @code{exec-path} at the installation,
6260 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6264 (autoload 'wl-draft-send-with-imput-async "im-wl")
6265 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6270 @node BBDB, supercite, imput, Living with other packages
6274 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6277 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6278 byte-compiled and installed.
6286 ;; @r{enable pop-ups}
6287 (setq bbdb-use-pop-up t)
6288 ;; @r{auto collection}
6289 (setq bbdb/mail-auto-create-p t)
6290 ;; @r{exceptional folders against auto collection}
6291 (setq bbdb-wl-ignore-folder-regexp "^@@")
6292 (setq signature-use-bbdb t)
6293 (setq bbdb-north-american-phone-numbers-p nil)
6294 ;; @r{shows the name of bbdb in the summary} :-)
6295 (setq wl-summary-from-function 'bbdb-wl-from-func)
6296 ;; @r{automatically add mailing list fields}
6297 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6298 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6302 You can complete address with BBDB by @kbd{M-@key{TAB}}
6306 @node supercite, mu-cite, BBDB, Living with other packages
6307 @subsection sc.el(supercite), sc-register.el
6311 The same setting as usual mailers should be OK. The following is an
6312 example of settings:
6316 (autoload 'sc-cite-original "supercite" nil t)
6317 (add-hook 'mail-citation-hook 'sc-cite-original)
6322 @node mu-cite, X-Face, supercite, Living with other packages
6323 @subsection mu-cite.el
6326 The same setting as usual mailers should be OK. The following is an
6327 example of settings.
6329 If you use mu-cite version 8.0 or earlier:
6333 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6334 (setq mail-citation-hook 'mu-cite/cite-original)
6338 If you use mu-cite version 8.1 or later:
6342 (autoload 'mu-cite-original "mu-cite" nil t)
6343 (add-hook 'mail-citation-hook (function mu-cite-original))
6347 @node X-Face, dired-dd, mu-cite, Living with other packages
6351 If you have installed one of the following, you can decode
6352 @samp{X-Face:} field in message buffer and you will see face image.
6355 * x-face-xmas:: XEmacs case
6356 * x-face-mule:: Emacs case
6359 If there is an encoded X-Face string in a file @file{~/.xface} (the
6360 value of the variable @code{wl-x-face-file}), it is inserted as a
6361 @samp{X-Face:} field in the draft buffer (if
6362 @code{wl-auto-insert-x-face} is non-nil).
6364 @node x-face-xmas, x-face-mule, X-Face, X-Face
6365 @subsubsection x-face-xmas (for XEmacs)
6368 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6369 1.3.6.13 or later, do the following:
6373 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6374 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6378 @node x-face-mule, , x-face-xmas, X-Face
6379 @subsubsection x-face-mule (for Emacs)
6383 If you use @file{x-face-mule.el} in bitmap-mule
6384 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6388 (autoload 'x-face-decode-message-header "x-face-mule")
6389 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6393 @subsubsection x-face-e21 (for Emacs 21.x)
6396 With Emacs 21.x, you can use @file{x-face-e21.el}
6397 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6398 to display X-Face. In this case, bitmap-mule is not required.
6403 (autoload 'x-face-decode-message-header "x-face-e21")
6404 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6409 @node dired-dd, MHC, X-Face, Living with other packages
6410 @subsection dired-dd(Dired-DragDrop)
6411 @pindex Dired-DragDrop
6413 @cindex Drag and Drop
6415 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6416 compose multi-part by simple Drag-and-Drop from dired to the draft
6417 buffer being edited in GNU Emacs (this feature is not Wanderlust
6418 specific, but general-purpose for SEMI).
6422 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6428 ;; @r{Set dired-x variables here.}
6429 ;; @r{To and flo@dots{}}
6431 (progn (require 'dired-dd)
6432 (require 'dired-dd-mime))))))
6436 @node MHC, Addrbook, dired-dd, Living with other packages
6440 Message Harmonized Calendaring system
6441 (@uref{http://www.quickhack.net/mhc/})
6443 By using MHC, you can make a calendar from the messages.
6449 (setq mhc-mailer-package 'wl)
6450 (autoload 'mhc-mode "mhc" nil t)
6451 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6452 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6460 (autoload 'mhc-wl-setup "mhc-wl")
6461 (add-hook 'wl-init-hook 'mhc-wl-setup)
6465 @node Addrbook, mime-w3m, MHC, Living with other packages
6466 @subsection wl-addrbook.el
6470 (@uref{http://www.mew.org/})
6472 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6473 @code{load-path} and do the following settings.
6477 (require 'wl-addrbook)
6482 @node mime-w3m, , Addrbook, Living with other packages
6483 @subsection mime-w3m.el
6486 You can display html part by using @file{mime-w3m.el}
6487 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6488 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6491 @node Highlights, Biff, Living with other packages, Customization
6494 @subsection Customizable Variables
6497 @item wl-summary-highlight
6498 @vindex wl-summary-highlight
6499 The initial setting is @code{t}.
6500 If non-nil, the summary is highlighted.
6502 @item wl-highlight-max-summary-lines
6503 @vindex wl-highlight-max-summary-lines
6504 The initial setting is 10000.
6505 The summary is not highlighted if it has more lines than this value.
6507 @item wl-summary-highlight-partial-threshold
6508 @vindex wl-summary-highlight-partial-threshold
6509 The initial setting is 1000.
6510 This is a threshold whether the whole summary is highlighted.
6511 If there are more lines of messages in the summary, it is partially
6514 @item wl-summary-partial-highlight-above-lines
6515 @vindex wl-summary-partial-highlight-above-lines
6516 The initial setting is 30. If there are more lines of messages than
6517 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6518 after the point that is the same number of lines as this value above the
6519 cursor line are highlighted partially. (If this value is @code{nil},
6520 the last same number of lines as the value of
6521 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6523 @item wl-highlight-body-too
6524 @vindex wl-highlight-body-too
6525 The initial setting is @code{t}.
6526 If non-nil, bodies of drafts and messages are also highlighted.
6528 @item wl-highlight-message-header-alist
6529 @vindex wl-highlight-message-header-alist
6530 When highlighting headers of drafts and messages, this variable
6531 specifies which faces are allocated to important
6532 (@code{wl-highlight-message-important-header-contents}), secondly
6533 important (@code{wl-highlight-message-important-header-contents2}), and
6534 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6536 Similarly, it can be used for allocating arbitrary faces to arbitrary
6537 regular expressions.
6539 @item wl-highlight-citation-prefix-regexp
6540 @vindex wl-highlight-citation-prefix-regexp
6541 Specifies a regular expression to which quoted lines in bodies of
6542 drafts and messages match.
6543 Bodies matching to this regular expression are highlighted by the faces
6544 specified by (@code{wl-highlight-message-cited-text-*}).
6546 @item wl-highlight-highlight-citation-too
6547 @vindex wl-highlight-highlight-citation-too
6548 The initial setting is @code{nil}.
6549 If non-nil, the quoting regular expression itself given by
6550 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6552 @item wl-highlight-citation-header-regexp
6553 @vindex wl-highlight-citation-header-regexp
6554 Specifies a regular expression that denotes beginning of quotation.
6555 Bodies matching to this regular expression are highlighted by the face
6556 specified by @code{wl-highlight-message-headers}.
6558 @item wl-highlight-max-header-size
6559 @vindex wl-highlight-max-header-size
6560 The initial setting is @code{nil}. If a header size is larger than this
6561 value, it will not be highlighted. If @code{nil}, always highlighted
6562 (ignore header size).
6564 @item wl-highlight-max-message-size
6565 @vindex wl-highlight-max-message-size
6566 The initial setting is 10000.
6567 If a message is larger than this value, it will not be highlighted.
6568 With this variable, highlight is suppressed for uuencode or huge digest
6571 @item wl-highlight-signature-separator
6572 @vindex wl-highlight-signature-separator
6573 Specifies regular expressions that denotes the boundary of a signature.
6574 It can be a regular expression, or a list of ones.
6575 Messages after the place that matches this regular expression are
6576 highlighted by the face specified by
6577 @code{wl-highlight-message-signature}.
6579 @item wl-max-signature-size
6580 @vindex wl-max-signature-size
6581 The initial setting is 400.
6582 This is the largest size for a signature to be highlighted.
6584 @item wl-use-highlight-mouse-line
6585 @vindex wl-use-highlight-mouse-line
6586 The initial setting is @code{t}.
6587 If non-nil, the line pointed by the mouse is highlighted in the folder
6588 mode, summary mode, and the like.
6591 @subsection Setting Colors and Fonts of the Characters
6593 If you want to change colors or fonts of the characters, you need to
6594 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6595 want to change fonts, and @code{set-face-foreground} for colors, and so
6596 on. You cannot write face settings in @file{.emacs}; write in
6599 For example, if you want to change the color for signatures to yellow,
6603 (set-face-foreground 'wl-highlight-message-signature "yellow")
6609 Faces defined in Wanderlust:
6612 @item wl-highlight-message-headers
6613 The face for field names of message headers.
6615 @item wl-highlight-message-header-contents
6616 The face for field bodies of message headers.
6618 @item wl-highlight-message-important-header-contents
6619 The face for important parts of message headers.
6620 Per default, this face is used for a body of @samp{Subject:} field.
6621 You can change its value by editing
6622 @code{wl-highlight-message-header-alist}.
6624 @item wl-highlight-message-important-header-contents2
6625 The face for secondly important parts of message headers.
6626 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6627 fields. You can change its value by editing
6628 @code{wl-highlight-message-header-alist}.
6630 @item wl-highlight-message-unimportant-header-contents
6631 The face for unimportant parts of message headers.
6632 Per default, this face is used for bodies of @samp{X-} fields
6633 @samp{User-Agent:} fields. You can change its value by editing
6634 @code{wl-highlight-message-header-alist}.
6636 @item wl-highlight-message-citation-header
6637 The face for headers of quoted messages.
6639 @item wl-highlight-message-cited-text-*
6640 The face for texts of quoted messages. The last @samp{*} is a
6641 @var{single figure} so that 10 different colors can be used according to
6644 @item wl-highlight-message-signature
6645 The face for signatures of messages. The initial settings are
6646 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6647 dark background colors.
6649 @item wl-highlight-header-separator-face
6650 The face for header separators of draft messages.
6652 @item wl-highlight-summary-important-face
6653 The face for message lines with important marks in the summary.
6655 @item wl-highlight-summary-new-face
6656 The face for message lines with new marks in the summary.
6658 @item wl-highlight-summary-displaying-face
6659 The face for the message line that is currently displayed.
6660 This face is overlaid.
6662 @item wl-highlight-thread-indent-face
6663 The face for the threads that is currently displayed.
6665 @item wl-highlight-summary-unread-face
6666 The face for message lines with unread marks in the summary.
6668 @item wl-highlight-summary-deleted-face
6669 The face for message lines with delete marks in the summary.
6671 @item wl-highlight-summary-refiled-face
6672 The face for message lines with re-file marks in the summary.
6674 @item wl-highlight-refile-destination-face
6675 The face for re-file information part of message lines with re-file
6676 marks in the summary.
6678 @item wl-highlight-summary-copied-face
6679 The face for message lines with copy marks in the summary.
6681 @item wl-highlight-summary-target-face
6682 The face for message lines with target marks @samp{*} in the summary.
6684 @item wl-highlight-summary-thread-top-face
6685 The face for message lines that are on the top of the thread in the
6688 @item wl-highlight-summary-normal-face
6689 The face for message lines that are not on top of the thread in the
6692 @item wl-highlight-folder-unknown-face
6693 The face for folders that are not known to have how many unsync messages
6696 @item wl-highlight-folder-zero-face
6697 The face for folders that have no unsync messages in the folder mode.
6699 @item wl-highlight-folder-few-face
6700 The face for folders that have some unsync messages in the folder mode.
6702 @item wl-highlight-folder-many-face
6703 The face for folders that have many unsync messages in the folder mode.
6704 The boundary between `some' and `many' is specified by the variable
6705 @code{wl-folder-many-unsync-threshold}.
6707 @item wl-highlight-folder-unread-face
6708 The face for folders that have no unsync but unread messages in the
6711 @item wl-highlight-folder-killed-face
6712 The face for folders that are deleted from the access group in the
6715 @item wl-highlight-folder-opened-face
6716 The face for open groups in the folder mode.
6717 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6718 @code{nil} or a @var{number}.
6720 @item wl-highlight-folder-closed-face
6721 The face for close groups in the folder mode.
6722 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6723 @code{nil} or a @var{number}.
6725 @item wl-highlight-folder-path-face
6726 The face for the path to the currently selected folder in the folder
6729 @item wl-highlight-logo-face
6730 The face for logo in the demo.
6732 @item wl-highlight-demo-face
6733 The face for strings (for example, a version number) in the demo.
6737 @node Biff, Advanced Settings, Highlights, Customization
6738 @section Notify Mail arrival
6741 Following setting is to notify mail arrival of @samp{%inbox}
6742 by the indicator on the modeline
6745 (setq wl-biff-check-folder-list '("%inbox"))
6748 @subsection Customizable Variables
6750 @item wl-biff-check-folder-list
6751 @vindex wl-biff-check-folder-list
6752 The initial setting is @code{nil}.
6753 This is the list of folders to check mail arrival.
6754 If @code{nil}, wl doesn't check mail arrival.
6756 @item wl-biff-check-interval
6757 @vindex wl-biff-check-interval
6758 The initial setting is 40 (in seconds).
6759 Check mail arrival in this period.
6761 @item wl-biff-notify-hook
6762 @vindex wl-biff-notify-hook
6763 This hook is run at the arrival of new mail.
6764 To beep with mail arrival(initial setting), set as follows.
6766 (setq wl-biff-notify-hook '(ding))
6768 For silence, set to @code{nil}.
6772 @node Advanced Settings, Customizable Variables, Biff, Customization
6773 @section Advanced Settings
6776 * Draft for Reply:: Draft for Reply
6777 * Thread Format:: Appearance of Thread
6778 * User-Agent Field:: @samp{User-Agent:} Header Field
6782 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6783 @subsection Draft for Replay
6784 @vindex wl-draft-reply-with-argument-list
6785 @vindex wl-draft-reply-without-argument-list
6786 @vindex wl-draft-reply-myself-with-argument-list
6787 @vindex wl-draft-reply-myself-without-argument-list
6789 If you want, when you replying to articles in mailing lists, the address
6790 in Reply-To field of the original message to be prepared to To field of
6791 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6796 (setq wl-draft-reply-without-argument-list
6797 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6798 ("Followup-To" . (nil nil ("Followup-To")))
6799 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6800 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6805 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6806 in the original message, @samp{Reply-To:} field in the original is
6807 copied to @samp{To:} field.)
6809 Moreover, the behavior of @kbd{a} with prefix argument can
6810 be directed by @code{wl-draft-reply-with-argument-list} as well.
6812 Note: To set the behavior when you reply to the message written by yourself, use
6813 @code{wl-draft-reply-myself-without-argument-list} and
6814 @code{wl-draft-reply-myself-with-argument-list}
6817 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6818 @subsection Appearance of Threads
6822 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6823 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6824 391 09/18(Fri)19:24 +-[ Murata-san ]
6825 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6826 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6827 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6828 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6829 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6830 412 09/22(Tue)09:28 | +-[ Teranishi ]
6831 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6832 416 09/22(Tue)12:38 | +-[ Teranishi ]
6833 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6834 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6838 Settings to make appearance of threads like shown above:
6842 (setq wl-thread-indent-level 2)
6843 (setq wl-thread-have-younger-brother-str "+")
6844 (setq wl-thread-youngest-child-str "+")
6845 (setq wl-thread-vertical-str "|")
6846 (setq wl-thread-horizontal-str "-")
6847 (setq wl-thread-space-str " ")
6851 If you do not want to see branches, do the following:
6855 (setq wl-thread-indent-level 2)
6856 (setq wl-thread-have-younger-brother-str " ")
6857 (setq wl-thread-youngest-child-str " ")
6858 (setq wl-thread-vertical-str " ")
6859 (setq wl-thread-horizontal-str " ")
6860 (setq wl-thread-space-str " ")
6865 @node User-Agent Field, , Thread Format, Advanced Settings
6866 @subsection User-Agent Field
6870 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6871 @samp{User-Agent:} fields, define a function that generate appropriate
6872 strings as you like, and set it to variable
6873 @code{wl-generate-mailer-string-function}.
6875 If you do not want verbose @samp{User-Agent:} field, do the following:
6879 (setq wl-generate-mailer-string-function
6882 (concat "User-Agent: "
6883 (wl-generate-user-agent-string-1 nil)))))
6887 The following is a example:
6891 (setq mime-edit-insert-user-agent-field nil)
6892 (setq wl-generate-mailer-string-function
6895 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6900 @node Customizable Variables, Hooks, Advanced Settings, Customization
6901 @section Customizable Variables
6903 Customizable variables that have not been described yet:
6906 @item wl-default-folder
6907 @vindex wl-default-folder
6908 The initial setting is @samp{%inbox}. This is the default value for moving to
6909 a folder and the like.
6911 @item wl-draft-folder
6912 @vindex wl-draft-folder
6913 The initial setting is @samp{+draft}. It is the folder to which drafts are
6914 saved. It must be a localdir folder.
6916 @item wl-trash-folder
6917 @vindex wl-trash-folder
6918 The initial setting is @samp{+trash}. It is the wastebasket folder.
6919 If you changed this variable, you had better restart Wanderlust.
6921 @item wl-interactive-exit
6922 @vindex wl-interactive-exit
6923 The initial setting is @code{t}.
6924 If non-nil, you are asked for confirmation when Wanderlust terminates.
6926 @item wl-interactive-send
6927 @vindex wl-interactive-send
6928 The initial setting is @code{t}.
6929 If non-nil, you are asked for confirmation when mail is sent.
6931 @item wl-folder-sync-range-alist
6932 @vindex wl-folder-sync-range-alist
6933 The initial setting is the alist shown below:
6938 ("^\\+draft$\\|^\\+queue$" . "all"))
6943 This is an associative list of regular expressions of folder names and
6944 update range of the summary. Update range is one of the @samp{all},
6945 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6946 @samp{last}. If a folder do not match, @samp{update} is used.
6949 @vindex wl-ask-range
6950 The initial setting is @code{t}.
6951 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6952 for updating the summary when you changed folders.
6954 @item wl-mime-charset
6955 @vindex wl-mime-charset
6956 The initial setting is @code{x-ctext}.
6957 This is the MIME charset for messages that are not MIME (e.g. without
6958 @samp{Content-Type:}). This value also used as default charset for
6959 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6960 this value as @code{iso-2022-jp}.)
6962 @item wl-highlight-folder-with-icon
6963 @vindex wl-highlight-folder-with-icon
6964 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6965 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6967 @item wl-strict-diff-folders
6968 @vindex wl-strict-diff-folders
6969 This is a list of regular expressions of folders.
6970 Unread messages are checked, for example when you press @kbd{s} in
6971 the folder mode, usually in a brief way (rapidly processed but not
6973 The folders matching this variable are seriously checked.
6974 You may want to set this variable so as to match conditional filter
6975 folders for IMAP4 folders.
6976 The initial setting is @code{nil}.
6978 @item wl-folder-use-server-diff
6979 @vindex wl-folder-use-server-diff
6980 When unread messages are checked, for example when you press @kbd{s} in
6981 the folder mode, usually (the number of messages on the server) @minus{}
6982 (the number of local messages) will be the number of unread messages.
6983 However, if this variable is non-nil, the number of unread messages on
6984 the server is checked. This affects IMAP4 folders only, but IMAP4
6985 folders in mail boxes matching
6986 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6987 the number of unread messages on the server, even if they matches this
6988 variable. The initial setting is @code{t}.
6990 @item wl-auto-check-folder-name
6991 @vindex wl-auto-check-folder-name
6992 The initial setting is @code{nil}.
6993 You can specify a folder or a group which is checked for unread message
6994 at the start. You can also specify a list of folders (groups) to be checked.
6995 If the value is @code{nil}, whole Desktop is checked at the start.
6996 If it is @code{none}, no folders are checked.
6998 @item wl-auto-uncheck-folder-list
6999 @vindex wl-auto-uncheck-folder-list
7000 The initial setting is the list shown below:
7009 You can set a list of regular expressions to specify folders
7010 which are not automatically checked even if they are included
7011 in some groups assigned by @code{wl-auto-check-folder-name}.
7013 @item wl-auto-check-folder-list
7014 @vindex wl-auto-check-folder-list
7015 The initial setting is @code{nil}.
7016 You can set a list of regular expressions to specify exceptions
7017 for @code{wl-auto-uncheck-folder-list}.
7019 @item wl-no-save-folder-list
7020 @vindex wl-no-save-folder-list
7021 The initial setting is the list shown below:
7030 This is a list of regular expressions of folders not to be saved.
7032 @item wl-save-folder-list
7033 @vindex wl-save-folder-list
7034 The initial setting is @code{nil}.
7035 This is a list of regular expressions of folders to be saved.
7036 This takes precedence over @code{wl-no-save-folder-list}.
7038 @item wl-folder-mime-charset-alist
7039 @vindex wl-folder-mime-charset-alist
7040 The initial setting is the alist shown below:
7044 (("^-alt\\.chinese" . big5)
7045 ("^-relcom\\." . koi8-r)
7047 ("^-han\\." . euc-kr))
7052 This is an associative list of regular expressions of folder names and
7054 If a folder do not match, @code{wl-mime-charset} is used.
7056 @item wl-folder-init-load-access-folders
7057 @vindex wl-folder-init-load-access-folders
7058 The initial setting is @code{nil}.
7059 This is a list of access groups to be loaded specifically at the start.
7060 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7062 @item wl-folder-init-no-load-access-folders
7063 @vindex wl-folder-init-no-load-access-folders
7064 The initial setting is @code{nil}.
7065 This is a list of access groups not to be loaded specifically at the
7067 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7069 @item wl-delete-folder-alist
7070 @vindex wl-delete-folder-alist
7071 The initial setting is the alist shown below:
7080 This list determines disposition of messages with delete marks.
7081 Each item in the list is a folder and destination; you can specify any
7082 one of the following in the place of destination:
7085 @code{remove} or @code{null} : deletes the messages instantly.
7086 string : moves the messages to the specific folder.
7087 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7090 @item wl-refile-policy-alist
7091 @vindex wl-refile-policy-alist
7092 The initial setting is the list shown below:
7102 This list determines whether messages with re-file marks are moved or
7103 copied. Each item in the list is a cons cell of a folder and
7104 @code{copy} or @code{move}.
7106 @item wl-x-face-file
7107 @vindex wl-x-face-file
7108 The initial setting is @file{~/.xface}.
7109 The name of the file that contains encoded X-Face strings.
7112 @item wl-demo-display-logo
7113 @vindex wl-demo-display-logo
7114 If non-nil, bitmap image is shown on the opening demo. If you set
7115 @code{xpm} or @code{xbm}, (if possible) display selected image type
7118 @item elmo-use-database
7119 @vindex elmo-use-database
7120 This is meaningful for XEmacs only. The initial setting depends on
7121 XEmacs (@code{t} for XEmacs with dbm).
7122 If non-nil, Message-ID is controlled by dbm.
7124 @item elmo-passwd-alist-file-name
7125 @vindex elmo-passwd-alist-file-name
7126 The initial setting is @file{passwd}.
7127 This is the name of the file in which passwords are saved.
7128 @code{elmo-passwd-alist-save} saves current passwords to the file.
7130 @item elmo-nntp-list-folders-use-cache
7131 @vindex elmo-nntp-list-folders-use-cache
7132 The initial setting is 600 (in seconds).
7133 This is period in seconds during which results of @samp{list} and
7134 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7137 @item elmo-nntp-max-number-precedes-list-active
7138 @vindex elmo-nntp-max-number-precedes-list-active
7139 The initial setting is @code{nil}.
7140 If non-nil, the number of article obtained by @samp{list active} in NNTP
7141 are used as the maximum article number of the folder.
7142 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7143 and if the number of read messages is not correct.
7145 @item elmo-nntp-default-use-listgroup
7146 @vindex elmo-nntp-default-use-listgroup
7147 The initial setting is @code{t}.
7148 If non-nil, @samp{listgroup} is used for checking the total number of
7149 articles. If it is @code{nil}, @samp{group} is used. In the latter
7150 case, the processing will be a little faster at the sacrifice of
7153 @item elmo-pop3-send-command-synchronously
7154 @vindex elmo-pop3-send-command-synchronously
7155 The initial setting is @code{nil}.
7156 If non-nil, POP3 commands are issued synchronously. Some implementation
7157 of POP3 server fails to get summary information without this setting.
7158 You may have to set this variable to @code{t}, if the process hangs
7159 while looking up POP3.
7161 @item elmo-dop-flush-confirm
7162 @vindex elmo-dop-flush-confirm
7163 The initial setting is @code{t}.
7164 If non-nil, you are asked for confirmation if accumulated off-line
7165 operations are executed.
7167 @item elmo-display-progress-threshold
7168 @vindex elmo-display-progress-threshold
7169 The initial setting is 20.
7170 Threshold for display of progress gauge. If number of renewal is more than
7171 this value, display progress gauge.
7175 @node Hooks, , Customizable Variables, Customization
7181 @node Mailing List, Addition, Customization, Top
7182 @chapter Wanderlust Mailing List
7187 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7190 Topics related to Wanderlust are discussed in the mailing list.
7191 The latest version is also announced there (in Japanese, sorry).
7193 A guide can be obtained automatically by sending mail to
7194 @t{wl-ctl@@lists.airs.net} with the body
7199 Please send bug reports or patches to the mailing list. You can post to
7200 the mailing list even though you are not a member of it.
7202 If you send a bug report, please attach Backtrace with it.
7203 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7206 I would like to express my thanks to the members of the mailing list for
7207 valuable advice and many pieces of code they contributed.
7210 @node Addition, Index, Mailing List, Top
7211 @chapter Additional Information
7213 @section Brief History
7216 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7217 3/10 Made a msgdb mechanism by elisp.
7218 3/26 IMAP and NNTP can be displayed in threads.
7219 4/13 Began to assemble thread display modules as elmo.
7220 5/01 Finished 0.1.0, initial version with many defects.
7221 6/12 I made a slip of the tongue and said I was writing elisp
7222 mailer supporting IMAP
7223 6/16 0.1.3 was announced at tm-ja, elisp ML.
7224 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7225 7/01 Support for mm-backend (0.3.0).
7226 8/25 multi folder added (0.5.0).
7227 8/28 filter folder added (0.5.1).
7228 9/10 You can open/close threads (0.6.0).
7229 9/11 fldmgr by Murata-san made editing folders easy.
7230 9/18 lha folders added by Okunishi-san (0.6.3).
7231 9/24 Display of branches of threads (0.6.5).
7232 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7233 10/28 Off-line operations (0.7.4).
7234 12/09 Becomes beta version.
7235 12/21 wl-expire by Murata-san.
7236 1999 2/03 auto-refile by Tsumura-san.
7237 4/28 wl-template by Murata-san.
7238 5/18 Released 1.0.0 stable.
7239 7/05 Scoring by Murata-san (2.1.0).
7240 9/26 New plugged system by Murata-san (2.2.2).
7241 12/20 Support Modified UTF7.
7242 2000 3/24 Released 1.1.0 stable.
7243 4/03 CVS development started.
7244 5/07 Thread restoration & Its speed up with Murata-san.
7245 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7246 7/11 killed message feature.
7247 7/18 Use UIDL in POP3.
7248 9/12 biff feature with Satata-san & Yamaoka-san.
7249 10/17 expire-hide by Okada-san.
7250 11/08 Released 2.4.0 stable.
7251 2001 7/04 Released 2.6.0 stable.
7252 8/21 wl-addrmgr by Kitamoto-san.
7253 12/27 Released 2.8.1 stable.
7256 See @file{ChangeLog} for details.
7260 According to a dictionary, Wanderlust has the meaning:
7264 n eager longing for or impulse towards travelling in distant lands
7265 [Ger, fr wandern to wander + lust desire, pleasure]
7269 but I had no profound intention. (if farfetched, IMAP @result{} you can
7270 read mail anywhere @result{} desire to wander ?)
7272 Elmo is the abbreviation of @samp{Elisp Library for Message
7273 Orchestration}. At first I meant the red puppet in the Sesame Street,
7274 but you may associate it with Wandering @result{} Drifting @result{}
7275 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7279 Each versions has code names (they are almost jokes).
7280 Currently they are picked up alphabetically from the top 40 hits of
7281 U.S. Billboard magazines in 1980s.
7283 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7286 @node Index, , Addition, Top
7290 * Concept Index:: Concept Index
7291 * Key Index:: Key Index
7292 * Variable Index:: Variable Index
7293 * Function Index:: Function Index
7296 @node Concept Index, Key Index, Index, Index
7297 @unnumberedsec Concept Index
7300 @node Key Index, Variable Index, Concept Index, Index
7301 @unnumberedsec Key Index
7304 @node Variable Index, Function Index, Key Index, Index
7305 @unnumberedsec Variable Index
7308 @node Function Index, , Variable Index, Index
7309 @unnumberedsec Function Index