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}
1033 $ml;zip/ -> Access group consists of archive folders
1034 under @file{~/Mail/ml}
1039 * Archiver:: Supported Archivers
1040 * Archive Tips:: TIPS
1041 * Archive Vars:: Customization
1045 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1046 @subsection Supported Archives
1056 By default, following archives are supported.
1060 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1061 GNU TAR('tgz, 'tar) ;; read-only
1065 If your archiver can include multiple files in one archive, you have a
1066 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1067 of the candidate. TAR is supported read-only because it cannot delete
1068 file in the archive (@code{mv})).
1070 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1071 archiver of Wanderlust because they cannot include multiple
1072 files. Archivers that cannot extract files to standard output are also
1075 @subsection OS specific information about archiver.
1077 Behaviors of the following archivers are confirmed by further experiences.
1078 (@samp{*} mark means recommended archiver).
1081 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1082 LHA OS/2 version Rel.2.06b Feb 18, 1998
1083 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1084 *Zip 2.2 (November 3rd 1997).
1085 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1086 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1087 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1089 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1090 LHa for UNIX V 1.14c
1091 UnZip 5.32 of 3 November 1997
1092 Zip 2.2 (November 3rd 1997)
1093 GNU tar 1.12 (1.11.x is no good)
1094 gzip 1.2.4 (18 Aug 93)
1096 [Win32] Win.98/Meadow
1100 GNU tar 1.11.8 + 1.5(WIN32)
1107 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1108 Hiramatsu version of LHA is only supported.
1109 In Win32, LHa32 is only supported (DOS version is no good).
1111 * Caution about GNU tar
1113 You have to take care about GNU tar's version because many version has
1114 problem on deleting file from archive.
1116 Please test @option{--delete} @option{-f} options work. Otherwise, your
1117 archive will be destroyed. No problem is reported on above versions of
1121 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1123 @cindex Archive Tips
1125 For comfortable migration, usage of @code{wl-summary-archive}
1126 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1127 archive folders created by expiration, you must set non-nil value to
1128 @code{elmo-archive-treat-file}.
1130 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1131 in processing speed. For comfortable use, Emacs20 is recommended.
1132 (If re-search's performance is the problem, 19.3x or later may be okay.)
1134 If many files are included in one archive,
1135 it takes long time to access the archive folder because
1136 archiver starting overhead is increased (especially LHA).
1137 150-200 messages in one archive is recommended.
1139 Of course, following is possible @t{:-)}
1140 (meanings of these variables are described later.)
1144 (setq wl-fcc "$backup")
1145 (setq wl-trash-folder "$trash;lha")
1149 @node Archive Vars, , Archive Tips, Archive Folder
1150 @subsection Variables About Archive Folder
1151 @cindex Archive variables
1154 @item elmo-archive-default-type
1155 @vindex elmo-archive-default-type
1156 The initial setting is @code{zip}.
1157 Set archiver type by symbol.
1159 @item elmo-archive-@var{type}-method-alist
1160 @vindex elmo-archive-TYPE-method-alist
1161 Define archiver @var{type}'s methods.
1162 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1163 Each element of the alist is following.
1167 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1168 (@var{action} . @var{function}) ;; function
1172 Currently available actions are following.
1176 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1177 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1184 actions enclosed with braces are optional (They are used for better
1187 @item elmo-archive-suffix-alist
1188 @vindex elmo-archive-suffix-alist
1189 An alist of archiver-type (symbol) and suffix.
1191 @item elmo-archive-file-regexp-alist
1192 @vindex elmo-archive-file-regexp-alist
1193 An alist of a regexp to get file number from list output of archiver
1194 and archiver-type (symbol).
1196 @item elmo-archive-method-list
1197 @vindex elmo-archive-method-list
1198 A list of elmo-archive-@var{type}-method-alist
1199 (@var{type} is a symbol of archiver-type).
1201 @item elmo-archive-lha-dos-compatible
1202 @vindex elmo-archive-lha-dos-compatible
1203 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1204 DOS (Mr. Yoshizaki original) compatible.
1206 @item elmo-archive-cmdstr-max-length
1207 @vindex elmo-archive-cmdstr-max-length
1208 The initial setting is 8000.
1210 Max length of command line argument for external archiver program.
1211 Emacs does not have a limit of command line byte length, but some OS
1212 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1213 this limit because it calls external archiver program directly (not
1214 called via shell). For example, you cannot delete messages if archiver
1215 program must receive larger bytes of arguments to delete. OS/2 have a
1216 command line argument limit of 8190 bytes, so we defined default as 8000
1219 However, you don't have an influence of command line argument limit
1220 if the archiver has `actions' to receive target file information from
1221 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1225 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1233 A folder to access e-mails via POP3 protocol (RFC 1939).
1239 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1244 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1245 as @var{authenticate-type}.
1247 You can specify @samp{uidl} (use UIDL command for message numbering) or
1248 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1252 @var{username} -> The value of @code{elmo-pop3-default-user}.
1253 Initial setting is @env{USER} environment variable or
1254 @env{LOGNAME} environment variable or return value of
1255 @code{(user-login-name)}.
1256 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1257 Initial setting is @samp{user}.
1258 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1259 If t, use UIDL for numbering. Initial setting is t.
1260 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1261 Initial setting is @samp{localhost}.
1262 @var{port} -> The value of @code{elmo-pop3-default-port}.
1263 Initial setting is 110.
1270 &hoge@@localhost -> access localhost as user @samp{hoge}.
1271 &hoge@@popserver:109 -> access the server "popserver" on port 109
1272 as user @samp{hoge}.
1276 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1277 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1278 @file{utils/sasl/lisp/} or Emacs/W3 package
1279 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1282 If the last character of the folder name is @samp{!}, Wanderlust
1283 connects to the POP server via SSL (Secure Socket Layer). If you set
1284 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1285 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1286 with @samp{!!}, STARTTLS connection will be established. if the value
1287 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1291 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1292 @section Shimbun Folder
1294 @cindex Shimbun Folder
1295 @cindex Folder, Shimbun
1300 A folder for watching "shimbun" (means "newspaper" in Japanese),
1301 news site and mailing list archives on WWW by using emacs-w3m
1302 (@uref{http://emacs-w3m.namazu.org/}).
1304 You should possess w3m and emacs-w3m to use this.
1310 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1314 Admissible values of @var{module-name} and @var{folder-name} are
1315 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1321 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1322 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1326 @subsection Variables About Shimbun Folder
1329 @item elmo-shimbun-update-overview-folder-list
1330 @vindex elmo-shimbun-update-overview-folder-list
1331 The initial setting is @code{nil}. You can specify a list of regular
1332 expressions of shimbun folder names. The overview of matched shimbun
1333 folder is updated when messages are fetched.
1334 You should @kbd{s rescan} after fetching to update summary.
1338 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1339 @section Namazu Folder
1341 @cindex Namazu Folder
1342 @cindex Folder, Namazu
1343 @cindex Folder, Text Search
1346 A folder to access messages found in namazu-index with some condition.
1347 It uses namazu (@uref{http://www.namazu.org/}) for search.
1353 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1357 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1363 [wanderlust] -> search messages matched with
1364 "wanderlust" from the default index
1365 [semi flim]~/Mail/semi -> search "semi flim" from the index
1366 in the directory "~/Mail/semi"
1372 @subsubsection Enter space to separate keywords
1374 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1376 @subsubsection Alias name for index
1378 You can define an alias name for index.
1383 (setq elmo-nmz-index-alias-alist
1384 '(("cache" . "~/.elmo/cache")
1385 ("docs" . "~/documents")))
1388 Above definition defines two index aliases.
1395 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1396 directory @file{~/.elmo/cache}.
1398 @subsubsection Multiple indices
1400 You can specify a list for @code{elmo-nmz-default-index-path} and
1401 @code{elmo-nmz-index-alias-alist}.
1402 When list is specified, all index contained in the list is used as the
1408 (setq elmo-nmz-index-alias-alist
1409 '(("all" . ("~/.elmo/cache" "~/documents"))
1410 ("cache" . "~/.elmo/cache")))
1413 Using above alias setting, you can specify
1419 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1420 directory @file{~/.elmo/cache} and @file{~/documents}.
1422 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1423 @section Multi Folder
1425 @cindex Multi Folder
1426 @cindex Folder, Multiple
1427 @cindex Folder, Marge
1429 A folder to access virtual folder which collects messages from
1436 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1440 After @samp{*} character, specify multiple folders you want to collect
1441 separated by @samp{,} like
1442 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1448 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1449 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1450 treated as one folder.
1452 *+inbox,-fj.rec.tv,%inbox
1453 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1458 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1459 @section Filter Folder
1461 @cindex Filter Folder
1462 @cindex Folder, Filtering
1463 @cindex Folder, Virtual
1464 @cindex Folder, Conditional
1466 A folder to access virtual folder which collects all messages that
1467 satisfy a condition.
1472 @samp{/} @var{condition} @samp{/} @var{target-folder}
1475 In the @var{condition} part, you can specify following.
1479 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1481 first: @var{number} messages are picked from top of folder.
1482 last: @var{number} messages are picked from bottom of folder.
1488 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1489 /first:20/%inbox -> First 20 messages from %inbox are picked.
1494 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1496 since: only messages arrived since @var{date} are picked.
1497 before: only messages arrived before @var{date} are picked.
1499 You can specify following as @var{date}.
1503 yesterday -> a day before today.
1504 lastweek -> same day of last week.
1505 lastmonth -> same day of last month.
1506 lastyear -> same day of last year.
1507 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1508 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1516 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1518 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1524 Field filter: @samp{@var{field}:@var{value}}
1526 All messages that have @var{field} and its value is @var{value} are picked.
1527 @var{field} and @var{value} are case insensitive.
1533 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1534 and its value includes "teranisi" string are picked.
1535 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1543 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1544 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1546 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1547 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1553 /from:teranisi&!to:teranisi/+inbox
1554 -> In +inbox, messages are picked if the message's
1555 From: field includes "teranisi" and
1556 To: field doesn't include "teranisi".
1558 /tocc:"Yuuichi Teranishi"/+inbox
1559 -> In +inbox, messages are picked if the
1560 message's To: field or Cc: field includes
1561 "Yuuichi Teranishi".
1563 /(from:yt|from:teranisi)&subject:report/+inbox
1564 -> In +inbox, messages are picked if the message's
1565 From: field includes "yt" or "teranisi", and
1566 Subject includes "report".
1572 Tip for string description:
1574 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1575 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1576 should be escaped with @samp{\} in it). You can enclose the string with
1577 @samp{"} even it does not contain these characters.
1583 *%inbox,/from:teranisi/%inbox@@server
1584 -> Messages in %inbox or
1585 message is in the %inbox@@server folder and it's From field
1586 includes "teranisi" are collected.
1588 /last:100//to:teranisi/*+inbox,%inbox
1589 -> Latest 100 messages which is in the +inbox or %inbox folder
1590 and To: field matches "teranisi".
1592 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1593 -> Pick messages which have From: field and it includes "hogehoge"
1594 from latest 20 messages in the %#mh/inbox@@localhost
1595 and To: or Cc: field includes "teranisi".
1598 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1599 @section Pipe Folder
1603 @cindex Download Message
1604 @cindex Incorporate Message
1606 In the pipe folder, messages are automatically transferred from the source
1607 folder to destination folder.
1612 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1615 When you access the pipe folder, messages are automatically transferred
1616 from @var{source-folder} to @var{destination-folder}.
1617 It is convenient if you want to download messages to local disk via POP.
1618 For example, if you specify following
1621 |&username@@popserver|+inbox
1625 and access it, messages are downloaded automatically from
1626 @samp{&username@@popserver} to @samp{+inbox}.
1628 On the other hand, if you put @samp{|:} instead of second @samp{|},
1629 then messages are copied to the destination folder (not deleted from
1630 source-folder). At the next time you access that folder, only new
1631 messages will be copied.
1634 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1637 If you want to copy messages from POP server and view them, specify the
1641 |&username@@popserver|:+inbox
1644 where messages will be kept on the server.
1650 |%inbox|%myinbox -> Download %inbox to %myinbox.
1651 |*&user@@popserver1,&user@@popserver2|+inbox
1652 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1653 |-gnu.emacs.sources|:+sources
1654 -> Copy messages from -gnu.emacs.sources to +sources.
1658 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1660 @node Internal Folder, , Pipe Folder, Folders
1661 @section Internal folder
1663 @cindex Internal Folder
1664 @cindex Folder, @samp{$} mark
1666 @c @cindex Folder, Null
1668 A folder to access internal messages of Wanderlust.
1680 A folder named @samp{'mark} is a special virtual folder which collects
1681 messages which have important mark @samp{$}.
1683 You can review important messages at once after you put important marks
1684 on the messages in the different folders.
1686 In this folder, if you delete message, important mark @samp{$} put on
1687 the message is removed. If you append messages to this folder, the
1688 message will have @samp{$} mark.
1690 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1691 folder. If you want IMAP folder's message remove from @samp{'mark}
1692 folder, remove important mark at IMAP Folder.)
1695 A folder named @samp{'sendlog} is a virtual folder which collects
1696 cached messages which are recoded on @file{~/.elmo/sendlog}.
1697 It might be useful when you forgot to add cc for yourself.
1698 To use this, you should set @code{wl-draft-use-cache} to non-nil
1699 so that sent messages are cached.
1702 You can access cached messages fetched via network by accessing
1703 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1704 the name of the subdirectories of the cache directory
1705 (@file{~/.elmo/cache}).
1708 @node Folder, Summary, Folders, Top
1709 @chapter Folder mode
1712 After you start Wanderlust, folder mode is appeared firstly.
1713 It contains folder list you subscribed.
1714 You can select and edit folders in this mode.
1717 * Selecting Folder:: Select folder you want to read
1718 * Folder Manager:: Editing folders
1722 @node Selecting Folder, Folder Manager, Folder, Folder
1723 @section Selecting Folder
1724 @cindex Selecting Folder
1726 @subsection Usage (TIPS)
1728 @subsubsection Check new, unread number
1730 Folder mode looks like this.
1731 (In XEmacs, it looks much nicer @t{;-)})
1735 [-]Desktop:14186/35580/67263
1740 [-]Emacsen:0/34/4837
1741 Wanderlust ML:0/0/558
1744 XEmacs Beta:0/29/255
1755 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1759 @kbd{s} key on the folder line updates these numbers.
1760 It changes its color if it has many new messages.
1762 The whole folder mode is a folder group named @samp{Desktop}.
1763 Folder group open/close by return key.
1764 A operation to a folder group is treated as operations on the
1766 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1767 six children folders update its unread number status.
1769 @subsubsection Select Folder
1771 To enter summary mode of the folder, type return (or space) key on
1773 If the variable @code{wl-stay-folder-window} has non-nil value,
1774 summary window appears on the right of the folder mode window.
1776 @subsection Key bindings
1778 Folder mode's key binding (related to selecting folders) is following.
1783 @kindex @key{SPC} (Folder)
1784 @kindex @key{RET} (Folder)
1785 @findex wl-folder-jump-to-current-entity
1786 Enter to the summary mode of the folder at the current cursor point.
1787 If the cursor is on the top of folder group line,
1788 the folder group is opened or closed.
1789 When the cursor is on the access group and this command is called
1790 with prefix argument, folder children list is updated to the newest one.
1791 (Children list is updated recursively if the access folder has hierarchical
1793 (@code{wl-folder-jump-to-current-entity})
1796 @kindex M-@key{RET} (Folder)
1797 @findex wl-folder-update-recursive-current-entity
1798 Folder children list of the access group at the current cursor point
1799 is updated to the newest one.
1800 (Children list is updated recursively if the access folder has hierarchical
1802 (@code{wl-folder-update-recursive-current-entity})
1807 Create a new draft message.
1812 @findex wl-folder-write-current-folder
1813 If the current cursor point is on the NNTP folder, create a new draft
1814 message which already has @samp{Newsgroups:} field. If the current
1815 cursor point is on the folder for mailing list (refile destination),
1816 create a new draft message which already has @samp{To:} field with
1817 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1819 (@code{wl-folder-write-current-folder})
1822 @kindex C-c C-o (Folder)
1823 @findex wl-jump-to-draft-buffer
1824 Move to the draft buffer if available. If multiple draft buffer exists,
1825 moved to one after another. If prefix argument is specified, load draft
1826 folder's message to the draft buffer and jump to it.
1827 (@code{wl-jump-to-draft-buffer})
1831 @findex wl-folder-check-current-entity
1832 Update new and unread number information of the folder at the current
1834 (@code{wl-folder-check-current-entity})
1838 @findex wl-folder-sync-current-entity
1839 Update summary information of the folder at the current cursor point.
1840 (@code{wl-folder-sync-current-entity})
1843 @kindex r s (Folder)
1844 @findex wl-folder-check-region
1845 Update new and unread number information of the folders in the currently
1847 (@code{wl-folder-check-region})
1850 @kindex r S (Folder)
1851 @findex wl-folder-sync-region
1852 Update summary information of the folders in the currently selected region.
1853 (@code{wl-folder-sync-region})
1857 @findex wl-status-update
1858 Sync up address book status with @file{~/.addresses}'s content.
1859 (@code{wl-status-update})
1863 @findex wl-folder-prev-unread
1864 Jump cursor to the folder which have unread messages on the upward from
1865 current cursor point.
1866 (@code{wl-folder-prev-unread})
1870 Jump cursor to the folder which have unread messages on the downward
1871 from current cursor point.
1872 (@code{wl-folder-next-unread})
1876 Move cursor to the folder on the previous line.
1877 (@code{wl-folder-prev-entity})
1881 Move cursor to the folder on the next line.
1882 (@code{wl-folder-next-entity})
1886 Jump to the folder specified by the user input.
1887 (@code{wl-folder-jump-folder})
1891 @findex wl-folder-prefetch-current-entity
1892 Prefetch new messages of the folder at the current cursor point by
1893 @code{wl-summary-incorporate}.
1894 If the cursor is on the folder group, it is executed recursively.
1895 (@code{wl-folder-prefetch-current-entity})
1899 @findex wl-folder-mark-as-read-all-current-entity
1900 Mark all unread messages of the folder at the current cursor point as read.
1901 If the cursor is on the folder group, it is executed recursively.
1902 (@code{wl-folder-mark-as-read-all-current-entity})
1906 @findex wl-folder-goto-first-unread-folder
1907 Enter summary mode of the first unread folder.
1908 (@code{wl-folder-goto-first-unread-folder})
1912 @findex wl-folder-empty-trash
1914 (@code{wl-folder-empty-trash})
1918 @findex wl-folder-flush-queue
1920 (@code{wl-folder-flush-queue})
1924 @findex wl-folder-virtual
1925 Move to the virtual folder with the condition specified.
1926 (@code{wl-folder-virtual})
1930 @findex wl-folder-pick
1931 Search the folders with the condition specified.
1932 (@code{wl-folder-pick})
1936 @findex wl-folder-open-all-unread-folder
1937 All unread folder is opened.
1938 (@code{wl-folder-open-all-unread-folder})
1942 @findex wl-folder-open-close
1943 Folder group is opened/closed.
1944 (@code{wl-thread-open-close})
1948 All folder group is opened.
1949 (@code{wl-folder-open-all})
1953 All folder group is closed.
1954 (@code{wl-folder-close-all})
1964 (@code{wl-folder-suspend})
1967 @kindex M-s (Folder)
1968 Save current folder status.
1972 @kindex M-t (Folder)
1973 Toggle Wanderlust's offline/online status.
1974 (@code{wl-toggle-plugged})
1977 @kindex C-t (Folder)
1978 Start Wanderlust's plug-status manager.
1979 (@code{wl-plugged-change})
1982 @subsection Customize variables
1985 @item wl-folders-file
1986 @vindex wl-folders-file
1987 The initial setting is @file{~/.folders}.
1988 Subscribed folders are described (saved) in this file.
1990 @item wl-folder-info-save
1991 @vindex wl-folder-info-save
1992 The initial setting is @code{t}. If non-nil, unread information is
1993 saved and used in the next Wanderlust session.
1995 @item wl-stay-folder-window
1996 @vindex wl-stay-folder-window
1997 The initial setting is @code{nil}.
1998 If non-nil, summary window is appeared on the right side of the folder buffer.
2000 @item wl-folder-window-width
2001 @vindex wl-folder-window-width
2002 The initial setting is 20.
2003 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2005 @item wl-folder-use-frame
2006 @vindex wl-folder-use-frame
2007 The initial setting is @code{nil}.
2008 If non-nil, use new frame for the folder window.
2010 @item wl-folder-many-unsync-threshold
2011 @vindex wl-folder-many-unsync-threshold
2012 The initial setting is 70.
2013 If the number of unread messages is more than this value,
2014 folder color is changed.
2016 @item wl-highlight-folder-by-numbers
2017 @vindex wl-highlight-folder-by-numbers
2018 This option controls how to highlight each line in the folder buffer.
2019 The default value is @code{t}, highlighting with various colors based on
2020 the message numbers. If it is @code{nil}, highlighting with various
2021 colors based on the folder status. In addition, if it is a number
2022 (e.g. 1), highlighting will be done based on both the message numbers
2023 and the folder status.
2025 @item wl-folder-desktop-name
2026 @vindex wl-folder-desktop-name
2027 The initial setting is @samp{Desktop}.
2028 The name of top folder group.
2030 @item wl-folder-petname-alist
2031 @vindex wl-folder-petname-alist
2032 The initial setting is @code{nil}.
2033 An alist of folder's realname and its nickname.
2035 @item wl-folder-access-subscribe-alist
2036 @vindex wl-folder-access-subscribe-alist
2037 The initial setting is @code{nil}.
2039 Control automatic subscribing and unsubscribing of the children list
2045 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2049 If @var{subscribe-flag} is non-nil, folders which have name matched to
2050 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2051 already unsubscribed folder is not displayed even when the
2052 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2059 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2060 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2061 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2062 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2066 @item wl-folder-hierarchy-access-folders
2067 @vindex wl-folder-hierarchy-access-folders
2068 The initial setting is the list shown below:
2077 A list of access groups which creates children folder list hierarchically.
2079 For example, if you specify
2080 @code{wl-folder-hierarchy-access-folders} like following,
2084 (setq wl-folder-hierarchy-access-folders
2085 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
2090 such access group hierarchy is obtained.
2096 -fj.comp.announce:0/0/2
2097 -fj.comp.dev.cdrom:0/0/0
2099 [+]-japan:238/238/1688
2102 -comp.unix.admin:0/0/0
2103 -comp.unix.dos-under-unix:0/0/0
2104 -comp.unix.programmer:0/0/0
2105 [-]-comp.unix.bsd:0/0/23
2106 -comp.unix.bsd.freebsd.announce:0/0/0
2111 If you opened @samp{-} in this example, only the direct children is created
2112 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2113 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2114 is not created until the children access group is opened.
2118 @node Folder Manager, , Selecting Folder, Folder
2119 @section Editing Folders
2120 @cindex Folder Manager
2121 @cindex Folder, Edit
2122 @cindex Folder, Subscribe
2123 @cindex Folder, Unsubscribe
2125 As described before, subscribed folder list is saved in @file{~/.folders} file.
2126 But you don't have to edit @file{~/.folders} directly.
2127 You can append, delete, edit folders from folder mode.
2129 @subsection Usage (Tips)
2131 @subsubsection Append Folder
2133 @kbd{m a} appends new folder to the folder mode.
2134 @kbd{m g} appends new folder group.
2135 To append new folder to this group, firstly open it,
2136 then execute append command in the next line.
2138 @subsubsection Edit Folder
2140 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2141 Thus, you can change folder position as if you were editing a normal file.
2143 @subsubsection Create Multi Folder.
2147 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2149 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2151 Type @kbd{m m}, then you can create multi folder.
2154 @subsubsection Delete Nickname, Filter
2156 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2157 minibuffer while appending.
2159 @subsubsection Append Folder to Empty Group
2161 To append new folder to the empty folder group
2162 (after you create folder group by typing @kbd{m g}),
2163 firstly open it, then execute append command in the next line.
2164 If it is closed, folder is appended on the same level with
2165 the above folder group. It is difficult to explain by words so try it.
2166 In other words, appended position depends on the
2167 above folder group's open/close status.
2169 @subsubsection Charset of the Folders File.
2171 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2173 @subsubsection Create Filter
2175 @kbd{m f} adds filter to the folder at the current cursor point. To
2176 create new filter folder and leave the current folder unchanged, copy it
2177 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2178 filter can be specified while appending filter. If you put
2179 ``''(@var{NULL}), filter is deleted.
2181 @subsubsection Sort Folders
2183 Sorting of the folders is executed by the function specified by
2184 @code{wl-fldmgr-sort-function}.
2185 The initial setting is @code{wl-fldmgr-sort-standard},
2186 which sorts alphabetically.
2187 Sorting affects only on the current folder group. It does not
2188 affect on the child groups.
2190 @subsubsection Hiding Folders in the Access Group
2192 Usually, access group displays all children folders, but you can set
2193 some folders hidden. Following operations are only available on access
2196 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2197 (subscribe/unsubscribe) of the folder at current cursor point. Against
2198 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2201 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2202 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2203 argument and if the argument has positive number, the unsubscribe it.
2204 If the prefix argument has negative value, folder becomes visible and if
2205 zero, folder visibility is toggled.
2207 The other commands, @code{wl-fldmgr-subscribe} and
2208 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2211 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2212 executed in the access group, they have a same effect with
2213 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2214 The difference is that cut commands deletes folders from the current
2217 @subsubsection Operations in the Access Group
2219 You can insert and delete folders in the access group like usual folder
2220 group. But insert and delete commands can be only available for the
2221 children folders of the access group and they only sets the subscribe
2222 status. In other words, insertion of the folder means subscribing,
2223 deletion means unsubscribing.
2224 @footnote{In the current implementation,
2225 it is faster to delete region than to unsubscribe region.}
2227 To update the access group when children folders are inserted or deleted
2228 by other way (other than Wanderlust),
2229 open the access group by typing @kbd{C-u @key{RET}}.
2230 @xref{Selecting Folder}.
2232 The order of children folders of access group is saved after
2233 insertion/deletion/sorting.
2234 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2235 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2236 newly created folders are inserted on the top of the access group.
2238 @subsection Key bindings
2239 @cindex Keybind, Folder Mode
2240 @cindex Keybind, Folder Buffer
2242 Key bindings on the folder mode related to folder editing are shown below.
2243 All bindings starts with @kbd{m}, and primary commands are binded to
2244 one stroke key binding.
2248 @kindex m a (Folder)
2249 @findex wl-fldmgr-add
2251 (@code{wl-fldmgr-add})
2256 @kindex m g (Folder)
2257 @findex wl-fldmgr-make-group
2258 Create a folder group.
2259 (@code{wl-fldmgr-make-group})
2262 @kindex m A (Folder)
2263 @findex wl-fldmgr-make-access-group
2264 Create an access group.
2265 (@code{wl-fldmgr-make-access-group})
2268 @kindex m d (Folder)
2269 @findex wl-fldmgr-delete
2270 Delete folder itself and msgdb.
2271 If the folder itself cannot be deleted like NNTP folder,
2272 only msgdb is deleted.
2273 (@code{wl-fldmgr-delete})
2278 @kindex m R (Folder)
2279 @findex wl-fldmgr-rename
2280 Change the name of folder or folder group.
2281 msgdb's path is also changed.
2282 (@code{wl-fldmgr-rename})
2288 @findex wl-fldmgr-make-multi
2289 Create a multi folders in the cutlist (cut, copied folders).
2290 (@code{wl-fldmgr-make-multi})
2295 @kindex m f (Folder)
2296 @findex wl-fldmgr-make-filter
2297 Create a filter folder. (Put a filter on the folder).
2298 (@code{wl-fldmgr-make-filter})
2302 @kindex M-c (Folder)
2303 @kindex m c (Folder)
2304 @findex wl-fldmgr-copy
2305 Copy folder (it is not available on folder group).
2306 (@code{wl-fldmgr-copy})
2310 @kindex M-w (Folder)
2311 @kindex m W (Folder)
2312 @findex wl-fldmgr-copy-region
2313 Copy folders in the specified region.
2314 (@code{wl-fldmgr-copy-region})
2318 @kindex C-k (Folder)
2319 @kindex m k (Folder)
2320 @findex wl-fldmgr-cut
2321 Cut folder. Folder itself is not deleted.
2322 (@code{wl-fldmgr-cut})
2326 @kindex C-w (Folder)
2327 @kindex m C-w (Folder)
2328 @findex wl-fldmgr-cut-region
2329 Cut folders in the specified region.
2330 (@code{wl-fldmgr-cut-region})
2334 @kindex C-y (Folder)
2335 @kindex m y (Folder)
2336 @findex wl-fldmgr-yank
2337 Paste folders that are copied or cut (folders in the cut-list).
2338 (@code{wl-fldmgr-yank})
2341 @kindex m p (Folder)
2342 @findex wl-fldmgr-set-petname
2343 Put nickname on the folder.
2344 (@code{wl-fldmgr-set-petname})
2347 @kindex m q (Folder)
2348 @findex wl-fldmgr-clear-cut-entity-list
2349 Clear the cut-list. (cut, copied folder information is cleared,
2350 you cannot paste after this)
2351 (@code{wl-fldmgr-clear-cut-entity-list})
2354 @kindex m s (Folder)
2355 @findex wl-fldmgr-sort
2356 Sort folders in the current folder group.
2357 (@code{wl-fldmgr-sort})
2360 @kindex m C-s (Folder)
2361 @findex wl-fldmgr-save
2362 Save current folder view to the @file{wl-folders-file}.
2363 (@code{wl-fldmgr-save})
2366 [Following commands are only available on the access groups]
2372 @kindex m u (Folder)
2373 @findex wl-fldmgr-unsubscribe
2374 Set the visibility of folder (subscribe/unsubscribe).
2375 (@code{wl-fldmgr-unsubscribe})
2380 @kindex r u (Folder)
2381 @findex wl-fldmgr-unsubscribe-region
2382 Set the visibility of the folders (subscribe/unsubscribe) in the
2384 (@code{wl-fldmgr-unsubscribe-region})
2389 @kindex m l (Folder)
2390 @findex wl-fldmgr-access-display-normal
2391 List folders that are currently available.
2392 (@code{wl-fldmgr-access-display-normal})
2397 @kindex m L (Folder)
2398 @findex wl-fldmgr-access-display-all
2399 List all folders regardless of the subscription status.
2400 (@code{wl-fldmgr-access-display-all})
2404 @subsection Customize variables
2407 @item wl-interactive-save-folders
2408 @vindex wl-interactive-save-folders
2409 The initial setting is @code{t}. If non-nil and folder view is
2410 modified, confirm saving it before Wanderlust or Emacs exits. If
2411 @code{nil}, save without confirmation.
2413 @item wl-fldmgr-make-backup
2414 @vindex wl-fldmgr-make-backup
2415 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2416 created before saving the folder status.
2418 @item wl-fldmgr-sort-function
2419 @vindex wl-fldmgr-sort-function
2420 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2421 sort folders. By default function, folders are sorted alphabetically
2422 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2425 @item wl-fldmgr-sort-group-first
2426 @vindex wl-fldmgr-sort-group-first
2427 The initial setting is @code{t}. If non-nil,
2428 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2429 does not care whether it is folder group or not.
2431 @item wl-folder-check-async
2432 @vindex wl-folder-check-async
2433 The initial setting is @code{t}. If non-nil, check folder's unread
2434 status asynchronously. It boosts newsgroup checking.
2436 @item wl-folder-check-fast
2437 @vindex wl-folder-check-fast
2438 The initial setting is @code{nil}.
2439 If non-nil, it does not update folder status while checking.
2441 @item wl-folder-notify-deleted
2442 @vindex wl-folder-notify-deleted
2443 The initial setting is @code{nil}.
2445 If non-nil, negative value is displayed when the message is deleted. If
2446 @code{sync}, folder is synchronized when the message is deleted. If
2447 @code{nil}, message deletion is ignored.
2449 @item wl-fldmgr-add-complete-with-current-folder-list
2450 @vindex wl-fldmgr-add-complete-with-current-folder-list
2451 The initial setting is @code{nil}.
2452 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2453 candidate for @code{wl-fldmgr-add}.
2456 @subsection Miscellanea
2458 Following is a note for folder editing.
2462 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2463 paste(yank) command pastes the folders on one cut or copy command
2464 (If copy command is executed by region, folders in the region are pasted
2465 by one paste command)
2468 You cannot cut @samp{Desktop} group.
2469 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2472 You cannot copy folder group.
2475 Operations on the access group are only available for the folders
2476 in the same access group.
2479 You cannot create a folder which has same name with the folders already exist.
2482 You cannot insert folders which have same name in one group.
2483 You can insert them in the different groups.
2484 You cannot put same nickname to the different folders.
2488 @node Summary, Message, Folder, Top
2489 @chapter Summary Mode
2491 After you select the folder via folder mode, you enter to the summary
2495 * Usage of Summary Mode:: TIPS
2496 * Thread Operations:: Thread operations
2497 * Cache:: File cache, Buffer cache, and Prefetch
2498 * Auto Refile:: Auto refile settings
2499 * Sticky Summary:: Summary make sticky
2500 * Key Bindings of Summary:: Key bindings
2501 * Variables of Summary:: Customize Summary Mode
2505 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2506 @section Usage (Tips)
2508 @subsection Summary Content
2510 In the summary mode, messages are displayed like following.
2514 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2515 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2516 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2517 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2524 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2528 You cannot change this in the current version.
2530 @var{Message number} is the message's unique number in the folder. In
2531 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2532 in the MH folder, it is the filename of the message.
2534 @var{Temporal mark} and @var{Persistent mark} are described later.
2536 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2537 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2538 Japanese, but if you want to display it in English, set the value of
2539 @code{wl-summary-weekday-name-lang} as @samp{en}.
2541 @var{Sender}'s indentation corresponds to the depth of the thread.
2542 Sender name is displayed as nickname if it is defined in the address
2543 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2544 displaying with nickname.
2546 If number is printed at the head of @var{Sender} part like @samp{+2},
2547 that means the message have 2 follow messages.
2549 @var{Subject} is the @samp{Subject:} header field of the message. If
2550 the message have same @samp{Subject:} with the parent message, it is not
2551 displayed. Some mailing list puts its sequence number in the
2552 @samp{Subject:} field, but it is
2553 ignored. @code{wl-summary-no-subject-message} is displayed when the
2554 message has empty subject field.
2556 @subsection Temporary Marks
2557 @cindex Mark, Temporary
2559 There are four temporary marks,
2560 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2561 Temporary marks indicates message operations.
2566 You can execute a command on the all messages that have @samp{*} mark,
2567 with the key bindings which begins with @kbd{m}.
2570 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2574 After you type @kbd{o} key, prompt appears to input refile destination.
2575 Your answer is printed in the summary line.
2579 You can put this mark by typing @kbd{O} key.
2580 The difference between this mark and refile mark is,
2581 this mark does not delete the message while latter does.
2584 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2586 @subsection Persistent Marks
2588 There are five persistent marks,
2589 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2591 The persistent mark indicates the message's status and it is saved.
2592 Each persistent mark indicates:
2598 It is unread message.
2600 It is unread but cached message.
2602 It is read but it is not cached.
2604 It is important message. You can put @samp{$} mark by typing @kbd{$}
2605 key (if already exists, the mark is deleted). It is convenient to put
2606 this mark on the messages to remember (If you want to remember to write
2607 a reply for the message, for example) because this mark remains after
2608 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2609 @samp{'mark} folder even the message itself is deleted in the actual folder.
2612 If the message is read and cached (or local message),there are no
2616 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2617 cache. Messages with the marks other than these, you can read them in
2618 the offline status even they are in the IMAP folder or netnews folder.
2620 Among messages with persistent marks, ones with marks specified by
2621 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2622 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2624 @subsection How To Read
2626 Basically, you can read messages only typing space key again and again.
2628 To update summary status to the newest status (synchronize),
2631 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2632 moves cursor to the next message.
2633 Enter message buffer by typing @kbd{j} key.
2634 To operate multipart, you have to enter to the message buffer.
2637 @subsection Pack the Message Numbers
2638 You can pack the message numbers in Summary by
2639 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2640 News Spool Folder and Maildir Folder are supported folder types.
2643 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2644 @section Thread Operations
2646 For example, the following line indicates one thread (a context of a topic).
2649 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2653 If you type @kbd{/} on this line, the thread is opened and it changes
2654 the appearance like following.
2658 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2659 388 09/17(Thu)22:34 +-[ Murata san ]
2663 (Message 388 is the replied message to the message 384.)
2664 If you type @kbd{/} key once again, the thread is closed.
2665 With prefix argument, @kbd{/} opens all children threads.
2667 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2670 Commands with the key binding that begins with @kbd{t} executes commands
2671 on the messages in the thread.
2672 @xref{Key Bindings of Summary}.
2674 @subsection reconstruct thread by hand
2676 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2677 (@code{wl-summary-save-current-message}) at the corresponding message,
2678 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2679 message then you have the reconstructed thread.
2682 @node Cache, Auto Refile, Thread Operations, Summary
2685 @subsection Cache File
2687 The messages which have to access via network (e.x. IMAP, NNTP folder)
2688 are cached as a local file. The cache file is saved under the directory
2689 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2690 elmo-cache-expire-by-size}. The command deletes cache files to the
2691 specified size by the order of last accessed time.
2693 @subsection Buffer Cache and Prefetching
2695 The messages that are read are kept in the cache buffer. It is called
2696 `buffer cache'. The number of cache buffer is specified by
2697 @code{wl-message-buffer-cache-size}.
2699 There are message prefetching mechanism in the Wanderlust that
2700 prefetches next message while you are reading.
2702 You can control the message prefetching mechanism by these two
2706 @item wl-message-buffer-prefetch-folder-type-list
2707 @vindex wl-message-buffer-prefetch-folder-type-list
2708 The initial setting is @code{t}. In this case, prefetch messages in all
2710 If it is a list of folder types, it specifies the folder types in which
2711 message prefetching is enabled.
2712 Following is an example (prefetch messages in nntp and imap4 folders)
2716 (setq wl-message-buffer-prefetch-folder-type-list
2721 In this case, multi folder that contains localdir and imap4 prefetches
2722 only imap4 messages. This variable precedes the value of
2723 @code{wl-message-buffer-prefetch-folder-list}.
2725 @item wl-message-buffer-prefetch-folder-list
2726 @vindex wl-message-buffer-prefetch-folder-list
2727 The initial setting is @code{nil}.
2728 A list of regexp of folders to enable message prefetching.
2730 @item wl-message-buffer-prefetch-depth
2731 @vindex wl-message-buffer-prefetch-depth
2732 The initial setting is 3. The number of messages for automatical prefetch.
2734 @item wl-message-buffer-prefetch-idle-time
2735 @vindex wl-message-buffer-prefetch-idle-time
2736 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2738 @item wl-message-buffer-prefetch-threshold
2739 @vindex wl-message-buffer-prefetch-threshold
2740 The initial setting is 30000 (bytes). If prefetching message has larger
2741 size than this value, Wanderlust does not prefetch automatically.
2742 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2743 the message is not checked for the size.
2747 @node Auto Refile, Sticky Summary, Cache, Summary
2748 @section Auto Refile
2749 @vindex elmo-msgdb-extra-fields
2750 @vindex wl-refile-rule-alist
2751 @findex wl-summary-auto-refile
2753 You can refile messages automatically, by typing @kbd{C-o}
2754 (@code{wl-summary-auto-refile}). It decides destination of refile by
2755 the content of the message header information (information in the msgdb).
2757 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2758 available. If you want to decide destination by other header fields,
2759 set the variable @code{elmo-msgdb-extra-fields} like following.
2763 (setq elmo-msgdb-extra-fields
2773 By this setting, Wanderlust saves extra fields in the msgdb. You have
2774 to type @kbd{s all} to get extra fields for the messages that are
2775 already exists in the summary.
2777 Then, specify the refile rule. The refile target folder of auto
2778 refiling is decided by the value of @code{wl-refile-rule-alist}.
2779 @code{wl-refile-rule-alist} is a list of a rule:
2783 (@var{field} (@var{regexp} . @var{target})
2784 (@var{regexp} . @var{target})
2789 Each rule means `if @var{field} value matches @var{regexp},
2790 then refile to @var{target} folder'.
2791 The rule matched first is applied.
2793 @var{field} is a string of field name. You can specify a list of field name
2794 string, too. In this case, if one of these fields is matched, then the
2795 rule is fired (i.e. OR condition).
2797 @var{regexp} is a regular expression for field value. @var{target} is a target
2798 folder string. You can specify a rule at @var{target} part, too. In this
2799 case, If the field value of the rule and the current rule is matched,
2800 then the current rule is fired (i.e. AND condition).
2802 In @var{target} part, you can refer matched substring of @var{regexp}.
2803 To refer substring, specify following in @var{target}:
2807 means substitute original matched text.
2810 means substitute what matched the @var{N}th `\(@dots{}\)'.
2811 (@var{N} is a number.)
2814 Following is an example of @code{wl-refile-rule-alist}.
2818 (setq wl-refile-rule-alist
2820 ("^Wanderlust" . "+wl")
2821 ("^Elisp" . "+elisp"))
2823 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2825 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2826 "+from-me-to-you"))))))
2830 After these settings, refile marks are automatically put on the condition
2831 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2833 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2835 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2836 with these persistent marks are not automatically refiled.
2837 It means Wanderlust does not execute auto refile on unread messages by
2838 the default setting.
2839 To execute auto refile on all messages, set following.
2842 (setq wl-summary-auto-refile-skip-marks nil)
2846 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2847 @section Sticky Summary
2848 @cindex Summary, Sticky
2849 @cindex Sticky Summary
2851 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2853 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2854 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2856 The buffer name of the sticky summary becomes like
2857 @samp{Summary:@var{folder-name}}.
2859 You can visit the sticky summary at any time by @kbd{C-x b}
2860 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2861 q}. Other operations in the sticky summary are same as normal summary.
2863 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2864 are automatically stuck.
2867 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2868 @section Key bindings
2869 @cindex Keybind, Summary Mode
2870 @cindex Keybind, Summary Buffer
2872 Key bindings of the summary mode are shown below.
2876 @kindex @key{SPC} (Summary)
2877 @findex wl-summary-read
2878 Proceed reading a message at the current cursor point.
2879 (@code{wl-summary-read})
2883 @findex wl-summary-redisplay
2884 Redisplay a message at the current cursor point.
2885 If this command is called with prefix argument,
2886 Redisplay message regardless of the message cache (message is re-loaded
2888 (@code{wl-summary-redisplay})
2892 @findex wl-summary-display-top
2893 Display the top message in the folder.
2894 (@code{wl-summary-display-top})
2898 @findex wl-summary-display-bottom
2899 Display the bottom message in the folder.
2900 (@code{wl-summary-display-bottom})
2904 @kindex @key{BS} (Summary)
2905 @kindex @key{DEL} (Summary)
2906 Display the previous page of the message at the current cursor point.
2907 @findex wl-summary-prev-page
2908 (@code{wl-summary-prev-page})
2911 @kindex @key{RET} (Summary)
2912 @findex wl-summary-next-line-content
2913 Display the next line of the message at the current cursor point.
2914 Display the message at the current cursor point if it is not displayed yet.
2915 (@code{wl-summary-next-line-content})
2920 @kindex M-@key{RET} (Summary)
2921 @findex wl-summary-prev-line-content
2922 Display the previous line of the message at the current cursor point.
2923 Display the message at the current cursor point if it is not displayed yet.
2924 (@code{wl-summary-prev-line-content})
2928 @findex wl-thread-open-close
2929 Toggle open or close the thread at the current cursor point.
2930 (@code{wl-thread-open-close})
2935 @findex wl-thread-open-all
2936 (@code{wl-thread-open-all})
2941 @findex wl-thread-close-all
2942 (@code{wl-thread-close-all})
2946 @findex wl-summary-goto-folder
2948 (@code{wl-summary-goto-folder})
2952 Mark all messages in the folder as read.
2953 @findex wl-summary-mark-as-read-all
2954 (@code{wl-summary-mark-as-read-all})
2958 @findex wl-summary-reply
2959 Prepare a draft for reply the message at the current cursor point.
2960 (@code{wl-summary-reply})
2964 @findex wl-summary-reply-with-citation
2965 Prepare a draft for reply the message at the current cursor point.
2966 (@code{wl-summary-reply-with-citation})
2970 @findex wl-summary-cancel-message
2971 If the message at current cursor point is your own netnews article,
2973 (@code{wl-summary-cancel-message})
2977 @findex wl-summary-reedit
2978 Prepare a draft for re-editing the message at current cursor point.
2979 If the message at current cursor point is your own netnews article,
2980 a draft for `supersedes message' for the message is prepared.
2981 (@code{wl-summary-reedit})
2984 @kindex M-e (Summary)
2985 @findex wl-summary-resend-bounced-mail
2986 If the message at current cursor point is a bounced message,
2987 a draft for re-sending original message is prepared.
2988 (@code{wl-summary-resend-bounced-mail})
2992 @findex wl-summary-forward
2993 A draft for forwarding the message at current cursor point is prepared.
2994 (@code{wl-summary-forward})
2998 @findex wl-summary-mark-as-important
2999 Put @samp{$} mark on the message at current cursor point.
3000 If already marked as @samp{$}, delete it.
3001 (@code{wl-summary-mark-as-important})
3007 Save the message at current cursor point.
3008 @findex wl-summary-save
3009 (@code{wl-summary-save})
3013 @findex wl-summary-next
3014 Move cursor to the next message.
3015 If message is marked with a temporal mark in
3016 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3017 In the offline mode, cursor is not moved to the messages which are not cached
3019 (@code{wl-summary-next})
3023 @findex wl-summary-prev
3024 Move cursor to the previous message.
3025 If message is marked with a temporal mark in
3026 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3027 In the offline mode, cursor is not moved to the messages which are not cached
3029 (@code{wl-summary-prev})
3033 @findex wl-summary-down
3034 Move cursor to the downward message which is unread or marked
3036 In the offline mode, cursor is not moved to the messages which are not cached
3038 If there are messages which have target mark @samp{*} in the summary,
3039 cursor is moved to the downward message which have a target mark.
3040 This behavior is changed according to the value of @code{wl-summary-move-order}.
3041 (@code{wl-summary-down})
3045 @findex wl-summary-up
3046 Move cursor to the upward message which is unread or marked
3048 In the offline mode, cursor is not moved to the messages which are not cached
3050 If there are messages which have target mark @samp{*} in the summary,
3051 cursor is moved to the downward message which have a target mark.
3052 This behavior is changed according to the value of @code{wl-summary-move-order}.
3053 (@code{wl-summary-up})
3057 @findex wl-summary-write
3058 Prepare a new draft.
3059 (@code{wl-summary-write})
3063 @findex wl-summary-write-current-folder
3064 Prepare a new draft. If the current folder is NNTP folder,
3065 @samp{Newsgroups:} field is completed. If the current folder is mailing
3066 list folder (refile destination), guess @samp{To:} field and completed
3067 (If @code{wl-subscribed-mailing-list} is valid list)
3068 (@code{wl-summary-write-current-folder})
3072 @findex wl-summary-redisplay-all-header
3073 Redisplay the message at current cursor point with all header fields.
3074 (@code{wl-summary-redisplay-all-header})
3078 @findex wl-summary-redisplay-no-mime
3079 Redisplay the message at current cursor point without MIME analysis.
3080 (@code{wl-summary-redisplay-no-mime})
3084 @findex wl-summary-burst
3085 If the message at current cursor point has
3086 encapsulates multiple messages using MIME,
3087 de-capsulate and extract them on the current folder.
3088 (@code{wl-summary-burst})
3091 @kindex @@ (Summary)
3092 @findex wl-summary-edit-addresses
3093 Append/change/delete the message's sender information to the address
3094 book @file{~/.addresses} interactively. If this command is called with
3095 prefix argument, arbitrary address can be edited.
3096 (@code{wl-summary-edit-petname})
3100 @findex wl-status-update
3101 Sync up address book status with @file{~/.addresses}'s content.
3102 (@code{wl-status-update})
3106 @findex wl-summary-pipe-message
3107 Pipe current message's content to the external process.
3108 (@code{wl-summary-pipe-message})
3112 @findex wl-summary-print-message
3113 Print out current message's content.
3114 It uses @code{ps-print} module in Emacs 20.x.
3115 If you don't use color printer, you might want to set
3116 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3119 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3122 (@code{wl-summary-print-message})
3126 @findex wl-summary-exit
3127 Exit current folder.
3128 (@code{wl-summary-exit})
3132 @findex wl-summary-jump-to-current-message
3133 Jump cursor to the currently displayed message's window.
3134 (@code{wl-summary-jump-to-current-message})
3138 Jump cursor to the other message.
3139 @findex wl-summary-jump-to-msg
3140 (@code{wl-summary-jump-to-msg})
3144 Update summary status and
3145 prefetch all messages which have marks included in the
3146 @code{wl-summary-incorporate-marks}.
3147 @findex wl-summary-incorporate
3148 (@code{wl-summary-incorporate})
3151 @kindex M-j (Summary)
3152 @findex wl-summary-jump-to-msg-by-message-id
3153 Jump cursor to the message which have specified @samp{Message-Id:}. If
3154 @code{elmo-use-database} is non-nil, other folder is also searched.
3155 (@code{wl-summary-jump-to-msg-by-message-id})
3159 Jump to parent message.
3160 @findex wl-summary-jump-to-parent-message
3161 (@code{wl-summary-jump-to-parent-message})
3165 @findex wl-summary-mark-as-unread
3166 Mark as unread the message at current cursor point.
3167 (@code{wl-summary-mark-as-unread})
3171 @findex wl-summary-sync
3172 Synchronize summary view after prompting the update range
3173 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3177 all ...Discard current summary and update all message.
3178 all-visible ...Discard current summary and update all visible message.
3179 update ...Update the difference between summary and the folder itself.
3180 rescan ...Rescan the msgdb and display again.
3181 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3182 cache-status ...Sync the all marks with the real status of cache.
3183 first, last ...Move to the filter folder(partial filter).
3188 (@code{wl-summary-sync})
3192 @findex wl-summary-sort
3194 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3195 (@code{wl-summary-sort})
3199 @findex wl-summary-toggle-thread
3200 Toggle the threading.
3201 Threading status is displayed on the modeline.
3202 @samp{@{S@}} means threading is off (Sequence) and
3203 @samp{@{T@}} means threading is on (Thread).
3204 (@code{wl-summary-toggle-thread})
3208 @findex wl-summary-toggle-disp-folder
3209 Toggle displaying of folder window.
3210 (@code{wl-summary-toggle-disp-folder})
3214 Toggle displaying of message window.
3215 @findex wl-summary-toggle-disp-msg
3216 (@code{wl-summary-toggle-disp-msg})
3220 Move to the virtual folder with the condition specified.
3221 If called with prefix argument and current folder is virtual, exit it.
3222 @findex wl-summary-virtual
3223 (@code{wl-summary-virtual})
3226 @kindex @key{TAB} (Summary)
3227 @findex wl-summary-goto-last-displayed-msg
3228 Jump to the message which is displayed last.
3229 (@code{wl-summary-goto-last-displayed-msg})
3233 Put @samp{*} mark on the messages that satisfies the specified condition.
3234 @findex wl-summary-pick
3235 (@code{wl-summary-pick})
3239 @findex wl-summary-mark-as-read
3240 Mark as read the message at the current cursor point.
3241 (@code{wl-summary-mark-as-read})
3245 Prefetch the message at the current cursor point.
3246 With prefix argument, prefetch the message even if it is cached.
3247 @findex wl-summary-prefetch
3248 (@code{wl-summary-prefetch})
3252 Execute @samp{D}, @samp{o} and @samp{O} marks.
3253 @findex wl-summary-exec
3254 (@code{wl-summary-exec})
3258 @findex wl-summary-target-mark-line
3259 Put target mark on the message at the current cursor point.
3260 (@code{wl-summary-target-mark-line})
3264 Put refile mark on the message at the current cursor point.
3265 @findex wl-summary-refile
3266 (@code{wl-summary-refile})
3269 @kindex C-o (Summary)
3270 Execute auto refile.
3271 @findex wl-summary-auto-refile
3272 (@code{wl-summary-auto-refile})
3276 Put copy mark on the message at the current cursor point.
3277 @findex wl-summary-copy
3278 (@code{wl-summary-copy})
3281 @kindex M-o (Summary)
3282 Put refile mark on the message at the current cursor point with the destination
3283 previously specified.
3284 @findex wl-summary-refile-prev-destination
3285 (@code{wl-summary-refile-prev-destination})
3289 @findex wl-summary-delete
3290 Put delete mark on the message at the current cursor point.
3291 (@code{wl-summary-delete})
3295 @findex wl-summary-unmark
3296 Unmark the temporal mark on the message at the current cursor point.
3297 (@code{wl-summary-unmark})
3301 Unmark all the temporal marks.
3302 @findex wl-summary-unmark-all
3303 (@code{wl-summary-unmark-all})
3306 @kindex r R (Summary)
3307 @findex wl-summary-mark-as-read-region
3308 Mark as read messages in the specified region.
3309 (@code{wl-summary-mark-as-read-region})
3312 @kindex r $ (Summary)
3313 @findex wl-summary-mark-as-important-region
3314 Mark as important @samp{$} messages in the specified region.
3315 If @samp{$} already exists, it is deleted.
3316 (@code{wl-summary-mark-as-important-region})
3319 @kindex r ! (Summary)
3320 @findex wl-summary-mark-as-unread-region
3321 Mark as unread messages in the specified region.
3322 (@code{wl-summary-mark-as-unread-region})
3325 @kindex r i (Summary)
3326 @findex wl-summary-prefetch-region
3327 Prefetch messages in the specified region.
3328 (@code{wl-summary-prefetch-region})
3331 @kindex r x (Summary)
3332 @findex wl-summary-exec-region
3333 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3335 (@code{wl-summary-exec-region})
3338 @kindex r * (Summary)
3339 @findex wl-summary-target-mark-region
3340 Put target mark on the messages in the specified region.
3341 (@code{wl-summary-target-mark-region})
3344 @kindex r o (Summary)
3345 @findex wl-summary-refile-region
3346 Put refile mark on the messages in the specified region.
3347 (@code{wl-summary-refile-region})
3350 @kindex r O (Summary)
3351 @findex wl-summary-copy-region
3352 Put copy mark on the messages in the specified region.
3353 (@code{wl-summary-copy-region})
3356 @kindex r d (Summary)
3357 @findex wl-summary-delete-region
3358 Put delete mark on the messages in the specified region.
3359 (@code{wl-summary-delete-region})
3362 @kindex r u (Summary)
3363 @findex wl-summary-unmark-region
3364 Delete temporal mark on the messages in the specified region.
3365 (@code{wl-summary-unmark-region})
3368 @kindex r y (Summary)
3369 Save messages in the specified region.
3370 @findex wl-summary-save-region
3371 (@code{wl-summary-save-region})
3374 @kindex t R (Summary)
3375 @findex wl-thread-mark-as-read
3376 Mark as read messages which are the descendant of the current thread.
3377 With prefix argument, it affects on the all messages in the thread tree.
3378 (@code{wl-thread-mark-as-read})
3381 @kindex t $ (Summary)
3382 @findex wl-thread-mark-as-important
3383 Put important mark @samp{$} on the messages which are the
3384 descendant of the current thread.
3385 If @samp{$} mark exists, it is deleted.
3386 With prefix argument, it affects on the all messages in the thread tree.
3387 (@code{wl-thread-mark-as-important})
3390 @kindex t ! (Summary)
3391 @findex wl-thread-mark-as-unread
3392 Mark as unread messages which are the descendant of the current thread.
3393 With prefix argument, it affects on the all messages in the thread tree.
3394 (@code{wl-thread-mark-as-unread})
3397 @kindex t i (Summary)
3398 @findex wl-thread-prefetch
3399 Prefetch messages which are the descendant of the current thread.
3400 With prefix argument, it affects on the all messages in the thread tree.
3401 (@code{wl-thread-prefetch})
3404 @kindex t x (Summary)
3405 @findex wl-thread-exec
3406 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3407 the descendant of the current thread. With prefix argument, it affects
3408 on the all messages in the thread tree.
3409 (@code{wl-thread-exec})
3412 @kindex t * (Summary)
3413 @findex wl-thread-target-mark
3414 Put target mark @samp{*} on the messages which are the descendant of the
3415 current thread. With prefix argument, it affects on the all messages in
3417 (@code{wl-thread-target-mark})
3420 @kindex t o (Summary)
3421 @findex wl-thread-refile
3422 Put refile mark on the messages which are the descendant of the current thread.
3423 With prefix argument, it affects on the all messages in the thread tree.
3424 (@code{wl-thread-refile})
3427 @kindex t O (Summary)
3428 @findex wl-thread-copy
3429 Put copy mark on the messages which are the descendant of the current thread.
3430 With prefix argument, it affects on the all messages in the thread tree.
3431 (@code{wl-thread-copy})
3434 @kindex t d (Summary)
3435 @findex wl-thread-delete
3436 Put delete mar on the messages which are the descendant of the current thread.
3437 With prefix argument, it affects on the all messages in the thread tree.
3438 (@code{wl-thread-delete})
3441 @kindex t u (Summary)
3442 @findex wl-thread-unmark
3443 Unmark temporal mark on the messages which are the descendant of the
3444 current thread. With prefix argument, it affects on the all messages in
3446 (@code{wl-thread-unmark})
3449 @kindex t y (Summary)
3450 @findex wl-thread-save
3451 Save messages which are the descendant of the current thread.
3452 With prefix argument, it affects on the all messages in the thread tree.
3453 (@code{wl-thread-save})
3456 @kindex m i (Summary)
3457 @findex wl-summary-target-mark-prefetch
3458 Prefetch all messages which have target mark @samp{*}.
3459 With prefix argument, prefetch all targets even if some of them are cached.
3460 (@code{wl-summary-target-mark-prefetch})
3463 @kindex m R (Summary)
3464 @findex wl-summary-target-mark-mark-as-read
3465 Mark as read all messages which have target mark @samp{*}.
3466 (@code{wl-summary-target-mark-mark-as-read})
3469 @kindex m $ (Summary)
3470 @findex wl-summary-target-mark-mark-as-important
3471 Mark as important all messages which have target mark @samp{*}.
3472 If already marked as @samp{$}, it is deleted.
3473 (@code{wl-summary-target-mark-mark-as-important})
3476 @kindex m ! (Summary)
3477 @findex wl-summary-target-mark-mark-as-unread
3478 Mark as unread all messages which have target mark @samp{*}.
3479 (@code{wl-summary-target-mark-mark-as-unread})
3482 @kindex m o (Summary)
3483 @findex wl-summary-target-mark-refile
3484 Put refile mark on the messages which have target mark @samp{*}.
3485 (@code{wl-summary-target-mark-refile})
3488 @kindex m O (Summary)
3489 @findex wl-summary-target-mark-copy
3490 Put copy mark on the messages which have target mark @samp{*}.
3491 (@code{wl-summary-target-mark-copy})
3494 @kindex m d (Summary)
3495 @findex wl-summary-target-mark-delete
3496 Put delete mark on the messages which have target mark @samp{*}.
3497 (@code{wl-summary-target-mark-delete})
3500 @kindex m y (Summary)
3501 @findex wl-summary-target-mark-save
3502 Save messages which have target mark @samp{*}.
3503 (@code{wl-summary-target-mark-save})
3506 @kindex m u (Summary)
3507 Unmark all temporal marks.
3508 (@code{wl-summary-delete-all-temp-marks})
3509 @findex wl-summary-delete-all-temp-marks
3512 @kindex m a (Summary)
3513 Put target mark @samp{*} on the all messages.
3514 (@code{wl-summary-target-mark-all})
3515 @findex wl-summary-target-mark-all
3518 @kindex m t (Summary)
3519 Put target mark @samp{*} on the messages in the current thread.
3520 @findex wl-summary-target-mark-thread
3521 (@code{wl-summary-target-mark-thread})
3524 @kindex m r (Summary)
3525 @findex wl-summary-target-mark-region
3526 Put target mark @samp{*} on the messages in the specified region.
3527 (@code{wl-summary-target-mark-region})
3530 @kindex m A (Summary)
3531 @findex wl-summary-target-mark-reply-with-citation
3532 Prepare a draft which cites all messages which have target mark @samp{*}.
3533 (@code{wl-summary-target-mark-reply-with-citation})
3536 @kindex m f (Summary)
3537 @findex wl-summary-target-mark-forward
3538 Prepare a draft which forwards all messages which have target mark @samp{*}.
3539 (@code{wl-summary-target-mark-forward})
3542 @kindex m U (Summary)
3543 @findex wl-summary-target-mark-uudecode
3544 Uudecode the messages which have target mark @samp{*}.
3545 (@code{wl-summary-target-mark-uudecode})
3548 @kindex m ? (Summary)
3549 @findex wl-summary-target-mark-pick
3550 Pick messages from the @samp{*} marked messages.
3551 That is, @samp{*} marks on the messages are remained
3552 if the specified condition is satisfied.
3553 (@code{wl-summary-target-mark-pick})
3556 @kindex M-t (Summary)
3557 @findex wl-toggle-plugged
3558 Toggle offline/online status of Wanderlust.
3559 (@code{wl-toggle-plugged})
3562 @kindex C-t (Summary)
3563 Start Wanderlust's plug-status manager.
3564 (@code{wl-plugged-change})
3567 @kindex C-c C-o (Summary)
3568 @findex wl-jump-to-draft-buffer
3569 Move to the draft buffer if available. If multiple draft buffer exists,
3570 moved to one after another. If prefix argument is specified, load draft
3571 folder's message to the draft buffer and jump to it.
3572 (@code{wl-jump-to-draft-buffer})
3575 @kindex M-w (Summary)
3576 @findex wl-summary-save-current-message
3577 Save the message at the current cursor point.
3578 (@code{wl-summary-save-current-message})
3581 @kindex C-y (Summary)
3582 @findex wl-summary-yank-saved-message
3583 Regard the message at the current cursor point as
3584 parent, connect the message saved by
3585 @code{wl-summary-save-current-message}
3587 (@code{wl-summary-yank-saved-message})
3591 @node Variables of Summary, , Key Bindings of Summary, Summary
3592 @section Customiziable variables
3595 @item wl-summary-move-order
3596 @vindex wl-summary-move-order
3597 The initial setting is @code{unread}. Specify cursor moving policy. If
3598 you want to precede new messages, set @code{new}. If you want to
3599 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3602 @item wl-auto-select-first
3603 @vindex wl-auto-select-first
3604 The initial setting is @code{nil}.
3605 If non-nil, first message is automatically displayed.
3607 @item wl-auto-select-next
3608 @vindex wl-auto-select-next
3609 The initial setting is @code{nil}. This controls behavior when there is
3610 no unread message in current summary.
3613 nil: asks whether you want to go back to folder mode
3614 'unread: asks whether you want to go to next unread folder
3615 If the next one comes to be possessing no unread message
3616 by treatment of cross-posted messages or Scoring, then
3617 asks whether you want to go to next to next folder.
3618 'skip-no-unread: similar as unread
3619 But does not ask before going to next to next folder.
3620 otherwise: asks whether you want to go to next unread folder
3623 It might be useful to set @code{'skip-no-unread} for people who
3624 want to continue reading by just pressing and pressing space key.
3626 @item wl-thread-insert-opened
3627 @vindex wl-thread-insert-opened
3628 The initial setting is @code{nil}.
3629 If non-nil, thread is inserted as opened.
3631 @item wl-thread-open-reading-thread
3632 @vindex wl-thread-open-reading-thread
3633 The initial setting is @code{t}. If non-nil, reading thread is
3634 automatically opened though it is closed thread.
3636 @item wl-summary-exit-next-move
3637 @vindex wl-summary-exit-next-move
3638 The initial setting is @code{t}. If non-nil, move to next folder at
3641 @item wl-folder-move-cur-folder
3642 @vindex wl-folder-move-cur-folder
3643 The initial setting is @code{nil}. If non-nil, cursor position on the
3646 @item wl-summary-weekday-name-lang
3647 @vindex wl-summary-weekday-name-lang
3648 The initial setting is @samp{ja}. Specify language of the weekday.
3649 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3650 displays Deutsch. You should rescan summary view after changing this value.
3652 @item wl-summary-fix-timezone
3653 @vindex wl-summary-fix-timezone
3654 The initial setting is @code{nil}.
3655 Time zone of the date string in summary mode is adjusted using this value.
3656 If @code{nil}, it is adjust to the default time zone information
3657 (system's default time zone or environment variable @samp{TZ}).
3659 @item wl-use-petname
3660 @vindex wl-use-petname
3661 The initial setting is @code{t}.
3662 If non-nil, sender part displays nickname.
3664 @item wl-break-pages
3665 @vindex wl-break-pages
3666 The initial setting is @code{t}.
3667 If non-nil, message is split as pages by @samp{^L}.
3669 @item wl-message-window-size
3670 @vindex wl-message-window-size
3671 The initial setting is '(1 . 4).
3672 A cons cell to specify the rate of summary and message window.
3673 car:cdr corresponds summary:message.
3675 @item wl-summary-no-from-message
3676 @vindex wl-summary-no-from-message
3677 The initial setting is @samp{nobody@@nowhere?}. A string which is
3678 displayed when there's no @samp{From:} field in the message.
3680 @item wl-summary-no-subject-message
3681 @vindex wl-summary-no-subject-message
3682 The initial setting is @samp{(WL:No Subject in original.)}. A string
3683 which is displayed when there's no @samp{Subject:} field in the message.
3685 @item wl-summary-use-frame
3686 @vindex wl-summary-use-frame
3687 The initial setting is @code{nil}.
3688 If non-nil, use new frame for the summary.
3690 @item wl-use-folder-petname
3691 @vindex wl-use-folder-petname
3692 The initial setting is the list shown below:
3701 A list of display policy (symbol) of folder nickname. Available symbols
3706 Display folder petname on modeline.
3708 Destination folder is notified as nickname if
3709 @code{wl-auto-select-next} is non-nil.
3711 You can input folder name by nickname in the function
3712 @code{wl-summary-read-folder}.
3715 @item wl-summary-move-direction-toggle
3716 @vindex wl-summary-move-direction-toggle
3717 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3718 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3719 want to aware of reading direction, set this to @code{t}.
3721 @item wl-summary-width
3722 @vindex wl-summary-width
3723 The initial setting is 80.
3724 Width of summary line. If @code{nil}, summary line's width is as is.
3726 @item wl-summary-from-width
3727 @vindex wl-summary-from-width
3728 The initial setting is 17.
3729 Width of sender part of summary line.
3731 @item wl-summary-subject-length-limit
3732 @vindex wl-summary-subject-length-limit
3733 The initial setting is @code{nil}. Specify the limit for the length of
3734 subject parts in summary. @code{nil} means unlimited.
3736 @item wl-summary-indent-length-limit
3737 @vindex wl-summary-indent-length-limit
3738 The initial setting is 46.
3739 Specify the limit of thread indent level. @code{nil} means unlimited
3741 If you set this to @code{nil} you should set @code{wl-summary-width}
3744 @item wl-summary-recenter
3745 @vindex wl-summary-recenter
3746 The initial setting is t.
3747 If non-nil, cursor point is moved to the center of the summary window.
3749 @item wl-summary-divide-thread-when-subject-changed
3750 @vindex wl-summary-divide-thread-when-subject-changed
3751 The initial setting is @code{nil}. If non-nil, thread is split if
3752 the subject is changed.
3754 @item wl-summary-search-via-nntp
3755 @vindex wl-summary-search-via-nntp
3756 The initial setting is @code{confirm}.
3758 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3759 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3760 from the NNTP server @code{elmo-nntp-default-server}. The value of
3761 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3762 @code{elmo-nntp-default-stream-type} are used.
3764 If @code{confirm}, server name can be specified. You can specify NNTP
3765 folder format like @samp{-:username@@servername:119!}.
3767 @item wl-summary-keep-cursor-command
3768 @vindex wl-summary-keep-cursor-command
3769 The initial setting is the list shown below:
3773 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3778 When you entered to summary by these commands and the target summary
3779 buffer already exists, summary status is not automatically updated and
3780 cursor position is saved.
3782 @item elmo-folder-update-threshold
3783 @vindex elmo-folder-update-threshold
3784 The initial setting is 500. If updated message number is larger than
3785 this value, confirm whether drop them or not (in the case where the value
3786 of @code{elmo-folder-update-confirm} is non-nil).
3788 @item elmo-folder-update-confirm
3789 @vindex elmo-folder-update-confirm
3790 The initial setting is @code{t}. If the value is non-nil, do check with
3791 @code{elmo-folder-update-threshold}.
3793 @item wl-summary-always-sticky-folder-list
3794 @vindex wl-summary-always-sticky-folder-list
3795 The initial setting is @code{nil}.
3796 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3797 are automatically stuck. Each element is regexp of folder name.
3799 @item wl-summary-reserve-mark-list
3800 @vindex wl-summary-reserve-mark-list
3801 The initial setting is the list shown below:
3810 If a message is already marked as temporal marks in this list, the
3811 message is not marked by any mark command.
3813 @item wl-summary-skip-mark-list
3814 @vindex wl-summary-skip-mark-list
3815 The initial setting is the list shown below:
3824 If a message is already marked as temporal marks in this list, the
3825 message is skipped at cursor move.
3827 @item elmo-message-fetch-threshold
3828 @vindex elmo-message-fetch-threshold
3829 The initial setting is 30000 (bytes). If displaying message has larger
3830 size than this value, Wanderlust confirms whether fetch the message or
3831 not (in the case where the value of @code{elmo-message-fetch-confirm}
3834 @item elmo-message-fetch-confirm
3835 @vindex elmo-message-fetch-confirm
3836 The initial setting is @code{t}. If the value is non-nil, do check with
3837 @code{elmo-message-fetch-threshold}.
3839 @item wl-prefetch-threshold
3840 @vindex wl-prefetch-threshold
3841 The initial setting is 30000 (bytes). If prefetching message has larger
3842 size than this value and @code{wl-prefetch-confirm} is non-nil,
3843 Wanderlust confirms whether prefetch the message or not. If
3844 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3845 without confirmation.
3847 @item wl-prefetch-confirm
3848 @vindex wl-prefetch-confirm
3849 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3850 prefetch the message or not if the message has larger size than
3851 @code{wl-prefetch-threshold}.
3853 @item elmo-imap4-use-cache
3854 @vindex elmo-imap4-use-cache
3855 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3858 @item elmo-nntp-use-cache
3859 @vindex elmo-nntp-use-cache
3860 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3863 @item elmo-pop3-use-cache
3864 @vindex elmo-pop3-use-cache
3865 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3868 @item elmo-shimbun-use-cache
3869 @vindex elmo-shimbun-use-cache
3870 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3873 @item wl-folder-process-duplicates-alist
3874 @vindex wl-folder-process-duplicates-alist
3875 The initial setting is @code{nil}.
3876 This list determines how to deal with duplicated messages in the same folder.
3877 Each item in the list is regexp of folder name and action; you can specify any
3878 one of the following in the place of action:
3881 @code{nil} : do nothing for duplicated messages.
3882 @code{hide} : hide duplicated messages from the summary.
3883 @code{read} : set duplicated messages as read.
3887 Following is an example (hide duplicated messages in multi folders)
3891 (setq wl-folder-process-duplicates-alist
3892 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3893 ("^\\*.*" . hide) (".*" . read)))
3899 @node Message, Draft, Summary, Top
3900 @chapter Message Buffer
3902 Message Buffers utilize MIME-View mode of SEMI. For operational
3903 procedures and key bindings, refer to respective documents.
3904 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3905 You can also see help by @kbd{?} in message buffer.
3907 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3908 brings you back to Summary mode. @kbd{l} toggles display of Summary
3911 @section Key Bindings
3917 @findex wl-message-toggle-disp-summary
3918 Toggles display of Summary mode buffer.
3919 (@code{wl-message-toggle-disp-summary})
3922 @findex wl-message-refer-article-or-url
3923 @kindex Button-2 (Message)
3924 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3925 corresponding message if found.
3926 (@code{wl-message-refer-article-or-url})
3928 @item Button-4 (upward movement of a wheel)
3929 @kindex Button-4 (Message)
3930 @findex wl-message-wheel-down
3931 Scrolls the message backwards. When the top of the message is hit,
3932 moves to the previous message.
3933 (@code{wl-message-wheel-down})
3935 @item Button-5 (downward movement of a wheel)
3936 @kindex Button-5 (Message)
3937 @findex wl-message-wheel-up
3938 Scrolls the message forward. When the bottom of the message is hit,
3939 moves to the next message.
3940 (@code{wl-message-wheel-up})
3943 @section Customizable Variables
3946 @item wl-message-window-size
3947 @vindex wl-message-window-size
3948 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3949 its car and cdr value corresponds to the ratio of Summary and Message
3952 @item wl-message-ignored-field-list
3953 @vindex wl-message-ignored-field-list
3954 (SEMI only) Initial setting is @code{nil}.
3955 All fields that match this list will be hidden in message buffer.
3956 Each elements are regexp of field-name.
3957 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3959 @item wl-message-visible-field-list
3960 @vindex wl-message-visible-field-list
3961 (SEMI only) Initial setting is @code{nil}.
3962 All fields that match this list will be display in message buffer.
3963 Each elements are regexp of field-name. This value precedes
3964 @code{wl-message-ignored-field-list}.
3965 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3967 @item wl-message-sort-field-list
3968 @vindex wl-message-sort-field-list
3969 (SEMI only) Initial setting is
3970 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3971 Header fields in message buffer are ordered by this value.
3972 Each elements are regexp of field-name.
3974 @item wl-message-truncate-lines
3975 @vindex wl-message-truncate-lines
3976 The initial value is the value of @code{default-truncate-lines}.
3977 If it is non-nil, truncate long lines in message buffer.
3980 @node Draft, Disconnected Operations, Message, Top
3981 @chapter Draft Buffer
3983 At Summary mode, pressing @kbd{w} and the like creates a new draft
3984 buffer. You can edit and send mail and news articles in this buffer.
3988 Basically it is Emacs-standard mail mode.
3990 @subsection Address Completion
3992 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3993 addresses. @kbd{@key{TAB}} completes them.
3995 If you want to submit a news article, add @samp{Newsgroups:} field by
3996 yourself. Field names can be completed by @kbd{@key{TAB}}.
3998 If you save the draft buffer you are editing, it is appended to the
3999 folder specified by @code{wl-draft-folder}.
4001 Using @samp{FCC:} field, you can specify the folder to which a copy of
4002 the message is saved when it is sent.
4004 @subsection Editing Messages
4006 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4007 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4008 a MIME user interface for GNU Emacs}.
4009 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4011 @subsection Dynamic Modification of Messages
4012 @vindex wl-draft-config-alist
4013 @c @cindex Change Message
4014 @c @cindex Message, Change Dynamic
4016 You can set @code{wl-draft-config-alist} so that header and body of the
4017 message will automatically modified depending on information of header
4020 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4022 In the example below, the header is modified when
4023 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4024 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4025 before sending the message.
4029 (setq wl-draft-config-alist
4030 '(((string-match "aaa\\.example\\.com$" (system-name))
4031 ;; @r{applied if the expression is non-nil}
4032 (wl-smtp-posting-server . "mailserver-B")
4033 (wl-nntp-posting-server . "newsserver-B")
4034 ;; @r{settings of temporary variables}
4036 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4037 ;; @r{applied if it matches the header of the draft buffer}
4038 ("Organization" . (format "Go %s" my-webpage)))
4039 ;; @r{you can write elisp expressions here (eval only)}
4040 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4041 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4046 The format of @code{wl-draft-config-alist} is:
4050 '(("@var{regexp of the header}" or @var{elisp expression}
4051 ("@var{Field}" . value(@var{elisp expression}))
4052 (@var{variable} . value(@var{elisp expression}))
4053 (@var{sub-function} . value(@var{elisp expression}))
4056 ("@var{regexp of the header}" or @var{elisp expression}
4057 ("@var{Field}" . value(@var{elisp expression}))
4062 Per default, there are 10 following sub-functions.
4065 'header: Inserts the specified string at the bottom of the header.
4066 'header-top: Inserts the specified string at the top of the header.
4067 'header-file: Inserts the specified file at the bottom of the header.
4068 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4069 'top: Inserts the specified string at the top of the body.
4070 'top-file: Inserts the specified file at the top of the body.
4071 'body: Replaces the body with the specified string.
4072 Specifying @code{nil} deletes the entire body string.
4073 'body-file: Replaces the body with the content of the specified file.
4074 'bottom: Inserts the specified string at the bottom of the body.
4075 'bottom-file: Inserts the specified file at the top of the body.
4076 'part-top: Inserts the specified string at the top of the current part.
4077 'part-bottom: Inserts the specified string at the bottom of the current part.
4078 'template: Applies the specified template.
4079 (refer to the next subsection)
4082 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4083 change them or add your own functions. If you read the code, you can
4084 easily find how to write the functions.
4086 At the first of each item, @var{a regular expression of the header} or
4087 an @var{elisp expression} should be specified. In the case of an elisp
4088 expression, the item is applied when the expression is evaluated
4091 Per default, when multiple items match or are evaluated non-nil, all
4092 such items are applied, but if you set a variable
4093 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4096 At the second of the item, a cons or a list of functions should be
4097 specified. The car part of the cons should be a header field, a
4098 variable, or a sub-function. When a header field is specified, the
4099 field will be modified. If a variable is specified, the value of the
4100 variable will be modified temporarily.
4102 In the cdr part of a cons, not only a variable but also an elisp
4103 expression can be specified as is. If the car part is a header field
4104 and the cdr part is @code{nil}, the field will be deleted.
4106 If you want to use name of parent folder, you can refer the buffer local
4107 variable @code{wl-draft-parent-folder}.
4109 See the next example as well:
4113 (setq wl-draft-config-alist
4115 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4116 ;; @r{applied if it matches the header of the buffer being replied}
4117 (body . " Hello.\n")
4118 (template . "default")
4123 As in the (1) above, if a header regexp is prepended with @code{reply},
4124 it is applied when the draft is prepared by @code{wl-summary-reply} for
4125 example, and when it matches the header being replied. It is ignored
4126 when there is no buffer being replied, like after @code{wl-draft} was
4129 Note that @code{wl-draft-config-alist} is applied only once when
4130 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4131 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4132 aborting transmission, execute @kbd{C-c C-e}
4133 (@code{wl-draft-config-exec}) explicitly.
4135 If you don't want to apply @code{wl-draft-config-alist} when
4136 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4140 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4143 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4144 prepared, do the following:
4147 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4150 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4151 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4155 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4158 @subsection Inserting Templates
4160 @cindex Apply Template
4162 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4163 @kbd{M-x wl-template-select} in the draft buffer.
4165 The format of @code{wl-template-alist} is almost the same as
4166 @code{wl-draft-config-alist}.
4170 (setq wl-template-alist
4173 ("Organization" . "Example Co.Ltd.")
4174 (body . "Hello.\n"))
4176 (template . "default") ;; @r{(a)}
4177 ("To" . "boss@@example.com")
4178 ("Subject" . "Report")
4179 (body-file . "~/work/report.txt")
4185 As you can see, the only difference is item (template) names such as
4186 @samp{default} and @samp{report}, instead of a regexp of header.
4187 Because definition of each item is the same as
4188 @code{wl-draft-config-alist}, you can call another template, like (a).
4190 Executing the command @code{wl-template-select} results in template
4191 selection, but the result differs depending on variable
4192 @code{wl-template-visible-select}.
4194 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4195 window is shown below the draft buffer. You can select a template by
4196 @kbd{n} and @kbd{p} seeing the buffer window.
4198 Press the @key{RET} key and the template is actually applied to the draft
4199 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4200 adjust the window size by @code{wl-template-buffer-lines}.
4202 If @code{wl-template-visible-select} is @code{nil}, you should type the
4203 name of the template in the mini buffer.
4205 As shown in the example in @code{wl-draft-config-alist}, you can select
4206 @samp{default} template by writing:
4209 (template . "default")
4212 @subsection Sending mail by POP-before-SMTP
4213 @cindex POP-before-SMTP
4215 You can send mail by POP-before-SMTP with this single line:
4218 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4222 Configure the following variables if you need.
4225 @item wl-pop-before-smtp-user
4226 The POP user name for POP-before-SMTP authentication.
4227 If unset, @code{elmo-pop3-default-user} is used.
4229 @item wl-pop-before-smtp-server
4230 The POP server name for POP-before-SMTP authentication.
4231 If unset, @code{elmo-pop3-default-server} is used.
4233 @item wl-pop-before-smtp-authenticate-type
4234 The POP authentication method for POP-before-SMTP authentication.
4235 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4237 @item wl-pop-before-smtp-port
4238 The POP port number for POP-before-SMTP authentication.
4239 If unset, @code{elmo-pop3-default-port} is used.
4241 @item wl-pop-before-smtp-stream-type
4242 If non-nil, POP connection is established using SSL. If
4243 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4244 unset, @code{elmo-pop3-default-stream-type} is used.
4247 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4248 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4250 Therefore, if SMTP server and POP server are actually the same, and if
4251 POP folder per default (such as @samp{&}) is available, no settings are
4254 Refer to the following URL about POP-before-SMTP.
4258 http://spam.ayamura.org/tools/smPbS.html
4259 http://www.iecc.com/pop-before-smtp.html
4263 @section Key Bindings
4264 @cindex Keybind, Draft Mode
4265 @cindex Keybind, Draft Buffer
4270 @kindex C-c C-y (Draft)
4271 @findex wl-draft-yank-original
4272 Cites the content of the current message buffer.
4273 (@code{wl-draft-yank-original})
4276 @kindex C-c C-p (Draft)
4277 @findex wl-draft-preview-message
4278 Previews the content of the current draft.
4279 This is useful for previewing MIME multi-part messages.
4280 (@code{wl-draft-preview-message})
4283 @kindex C-c C-s (Draft)
4284 @findex wl-draft-send
4285 Sends the content of the current draft. Does not erase the draft buffer.
4286 This is useful for sending multiple messages, which are a little different
4288 (@code{wl-draft-send})
4291 @kindex C-c C-c (Draft)
4292 @findex wl-draft-send-and-exit
4293 Sends the content of the current draft and erases the draft buffer.
4294 (@code{wl-draft-send-and-exit})
4297 @kindex C-x C-s (Draft)
4298 @findex wl-draft-save
4299 Save the current draft.
4300 (@code{wl-draft-save})
4303 @kindex C-c C-k (Draft)
4304 @findex wl-draft-kill
4305 Kills the current draft.
4306 (@code{wl-draft-kill})
4309 @kindex C-x k (Draft)
4310 @findex wl-draft-mimic-kill-buffer
4311 Kills the current draft.
4312 (@code{wl-draft-mimic-kill-buffer})
4315 @kindex C-c C-z (Draft)
4316 @findex wl-draft-save-and-exit
4317 Saves the current draft, and erases the draft buffer.
4318 This is useful if you want to suspend editing of the draft.
4319 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4320 the @samp{+draft} folder.
4321 (@code{wl-draft-save-and-exit})
4324 @kindex C-c C-r (Draft)
4325 @findex wl-caesar-region
4326 Encodes or decodes the specified region in Caesar cipher.
4327 (@code{wl-caesar-region})
4331 @findex wl-draft-highlight-and-recenter
4332 Recenter and rehighlight current draft.
4333 (@code{wl-draft-highlight-and-recenter})
4337 @findex wl-toggle-plugged
4338 Toggles off-line/on-line states of Wanderlust.
4339 (@code{wl-toggle-plugged})
4342 @kindex C-c C-o (Draft)
4343 @findex wl-jump-to-draft-buffer
4344 Jumps to the other draft buffer, if exists.
4345 With prefix argument, reads a file (if any) from the draft folder when
4346 there is no such buffer.
4347 (@code{wl-jump-to-draft-buffer})
4350 @kindex C-c C-e (Draft)
4351 @findex wl-draft-config-exec
4352 Applies @code{wl-draft-config-alist}.
4353 (@code{wl-draft-config-exec})
4356 @kindex C-c C-j (Draft)
4357 @findex wl-template-select
4359 (@code{wl-template-select})
4362 @kindex C-c C-a (Draft)
4364 Enter Address Manager.
4365 @xref{Address Manager}.
4369 @kindex C-c C-d (Draft)
4370 @findex wl-draft-elide-region
4371 Elide the text between point and mark (@code{wl-draft-elide-region}).
4372 The text is killed and replaced with the contents of the variable
4373 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4377 @section Customizable Variables
4380 @item wl-subscribed-mailing-list
4381 @vindex wl-subscribed-mailing-list
4382 The initial setting is @code{nil}. Mailing lists to which you
4383 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4384 field of a reply draft, removes your own address from
4385 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4386 contained in @samp{To:} or @samp{Cc:} field of a message to be
4387 automatically re-filed, the destination folder will be leaned in
4388 connection with the address.
4394 (setq wl-subscribed-mailing-list
4395 '("wl@@lists.airs.net"
4397 "emacs-mime-ja@@m17n.org"))
4401 @item wl-insert-mail-followup-to
4402 @vindex wl-insert-mail-followup-to
4403 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4404 field is automatically inserted in the draft buffer.
4406 @item wl-insert-mail-reply-to
4407 @vindex wl-insert-mail-reply-to
4408 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4409 field is automatically inserted in the draft buffer.
4411 @item wl-auto-insert-x-face
4412 @vindex wl-auto-insert-x-face
4413 The initial setting is @code{t}. If non-nil and there is an encoded
4414 X-Face string in a file @file{~/.xface} (the value of the variable
4415 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4416 draft buffer. If @code{nil}, it is not automatically inserted.
4418 @item wl-insert-message-id
4419 @vindex wl-insert-message-id
4420 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4421 is automatically inserted on the transmission.
4423 @item wl-message-id-use-wl-from
4424 @vindex wl-message-id-use-wl-from
4425 The initial setting is @code{nil}. If non-nil, the value of
4426 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4428 @item wl-local-domain
4429 @vindex wl-local-domain
4430 The initial setting is @code{nil}. If @code{nil}, the return value of
4431 the function @code{system-name} will be used as the domain part of
4434 If @code{system-name} does not return FQDN (i.e. the full name of the
4435 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4436 to the string of the local domain name without hostname (like
4437 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4438 @samp{.} @code{wl-local-domain} is used as domain part of the
4441 If your terminal does not have global IP, set the value of
4442 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4443 you use invalid @samp{Message-ID:}.)
4445 Moreover, concatenation of @code{system-name} @samp{.}
4446 @code{wl-local-domain} will be used as an argument to the HELO command
4449 @item wl-message-id-domain
4450 @vindex wl-message-id-domain
4451 The initial setting is @code{nil}. If non-nil, this value is used as a
4452 domain part of the @samp{Message-ID:}. If your terminal does not have
4453 global IP address, set unique string to this value (e.x. your e-mail
4456 @item wl-unique-id-suffix
4457 @vindex wl-unique-id-suffix
4458 The initial setting is @samp{.wl}. You can specify the string in generated
4459 Message-ID which appear just before @samp{@@}.
4461 @item wl-draft-config-alist
4462 @vindex wl-draft-config-alist
4463 The initial setting is @code{nil}. Modifies the draft message just
4464 before the transmission. The content of @code{wl-draft-config-alist}
4465 will be automatically applied only once on the transmission. If you
4466 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4469 @item wl-template-alist
4470 @vindex wl-template-alist
4471 The initial setting is @code{nil}.
4472 This variable specifies the template to be applied in the draft buffer.
4474 @item wl-draft-config-matchone
4475 @vindex wl-draft-config-matchone
4476 The initial setting is @code{nil}. If non-nil, only the first matching
4477 item is used when @code{wl-draft-config-alist} is applied. If
4478 @code{nil}, all matching items are used.
4480 @item wl-template-visible-select
4481 @vindex wl-template-visible-select
4482 The initial setting is @code{t}.
4483 If non-nil, you can preview the result of the template selection in
4486 @item wl-template-confirm
4487 @vindex wl-template-confirm
4488 The initial setting is @code{nil}.
4489 If non-nil, asks for confirmation when you press the enter key to select
4490 template while previewing.
4492 @item wl-template-buffer-lines
4493 @vindex wl-template-buffer-lines
4494 The initial setting is 7.
4495 If @code{wl-template-visible-select} is non-nil, this variable specifies
4496 the size of the preview window.
4498 @item wl-draft-reply-buffer-style
4499 @vindex wl-draft-reply-buffer-style
4500 The initial setting is @code{split}. @code{split} or @code{full} can be
4501 specified. In the case of @code{full}, the whole frame will be used for
4502 a reply draft buffer when it is prepared.
4504 @item wl-draft-use-frame
4505 @vindex wl-draft-use-frame
4506 The initial setting is @code{nil}.
4507 If non-nil, use new frame for the draft.
4509 @item wl-draft-truncate-lines
4510 @vindex wl-draft-truncate-lines
4511 The initial value is the value of @code{default-truncate-lines}.
4512 If it is non-nil, truncate long lines in draft buffer.
4516 The initial setting is the value of the variable
4517 @code{user-mail-address}. The value of this variable is inserted as a
4518 @samp{From:} field of the draft when it is prepared.
4520 @item wl-envelope-from
4521 @vindex wl-envelope-from
4522 The initial setting is @code{nil}.
4523 The value of this variable is used for envelope from (MAIL FROM).
4524 If @code{nil}, the address part of @code{wl-from} is used.
4526 @item wl-user-mail-address-list
4527 @vindex wl-user-mail-address-list
4528 The initial setting is @code{nil}.
4529 This is the User's address list. If you have multiple addresses,
4534 The initial setting is @code{nil}.
4535 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4536 the draft when it is prepared. If function is specified, its return
4541 The initial setting is @code{nil}.
4542 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4543 the draft when it is prepared.
4545 @item wl-reply-subject-prefix
4546 @vindex wl-reply-subject-prefix
4547 The initial setting is @samp{Re: }.
4548 In the @samp{Subject:} of the reply draft, this string is prepended to
4549 the @samp{Subject:} of being replied.
4551 @item wl-draft-reply-use-address-with-full-name
4552 @vindex wl-draft-reply-use-address-with-full-name
4553 The initial setting is @code{t}.
4554 If non-nil, insert her full name with address when prepare a draft for
4555 reply a message. If it is @code{nil}, insert her address only.
4557 @item wl-draft-enable-queuing
4558 @vindex wl-draft-enable-queuing
4559 The initial setting is @code{t}.
4560 This flag controls off-line transmission. If non-nil, the draft is
4563 @item wl-draft-use-cache
4564 @vindex wl-draft-use-cache
4565 The initial setting is @code{nil}. If the value is non-nil and
4566 @code{wl-insert-message-id} is nil, cache the message which is sent.
4568 @item wl-fcc-force-as-read
4569 @vindex wl-fcc-force-as-read
4570 The initial setting is @code{nil}. If the value is non-nil,
4571 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4573 @item wl-auto-flush-queue
4574 @vindex wl-auto-flush-queue
4575 The initial setting is t.
4576 This flag controls automatic transmission of the queue when Wanderlust
4577 becomes on-line. If non-nil, the queue is automatically transmitted
4578 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4579 manually, press @kbd{F} in the folder mode.
4581 @item wl-ignored-forwarded-headers
4582 @vindex wl-ignored-forwarded-headers
4583 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4584 All headers that match this regexp will be deleted when forwarding a message.
4586 @item wl-ignored-resent-headers
4587 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4588 All headers that match this regexp will be deleted when resending a message.
4590 @item wl-draft-always-delete-myself
4591 @vindex wl-draft-always-delete-myself
4592 If non-nil, always removes your own address from @samp{To:} and
4593 @samp{Cc:} when you are replying to the mail addressed to you.
4595 @item wl-draft-delete-myself-from-bcc-fcc
4596 @vindex wl-draft-delete-myself-from-bcc-fcc
4597 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4598 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4600 @item wl-smtp-posting-server
4601 @vindex wl-smtp-posting-server
4602 The initial setting is @code{nil}.
4603 This is the SMTP server name for mail transmission.
4605 @item wl-smtp-posting-user
4606 @vindex wl-smtp-posting-user
4607 The initial setting is @code{nil}.
4608 This is the user name for SMTP AUTH authentication. If @code{nil},
4609 @code{smtp-authenticate-user} is used.
4611 @item wl-smtp-authenticate-type
4612 @vindex wl-smtp-authenticate-type
4613 The initial setting is @code{nil}.
4614 This is the authentication method for SMTP AUTH authentication. If
4615 @code{nil}, @code{smtp-authenticate-type} is used. If
4616 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4619 @item wl-smtp-connection-type
4620 @vindex wl-smtp-connection-type
4621 The initial setting is @code{nil}.
4622 This variable specifies how to establish SMTP connections.
4623 If @code{nil}, @code{smtp-connection-type} is used.
4624 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4626 @item wl-nntp-posting-server
4627 @vindex wl-nntp-posting-server
4628 The initial setting is @code{nil}.
4629 This is the NNTP server name used for news submission.
4630 If @code{nil}, @code{elmo-nntp-default-server} is used.
4632 @item wl-nntp-posting-user
4633 @vindex wl-nntp-posting-user
4634 The initial setting is @code{nil}.
4635 This is the user name for AUTHINFO authentication on news submission.
4636 If @code{nil}, @code{elmo-nntp-default-user} is used.
4637 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4639 @item wl-nntp-posting-port
4640 @vindex wl-nntp-posting-port
4641 The initial setting is @code{nil}.
4642 This is the port number of the NNTP server used for news submission.
4643 If @code{nil}, @code{elmo-nntp-default-server} is used.
4645 @item wl-nntp-posting-stream-type
4646 @vindex wl-nntp-posting-stream-type
4647 The initial setting is @code{nil}.
4648 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4649 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4650 connection will be established.
4652 @item wl-pop-before-smtp-user
4653 @vindex wl-pop-before-smtp-user
4654 The initial setting is @code{nil}.
4655 This is the POP user name for POP-before-SMTP.
4656 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4658 @item wl-pop-before-smtp-server
4659 @vindex wl-pop-before-smtp-server
4660 The initial setting is @code{nil}.
4661 This is the POP server name for POP-before-SMTP.
4662 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4664 @item wl-pop-before-smtp-authenticate-type
4665 @vindex wl-pop-before-smtp-authenticate-type
4666 The initial setting is @code{nil}.
4667 This is the authentication method for POP-before-SMTP authentication.
4668 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4670 @item wl-pop-before-smtp-port
4671 @vindex wl-pop-before-smtp-port
4672 The initial setting is @code{nil}.
4673 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4674 @code{elmo-pop3-default-port} is used.
4676 @item wl-pop-before-smtp-stream-type
4677 @vindex wl-pop-before-smtp-stream-type
4678 The initial setting is @code{nil}.
4679 This flag controls the use of SSL for POP-before-SMTP. If it is
4680 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4681 STARTTLS (RFC2595) connection will be established.
4683 @item wl-draft-queue-save-variables
4684 @vindex wl-draft-queue-save-variables
4685 Specifies a list of variable to which queued messages are saved on the
4686 off-line transmission.
4688 @item wl-draft-sendlog
4689 @vindex wl-draft-sendlog
4690 The initial setting is @code{t}.
4691 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4695 @item drafts are sent by smtp or qmail
4696 @item saved into folders by fcc
4697 @item saved into folders by queuing
4700 (it is written even if the transmission fails).
4701 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4702 and left to the logging function of @command{imput}.
4705 @item wl-draft-sendlog-max-size
4706 @vindex wl-draft-sendlog-max-size
4707 The initial setting is 20000 (in bytes).
4708 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4709 beyond the size specified by this variable.
4713 The initial setting is @code{nil}.
4714 If non-nil, address completion uses LDAP.
4716 @item wl-ldap-server
4717 @vindex wl-ldap-server
4718 The initial setting is @samp{localhost}.
4719 LDAP server name for address completion.
4722 @vindex wl-ldap-port
4723 The initial setting is @code{nil}.
4724 If non-nil, the value is used as port number.
4727 @vindex wl-ldap-base
4728 The initial setting is @samp{c=US}.
4729 LDAP search starting point (base) for address completion.
4731 @item wl-draft-remove-group-list-contents
4732 @vindex wl-draft-remove-group-list-contents
4733 The initial setting is @code{t}.
4734 If non-nil, remove the group-lists' members in the recipients when
4735 sending the message (group-list means the description such as
4736 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4739 @node Disconnected Operations, Expire and Archive, Draft, Top
4740 @chapter Off-line Management
4741 @cindex Disconnected Operations
4743 Wanderlust has on-line and off-line states.
4746 * Off-line State:: Wanderlust has on-line and off-line states
4747 * Enable Operations:: Enable Disconnected Operations
4748 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4749 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4750 * Variables of Plugged Mode:: Customize Plugged Mode
4754 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4755 @section Off-line State
4757 Wanderlust has on-line and off-line states. In the off-line state, you
4758 cannot access messages via network, unless they are cached.
4760 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4761 in the mode line indicates the off-line state. In folder or summary
4762 modes, press @kbd{M-t} to switch between off- and on-line.
4764 You can invoke Wanderlust in the off-line state by setting
4765 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4767 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4768 ignores uncached messages.
4771 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4772 @section Enable Disconeected Operations
4774 Even in the off-line state, provided that relevant messages are cached,
4775 and the variable @code{elmo-enable-disconnected-operation} (described
4776 later) is non-nil, you can following operations:
4777 @xref{Plugged Mode}, @xref{Off-line State settings}.
4780 * Send Messages off-line:: Transmit Messages
4781 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4782 * Creation of Folders:: Create Folders off-line (IMAP4)
4783 * Marking:: Mark (IMAP4)
4784 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4787 As soon as Wanderlust becomes on-line, such operations invoked off-line
4788 are reflected in the servers via network.
4791 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4792 @subsection Transmission of Messages
4794 You can send mail/news messages off-line (if you are using
4795 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4796 accumulated in the queue folder, @samp{+queue}. These messages are
4797 transmitted at once when Wanderlust becomes on-line.
4799 You can visit @samp{+queue} in the off-line state and confirm content of
4800 messages in the queue. You can also remove messages. Removed messages
4801 are not transmitted even in the on-line state.
4804 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4805 @subsection Re-file and Copy (IMAP4)
4807 Re-file and copy operations to IMAP folders invoked during the off-line
4808 state are accumulated in the queue, and reflected in the server side
4809 when Wanderlust becomes on-line. If you visit destination folders after
4810 off-line re-file or copy, it looks as if messages were appended even in
4813 For the safety reasons, messages re-filed off-line are removed from
4814 source folders only if their @samp{Message-ID:} match messages on the
4815 servers. While the queue is processed, messages that failed to be
4816 re-filed or copied to the specified folders are appended to the folder
4820 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4821 @subsection Creation of Folders (IMAP4)
4823 You can create IMAP folders off-line. The creation of folders are
4824 reflected in the servers when Wanderlust becomes on-line. At that time,
4825 if folders failed to be created on the servers for any reasons, messages
4826 re-filed to such folders are appended to the folder @samp{+lost+found}.
4829 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4830 @subsection Marking (IMAP4)
4832 Off-line changes in unread/read and importance mark @samp{$} information
4833 are also reflected in the servers when Wanderlust becomes on-line.
4836 @node Pre-fetching Reservations, , Marking, Enable Operations
4837 @subsection Pre-fetching (IMAP4, NNTP)
4839 You can make reservations for pre-fetching messages in IMAP or NNTP
4840 folders. Reserved messages are marked with @samp{!} but not cached
4841 yet. When Wanderlust becomes on-line, they are pre-fetched from
4844 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4845 these off-line operations for IMAP4 and NNTP do not take place, and
4846 off-line re-file, copy or suchlike simply results in error.
4848 Because off-line operations use cache files, it is a bad idea to erase
4849 them by hand; it may cause Wanderlust to malfunction.
4851 If you want to remove caches, be sure to execute @kbd{M-x
4852 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4853 remove caches for messages relevant to off-line operations.
4856 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4857 @section Switching On-line/Off-line per Server/Port
4859 @kbd{M-t} described above switches networking states as a whole, but you
4860 can switch on-line/off-line per server/port.
4862 Pressing @kbd{C-t} in the folder or summary modes brings you in
4863 wl-plugged-mode shown below, in which you can change the plugged state
4868 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4871 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4872 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4874 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4875 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4881 The first line indicates status of the following three variables, and
4882 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4883 column modifies the values of these variables.
4887 "Queuing" @code{wl-draft-enable-queuing}
4888 "AutoFlushQueue" @code{wl-auto-flush-queue}
4889 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4893 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4896 The second and after lines indicate on-line/off-line states of servers
4897 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4898 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4899 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4901 @dfn{sending queue} means messages accumulated in the folder
4902 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4903 off-line operations when @code{elmo-enable-disconnected-operation} is
4905 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4906 @c off-line operations are enabled.
4908 They are displayed if there are any of them. In the example above, in
4909 the sending queue there are two messages (the first and the second in
4910 the queue folder) for smtp to hosta and one (the third) for nntp to
4911 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4914 If you change @samp{(wl-plugged)} in the second line, the variable
4915 @code{wl-plugged} is changed, so that the mode line indicator and
4916 plugged states of all ports are affected. If you change plugged states
4917 of any servers or ports, @samp{(wl-plugged)} in the second line is
4918 affected depending on @code{elmo-plugged-condition} settings and the
4919 plugged state of each port.
4922 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4923 @section Invoking Wanderlust in the Off-line State
4925 As described before, if you set @code{wl-plugged} to @code{nil} in
4926 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4927 off-line state. You can specify off-line state on a per server or port
4928 basis. Refer to @code{wl-reset-plugged-alist} also.
4930 Usually, when Wanderlust starts up, the plugged state of each port is
4931 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4932 @code{wl-nntp-posting-server} and so on. If you want to change the
4933 plugged state of these ports or to add other ports, configure
4934 @code{wl-make-plugged-hook} with a function.
4938 (add-hook 'wl-make-plugged-hook
4940 (elmo-set-plugged plugged-value(t/nil) server port)
4941 ;; @r{add or change plugged states of the port of the server}
4942 (elmo-set-plugged plugged-value(t/nil) server)
4943 ;; @r{if the port is omitted, all ports are affected}
4944 ;; @r{(you cannot omit the port if you newly add the server)}
4950 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4951 @section Customizable Variables
4956 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4957 mode from the beginning.
4959 @item wl-queue-folder
4960 @vindex wl-queue-folder
4961 The initial setting is @samp{+queue}.
4962 This is the folder in which messages in the transmission queue are
4965 @item wl-auto-flush-queue
4966 @vindex wl-auto-flush-queue
4967 The initial setting is @code{t}.
4968 This flag controls automatic transmission of the queue when Wanderlust
4969 becomes on-line. If non-nil, the queue is automatically transmitted
4970 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4971 manually, press @kbd{F} in the folder mode.
4973 @item elmo-enable-disconnected-operation
4974 @vindex elmo-enable-disconnected-operation
4975 The initial setting is @code{nil}. Controls off-line operations
4976 regarding IMAP4. If non-nil, off-line operations are carried out.
4978 @item elmo-lost+found-folder
4979 @vindex elmo-lost+found-folder
4980 The initial setting is @samp{+lost+found}.
4981 This is the folder to which messages are saved when they fails to be
4982 appended while the off-line re-file/copy queue is processed.
4984 @item elmo-plugged-condition
4985 @vindex elmo-plugged-condition
4986 The initial setting is @code{one}.
4987 The value of @code{wl-plugged} reflects the return value of the function
4988 @code{elmo-plugged-p} (without arguments).
4989 This variable @code{elmo-plugged-condition} specifies the condition on
4990 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4991 plugged state of each port.
4994 'one : plugged if one or more ports are plugged.
4995 'all : plugged if all ports are plugged.
4996 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4997 states of the ports.
4998 @var{function} : reflects the return value of the @var{function}
4999 functions available per default
5000 'elmo-plug-on-by-servers
5001 : reflects the plugged state of the servers specified by the
5002 variable elmo-plug-on-servers.
5003 'elmo-plug-on-by-exclude-servers
5004 : reflects the plugged state of the servers that are not
5005 in elmo-plug-on-exclude-servers.
5006 elmo-plug-on-exclude-servers defaults to
5009 (system-name)without the domain part)
5015 (setq elmo-plugged-condition 'all)
5017 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5018 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5020 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5021 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5025 @item wl-reset-plugged-alist
5026 @vindex wl-reset-plugged-alist
5027 The initial setting is @code{t}. If non-nil, plugged states are
5028 initialized on a per server or port basis when Wanderlust starts up.
5030 If @code{nil}, plugged states are retained while Emacs is running. In
5031 other words, they are initialized when Emacs is restarted even if the
5032 value is @code{nil}.
5036 @node Expire and Archive, Scoring, Disconnected Operations, Top
5037 @chapter Automatic Expiration and Archiving of Messages
5038 @cindex Expire and Archive
5041 * Expire:: Expiration and Archiving
5042 * Archive:: Archiving All Messages
5046 @node Expire, Archive, Expire and Archive, Expire and Archive
5048 @cindex Expire Message
5050 Expiration means deletion of old messages which have outlasted a
5051 certain period of time.
5053 @code{wl-expire} supports not only simple deletion, but also moving to
5054 specified archiving folders.
5058 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5059 or @kbd{M-e} in the summary mode.
5061 @subsection Configuring @code{wl-expire-alist}
5063 An example configuration of @code{wl-expire-alist} is shown below.
5064 Everything in this @code{wl-expire-alist} makes a great difference in
5065 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5066 to @code{t}, especially in the initial stage.
5070 (setq wl-expire-alist
5071 '(("^\\+trash$" (date 14) remove)
5073 ("^\\+tmp$" (date 7) trash)
5074 ;; @r{re-file to @code{wl-trash-folder}}
5075 ("^\\+outbox$" (number 300) "$outbox;lha")
5076 ;; @r{re-file to the specific folder}
5078 ;; @r{do not expire}
5079 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5080 ;; @r{archive by message number (retaining numbers)}
5081 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5082 ;; @r{archive by a fixed number (retaining numbers)}
5083 ("^\\+diary$" (date 30) wl-expire-archive-date)
5084 ;; @r{archive by year and month (numbers discarded)}
5089 Items in the list has the format of:
5092 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5096 The folder is examined if it matches @var{regexp-for-folders} from the
5097 beginning of the list. If you invoke expiration on the folder that does
5098 not match any of them, nothing will happen. And if either the second or
5099 the third element of the item is @code{nil}, expiration will not take
5102 You can use any one of the following for
5103 @var{specification-of-message-to-be-deleted}:
5106 @item (number @var{n1} [@var{n2}])
5107 deletes messages depending on the number of messages in the folder.
5109 @var{n1} is the number of messages which should survive deletion, for example
5110 if its value is 500, the newest 500 messages survive and the rests are
5113 @var{n2} is the number of messages in the folder on which expiration should
5114 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5115 folders with 510 or more messages are expired.
5116 If you configured automatic expiration, frequently used folders may
5117 expire every time it receive messages, and you may be annoyed with the
5118 long delay in reading mail.
5119 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5120 expiration would not take place until a certain number of messages
5123 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5124 with important/new/unread) are not deleted.
5125 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5126 will expire so as to have 500 messages including such ones.
5127 Otherwise, it will have 500 messages except such ones.
5129 @item (date @var{d1})
5130 deletes messages depending on the dates.
5132 Messages dated @var{d1} or more days ago are deleted, for example if its
5133 value is seven, messages seven days old or more are deleted. Note that
5134 the date is the one in the @samp{Date:} field of the message, not when
5135 the message entered the folder.
5137 Messages with no or invalid @samp{Date:} field does not expire; you
5138 might have to delete them by hand.
5141 You can use any one of the following in the place of @var{destination}:
5145 deletes the messages instantly.
5148 hide the messages from summary (messages are not deleted).
5151 moves the messages to @code{wl-trash-folder}.
5153 @item @var{string}(folder)
5154 moves the messages to the folder specified with @var{string}.
5156 It would be useful for specifying an archiving folder, but because this
5157 does not move important messages, it might be better to use the
5158 standard functions described below.
5160 @item @var{function}
5161 invokes the specified @var{function}.
5163 To the @var{function}, three arguments are passed: a folder name, a list
5164 of messages to be deleted, and msgdb information of the summary. You
5165 can specify function-specific arguments after the name of the
5166 @var{function}. Note that the list contains messages with marks in
5167 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5170 These are four standard functions; three of them move messages to an archive
5171 folder in the specified way. This means old messages can be compressed
5172 and saved in a file, being deleted from the original folder.
5173 The last one divides messages to some MH folders.
5176 @item wl-expire-archive-number1
5177 re-files to archiving folders corresponding to the message numbers of
5178 the messages being deleted. For example, a message numbered 102 will be
5179 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5180 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5181 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5183 The archiving folders to which messages are re-filed are determined by
5184 the name of the folder as follows (in this case, archiving folders are
5185 handled as if @code{elmo-archive-treat-file} were non-nil).
5188 @item If the folder type is localdir:
5189 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5191 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5192 (@file{~/Mail/ml/wl-00100.zip}).
5194 @item The folder type is other than localdir:
5195 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5197 For example, @samp{%#mh/ml/wl} corresponds to
5198 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5201 As you can see, in the case of localdir, the folder type is not included
5202 in the path name, but otherwise it is included.
5203 And you can control the prefix to the archiving folder name by
5204 @code{wl-expire-archive-folder-prefix}.
5205 Refer to @code{wl-expire-archive-folder-prefix} for details.
5207 @item wl-expire-archive-number2
5208 re-files every certain number of messages to archiving folders.
5210 This differs from @samp{wl-expire-archive-number1} in that this re-files
5211 to the folder up to the specified number regardless of message numbers.
5212 The archiving folders to which messages are re-filed are determined in the
5213 same way as @code{wl-expire-archive-number1}.
5215 @item wl-expire-archive-date
5216 re-files messages depending on its date (year and month) to archive
5219 For example, a message dated December 1998 is re-filed to
5220 @code{$folder-199812;zip}. The name of the archiving folders except the
5221 date part are determined in the same way as
5222 @code{wl-expire-archive-number1}.
5225 You can set the first argument to these three standard functions to non-nil
5226 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5227 For example, it can be specified just after the name of the function:
5230 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5233 If you omit the argument, consecutive numbers from 1 are assigned for
5234 each archiving folder.
5236 @item wl-expire-localdir-date
5237 divedes messages depending on its date (year and month) to MH folders
5238 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5242 @subsection Treatment for Important or Unread Messages
5244 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5245 standard function, messages with marks in
5246 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5247 messages} thereafter) are retained.
5249 Per default, this variable include the important, new, and unread marks,
5250 so that messages with these marks are not removed.
5251 Note that you cannot include the temporary mark (i.e. temporary marks
5252 are removed anyway), and be sure to process temporary marks before you
5255 @subsection Auto Expiration
5257 The following setup invokes expiration when you move into the summary
5258 mode. There will be no confirmation, so make sure you made no mistake
5259 in regexp and other settings before you set up this.
5263 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5267 In the folder mode, you can invoke expiration per group as well as per
5268 folder. Therefore, if you specify @samp{Desktop} group, all folders
5269 matching @code{wl-expire-alist} expire.
5273 @subsection Treating archive folders.
5274 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5275 you must set non-nil value to @code{elmo-archive-treat-file}.
5277 @subsection Confirming
5279 If you are to use @code{remove}, try @code{trash} at first and see
5280 messages move to @code{wl-trash-folder} as expected, then replace it
5281 with @code{remove}. It would be dangerous to use @code{remove} from the
5284 If you are to use @code{wl-expire-archive-number1} and the like, try to
5285 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5286 you can append messages to it. Even if settings in
5287 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5288 would not be saved anywhere and disappeared in case the archiver program
5291 After you make sure you can archive to the folder correctly, you can
5292 invoke expiration and utilize the log.
5294 If you set @code{wl-expire-use-log} to @code{t},
5295 @file{~/.elmo/expired-log} should contain the log, for example:
5299 delete +ml/wl (593 594 595 596 597 598 599)
5300 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5304 The first column indicates the operation, i.e. @samp{delete},
5305 @samp{copy}, or @samp{move}. The next is the name of the folder that
5306 expired. In the case of @samp{copy} and @samp{move}, the destination
5307 folder is recorded after @samp{->}. The last is the list of message
5308 numbers that are actually deleted or moved (in the case of @samp{copy}
5309 and @samp{move}, the number is the one in the source folder, rather than
5310 the destination folder).
5312 @subsection Re-filing Reserved Messages
5314 The three standard functions copy reserved messages to the archive
5315 folder, but do not delete them from the source folder. Because
5316 reserved messages and the like always remain, they are recorded in
5317 @file{~/.elmo/expired-alist} so that they are not copied over and over
5318 again. They are not recorded if copied by @code{wl-summary-archive}.
5320 If you enabled logging, usually @samp{move} is recorded for re-filing,
5321 but instead @samp{copy} and @samp{delete} are recorded separately if
5322 reserved messages are involved. This is because it actually copies
5323 messages including reserved, then deletes ones except reserved in that
5326 @section Customizable Variables
5329 @item wl-expire-alist
5330 @vindex wl-expire-alist
5331 The initial setting is @code{nil}.
5332 This variable specifies folders and methods to expire. For details,
5333 refer to @code{wl-expire-alist} settings above.
5335 @item wl-summary-expire-reserve-marks
5336 @vindex wl-summary-expire-reserve-marks
5337 The initial setting is the list below.
5341 (list wl-summary-important-mark
5343 wl-summary-unread-mark
5344 wl-summary-unread-uncached-mark
5345 wl-summary-unread-cached-mark)
5349 Messages with these marks are retained in the folder, even after
5351 Only permanent marks can be listed, not temporary marks.
5353 You can list marks one by one as in the default; you can use the
5354 following settings as well:
5358 All messages with permanent marks are retained,
5359 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5363 All messages are handled as usual ones that are already read, no matter
5364 what marks they have; even important messages are deleted.
5367 @item wl-expire-archive-files
5368 @vindex wl-expire-archive-files
5369 The initial setting is 100.
5370 This variable specifies the number of messages to be retained in one
5373 @item wl-expire-number-with-reserve-marks
5374 @vindex wl-expire-number-with-reserve-marks
5375 The initial setting is @code{nil}.
5376 If non-nil, if expiring messages are specified by @code{number},
5377 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5379 @item wl-expire-archive-get-folder-function
5380 @vindex wl-expire-archive-get-folder-function
5381 The initial setting is @code{wl-expire-archive-get-folder}.
5383 This variable specifies a function that returns the name of an archiving
5384 folder for standard functions in the place of @var{destination}.
5385 You can use the following three variables for simple modification of
5386 folder names; if you want more complex settings, define your own
5387 function in this variable.
5389 @code{wl-expire-archive-get-folder} can be customized by these
5392 @item @code{wl-expire-archive-folder-name-fmt}
5393 @item @code{wl-expire-archive-folder-type}
5394 @item @code{wl-expire-archive-folder-prefix}
5397 @item wl-expire-archive-folder-name-fmt
5398 @vindex wl-expire-archive-folder-name-fmt
5399 The initial setting is @samp{%s-%%05d;%s}.
5400 This is a @code{format} string for archiving folders used in
5401 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5402 Note that you must specify the message number by @samp{%%d}, because it
5403 is parsed twice by @code{format}.
5405 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5408 @item wl-expire-archive-date-folder-name-fmt
5409 @vindex wl-expire-archive-date-folder-name-fmt
5410 The initial setting is @samp{%s-%%04d%%02d;%s}.
5411 This is a @code{format} string for archiving folders used in
5412 @code{wl-expire-archive-date}. Note that you must specify the message
5413 number by @samp{%%d}, because it is parsed twice by @code{format}.
5414 There should be @samp{%%d} twice, one for the year and the other for the
5417 If you modify this, adjust
5418 @code{wl-expire-archive-date-folder-num-regexp} as well.
5420 @item wl-expire-archive-folder-type
5421 @vindex wl-expire-archive-folder-type
5422 The initial setting is @code{zip}.
5423 This variable specifies an archiver type of the archiving folders.
5425 @item wl-expire-archive-folder-prefix
5426 @vindex wl-expire-archive-folder-prefix
5427 The initial setting is @code{nil}.
5428 This variable specifies the prefix (directory structure) to archiving
5430 Exercise extreme caution in using this feature, as it has not been
5432 In the worst case, there is a fear of destructing archiving folders.
5436 There will be no prefix.
5439 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5440 @samp{$ml/wl-00000;zip;wl}.
5443 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5446 @samp{$ml/wl-00000;zip;ml/wl}.
5449 @item wl-expire-archive-folder-num-regexp
5450 @vindex wl-expire-archive-folder-num-regexp
5451 The initial setting is @samp{-\\([-0-9]+\\);}.
5452 This variable specifies the regular expression to be used for getting
5453 message numbers from multiple archiving folders specified by
5454 @code{elmo-list-folders}.
5455 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5457 @item wl-expire-archive-date-folder-num-regexp
5458 @vindex wl-expire-archive-date-folder-num-regexp
5459 The initial setting is @samp{-\\([-0-9]+\\);}.
5460 This is the regular expression to be used for getting message numbers
5461 from multiple archiving folders specified by @code{elmo-list-folders}.
5462 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5464 @item wl-expire-delete-oldmsg-confirm
5465 @vindex wl-expire-delete-oldmsg-confirm
5466 The initial setting is @code{t}.
5467 If non-nil, messages older than the one with the largest number will be
5468 deleted with confirmation.
5469 If @code{nil}, they are deleted without confirmation.
5471 This feature is valid only if non-nil is specified as a argument to the
5472 standard functions so as to retain numbers.
5474 @item wl-expire-use-log
5475 @vindex wl-expire-use-log
5476 The initial setting is @code{nil}.
5477 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5478 They are appended but not truncated or rotated automatically; you might
5479 need to remove it manually.
5481 @item wl-expire-add-seen-list
5482 @vindex wl-expire-add-seen-list
5483 The initial setting is @code{t}.
5485 If non-nil, when messages are re-filed by expiration, read/unread
5486 information is passed to the destination folder.
5488 However if you do not read the destination folder from Wanderlust,
5489 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5490 want to set this to @code{nil} if you are simply saving to some
5491 archiving folders. Even if its value is @code{nil}, messages in the
5492 archiving folders are simply treated as unread; it does not affect
5495 @item wl-expire-folder-update-msgdb
5496 @vindex wl-expire-folder-update-msgdb
5497 The initial setting is @code{t}.
5498 If @code{t}, in the folder mode, expiration is carried out after
5499 updating summary information. If you specified a list of regular
5500 expressions of folder names, summary information is updated for matching
5505 @node Archive, , Expire, Expire and Archive
5506 @section Archiving Messages
5508 @subsection Archiving Messages
5509 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5510 folders. If there are the archiving folders already, only new messages
5513 You can use @code{wl-archive-alist} in order to specify how messages are
5514 archived according to their folder names, as in @code{wl-expire-alist}.
5519 (setq wl-archive-alist
5520 '(("^\\+tmp$" wl-archive-date)
5521 ("^\\+outbox$" wl-archive-number2)
5522 (".*" wl-archive-number1)))
5526 Each item in the list has the following format:
5529 (@var{folders-regexp} @var{deleting-function})
5532 As you can see, you can only use a function after @var{folders-regexp}.
5533 Per default, there are three functions:
5536 @item @code{wl-archive-number1}
5537 @item @code{wl-archive-number2}
5538 @item @code{wl-archive-date}
5541 As inferred from their names, they work similarly to "expire" versions,
5542 other than the following points:
5545 @item No messages are deleted
5546 @item Message numbers are retained even if invoked without arguments
5549 These functions are good to archive all messages in a folder by their
5550 numbers or by their dates.
5551 These are also useful for backup or confirmation purposes before
5553 If you try to re-file them after they are archived, they are deleted but
5556 Per default, the archiving folders to which messages are copied are
5557 determined automatically by @code{wl-expire-archive-get-folder-function}.
5558 You can copy to a specific folder by invoking with a prefix argument,
5559 i.e. @kbd{C-u M-x wl-summary-archive}.
5561 Note that this feature has not been seriously tested, because you can
5562 simply copy to an archiving folder, for example by
5563 @code{wl-summary-copy-region}.
5565 The archiving folders are determined by the same logic as in
5566 @code{wl-summary-expire}; the following customizable variables are
5570 @item @code{wl-expire-archive-files}
5571 @item @code{wl-expire-archive-get-folder-function}
5572 @item @code{wl-expire-archive-folder-name-fmt}
5573 @item @code{wl-expire-archive-folder-type}
5574 @item @code{wl-expire-archive-folder-prefix}
5575 @item @code{wl-expire-archive-folder-num-regexp}
5578 @subsection Customizable Variables
5581 @item wl-archive-alist
5582 @vindex wl-archive-alist
5583 The initial setting is the list shown below:
5587 ((".*" wl-archive-number1))
5592 This variable specifies a function that copies to archiving folders.
5593 To the function, three arguments are passed: a folder name, a list of
5594 messages in the folder, and msgdb information of the summary.
5595 Needless to say, you can use your own function.
5599 @node Scoring, Address Book, Expire and Archive, Top
5600 @chapter Score of the Messages
5602 @c @cindex Kill File
5604 Scoring is the function that associates a score (value) with each
5605 message, and marks as read or deletes from the summary according to it.
5607 You can put target or important marks on essential messages, or read marks
5608 on the ones you do not want to read, for example spam articles.
5610 This scoring function has a capability and a format similar to the one
5611 that Gnus has, although there are some unsupported features and
5612 Wanderlust specifics.
5613 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5616 * Score Commands:: Score Commands
5617 * Score File Format:: Score File Format
5621 @node Score Commands, Score File Format, Scoring, Scoring
5622 @section Score Commands
5623 @cindex Score Commands
5625 @subsection Score File Specification
5627 @code{wl-score-folder-alist} specifies score files or variables in which
5628 scores are defined, corresponding to folder names.
5632 (setq wl-score-folder-alist
5641 If paths to the score files are omitted, the directory specified in the
5642 variable @code{wl-score-files-directory} is assumed.
5644 No matter what you write in @code{wl-score-folder-alist}, the default
5645 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5646 read (it does not have to exist).
5647 Therefore, in the example above, the three score files,
5648 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5649 the folders that matches @samp{^-.*}.
5651 @subsection Scored Messages
5653 Scores are attached to the messages that are specified by
5654 @code{wl-summary-score-marks} temporarily when the summary is updated;
5655 when you exit from the summary, the scores are removed and reverts to
5658 @subsection Creation of Score Files
5660 In the summary buffer, move to an appropriate message and type @kbd{L}.
5661 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5662 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5664 This makes @minus{}1000 are scored for messages with the same
5665 @samp{Subject:} as the string you entered. That is, such a score file
5666 is created automatically.
5668 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5669 The score file you just made appears.
5670 This buffer is called @dfn{score editing buffer} thereafter.
5671 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5672 as you are previously; type @kbd{a}. Then a score entry for "From"
5674 In this way, you can create a score file easily either in the summary
5675 buffer or in the score editing buffer.
5677 By the way, you might be aware the numbers of key strokes are different
5678 between @kbd{s s p} and @kbd{a}.
5679 This is determined by @code{wl-score-header-default-entry}.
5680 This variable specifies the default score entries corresponding to
5682 For example, for "subject" field, a type and a time limit are prompted,
5683 but for "from" field, they are fixed upon automatically as substring and
5684 permanent respectively.
5685 However, score values can be modified by the prefix argument.
5686 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5689 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5690 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5691 erasing contents of the buffer deletes the score file being edited.
5695 @subsubsection Selecting Score Files
5697 You can change score files to which scores are appended by
5698 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5699 @code{wl-score-change-score-file}.
5701 @subsubsection Summing Up the Score
5703 If you add the same entries by @code{wl-summary-increase-score},
5704 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5705 scores for the entry is summed up.
5707 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5708 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5709 @minus{}1200 will be created as a result.
5711 @subsubsection Creating Thread Key
5713 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5714 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5716 @subsubsection Creating Followup Key
5718 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5719 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5720 at the cursor to @samp{References} key.
5721 If @code{wl-score-auto-make-followup-entry} is non-nil,
5722 @samp{Message-ID} of all messages to be followed up within dates
5723 specified by @code{wl-score-expiry-days}.
5725 @subsection Key Bindings
5730 @findex wl-summary-increase-score
5731 Increases the score for the current message.
5732 And the score entry is appended to the score file at the same moment.
5733 You can specify the score value by a prefix argument.
5737 @findex wl-summary-lower-score
5738 Decreases the score for the current message.
5739 And the score entry is appended to the score file at the same moment.
5740 You can specify the score value by a prefix argument.
5743 @kindex h R (Summary)
5744 @findex wl-summary-rescore
5745 Re-applies the scoring.
5746 However, already scored messages are not scored anew.
5749 @kindex h c (Summary)
5750 @findex wl-score-change-score-file
5751 Changes the score file currently selected.
5754 @kindex h e (Summary)
5755 @findex wl-score-edit-current-scores
5756 Edits the score file currently selected.
5757 If there are multiple score files, the previously specified one is
5761 @kindex h f (Summary)
5762 @findex wl-score-edit-file
5763 Edits an arbitrary score file and selects it.
5766 @kindex h F (Summary)
5767 @findex wl-score-flush-cache
5768 Erases caches associated to the score files that are read.
5769 If you modified score files directly (from other than Wanderlust), you
5770 need to re-read them after erasing the cache.
5773 @kindex h m (Summary)
5774 @findex wl-score-set-mark-below
5775 Specifies the criterion for scores to be marked as read.
5776 Messages with scores less than this value are marked as read.
5779 @kindex h x (Summary)
5780 @findex wl-score-set-expunge-below
5781 Specifies the criterion for scores to be deleted from the summary.
5782 Messages with scores less than this value are deleted.
5783 "Deleted" means it is not shown; they are not removed from the summary
5784 information or the folder.
5785 The deleted messages can be shown by rescan-noscore again.
5788 @subsection Key Bindings in the Score Editing Buffer
5792 @kindex C-c C-k (Score Mode)
5793 @findex wl-score-edit-kill
5794 Abandons the file being edited.
5797 @kindex C-c C-c (Score Mode)
5798 @findex wl-score-edit-exit
5799 Saves the file being edited, and quits from the edit mode.
5802 @kindex C-c C-p (Score Mode)
5803 @findex wl-score-pretty-print
5807 @kindex C-c C-d (Score Mode)
5808 @findex wl-score-edit-insert-date
5809 Inserts the number of dates from Dec. 31, 1 B.C.
5810 It is used for creating the third factor of time-limited scores.
5813 @kindex C-c C-s (Score Mode)
5814 @findex wl-score-edit-insert-header
5815 Inserts the header of the message selected in the summary buffer.
5818 @kindex C-c C-e (Score Mode)
5819 @findex wl-score-edit-insert-entry
5820 Inserts the score entry of the message selected in the summary buffer.
5823 @subsection Customizable Variables
5826 @item wl-summary-default-score
5827 @vindex wl-summary-default-score
5828 The initial setting is 0 (zero).
5829 This variable specifies the default value of the score.
5830 The score is increased or decreased based upon this value.
5832 @item wl-summary-important-above
5833 @vindex wl-summary-important-above
5834 The initial setting is @code{nil}.
5835 Messages with scores larger than this value are attached with the
5836 important mark (@samp{$}).
5837 If @code{nil}, no important marks are attached.
5839 @item wl-summary-target-above
5840 @vindex wl-summary-target-above
5841 The initial setting is @code{nil}.
5842 Messages with scores larger than this value are attached with the target
5844 If @code{nil}, no target marks are attached.
5846 @item wl-summary-mark-below
5847 @vindex wl-summary-mark-below
5848 The initial setting is 0 (zero).
5849 Messages with scores smaller than this value are marked as read.
5851 @item wl-summary-expunge-below
5852 @vindex wl-summary-expunge-below
5853 The initial setting is @code{nil}.
5854 Messages with scores smaller than this value are deleted from the
5856 If @code{nil}, they are not deleted.
5858 @item wl-summary-score-marks
5859 @vindex wl-summary-score-marks
5860 The initial setting is the list shown below:
5864 (list wl-summary-new-mark)
5869 Messages with these marks are scored.
5871 @item wl-use-scoring
5872 @vindex wl-use-scoring
5873 The initial setting is t.
5874 If non-nil, scoring is enabled.
5876 @item wl-score-files-directory
5877 @vindex wl-score-files-directory
5878 The initial setting is @file{~/.elmo/}.
5879 The default directory for score files.
5881 @item wl-score-interactive-default-score
5882 @vindex wl-score-interactive-default-score
5883 The initial setting is 1000.
5884 This value is used as a score when a score factor is @code{nil} in the
5885 score file. It is also used in @code{wl-summary-increase-score} and
5886 @code{wl-summary-lower-score}, on condition that the value of
5887 @code{wl-score-header-default-entry} is @code{nil}.
5889 @item wl-score-expiry-days
5890 @vindex wl-score-expiry-days
5891 The initial setting is 7.
5892 This is the number of days before time-limited scores are deleted.
5894 @item wl-score-update-entry-dates
5895 @vindex wl-score-update-entry-dates
5896 The initial setting is @code{t}.
5897 If non-nil, it enables deletion of time-limited scores.
5899 @item wl-score-header-default-entry
5900 @vindex wl-score-header-default-entry
5901 Specifies the default value for each header field for score entries
5902 created by @code{wl-summary-increase-score},
5903 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5905 @item wl-score-simplify-fuzzy-regexp
5906 @vindex wl-score-simplify-fuzzy-regexp
5907 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5908 regular expression to be deleted from the string.
5909 Because this is usually used for Subject, the default is prefixes that
5910 are attached by mailing list programs.
5912 @item wl-summary-rescore-partial-threshold
5913 @vindex wl-summary-rescore-partial-threshold
5914 The initial setting is 200.
5915 When sync-all or rescan is executed, if there are messages more than
5916 this value, only the last same number of messages as this value are
5919 @item wl-summary-auto-sync-marks
5920 @vindex wl-summary-auto-sync-marks
5921 If non-nil, unread/important marks are synchronized when the summary
5923 Unread marks reflect information on the IMAP4 server.
5924 Important marks reflect information on the IMAP4 server (flagged or
5925 not), and contents of @samp{'mark} folder.
5926 The initial setting is @code{t}.
5930 @node Score File Format, , Score Commands, Scoring
5931 @section Score File Format
5932 @cindex Score File Format
5934 The format of score files are the same as Gnus, and basically you can
5935 use Gnus score files as they are. But they are not fully compatible
5936 because some keys are not supported and there are Wanderlust specifics.
5937 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5942 ("for sale" -1000 nil s)
5943 ("profit" -1000 nil s))
5945 ("spam@@spamspamspam" -10000 nil s))
5947 ("my@@address" 3001 nil s))
5949 (1000000 -10 nil >))
5959 If the key is a string, it is the name of the header to be matched.
5960 The following keys are available:
5961 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5962 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5963 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5964 @code{Chars} and @code{Lines} mean the size and the number of lines of
5965 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5966 are described later.
5967 The rest corresponds the field of the same name.
5969 Arbitrary numbers of core entries are specified after the key.
5970 Each score entry consists of these five factors:
5974 A factor that matches header. This should be a number in the cases of
5975 @code{lines} and @code{chars}, otherwise a string.
5978 A score factor. When the first item matches, the score of the message
5979 is increased or decreased by this value.
5982 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5983 of a number, the score is deleted if it does not match for days
5984 (@code{wl-score-expiry-days}) from the date specified by this.
5985 The date is since Dec. 31, 1 B.C.
5988 A type factor. This specifies the way the first factor matches.
5989 Available types depend on keys.
5992 @item From, Subject, References, Message-ID
5993 For these keys in string, @code{r} and @code{R} (regexp),
5994 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5995 as well as @code{f} and @code{F} (fuzzy) can be used.
5996 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5999 For these keys, the following five numerical relative operators can be
6000 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6003 This key matches @code{From} header, and scores all follow-ups to the
6005 For example, it would be useful for increasing scores for follow-ups to
6008 You can use the same types as @code{From} except for @code{f}.
6009 And a @samp{Followup} entry is automatically appended to the score file.
6012 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6013 A @samp{Thread} entry is automatically appended for each article that
6014 has @var{x} in the @code{References} header.
6015 You can make sure the whole thread including messages that does not have
6016 all ancestors @code{Message-ID} in @code{References} is scored.
6018 You can use the same types as @code{References} except for @code{f}.
6019 And a @samp{Thread} entry is automatically appended to the score file.
6023 A factor for extension header. This is meaningful only if the key is
6025 This specifies headers to be matched other than standard headers like
6026 @code{Subject} and @code{From}.
6027 Note that you should specify the header in
6028 @code{elmo-msgdb-extra-fields} also.
6029 Therefore it does not work in folders where extension headers cannot be
6034 The sum of these scores @emph{after all factors are applied} becomes the
6035 score of the message.
6037 @cindex Score File Atoms
6039 Messages with a score less than this value is marked as read.
6040 The default is @code{wl-summary-mark-below}.
6043 Messages with a score less than this value is deleted from the summary.
6044 The default is @code{wl-summary-expunge-below}.
6046 @item mark-and-expunge
6047 Both @code{mark} and @code{expunge} are applied,
6048 i.e. messages with a score less than this value is marked as read and
6049 deleted from the summary.
6052 Messages with a score greater than this value is attached with temp
6054 The default is @code{wl-summary-target-above}.
6057 Messages with a score greater than this value is attached with important
6059 The default is @code{wl-summary-important-above}.
6064 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6065 are used, you need to set @code{elmo-msgdb-extra-fields}.
6068 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6071 There are other restrictions as shown below:
6074 @item Because @samp{References} field in the summary information
6075 contains only the last @samp{Message-ID}, @code{references} key matches
6079 Keys that can be seen by folder of types:
6083 chars lines xref extra
6084 localdir,localnews Y E E E
6085 nntp (supporting xover) Y E E N
6091 N: cannot be seen (ignored)
6092 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6097 @node Address Book, Customization, Scoring, Top
6098 @chapter Address Book
6099 @cindex Address Book
6101 With address book, you can utilize address completion, and you have
6102 summary displayed with nicknames.
6105 * Mail Addresses:: Definition of Address Book
6106 * Address Manager:: Address Manager
6109 @node Mail Addresses, Address Manager, Address Book, Address Book
6110 @section Address book
6111 @cindex Address book Definition
6113 @cindex Alias, Address
6115 The file @file{~/.addresses} is a simple address book for Wanderlust.
6116 Make address file @file{~/.addresses}, and edit to suit your requirement.
6118 The data written in @file{~/.addresses} are used for address completion
6119 under draft editing mode. Furthermore, they are used when showing names
6120 in summary display mode. You can safely skip this section, if you don't
6121 want to customize address completion and summary display.
6122 It is possible to add/change/remove addresses from @file{~/.addresses} in
6123 summary buffer after Wanderlust is invoked. @refill
6125 The format is very simple. Like this. @refill
6130 # @r{Lines begin with @samp{#} are comment.}
6131 # @r{Empty lines are ignored}
6133 # @r{Format of each line:}
6134 # @var{email-address} "@var{nickname} "@var{realname}"
6136 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6137 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6138 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6143 One line defines one persons description.
6145 Actually, in default setup, @var{nickname} is used in summary-mode and
6146 @var{realname} is used in draft preparation mode. This behavior is
6147 better understood if you try it and confirmed the function first. You
6148 can write and try a small definition, so you will know the idea of the
6149 address book before writing a big one.
6151 And, if MH alias file is specified in variable @code{wl-alias-file},
6152 it is used as an address information in the draft preparation mode.
6154 If variable @code{wl-use-ldap} is non-nil (initial setting is
6155 @code{nil}), address completion in draft mode uses LDAP information.
6157 If you use LDAP, you have to set @code{wl-ldap-server},
6158 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6159 not have LDAP feature as built-in feature (Currently only XEmacs can
6160 have built-in LDAP feature), you have to set command exec @env{PATH} to
6161 the program @command{ldapsearch}.
6164 @node Address Manager, , Mail Addresses, Address Book
6165 @section Address Manager
6166 @cindex Address Manager
6168 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6169 the address book and insert address to draft buffer.
6171 @subsection Key Bindings
6175 @kindex t (Address Manager)
6176 @findex wl-addrmgr-set-to
6177 Add @samp{To:} mark.
6180 @kindex c (Address Manager)
6181 @findex wl-addrmgr-set-cc
6182 Add @samp{Cc:} mark.
6185 @kindex b (Address Manager)
6186 @findex wl-addrmgr-set-bcc
6187 Add @samp{Bcc:} mark.
6190 @kindex u (Address Manager)
6191 @findex wl-addrmgr-unmark
6195 @kindex x (Address Manager)
6196 @findex wl-addrmgr-apply
6198 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6199 buffer and quit address manager. When no draft buffer, make new draft
6200 with insert marked addresses.
6202 If no mark, quit address manager.
6206 @kindex q (Address Manager)
6207 @findex wl-addrmgr-quit
6208 Quit address manager.
6211 @kindex a (Address Manager)
6212 @findex wl-addrmgr-add
6216 @kindex d (Address Manager)
6217 @findex wl-addrmgr-delete
6221 @kindex e (Address Manager)
6222 @findex wl-addrmgr-edit
6227 @node Customization, Mailing List, Address Book, Top
6228 @chapter Customizing Wanderlust
6229 @cindex Customization
6232 * Living with other packages:: Cooperating with other packages
6233 * Highlights:: Highlights
6234 * Biff:: Notify Mail arrival
6235 * Advanced Settings:: Advanced Settings
6236 * Customizable Variables:: Customizable Variables
6241 @node Living with other packages, Highlights, Customization, Customization
6242 @section Living with other packages
6244 Examples with other packages.
6247 * imput:: imput (im-wl.el)
6249 * supercite:: supercite.el
6250 * mu-cite:: mu-cite.el
6251 * X-Face:: x-face,bitmap-mule
6252 * dired-dd:: dired-dd.el
6254 * Addrbook:: Addrbook
6255 * mime-w3m:: mime-w3m.el
6259 @node imput, BBDB, Living with other packages, Living with other packages
6264 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6267 If @command{imput} is on the @code{exec-path} at the installation,
6268 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6272 (autoload 'wl-draft-send-with-imput-async "im-wl")
6273 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6278 @node BBDB, supercite, imput, Living with other packages
6282 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6285 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6286 byte-compiled and installed.
6294 ;; @r{enable pop-ups}
6295 (setq bbdb-use-pop-up t)
6296 ;; @r{auto collection}
6297 (setq bbdb/mail-auto-create-p t)
6298 ;; @r{exceptional folders against auto collection}
6299 (setq bbdb-wl-ignore-folder-regexp "^@@")
6300 (setq signature-use-bbdb t)
6301 (setq bbdb-north-american-phone-numbers-p nil)
6302 ;; @r{shows the name of bbdb in the summary} :-)
6303 (setq wl-summary-from-function 'bbdb-wl-from-func)
6304 ;; @r{automatically add mailing list fields}
6305 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6306 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6310 You can complete address with BBDB by @kbd{M-@key{TAB}}
6314 @node supercite, mu-cite, BBDB, Living with other packages
6315 @subsection sc.el(supercite), sc-register.el
6319 The same setting as usual mailers should be OK. The following is an
6320 example of settings:
6324 (autoload 'sc-cite-original "supercite" nil t)
6325 (add-hook 'mail-citation-hook 'sc-cite-original)
6330 @node mu-cite, X-Face, supercite, Living with other packages
6331 @subsection mu-cite.el
6334 The same setting as usual mailers should be OK. The following is an
6335 example of settings.
6337 If you use mu-cite version 8.0 or earlier:
6341 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6342 (setq mail-citation-hook 'mu-cite/cite-original)
6346 If you use mu-cite version 8.1 or later:
6350 (autoload 'mu-cite-original "mu-cite" nil t)
6351 (add-hook 'mail-citation-hook (function mu-cite-original))
6355 @node X-Face, dired-dd, mu-cite, Living with other packages
6359 If you have installed one of the following, you can decode
6360 @samp{X-Face:} field in message buffer and you will see face image.
6363 * x-face-xmas:: XEmacs case
6364 * x-face-mule:: Emacs case
6367 If there is an encoded X-Face string in a file @file{~/.xface} (the
6368 value of the variable @code{wl-x-face-file}), it is inserted as a
6369 @samp{X-Face:} field in the draft buffer (if
6370 @code{wl-auto-insert-x-face} is non-nil).
6372 @node x-face-xmas, x-face-mule, X-Face, X-Face
6373 @subsubsection x-face-xmas (for XEmacs)
6376 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6377 1.3.6.13 or later, do the following:
6381 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6382 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6386 @node x-face-mule, , x-face-xmas, X-Face
6387 @subsubsection x-face-mule (for Emacs)
6391 If you use @file{x-face-mule.el} in bitmap-mule
6392 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6396 (autoload 'x-face-decode-message-header "x-face-mule")
6397 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6401 @subsubsection x-face-e21 (for Emacs 21.x)
6404 With Emacs 21.x, you can use @file{x-face-e21.el}
6405 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6406 to display X-Face. In this case, bitmap-mule is not required.
6411 (autoload 'x-face-decode-message-header "x-face-e21")
6412 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6417 @node dired-dd, MHC, X-Face, Living with other packages
6418 @subsection dired-dd(Dired-DragDrop)
6419 @pindex Dired-DragDrop
6421 @cindex Drag and Drop
6423 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6424 compose multi-part by simple Drag-and-Drop from dired to the draft
6425 buffer being edited in GNU Emacs (this feature is not Wanderlust
6426 specific, but general-purpose for SEMI).
6430 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6436 ;; @r{Set dired-x variables here.}
6437 ;; @r{To and flo@dots{}}
6439 (progn (require 'dired-dd)
6440 (require 'dired-dd-mime))))))
6444 @node MHC, Addrbook, dired-dd, Living with other packages
6448 Message Harmonized Calendaring system
6449 (@uref{http://www.quickhack.net/mhc/})
6451 By using MHC, you can make a calendar from the messages.
6457 (setq mhc-mailer-package 'wl)
6458 (autoload 'mhc-mode "mhc" nil t)
6459 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6460 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6468 (autoload 'mhc-wl-setup "mhc-wl")
6469 (add-hook 'wl-init-hook 'mhc-wl-setup)
6473 @node Addrbook, mime-w3m, MHC, Living with other packages
6474 @subsection wl-addrbook.el
6478 (@uref{http://www.mew.org/})
6480 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6481 @code{load-path} and do the following settings.
6485 (require 'wl-addrbook)
6490 @node mime-w3m, , Addrbook, Living with other packages
6491 @subsection mime-w3m.el
6494 You can display html part by using @file{mime-w3m.el}
6495 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6496 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6499 @node Highlights, Biff, Living with other packages, Customization
6502 @subsection Customizable Variables
6505 @item wl-summary-highlight
6506 @vindex wl-summary-highlight
6507 The initial setting is @code{t}.
6508 If non-nil, the summary is highlighted.
6510 @item wl-highlight-max-summary-lines
6511 @vindex wl-highlight-max-summary-lines
6512 The initial setting is 10000.
6513 The summary is not highlighted if it has more lines than this value.
6515 @item wl-summary-highlight-partial-threshold
6516 @vindex wl-summary-highlight-partial-threshold
6517 The initial setting is 1000.
6518 This is a threshold whether the whole summary is highlighted.
6519 If there are more lines of messages in the summary, it is partially
6522 @item wl-summary-partial-highlight-above-lines
6523 @vindex wl-summary-partial-highlight-above-lines
6524 The initial setting is 30. If there are more lines of messages than
6525 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6526 after the point that is the same number of lines as this value above the
6527 cursor line are highlighted partially. (If this value is @code{nil},
6528 the last same number of lines as the value of
6529 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6531 @item wl-highlight-body-too
6532 @vindex wl-highlight-body-too
6533 The initial setting is @code{t}.
6534 If non-nil, bodies of drafts and messages are also highlighted.
6536 @item wl-highlight-message-header-alist
6537 @vindex wl-highlight-message-header-alist
6538 When highlighting headers of drafts and messages, this variable
6539 specifies which faces are allocated to important
6540 (@code{wl-highlight-message-important-header-contents}), secondly
6541 important (@code{wl-highlight-message-important-header-contents2}), and
6542 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6544 Similarly, it can be used for allocating arbitrary faces to arbitrary
6545 regular expressions.
6547 @item wl-highlight-citation-prefix-regexp
6548 @vindex wl-highlight-citation-prefix-regexp
6549 Specifies a regular expression to which quoted lines in bodies of
6550 drafts and messages match.
6551 Bodies matching to this regular expression are highlighted by the faces
6552 specified by (@code{wl-highlight-message-cited-text-*}).
6554 @item wl-highlight-highlight-citation-too
6555 @vindex wl-highlight-highlight-citation-too
6556 The initial setting is @code{nil}.
6557 If non-nil, the quoting regular expression itself given by
6558 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6560 @item wl-highlight-citation-header-regexp
6561 @vindex wl-highlight-citation-header-regexp
6562 Specifies a regular expression that denotes beginning of quotation.
6563 Bodies matching to this regular expression are highlighted by the face
6564 specified by @code{wl-highlight-message-headers}.
6566 @item wl-highlight-max-header-size
6567 @vindex wl-highlight-max-header-size
6568 The initial setting is @code{nil}. If a header size is larger than this
6569 value, it will not be highlighted. If @code{nil}, always highlighted
6570 (ignore header size).
6572 @item wl-highlight-max-message-size
6573 @vindex wl-highlight-max-message-size
6574 The initial setting is 10000.
6575 If a message is larger than this value, it will not be highlighted.
6576 With this variable, highlight is suppressed for uuencode or huge digest
6579 @item wl-highlight-signature-separator
6580 @vindex wl-highlight-signature-separator
6581 Specifies regular expressions that denotes the boundary of a signature.
6582 It can be a regular expression, or a list of ones.
6583 Messages after the place that matches this regular expression are
6584 highlighted by the face specified by
6585 @code{wl-highlight-message-signature}.
6587 @item wl-max-signature-size
6588 @vindex wl-max-signature-size
6589 The initial setting is 400.
6590 This is the largest size for a signature to be highlighted.
6592 @item wl-use-highlight-mouse-line
6593 @vindex wl-use-highlight-mouse-line
6594 The initial setting is @code{t}.
6595 If non-nil, the line pointed by the mouse is highlighted in the folder
6596 mode, summary mode, and the like.
6599 @subsection Setting Colors and Fonts of the Characters
6601 If you want to change colors or fonts of the characters, you need to
6602 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6603 want to change fonts, and @code{set-face-foreground} for colors, and so
6604 on. You cannot write face settings in @file{.emacs}; write in
6607 For example, if you want to change the color for signatures to yellow,
6611 (set-face-foreground 'wl-highlight-message-signature "yellow")
6617 Faces defined in Wanderlust:
6620 @item wl-highlight-message-headers
6621 The face for field names of message headers.
6623 @item wl-highlight-message-header-contents
6624 The face for field bodies of message headers.
6626 @item wl-highlight-message-important-header-contents
6627 The face for important parts of message headers.
6628 Per default, this face is used for a body of @samp{Subject:} field.
6629 You can change its value by editing
6630 @code{wl-highlight-message-header-alist}.
6632 @item wl-highlight-message-important-header-contents2
6633 The face for secondly important parts of message headers.
6634 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6635 fields. You can change its value by editing
6636 @code{wl-highlight-message-header-alist}.
6638 @item wl-highlight-message-unimportant-header-contents
6639 The face for unimportant parts of message headers.
6640 Per default, this face is used for bodies of @samp{X-} fields
6641 @samp{User-Agent:} fields. You can change its value by editing
6642 @code{wl-highlight-message-header-alist}.
6644 @item wl-highlight-message-citation-header
6645 The face for headers of quoted messages.
6647 @item wl-highlight-message-cited-text-*
6648 The face for texts of quoted messages. The last @samp{*} is a
6649 @var{single figure} so that 10 different colors can be used according to
6652 @item wl-highlight-message-signature
6653 The face for signatures of messages. The initial settings are
6654 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6655 dark background colors.
6657 @item wl-highlight-header-separator-face
6658 The face for header separators of draft messages.
6660 @item wl-highlight-summary-important-face
6661 The face for message lines with important marks in the summary.
6663 @item wl-highlight-summary-new-face
6664 The face for message lines with new marks in the summary.
6666 @item wl-highlight-summary-displaying-face
6667 The face for the message line that is currently displayed.
6668 This face is overlaid.
6670 @item wl-highlight-thread-indent-face
6671 The face for the threads that is currently displayed.
6673 @item wl-highlight-summary-unread-face
6674 The face for message lines with unread marks in the summary.
6676 @item wl-highlight-summary-deleted-face
6677 The face for message lines with delete marks in the summary.
6679 @item wl-highlight-summary-refiled-face
6680 The face for message lines with re-file marks in the summary.
6682 @item wl-highlight-refile-destination-face
6683 The face for re-file information part of message lines with re-file
6684 marks in the summary.
6686 @item wl-highlight-summary-copied-face
6687 The face for message lines with copy marks in the summary.
6689 @item wl-highlight-summary-target-face
6690 The face for message lines with target marks @samp{*} in the summary.
6692 @item wl-highlight-summary-thread-top-face
6693 The face for message lines that are on the top of the thread in the
6696 @item wl-highlight-summary-normal-face
6697 The face for message lines that are not on top of the thread in the
6700 @item wl-highlight-folder-unknown-face
6701 The face for folders that are not known to have how many unsync messages
6704 @item wl-highlight-folder-zero-face
6705 The face for folders that have no unsync messages in the folder mode.
6707 @item wl-highlight-folder-few-face
6708 The face for folders that have some unsync messages in the folder mode.
6710 @item wl-highlight-folder-many-face
6711 The face for folders that have many unsync messages in the folder mode.
6712 The boundary between `some' and `many' is specified by the variable
6713 @code{wl-folder-many-unsync-threshold}.
6715 @item wl-highlight-folder-unread-face
6716 The face for folders that have no unsync but unread messages in the
6719 @item wl-highlight-folder-killed-face
6720 The face for folders that are deleted from the access group in the
6723 @item wl-highlight-folder-opened-face
6724 The face for open groups in the folder mode.
6725 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6726 @code{nil} or a @var{number}.
6728 @item wl-highlight-folder-closed-face
6729 The face for close groups in the folder mode.
6730 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6731 @code{nil} or a @var{number}.
6733 @item wl-highlight-folder-path-face
6734 The face for the path to the currently selected folder in the folder
6737 @item wl-highlight-logo-face
6738 The face for logo in the demo.
6740 @item wl-highlight-demo-face
6741 The face for strings (for example, a version number) in the demo.
6745 @node Biff, Advanced Settings, Highlights, Customization
6746 @section Notify Mail arrival
6749 Following setting is to notify mail arrival of @samp{%inbox}
6750 by the indicator on the modeline
6753 (setq wl-biff-check-folder-list '("%inbox"))
6756 @subsection Customizable Variables
6758 @item wl-biff-check-folder-list
6759 @vindex wl-biff-check-folder-list
6760 The initial setting is @code{nil}.
6761 This is the list of folders to check mail arrival.
6762 If @code{nil}, wl doesn't check mail arrival.
6764 @item wl-biff-check-interval
6765 @vindex wl-biff-check-interval
6766 The initial setting is 40 (in seconds).
6767 Check mail arrival in this period.
6769 @item wl-biff-notify-hook
6770 @vindex wl-biff-notify-hook
6771 This hook is run at the arrival of new mail.
6772 To beep with mail arrival(initial setting), set as follows.
6774 (setq wl-biff-notify-hook '(ding))
6776 For silence, set to @code{nil}.
6780 @node Advanced Settings, Customizable Variables, Biff, Customization
6781 @section Advanced Settings
6784 * Draft for Reply:: Draft for Reply
6785 * Thread Format:: Appearance of Thread
6786 * User-Agent Field:: @samp{User-Agent:} Header Field
6790 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6791 @subsection Draft for Replay
6792 @vindex wl-draft-reply-with-argument-list
6793 @vindex wl-draft-reply-without-argument-list
6794 @vindex wl-draft-reply-myself-with-argument-list
6795 @vindex wl-draft-reply-myself-without-argument-list
6797 If you want, when you replying to articles in mailing lists, the address
6798 in Reply-To field of the original message to be prepared to To field of
6799 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6804 (setq wl-draft-reply-without-argument-list
6805 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6806 ("Followup-To" . (nil nil ("Followup-To")))
6807 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6808 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6813 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6814 in the original message, @samp{Reply-To:} field in the original is
6815 copied to @samp{To:} field.)
6817 Moreover, the behavior of @kbd{a} with prefix argument can
6818 be directed by @code{wl-draft-reply-with-argument-list} as well.
6820 Note: To set the behavior when you reply to the message written by yourself, use
6821 @code{wl-draft-reply-myself-without-argument-list} and
6822 @code{wl-draft-reply-myself-with-argument-list}
6825 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6826 @subsection Appearance of Threads
6830 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6831 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6832 391 09/18(Fri)19:24 +-[ Murata-san ]
6833 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6834 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6835 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6836 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6837 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6838 412 09/22(Tue)09:28 | +-[ Teranishi ]
6839 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6840 416 09/22(Tue)12:38 | +-[ Teranishi ]
6841 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6842 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6846 Settings to make appearance of threads like shown above:
6850 (setq wl-thread-indent-level 2)
6851 (setq wl-thread-have-younger-brother-str "+")
6852 (setq wl-thread-youngest-child-str "+")
6853 (setq wl-thread-vertical-str "|")
6854 (setq wl-thread-horizontal-str "-")
6855 (setq wl-thread-space-str " ")
6859 If you do not want to see branches, do the following:
6863 (setq wl-thread-indent-level 2)
6864 (setq wl-thread-have-younger-brother-str " ")
6865 (setq wl-thread-youngest-child-str " ")
6866 (setq wl-thread-vertical-str " ")
6867 (setq wl-thread-horizontal-str " ")
6868 (setq wl-thread-space-str " ")
6873 @node User-Agent Field, , Thread Format, Advanced Settings
6874 @subsection User-Agent Field
6878 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6879 @samp{User-Agent:} fields, define a function that generate appropriate
6880 strings as you like, and set it to variable
6881 @code{wl-generate-mailer-string-function}.
6883 If you do not want verbose @samp{User-Agent:} field, do the following:
6887 (setq wl-generate-mailer-string-function
6890 (concat "User-Agent: "
6891 (wl-generate-user-agent-string-1 nil)))))
6895 The following is a example:
6899 (setq mime-edit-insert-user-agent-field nil)
6900 (setq wl-generate-mailer-string-function
6903 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6908 @node Customizable Variables, Hooks, Advanced Settings, Customization
6909 @section Customizable Variables
6911 Customizable variables that have not been described yet:
6914 @item wl-default-folder
6915 @vindex wl-default-folder
6916 The initial setting is @samp{%inbox}. This is the default value for moving to
6917 a folder and the like.
6919 @item wl-draft-folder
6920 @vindex wl-draft-folder
6921 The initial setting is @samp{+draft}. It is the folder to which drafts are
6922 saved. It must be a localdir folder.
6924 @item wl-trash-folder
6925 @vindex wl-trash-folder
6926 The initial setting is @samp{+trash}. It is the wastebasket folder.
6927 If you changed this variable, you had better restart Wanderlust.
6929 @item wl-interactive-exit
6930 @vindex wl-interactive-exit
6931 The initial setting is @code{t}.
6932 If non-nil, you are asked for confirmation when Wanderlust terminates.
6934 @item wl-interactive-send
6935 @vindex wl-interactive-send
6936 The initial setting is @code{t}.
6937 If non-nil, you are asked for confirmation when mail is sent.
6939 @item wl-folder-sync-range-alist
6940 @vindex wl-folder-sync-range-alist
6941 The initial setting is the alist shown below:
6946 ("^\\+draft$\\|^\\+queue$" . "all"))
6951 This is an associative list of regular expressions of folder names and
6952 update range of the summary. Update range is one of the @samp{all},
6953 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6954 @samp{last}. If a folder do not match, @samp{update} is used.
6957 @vindex wl-ask-range
6958 The initial setting is @code{t}.
6959 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6960 for updating the summary when you changed folders.
6962 @item wl-mime-charset
6963 @vindex wl-mime-charset
6964 The initial setting is @code{x-ctext}.
6965 This is the MIME charset for messages that are not MIME (e.g. without
6966 @samp{Content-Type:}). This value also used as default charset for
6967 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6968 this value as @code{iso-2022-jp}.)
6970 @item wl-highlight-folder-with-icon
6971 @vindex wl-highlight-folder-with-icon
6972 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6973 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6975 @item wl-strict-diff-folders
6976 @vindex wl-strict-diff-folders
6977 This is a list of regular expressions of folders.
6978 Unread messages are checked, for example when you press @kbd{s} in
6979 the folder mode, usually in a brief way (rapidly processed but not
6981 The folders matching this variable are seriously checked.
6982 You may want to set this variable so as to match conditional filter
6983 folders for IMAP4 folders.
6984 The initial setting is @code{nil}.
6986 @item wl-folder-use-server-diff
6987 @vindex wl-folder-use-server-diff
6988 When unread messages are checked, for example when you press @kbd{s} in
6989 the folder mode, usually (the number of messages on the server) @minus{}
6990 (the number of local messages) will be the number of unread messages.
6991 However, if this variable is non-nil, the number of unread messages on
6992 the server is checked. This affects IMAP4 folders only, but IMAP4
6993 folders in mail boxes matching
6994 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6995 the number of unread messages on the server, even if they matches this
6996 variable. The initial setting is @code{t}.
6998 @item wl-auto-check-folder-name
6999 @vindex wl-auto-check-folder-name
7000 The initial setting is @code{nil}.
7001 You can specify a folder or a group which is checked for unread message
7002 at the start. You can also specify a list of folders (groups) to be checked.
7003 If the value is @code{nil}, whole Desktop is checked at the start.
7004 If it is @code{none}, no folders are checked.
7006 @item wl-auto-uncheck-folder-list
7007 @vindex wl-auto-uncheck-folder-list
7008 The initial setting is the list shown below:
7017 You can set a list of regular expressions to specify folders
7018 which are not automatically checked even if they are included
7019 in some groups assigned by @code{wl-auto-check-folder-name}.
7021 @item wl-auto-check-folder-list
7022 @vindex wl-auto-check-folder-list
7023 The initial setting is @code{nil}.
7024 You can set a list of regular expressions to specify exceptions
7025 for @code{wl-auto-uncheck-folder-list}.
7027 @item wl-no-save-folder-list
7028 @vindex wl-no-save-folder-list
7029 The initial setting is the list shown below:
7038 This is a list of regular expressions of folders not to be saved.
7040 @item wl-save-folder-list
7041 @vindex wl-save-folder-list
7042 The initial setting is @code{nil}.
7043 This is a list of regular expressions of folders to be saved.
7044 This takes precedence over @code{wl-no-save-folder-list}.
7046 @item wl-folder-mime-charset-alist
7047 @vindex wl-folder-mime-charset-alist
7048 The initial setting is the alist shown below:
7052 (("^-alt\\.chinese" . big5)
7053 ("^-relcom\\." . koi8-r)
7055 ("^-han\\." . euc-kr))
7060 This is an associative list of regular expressions of folder names and
7062 If a folder do not match, @code{wl-mime-charset} is used.
7064 @item wl-folder-init-load-access-folders
7065 @vindex wl-folder-init-load-access-folders
7066 The initial setting is @code{nil}.
7067 This is a list of access groups to be loaded specifically at the start.
7068 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7070 @item wl-folder-init-no-load-access-folders
7071 @vindex wl-folder-init-no-load-access-folders
7072 The initial setting is @code{nil}.
7073 This is a list of access groups not to be loaded specifically at the
7075 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7077 @item wl-delete-folder-alist
7078 @vindex wl-delete-folder-alist
7079 The initial setting is the alist shown below:
7088 This list determines disposition of messages with delete marks.
7089 Each item in the list is a folder and destination; you can specify any
7090 one of the following in the place of destination:
7093 @code{remove} or @code{null} : deletes the messages instantly.
7094 string : moves the messages to the specific folder.
7095 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7098 @item wl-refile-policy-alist
7099 @vindex wl-refile-policy-alist
7100 The initial setting is the list shown below:
7110 This list determines whether messages with re-file marks are moved or
7111 copied. Each item in the list is a cons cell of a folder and
7112 @code{copy} or @code{move}.
7114 @item wl-x-face-file
7115 @vindex wl-x-face-file
7116 The initial setting is @file{~/.xface}.
7117 The name of the file that contains encoded X-Face strings.
7120 @item wl-demo-display-logo
7121 @vindex wl-demo-display-logo
7122 If non-nil, bitmap image is shown on the opening demo. If you set
7123 @code{xpm} or @code{xbm}, (if possible) display selected image type
7126 @item elmo-use-database
7127 @vindex elmo-use-database
7128 This is meaningful for XEmacs only. The initial setting depends on
7129 XEmacs (@code{t} for XEmacs with dbm).
7130 If non-nil, Message-ID is controlled by dbm.
7132 @item elmo-passwd-alist-file-name
7133 @vindex elmo-passwd-alist-file-name
7134 The initial setting is @file{passwd}.
7135 This is the name of the file in which passwords are saved.
7136 @code{elmo-passwd-alist-save} saves current passwords to the file.
7138 @item elmo-nntp-list-folders-use-cache
7139 @vindex elmo-nntp-list-folders-use-cache
7140 The initial setting is 600 (in seconds).
7141 This is period in seconds during which results of @samp{list} and
7142 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7145 @item elmo-nntp-max-number-precedes-list-active
7146 @vindex elmo-nntp-max-number-precedes-list-active
7147 The initial setting is @code{nil}.
7148 If non-nil, the number of article obtained by @samp{list active} in NNTP
7149 are used as the maximum article number of the folder.
7150 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7151 and if the number of read messages is not correct.
7153 @item elmo-nntp-default-use-listgroup
7154 @vindex elmo-nntp-default-use-listgroup
7155 The initial setting is @code{t}.
7156 If non-nil, @samp{listgroup} is used for checking the total number of
7157 articles. If it is @code{nil}, @samp{group} is used. In the latter
7158 case, the processing will be a little faster at the sacrifice of
7161 @item elmo-pop3-send-command-synchronously
7162 @vindex elmo-pop3-send-command-synchronously
7163 The initial setting is @code{nil}.
7164 If non-nil, POP3 commands are issued synchronously. Some implementation
7165 of POP3 server fails to get summary information without this setting.
7166 You may have to set this variable to @code{t}, if the process hangs
7167 while looking up POP3.
7169 @item elmo-dop-flush-confirm
7170 @vindex elmo-dop-flush-confirm
7171 The initial setting is @code{t}.
7172 If non-nil, you are asked for confirmation if accumulated off-line
7173 operations are executed.
7175 @item elmo-display-progress-threshold
7176 @vindex elmo-display-progress-threshold
7177 The initial setting is 20.
7178 Threshold for display of progress gauge. If number of renewal is more than
7179 this value, display progress gauge.
7183 @node Hooks, , Customizable Variables, Customization
7189 @node Mailing List, Addition, Customization, Top
7190 @chapter Wanderlust Mailing List
7194 Topics related to Wanderlust are discussed in following mailing lists.
7195 The latest version is also announced there.
7198 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7201 In this list Japanese is mainly used for discussion. We also have a list
7202 for discussion in English:
7205 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7207 (Messages posted to this list are also forwarded to the former one.)
7209 A guide can be obtained automatically by sending mail to
7210 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7211 the English one) with the body
7217 Please send bug reports or patches to one of those lists. You can post to
7218 the mailing list even though you are not a member of it.
7220 If you send a bug report, please attach Backtrace with it.
7221 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7224 I would like to express my thanks to the members of the mailing list for
7225 valuable advice and many pieces of code they contributed.
7228 @node Addition, Index, Mailing List, Top
7229 @chapter Additional Information
7231 @section Brief History
7234 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7235 3/10 Made a msgdb mechanism by elisp.
7236 3/26 IMAP and NNTP can be displayed in threads.
7237 4/13 Began to assemble thread display modules as elmo.
7238 5/01 Finished 0.1.0, initial version with many defects.
7239 6/12 I made a slip of the tongue and said I was writing elisp
7240 mailer supporting IMAP
7241 6/16 0.1.3 was announced at tm-ja, elisp ML.
7242 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7243 7/01 Support for mm-backend (0.3.0).
7244 8/25 multi folder added (0.5.0).
7245 8/28 filter folder added (0.5.1).
7246 9/10 You can open/close threads (0.6.0).
7247 9/11 fldmgr by Murata-san made editing folders easy.
7248 9/18 lha folders added by Okunishi-san (0.6.3).
7249 9/24 Display of branches of threads (0.6.5).
7250 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7251 10/28 Off-line operations (0.7.4).
7252 12/09 Becomes beta version.
7253 12/21 wl-expire by Murata-san.
7254 1999 2/03 auto-refile by Tsumura-san.
7255 4/28 wl-template by Murata-san.
7256 5/18 Released 1.0.0 stable.
7257 7/05 Scoring by Murata-san (2.1.0).
7258 9/26 New plugged system by Murata-san (2.2.2).
7259 12/20 Support Modified UTF7.
7260 2000 3/24 Released 1.1.0 stable.
7261 4/03 CVS development started.
7262 5/07 Thread restoration & Its speed up with Murata-san.
7263 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7264 7/11 killed message feature.
7265 7/18 Use UIDL in POP3.
7266 9/12 biff feature with Satata-san & Yamaoka-san.
7267 10/17 expire-hide by Okada-san.
7268 11/08 Released 2.4.0 stable.
7269 2001 7/04 Released 2.6.0 stable.
7270 8/21 wl-addrmgr by Kitamoto-san.
7271 12/27 Released 2.8.1 stable.
7274 See @file{ChangeLog} for details.
7278 According to a dictionary, Wanderlust has the meaning:
7282 n eager longing for or impulse towards travelling in distant lands
7283 [Ger, fr wandern to wander + lust desire, pleasure]
7287 but I had no profound intention. (if farfetched, IMAP @result{} you can
7288 read mail anywhere @result{} desire to wander ?)
7290 Elmo is the abbreviation of @samp{Elisp Library for Message
7291 Orchestration}. At first I meant the red puppet in the Sesame Street,
7292 but you may associate it with Wandering @result{} Drifting @result{}
7293 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7297 Each versions has code names (they are almost jokes).
7298 Currently they are picked up alphabetically from the top 40 hits of
7299 U.S. Billboard magazines in 1980s.
7301 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7304 @node Index, , Addition, Top
7308 * Concept Index:: Concept Index
7309 * Key Index:: Key Index
7310 * Variable Index:: Variable Index
7311 * Function Index:: Function Index
7314 @node Concept Index, Key Index, Index, Index
7315 @unnumberedsec Concept Index
7318 @node Key Index, Variable Index, Concept Index, Index
7319 @unnumberedsec Key Index
7322 @node Variable Index, Function Index, Key Index, Index
7323 @unnumberedsec Variable Index
7326 @node Function Index, , Variable Index, Index
7327 @unnumberedsec Function Index