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 regular expressions for access groups which creates children
2078 folder list hierarchically.
2080 For example, if you specify
2081 @code{wl-folder-hierarchy-access-folders} like following,
2085 (setq wl-folder-hierarchy-access-folders
2086 '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
2091 such access group hierarchy is obtained.
2097 -fj.comp.announce:0/0/2
2098 -fj.comp.dev.cdrom:0/0/0
2100 [+]-japan:238/238/1688
2103 -comp.unix.admin:0/0/0
2104 -comp.unix.dos-under-unix:0/0/0
2105 -comp.unix.programmer:0/0/0
2106 [-]-comp.unix.bsd:0/0/23
2107 -comp.unix.bsd.freebsd.announce:0/0/0
2112 If you opened @samp{-} in this example, only the direct children is created
2113 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2114 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2115 is not created until the children access group is opened.
2119 @node Folder Manager, , Selecting Folder, Folder
2120 @section Editing Folders
2121 @cindex Folder Manager
2122 @cindex Folder, Edit
2123 @cindex Folder, Subscribe
2124 @cindex Folder, Unsubscribe
2126 As described before, subscribed folder list is saved in @file{~/.folders} file.
2127 But you don't have to edit @file{~/.folders} directly.
2128 You can append, delete, edit folders from folder mode.
2130 @subsection Usage (Tips)
2132 @subsubsection Append Folder
2134 @kbd{m a} appends new folder to the folder mode.
2135 @kbd{m g} appends new folder group.
2136 To append new folder to this group, firstly open it,
2137 then execute append command in the next line.
2139 @subsubsection Edit Folder
2141 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2142 Thus, you can change folder position as if you were editing a normal file.
2144 @subsubsection Create Multi Folder.
2148 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2150 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2152 Type @kbd{m m}, then you can create multi folder.
2155 @subsubsection Delete Nickname, Filter
2157 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2158 minibuffer while appending.
2160 @subsubsection Append Folder to Empty Group
2162 To append new folder to the empty folder group
2163 (after you create folder group by typing @kbd{m g}),
2164 firstly open it, then execute append command in the next line.
2165 If it is closed, folder is appended on the same level with
2166 the above folder group. It is difficult to explain by words so try it.
2167 In other words, appended position depends on the
2168 above folder group's open/close status.
2170 @subsubsection Charset of the Folders File.
2172 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2174 @subsubsection Create Filter
2176 @kbd{m f} adds filter to the folder at the current cursor point. To
2177 create new filter folder and leave the current folder unchanged, copy it
2178 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2179 filter can be specified while appending filter. If you put
2180 ``''(@var{NULL}), filter is deleted.
2182 @subsubsection Sort Folders
2184 Sorting of the folders is executed by the function specified by
2185 @code{wl-fldmgr-sort-function}.
2186 The initial setting is @code{wl-fldmgr-sort-standard},
2187 which sorts alphabetically.
2188 Sorting affects only on the current folder group. It does not
2189 affect on the child groups.
2191 @subsubsection Hiding Folders in the Access Group
2193 Usually, access group displays all children folders, but you can set
2194 some folders hidden. Following operations are only available on access
2197 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2198 (subscribe/unsubscribe) of the folder at current cursor point. Against
2199 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2202 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2203 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2204 argument and if the argument has positive number, the unsubscribe it.
2205 If the prefix argument has negative value, folder becomes visible and if
2206 zero, folder visibility is toggled.
2208 The other commands, @code{wl-fldmgr-subscribe} and
2209 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2212 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2213 executed in the access group, they have a same effect with
2214 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2215 The difference is that cut commands deletes folders from the current
2218 @subsubsection Operations in the Access Group
2220 You can insert and delete folders in the access group like usual folder
2221 group. But insert and delete commands can be only available for the
2222 children folders of the access group and they only sets the subscribe
2223 status. In other words, insertion of the folder means subscribing,
2224 deletion means unsubscribing.
2225 @footnote{In the current implementation,
2226 it is faster to delete region than to unsubscribe region.}
2228 To update the access group when children folders are inserted or deleted
2229 by other way (other than Wanderlust),
2230 open the access group by typing @kbd{C-u @key{RET}}.
2231 @xref{Selecting Folder}.
2233 The order of children folders of access group is saved after
2234 insertion/deletion/sorting.
2235 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2236 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2237 newly created folders are inserted on the top of the access group.
2239 @subsection Key bindings
2240 @cindex Keybind, Folder Mode
2241 @cindex Keybind, Folder Buffer
2243 Key bindings on the folder mode related to folder editing are shown below.
2244 All bindings starts with @kbd{m}, and primary commands are binded to
2245 one stroke key binding.
2249 @kindex m a (Folder)
2250 @findex wl-fldmgr-add
2252 (@code{wl-fldmgr-add})
2257 @kindex m g (Folder)
2258 @findex wl-fldmgr-make-group
2259 Create a folder group.
2260 (@code{wl-fldmgr-make-group})
2263 @kindex m A (Folder)
2264 @findex wl-fldmgr-make-access-group
2265 Create an access group.
2266 (@code{wl-fldmgr-make-access-group})
2269 @kindex m d (Folder)
2270 @findex wl-fldmgr-delete
2271 Delete folder itself and msgdb.
2272 If the folder itself cannot be deleted like NNTP folder,
2273 only msgdb is deleted.
2274 (@code{wl-fldmgr-delete})
2279 @kindex m R (Folder)
2280 @findex wl-fldmgr-rename
2281 Change the name of folder or folder group.
2282 msgdb's path is also changed.
2283 (@code{wl-fldmgr-rename})
2289 @findex wl-fldmgr-make-multi
2290 Create a multi folders in the cutlist (cut, copied folders).
2291 (@code{wl-fldmgr-make-multi})
2296 @kindex m f (Folder)
2297 @findex wl-fldmgr-make-filter
2298 Create a filter folder. (Put a filter on the folder).
2299 (@code{wl-fldmgr-make-filter})
2303 @kindex M-c (Folder)
2304 @kindex m c (Folder)
2305 @findex wl-fldmgr-copy
2306 Copy folder (it is not available on folder group).
2307 (@code{wl-fldmgr-copy})
2311 @kindex M-w (Folder)
2312 @kindex m W (Folder)
2313 @findex wl-fldmgr-copy-region
2314 Copy folders in the specified region.
2315 (@code{wl-fldmgr-copy-region})
2319 @kindex C-k (Folder)
2320 @kindex m k (Folder)
2321 @findex wl-fldmgr-cut
2322 Cut folder. Folder itself is not deleted.
2323 (@code{wl-fldmgr-cut})
2327 @kindex C-w (Folder)
2328 @kindex m C-w (Folder)
2329 @findex wl-fldmgr-cut-region
2330 Cut folders in the specified region.
2331 (@code{wl-fldmgr-cut-region})
2335 @kindex C-y (Folder)
2336 @kindex m y (Folder)
2337 @findex wl-fldmgr-yank
2338 Paste folders that are copied or cut (folders in the cut-list).
2339 (@code{wl-fldmgr-yank})
2342 @kindex m p (Folder)
2343 @findex wl-fldmgr-set-petname
2344 Put nickname on the folder.
2345 (@code{wl-fldmgr-set-petname})
2348 @kindex m q (Folder)
2349 @findex wl-fldmgr-clear-cut-entity-list
2350 Clear the cut-list. (cut, copied folder information is cleared,
2351 you cannot paste after this)
2352 (@code{wl-fldmgr-clear-cut-entity-list})
2355 @kindex m s (Folder)
2356 @findex wl-fldmgr-sort
2357 Sort folders in the current folder group.
2358 (@code{wl-fldmgr-sort})
2361 @kindex m C-s (Folder)
2362 @findex wl-fldmgr-save
2363 Save current folder view to the @file{wl-folders-file}.
2364 (@code{wl-fldmgr-save})
2367 [Following commands are only available on the access groups]
2373 @kindex m u (Folder)
2374 @findex wl-fldmgr-unsubscribe
2375 Set the visibility of folder (subscribe/unsubscribe).
2376 (@code{wl-fldmgr-unsubscribe})
2381 @kindex r u (Folder)
2382 @findex wl-fldmgr-unsubscribe-region
2383 Set the visibility of the folders (subscribe/unsubscribe) in the
2385 (@code{wl-fldmgr-unsubscribe-region})
2390 @kindex m l (Folder)
2391 @findex wl-fldmgr-access-display-normal
2392 List folders that are currently available.
2393 (@code{wl-fldmgr-access-display-normal})
2398 @kindex m L (Folder)
2399 @findex wl-fldmgr-access-display-all
2400 List all folders regardless of the subscription status.
2401 (@code{wl-fldmgr-access-display-all})
2405 @subsection Customize variables
2408 @item wl-interactive-save-folders
2409 @vindex wl-interactive-save-folders
2410 The initial setting is @code{t}. If non-nil and folder view is
2411 modified, confirm saving it before Wanderlust or Emacs exits. If
2412 @code{nil}, save without confirmation.
2414 @item wl-fldmgr-make-backup
2415 @vindex wl-fldmgr-make-backup
2416 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2417 created before saving the folder status.
2419 @item wl-fldmgr-sort-function
2420 @vindex wl-fldmgr-sort-function
2421 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2422 sort folders. By default function, folders are sorted alphabetically
2423 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2426 @item wl-fldmgr-sort-group-first
2427 @vindex wl-fldmgr-sort-group-first
2428 The initial setting is @code{t}. If non-nil,
2429 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2430 does not care whether it is folder group or not.
2432 @item wl-folder-check-async
2433 @vindex wl-folder-check-async
2434 The initial setting is @code{t}. If non-nil, check folder's unread
2435 status asynchronously. It boosts newsgroup checking.
2437 @item wl-folder-check-fast
2438 @vindex wl-folder-check-fast
2439 The initial setting is @code{nil}.
2440 If non-nil, it does not update folder status while checking.
2442 @item wl-folder-notify-deleted
2443 @vindex wl-folder-notify-deleted
2444 The initial setting is @code{nil}.
2446 If non-nil, negative value is displayed when the message is deleted. If
2447 @code{sync}, folder is synchronized when the message is deleted. If
2448 @code{nil}, message deletion is ignored.
2450 @item wl-fldmgr-add-complete-with-current-folder-list
2451 @vindex wl-fldmgr-add-complete-with-current-folder-list
2452 The initial setting is @code{nil}.
2453 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2454 candidate for @code{wl-fldmgr-add}.
2457 @subsection Miscellanea
2459 Following is a note for folder editing.
2463 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2464 paste(yank) command pastes the folders on one cut or copy command
2465 (If copy command is executed by region, folders in the region are pasted
2466 by one paste command)
2469 You cannot cut @samp{Desktop} group.
2470 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2473 You cannot copy folder group.
2476 Operations on the access group are only available for the folders
2477 in the same access group.
2480 You cannot create a folder which has same name with the folders already exist.
2483 You cannot insert folders which have same name in one group.
2484 You can insert them in the different groups.
2485 You cannot put same nickname to the different folders.
2489 @node Summary, Message, Folder, Top
2490 @chapter Summary Mode
2492 After you select the folder via folder mode, you enter to the summary
2496 * Usage of Summary Mode:: TIPS
2497 * Thread Operations:: Thread operations
2498 * Cache:: File cache, Buffer cache, and Prefetch
2499 * Auto Refile:: Auto refile settings
2500 * Sticky Summary:: Summary make sticky
2501 * Key Bindings of Summary:: Key bindings
2502 * Variables of Summary:: Customize Summary Mode
2506 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2507 @section Usage (Tips)
2509 @subsection Summary Content
2511 In the summary mode, messages are displayed like following.
2515 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2516 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2517 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2518 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2525 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2529 You cannot change this in the current version.
2531 @var{Message number} is the message's unique number in the folder. In
2532 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2533 in the MH folder, it is the filename of the message.
2535 @var{Temporal mark} and @var{Persistent mark} are described later.
2537 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2538 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2539 Japanese, but if you want to display it in English, set the value of
2540 @code{wl-summary-weekday-name-lang} as @samp{en}.
2542 @var{Sender}'s indentation corresponds to the depth of the thread.
2543 Sender name is displayed as nickname if it is defined in the address
2544 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2545 displaying with nickname.
2547 If number is printed at the head of @var{Sender} part like @samp{+2},
2548 that means the message have 2 follow messages.
2550 @var{Subject} is the @samp{Subject:} header field of the message. If
2551 the message have same @samp{Subject:} with the parent message, it is not
2552 displayed. Some mailing list puts its sequence number in the
2553 @samp{Subject:} field, but it is
2554 ignored. @code{wl-summary-no-subject-message} is displayed when the
2555 message has empty subject field.
2557 @subsection Temporary Marks
2558 @cindex Mark, Temporary
2560 There are four temporary marks,
2561 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2562 Temporary marks indicates message operations.
2567 You can execute a command on the all messages that have @samp{*} mark,
2568 with the key bindings which begins with @kbd{m}.
2571 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2575 After you type @kbd{o} key, prompt appears to input refile destination.
2576 Your answer is printed in the summary line.
2580 You can put this mark by typing @kbd{O} key.
2581 The difference between this mark and refile mark is,
2582 this mark does not delete the message while latter does.
2585 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2587 @subsection Persistent Marks
2589 There are five persistent marks,
2590 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2592 The persistent mark indicates the message's status and it is saved.
2593 Each persistent mark indicates:
2599 It is unread message.
2601 It is unread but cached message.
2603 It is read but it is not cached.
2605 It is important message. You can put @samp{$} mark by typing @kbd{$}
2606 key (if already exists, the mark is deleted). It is convenient to put
2607 this mark on the messages to remember (If you want to remember to write
2608 a reply for the message, for example) because this mark remains after
2609 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2610 @samp{'mark} folder even the message itself is deleted in the actual folder.
2613 If the message is read and cached (or local message),there are no
2617 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2618 cache. Messages with the marks other than these, you can read them in
2619 the offline status even they are in the IMAP folder or netnews folder.
2621 Among messages with persistent marks, ones with marks specified by
2622 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2623 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2625 @subsection How To Read
2627 Basically, you can read messages only typing space key again and again.
2629 To update summary status to the newest status (synchronize),
2632 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2633 moves cursor to the next message.
2634 Enter message buffer by typing @kbd{j} key.
2635 To operate multipart, you have to enter to the message buffer.
2638 @subsection Pack the Message Numbers
2639 You can pack the message numbers in Summary by
2640 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2641 News Spool Folder and Maildir Folder are supported folder types.
2644 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2645 @section Thread Operations
2647 For example, the following line indicates one thread (a context of a topic).
2650 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2654 If you type @kbd{/} on this line, the thread is opened and it changes
2655 the appearance like following.
2659 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2660 388 09/17(Thu)22:34 +-[ Murata san ]
2664 (Message 388 is the replied message to the message 384.)
2665 If you type @kbd{/} key once again, the thread is closed.
2666 With prefix argument, @kbd{/} opens all children threads.
2668 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2671 Commands with the key binding that begins with @kbd{t} executes commands
2672 on the messages in the thread.
2673 @xref{Key Bindings of Summary}.
2675 @subsection reconstruct thread by hand
2677 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2678 (@code{wl-summary-save-current-message}) at the corresponding message,
2679 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2680 message then you have the reconstructed thread.
2683 @node Cache, Auto Refile, Thread Operations, Summary
2686 @subsection Cache File
2688 The messages which have to access via network (e.x. IMAP, NNTP folder)
2689 are cached as a local file. The cache file is saved under the directory
2690 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2691 elmo-cache-expire-by-size}. The command deletes cache files to the
2692 specified size by the order of last accessed time.
2694 @subsection Buffer Cache and Prefetching
2696 The messages that are read are kept in the cache buffer. It is called
2697 `buffer cache'. The number of cache buffer is specified by
2698 @code{wl-message-buffer-cache-size}.
2700 There are message prefetching mechanism in the Wanderlust that
2701 prefetches next message while you are reading.
2703 You can control the message prefetching mechanism by these two
2707 @item wl-message-buffer-prefetch-folder-type-list
2708 @vindex wl-message-buffer-prefetch-folder-type-list
2709 The initial setting is @code{t}. In this case, prefetch messages in all
2711 If it is a list of folder types, it specifies the folder types in which
2712 message prefetching is enabled.
2713 Following is an example (prefetch messages in nntp and imap4 folders)
2717 (setq wl-message-buffer-prefetch-folder-type-list
2722 In this case, multi folder that contains localdir and imap4 prefetches
2723 only imap4 messages. This variable precedes the value of
2724 @code{wl-message-buffer-prefetch-folder-list}.
2726 @item wl-message-buffer-prefetch-folder-list
2727 @vindex wl-message-buffer-prefetch-folder-list
2728 The initial setting is @code{nil}.
2729 A list of regexp of folders to enable message prefetching.
2731 @item wl-message-buffer-prefetch-depth
2732 @vindex wl-message-buffer-prefetch-depth
2733 The initial setting is 3. The number of messages for automatical prefetch.
2735 @item wl-message-buffer-prefetch-idle-time
2736 @vindex wl-message-buffer-prefetch-idle-time
2737 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2739 @item wl-message-buffer-prefetch-threshold
2740 @vindex wl-message-buffer-prefetch-threshold
2741 The initial setting is 30000 (bytes). If prefetching message has larger
2742 size than this value, Wanderlust does not prefetch automatically.
2743 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2744 the message is not checked for the size.
2746 @item wl-auto-prefetch-first
2747 @vindex wl-auto-prefetch-first
2748 The initial setting is @code{nil}.
2749 If non-nil, first message is automatically prefetched to the buffer
2750 when you enter the folder.
2754 @node Auto Refile, Sticky Summary, Cache, Summary
2755 @section Auto Refile
2756 @vindex elmo-msgdb-extra-fields
2757 @vindex wl-refile-rule-alist
2758 @findex wl-summary-auto-refile
2760 You can refile messages automatically, by typing @kbd{C-o}
2761 (@code{wl-summary-auto-refile}). It decides destination of refile by
2762 the content of the message header information (information in the msgdb).
2764 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2765 available. If you want to decide destination by other header fields,
2766 set the variable @code{elmo-msgdb-extra-fields} like following.
2770 (setq elmo-msgdb-extra-fields
2780 By this setting, Wanderlust saves extra fields in the msgdb. You have
2781 to type @kbd{s all} to get extra fields for the messages that are
2782 already exists in the summary.
2784 Then, specify the refile rule. The refile target folder of auto
2785 refiling is decided by the value of @code{wl-refile-rule-alist}.
2786 @code{wl-refile-rule-alist} is a list of a rule:
2790 (@var{field} (@var{regexp} . @var{target})
2791 (@var{regexp} . @var{target})
2796 Each rule means `if @var{field} value matches @var{regexp},
2797 then refile to @var{target} folder'.
2798 The rule matched first is applied.
2800 @var{field} is a string of field name. You can specify a list of field name
2801 string, too. In this case, if one of these fields is matched, then the
2802 rule is fired (i.e. OR condition).
2804 @var{regexp} is a regular expression for field value. @var{target} is a target
2805 folder string. You can specify a rule at @var{target} part, too. In this
2806 case, If the field value of the rule and the current rule is matched,
2807 then the current rule is fired (i.e. AND condition).
2809 In @var{target} part, you can refer matched substring of @var{regexp}.
2810 To refer substring, specify following in @var{target}:
2814 means substitute original matched text.
2817 means substitute what matched the @var{N}th `\(@dots{}\)'.
2818 (@var{N} is a number.)
2821 Following is an example of @code{wl-refile-rule-alist}.
2825 (setq wl-refile-rule-alist
2827 ("^Wanderlust" . "+wl")
2828 ("^Elisp" . "+elisp"))
2830 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2832 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2833 "+from-me-to-you"))))))
2837 After these settings, refile marks are automatically put on the condition
2838 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2840 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2842 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2843 with these persistent marks are not automatically refiled.
2844 It means Wanderlust does not execute auto refile on unread messages by
2845 the default setting.
2846 To execute auto refile on all messages, set following.
2849 (setq wl-summary-auto-refile-skip-marks nil)
2853 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2854 @section Sticky Summary
2855 @cindex Summary, Sticky
2856 @cindex Sticky Summary
2858 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2860 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2861 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2863 The buffer name of the sticky summary becomes like
2864 @samp{Summary:@var{folder-name}}.
2866 You can visit the sticky summary at any time by @kbd{C-x b}
2867 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2868 q}. Other operations in the sticky summary are same as normal summary.
2870 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2871 are automatically stuck.
2874 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2875 @section Key bindings
2876 @cindex Keybind, Summary Mode
2877 @cindex Keybind, Summary Buffer
2879 Key bindings of the summary mode are shown below.
2883 @kindex @key{SPC} (Summary)
2884 @findex wl-summary-read
2885 Proceed reading a message at the current cursor point.
2886 (@code{wl-summary-read})
2890 @findex wl-summary-redisplay
2891 Redisplay a message at the current cursor point.
2892 If this command is called with prefix argument,
2893 Redisplay message regardless of the message cache (message is re-loaded
2895 (@code{wl-summary-redisplay})
2899 @findex wl-summary-display-top
2900 Display the top message in the folder.
2901 (@code{wl-summary-display-top})
2905 @findex wl-summary-display-bottom
2906 Display the bottom message in the folder.
2907 (@code{wl-summary-display-bottom})
2911 @kindex @key{BS} (Summary)
2912 @kindex @key{DEL} (Summary)
2913 Display the previous page of the message at the current cursor point.
2914 @findex wl-summary-prev-page
2915 (@code{wl-summary-prev-page})
2918 @kindex @key{RET} (Summary)
2919 @findex wl-summary-next-line-content
2920 Display the next line of the message at the current cursor point.
2921 Display the message at the current cursor point if it is not displayed yet.
2922 (@code{wl-summary-next-line-content})
2927 @kindex M-@key{RET} (Summary)
2928 @findex wl-summary-prev-line-content
2929 Display the previous line of the message at the current cursor point.
2930 Display the message at the current cursor point if it is not displayed yet.
2931 (@code{wl-summary-prev-line-content})
2935 @findex wl-thread-open-close
2936 Toggle open or close the thread at the current cursor point.
2937 (@code{wl-thread-open-close})
2942 @findex wl-thread-open-all
2943 (@code{wl-thread-open-all})
2948 @findex wl-thread-close-all
2949 (@code{wl-thread-close-all})
2953 @findex wl-summary-goto-folder
2955 (@code{wl-summary-goto-folder})
2959 Mark all messages in the folder as read.
2960 @findex wl-summary-mark-as-read-all
2961 (@code{wl-summary-mark-as-read-all})
2965 @findex wl-summary-reply
2966 Prepare a draft for reply the message at the current cursor point.
2967 (@code{wl-summary-reply})
2971 @findex wl-summary-reply-with-citation
2972 Prepare a draft for reply the message at the current cursor point.
2973 (@code{wl-summary-reply-with-citation})
2977 @findex wl-summary-cancel-message
2978 If the message at current cursor point is your own netnews article,
2980 (@code{wl-summary-cancel-message})
2984 @findex wl-summary-reedit
2985 Prepare a draft for re-editing the message at current cursor point.
2986 If the message at current cursor point is your own netnews article,
2987 a draft for `supersedes message' for the message is prepared.
2988 (@code{wl-summary-reedit})
2991 @kindex M-e (Summary)
2992 @findex wl-summary-resend-bounced-mail
2993 If the message at current cursor point is a bounced message,
2994 a draft for re-sending original message is prepared.
2995 (@code{wl-summary-resend-bounced-mail})
2999 @findex wl-summary-forward
3000 A draft for forwarding the message at current cursor point is prepared.
3001 (@code{wl-summary-forward})
3005 @findex wl-summary-mark-as-important
3006 Put @samp{$} mark on the message at current cursor point.
3007 If already marked as @samp{$}, delete it.
3008 (@code{wl-summary-mark-as-important})
3014 Save the message at current cursor point.
3015 @findex wl-summary-save
3016 (@code{wl-summary-save})
3020 @findex wl-summary-next
3021 Move cursor to the next message.
3022 If message is marked with a temporal mark in
3023 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3024 In the offline mode, cursor is not moved to the messages which are not cached
3026 (@code{wl-summary-next})
3030 @findex wl-summary-prev
3031 Move cursor to the previous message.
3032 If message is marked with a temporal mark in
3033 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3034 In the offline mode, cursor is not moved to the messages which are not cached
3036 (@code{wl-summary-prev})
3040 @findex wl-summary-down
3041 Move cursor to the downward message which is unread or marked
3043 In the offline mode, cursor is not moved to the messages which are not cached
3045 If there are messages which have target mark @samp{*} in the summary,
3046 cursor is moved to the downward message which have a target mark.
3047 This behavior is changed according to the value of @code{wl-summary-move-order}.
3048 (@code{wl-summary-down})
3052 @findex wl-summary-up
3053 Move cursor to the upward message which is unread or marked
3055 In the offline mode, cursor is not moved to the messages which are not cached
3057 If there are messages which have target mark @samp{*} in the summary,
3058 cursor is moved to the downward message which have a target mark.
3059 This behavior is changed according to the value of @code{wl-summary-move-order}.
3060 (@code{wl-summary-up})
3064 @findex wl-summary-write
3065 Prepare a new draft.
3066 (@code{wl-summary-write})
3070 @findex wl-summary-write-current-folder
3071 Prepare a new draft. If the current folder is NNTP folder,
3072 @samp{Newsgroups:} field is completed. If the current folder is mailing
3073 list folder (refile destination), guess @samp{To:} field and completed
3074 (If @code{wl-subscribed-mailing-list} is valid list)
3075 (@code{wl-summary-write-current-folder})
3079 @findex wl-summary-redisplay-all-header
3080 Redisplay the message at current cursor point with all header fields.
3081 (@code{wl-summary-redisplay-all-header})
3085 @findex wl-summary-redisplay-no-mime
3086 Redisplay the message at current cursor point without MIME analysis.
3087 (@code{wl-summary-redisplay-no-mime})
3091 @findex wl-summary-burst
3092 If the message at current cursor point has
3093 encapsulates multiple messages using MIME,
3094 de-capsulate and extract them on the current folder.
3095 (@code{wl-summary-burst})
3098 @kindex @@ (Summary)
3099 @findex wl-summary-edit-addresses
3100 Append/change/delete the message's sender information to the address
3101 book @file{~/.addresses} interactively. If this command is called with
3102 prefix argument, arbitrary address can be edited.
3103 (@code{wl-summary-edit-petname})
3107 @findex wl-status-update
3108 Sync up address book status with @file{~/.addresses}'s content.
3109 (@code{wl-status-update})
3113 @findex wl-summary-pipe-message
3114 Pipe current message's content to the external process.
3115 (@code{wl-summary-pipe-message})
3119 @findex wl-summary-print-message
3120 Print out current message's content.
3121 It uses @code{ps-print} module in Emacs 20.x.
3122 If you don't use color printer, you might want to set
3123 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3126 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3129 (@code{wl-summary-print-message})
3133 @findex wl-summary-exit
3134 Exit current folder.
3135 (@code{wl-summary-exit})
3139 @findex wl-summary-jump-to-current-message
3140 Jump cursor to the currently displayed message's window.
3141 (@code{wl-summary-jump-to-current-message})
3145 Jump cursor to the other message.
3146 @findex wl-summary-jump-to-msg
3147 (@code{wl-summary-jump-to-msg})
3151 Update summary status and
3152 prefetch all messages which have marks included in the
3153 @code{wl-summary-incorporate-marks}.
3154 @findex wl-summary-incorporate
3155 (@code{wl-summary-incorporate})
3158 @kindex M-j (Summary)
3159 @findex wl-summary-jump-to-msg-by-message-id
3160 Jump cursor to the message which have specified @samp{Message-Id:}. If
3161 @code{elmo-use-database} is non-nil, other folder is also searched.
3162 (@code{wl-summary-jump-to-msg-by-message-id})
3166 Jump to parent message.
3167 @findex wl-summary-jump-to-parent-message
3168 (@code{wl-summary-jump-to-parent-message})
3172 @findex wl-summary-mark-as-unread
3173 Mark as unread the message at current cursor point.
3174 (@code{wl-summary-mark-as-unread})
3178 @findex wl-summary-sync
3179 Synchronize summary view after prompting the update range
3180 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3184 all ...Discard current summary and update all message.
3185 all-visible ...Discard current summary and update all visible message.
3186 update ...Update the difference between summary and the folder itself.
3187 rescan ...Rescan the msgdb and display again.
3188 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3189 cache-status ...Sync the all marks with the real status of cache.
3190 first, last ...Move to the filter folder(partial filter).
3195 (@code{wl-summary-sync})
3199 @findex wl-summary-sort
3201 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3202 (@code{wl-summary-sort})
3206 @findex wl-summary-toggle-thread
3207 Toggle the threading.
3208 Threading status is displayed on the modeline.
3209 @samp{@{S@}} means threading is off (Sequence) and
3210 @samp{@{T@}} means threading is on (Thread).
3211 (@code{wl-summary-toggle-thread})
3215 @findex wl-summary-toggle-disp-folder
3216 Toggle displaying of folder window.
3217 (@code{wl-summary-toggle-disp-folder})
3221 Toggle displaying of message window.
3222 @findex wl-summary-toggle-disp-msg
3223 (@code{wl-summary-toggle-disp-msg})
3227 Move to the virtual folder with the condition specified.
3228 If called with prefix argument and current folder is virtual, exit it.
3229 @findex wl-summary-virtual
3230 (@code{wl-summary-virtual})
3233 @kindex @key{TAB} (Summary)
3234 @findex wl-summary-goto-last-displayed-msg
3235 Jump to the message which is displayed last.
3236 (@code{wl-summary-goto-last-displayed-msg})
3240 Put @samp{*} mark on the messages that satisfies the specified condition.
3241 @findex wl-summary-pick
3242 (@code{wl-summary-pick})
3246 @findex wl-summary-mark-as-read
3247 Mark as read the message at the current cursor point.
3248 (@code{wl-summary-mark-as-read})
3252 Prefetch the message at the current cursor point.
3253 With prefix argument, prefetch the message even if it is cached.
3254 @findex wl-summary-prefetch
3255 (@code{wl-summary-prefetch})
3259 Execute @samp{D}, @samp{o} and @samp{O} marks.
3260 @findex wl-summary-exec
3261 (@code{wl-summary-exec})
3265 @findex wl-summary-target-mark-line
3266 Put target mark on the message at the current cursor point.
3267 (@code{wl-summary-target-mark-line})
3271 Put refile mark on the message at the current cursor point.
3272 @findex wl-summary-refile
3273 (@code{wl-summary-refile})
3276 @kindex C-o (Summary)
3277 Execute auto refile.
3278 @findex wl-summary-auto-refile
3279 (@code{wl-summary-auto-refile})
3283 Put copy mark on the message at the current cursor point.
3284 @findex wl-summary-copy
3285 (@code{wl-summary-copy})
3288 @kindex M-o (Summary)
3289 Put refile mark on the message at the current cursor point with the destination
3290 previously specified.
3291 @findex wl-summary-refile-prev-destination
3292 (@code{wl-summary-refile-prev-destination})
3296 @findex wl-summary-delete
3297 Put delete mark on the message at the current cursor point.
3298 (@code{wl-summary-delete})
3302 @findex wl-summary-unmark
3303 Unmark the temporal mark on the message at the current cursor point.
3304 (@code{wl-summary-unmark})
3308 Unmark all the temporal marks.
3309 @findex wl-summary-unmark-all
3310 (@code{wl-summary-unmark-all})
3313 @kindex r R (Summary)
3314 @findex wl-summary-mark-as-read-region
3315 Mark as read messages in the specified region.
3316 (@code{wl-summary-mark-as-read-region})
3319 @kindex r $ (Summary)
3320 @findex wl-summary-mark-as-important-region
3321 Mark as important @samp{$} messages in the specified region.
3322 If @samp{$} already exists, it is deleted.
3323 (@code{wl-summary-mark-as-important-region})
3326 @kindex r ! (Summary)
3327 @findex wl-summary-mark-as-unread-region
3328 Mark as unread messages in the specified region.
3329 (@code{wl-summary-mark-as-unread-region})
3332 @kindex r i (Summary)
3333 @findex wl-summary-prefetch-region
3334 Prefetch messages in the specified region.
3335 (@code{wl-summary-prefetch-region})
3338 @kindex r x (Summary)
3339 @findex wl-summary-exec-region
3340 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3342 (@code{wl-summary-exec-region})
3345 @kindex r * (Summary)
3346 @findex wl-summary-target-mark-region
3347 Put target mark on the messages in the specified region.
3348 (@code{wl-summary-target-mark-region})
3351 @kindex r o (Summary)
3352 @findex wl-summary-refile-region
3353 Put refile mark on the messages in the specified region.
3354 (@code{wl-summary-refile-region})
3357 @kindex r O (Summary)
3358 @findex wl-summary-copy-region
3359 Put copy mark on the messages in the specified region.
3360 (@code{wl-summary-copy-region})
3363 @kindex r d (Summary)
3364 @findex wl-summary-delete-region
3365 Put delete mark on the messages in the specified region.
3366 (@code{wl-summary-delete-region})
3369 @kindex r u (Summary)
3370 @findex wl-summary-unmark-region
3371 Delete temporal mark on the messages in the specified region.
3372 (@code{wl-summary-unmark-region})
3375 @kindex r y (Summary)
3376 Save messages in the specified region.
3377 @findex wl-summary-save-region
3378 (@code{wl-summary-save-region})
3381 @kindex t R (Summary)
3382 @findex wl-thread-mark-as-read
3383 Mark as read messages which are the descendant of the current thread.
3384 With prefix argument, it affects on the all messages in the thread tree.
3385 (@code{wl-thread-mark-as-read})
3388 @kindex t $ (Summary)
3389 @findex wl-thread-mark-as-important
3390 Put important mark @samp{$} on the messages which are the
3391 descendant of the current thread.
3392 If @samp{$} mark exists, it is deleted.
3393 With prefix argument, it affects on the all messages in the thread tree.
3394 (@code{wl-thread-mark-as-important})
3397 @kindex t ! (Summary)
3398 @findex wl-thread-mark-as-unread
3399 Mark as unread 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-mark-as-unread})
3404 @kindex t i (Summary)
3405 @findex wl-thread-prefetch
3406 Prefetch messages which are the descendant of the current thread.
3407 With prefix argument, it affects on the all messages in the thread tree.
3408 (@code{wl-thread-prefetch})
3411 @kindex t x (Summary)
3412 @findex wl-thread-exec
3413 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3414 the descendant of the current thread. With prefix argument, it affects
3415 on the all messages in the thread tree.
3416 (@code{wl-thread-exec})
3419 @kindex t * (Summary)
3420 @findex wl-thread-target-mark
3421 Put target mark @samp{*} on the messages which are the descendant of the
3422 current thread. With prefix argument, it affects on the all messages in
3424 (@code{wl-thread-target-mark})
3427 @kindex t o (Summary)
3428 @findex wl-thread-refile
3429 Put refile 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-refile})
3434 @kindex t O (Summary)
3435 @findex wl-thread-copy
3436 Put copy mark 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-copy})
3441 @kindex t d (Summary)
3442 @findex wl-thread-delete
3443 Put delete mar on the messages which are the descendant of the current thread.
3444 With prefix argument, it affects on the all messages in the thread tree.
3445 (@code{wl-thread-delete})
3448 @kindex t u (Summary)
3449 @findex wl-thread-unmark
3450 Unmark temporal mark on the messages which are the descendant of the
3451 current thread. With prefix argument, it affects on the all messages in
3453 (@code{wl-thread-unmark})
3456 @kindex t y (Summary)
3457 @findex wl-thread-save
3458 Save messages which are the descendant of the current thread.
3459 With prefix argument, it affects on the all messages in the thread tree.
3460 (@code{wl-thread-save})
3463 @kindex m i (Summary)
3464 @findex wl-summary-target-mark-prefetch
3465 Prefetch all messages which have target mark @samp{*}.
3466 With prefix argument, prefetch all targets even if some of them are cached.
3467 (@code{wl-summary-target-mark-prefetch})
3470 @kindex m R (Summary)
3471 @findex wl-summary-target-mark-mark-as-read
3472 Mark as read all messages which have target mark @samp{*}.
3473 (@code{wl-summary-target-mark-mark-as-read})
3476 @kindex m $ (Summary)
3477 @findex wl-summary-target-mark-mark-as-important
3478 Mark as important all messages which have target mark @samp{*}.
3479 If already marked as @samp{$}, it is deleted.
3480 (@code{wl-summary-target-mark-mark-as-important})
3483 @kindex m ! (Summary)
3484 @findex wl-summary-target-mark-mark-as-unread
3485 Mark as unread all messages which have target mark @samp{*}.
3486 (@code{wl-summary-target-mark-mark-as-unread})
3489 @kindex m o (Summary)
3490 @findex wl-summary-target-mark-refile
3491 Put refile mark on the messages which have target mark @samp{*}.
3492 (@code{wl-summary-target-mark-refile})
3495 @kindex m O (Summary)
3496 @findex wl-summary-target-mark-copy
3497 Put copy mark on the messages which have target mark @samp{*}.
3498 (@code{wl-summary-target-mark-copy})
3501 @kindex m d (Summary)
3502 @findex wl-summary-target-mark-delete
3503 Put delete mark on the messages which have target mark @samp{*}.
3504 (@code{wl-summary-target-mark-delete})
3507 @kindex m y (Summary)
3508 @findex wl-summary-target-mark-save
3509 Save messages which have target mark @samp{*}.
3510 (@code{wl-summary-target-mark-save})
3513 @kindex m u (Summary)
3514 Unmark all temporal marks.
3515 (@code{wl-summary-delete-all-temp-marks})
3516 @findex wl-summary-delete-all-temp-marks
3519 @kindex m a (Summary)
3520 Put target mark @samp{*} on the all messages.
3521 (@code{wl-summary-target-mark-all})
3522 @findex wl-summary-target-mark-all
3525 @kindex m t (Summary)
3526 Put target mark @samp{*} on the messages in the current thread.
3527 @findex wl-summary-target-mark-thread
3528 (@code{wl-summary-target-mark-thread})
3531 @kindex m r (Summary)
3532 @findex wl-summary-target-mark-region
3533 Put target mark @samp{*} on the messages in the specified region.
3534 (@code{wl-summary-target-mark-region})
3537 @kindex m A (Summary)
3538 @findex wl-summary-target-mark-reply-with-citation
3539 Prepare a draft which cites all messages which have target mark @samp{*}.
3540 (@code{wl-summary-target-mark-reply-with-citation})
3543 @kindex m f (Summary)
3544 @findex wl-summary-target-mark-forward
3545 Prepare a draft which forwards all messages which have target mark @samp{*}.
3546 (@code{wl-summary-target-mark-forward})
3549 @kindex m U (Summary)
3550 @findex wl-summary-target-mark-uudecode
3551 Uudecode the messages which have target mark @samp{*}.
3552 (@code{wl-summary-target-mark-uudecode})
3555 @kindex m ? (Summary)
3556 @findex wl-summary-target-mark-pick
3557 Pick messages from the @samp{*} marked messages.
3558 That is, @samp{*} marks on the messages are remained
3559 if the specified condition is satisfied.
3560 (@code{wl-summary-target-mark-pick})
3563 @kindex M-t (Summary)
3564 @findex wl-toggle-plugged
3565 Toggle offline/online status of Wanderlust.
3566 (@code{wl-toggle-plugged})
3569 @kindex C-t (Summary)
3570 Start Wanderlust's plug-status manager.
3571 (@code{wl-plugged-change})
3574 @kindex C-c C-o (Summary)
3575 @findex wl-jump-to-draft-buffer
3576 Move to the draft buffer if available. If multiple draft buffer exists,
3577 moved to one after another. If prefix argument is specified, load draft
3578 folder's message to the draft buffer and jump to it.
3579 (@code{wl-jump-to-draft-buffer})
3582 @kindex M-w (Summary)
3583 @findex wl-summary-save-current-message
3584 Save the message at the current cursor point.
3585 (@code{wl-summary-save-current-message})
3588 @kindex C-y (Summary)
3589 @findex wl-summary-yank-saved-message
3590 Regard the message at the current cursor point as
3591 parent, connect the message saved by
3592 @code{wl-summary-save-current-message}
3594 (@code{wl-summary-yank-saved-message})
3598 @node Variables of Summary, , Key Bindings of Summary, Summary
3599 @section Customiziable variables
3602 @item wl-summary-move-order
3603 @vindex wl-summary-move-order
3604 The initial setting is @code{unread}. Specify cursor moving policy. If
3605 you want to precede new messages, set @code{new}. If you want to
3606 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3609 @item wl-auto-select-first
3610 @vindex wl-auto-select-first
3611 The initial setting is @code{nil}.
3612 If non-nil, first message is automatically displayed when you enter
3615 @item wl-auto-select-next
3616 @vindex wl-auto-select-next
3617 The initial setting is @code{nil}. This controls behavior when there is
3618 no unread message in current summary.
3621 nil: asks whether you want to go back to folder mode
3622 'unread: asks whether you want to go to next unread folder
3623 If the next one comes to be possessing no unread message
3624 by treatment of cross-posted messages or Scoring, then
3625 asks whether you want to go to next to next folder.
3626 'skip-no-unread: similar as unread
3627 But does not ask before going to next to next folder.
3628 otherwise: asks whether you want to go to next unread folder
3631 It might be useful to set @code{'skip-no-unread} for people who
3632 want to continue reading by just pressing and pressing space key.
3634 @item wl-thread-insert-opened
3635 @vindex wl-thread-insert-opened
3636 The initial setting is @code{nil}.
3637 If non-nil, thread is inserted as opened.
3639 @item wl-thread-open-reading-thread
3640 @vindex wl-thread-open-reading-thread
3641 The initial setting is @code{t}. If non-nil, reading thread is
3642 automatically opened though it is closed thread.
3644 @item wl-summary-exit-next-move
3645 @vindex wl-summary-exit-next-move
3646 The initial setting is @code{t}. If non-nil, move to next folder at
3649 @item wl-folder-move-cur-folder
3650 @vindex wl-folder-move-cur-folder
3651 The initial setting is @code{nil}. If non-nil, cursor position on the
3654 @item wl-summary-weekday-name-lang
3655 @vindex wl-summary-weekday-name-lang
3656 The initial setting is @samp{ja}. Specify language of the weekday.
3657 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3658 displays Deutsch. You should rescan summary view after changing this value.
3660 @item wl-summary-fix-timezone
3661 @vindex wl-summary-fix-timezone
3662 The initial setting is @code{nil}.
3663 Time zone of the date string in summary mode is adjusted using this value.
3664 If @code{nil}, it is adjust to the default time zone information
3665 (system's default time zone or environment variable @samp{TZ}).
3667 @item wl-use-petname
3668 @vindex wl-use-petname
3669 The initial setting is @code{t}.
3670 If non-nil, sender part displays nickname.
3672 @item wl-break-pages
3673 @vindex wl-break-pages
3674 The initial setting is @code{t}.
3675 If non-nil, message is split as pages by @samp{^L}.
3677 @item wl-message-window-size
3678 @vindex wl-message-window-size
3679 The initial setting is '(1 . 4).
3680 A cons cell to specify the rate of summary and message window.
3681 car:cdr corresponds summary:message.
3683 @item wl-summary-no-from-message
3684 @vindex wl-summary-no-from-message
3685 The initial setting is @samp{nobody@@nowhere?}. A string which is
3686 displayed when there's no @samp{From:} field in the message.
3688 @item wl-summary-no-subject-message
3689 @vindex wl-summary-no-subject-message
3690 The initial setting is @samp{(WL:No Subject in original.)}. A string
3691 which is displayed when there's no @samp{Subject:} field in the message.
3693 @item wl-summary-use-frame
3694 @vindex wl-summary-use-frame
3695 The initial setting is @code{nil}.
3696 If non-nil, use new frame for the summary.
3698 @item wl-use-folder-petname
3699 @vindex wl-use-folder-petname
3700 The initial setting is the list shown below:
3709 A list of display policy (symbol) of folder nickname. Available symbols
3714 Display folder petname on modeline.
3716 Destination folder is notified as nickname if
3717 @code{wl-auto-select-next} is non-nil.
3719 You can input folder name by nickname in the function
3720 @code{wl-summary-read-folder}.
3723 @item wl-summary-move-direction-toggle
3724 @vindex wl-summary-move-direction-toggle
3725 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3726 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3727 want to aware of reading direction, set this to @code{t}.
3729 @item wl-summary-width
3730 @vindex wl-summary-width
3731 The initial setting is 80.
3732 Width of summary line. If @code{nil}, summary line's width is as is.
3734 @item wl-summary-from-width
3735 @vindex wl-summary-from-width
3736 The initial setting is 17.
3737 Width of sender part of summary line.
3739 @item wl-summary-subject-length-limit
3740 @vindex wl-summary-subject-length-limit
3741 The initial setting is @code{nil}. Specify the limit for the length of
3742 subject parts in summary. @code{nil} means unlimited.
3744 @item wl-summary-indent-length-limit
3745 @vindex wl-summary-indent-length-limit
3746 The initial setting is 46.
3747 Specify the limit of thread indent level. @code{nil} means unlimited
3749 If you set this to @code{nil} you should set @code{wl-summary-width}
3752 @item wl-summary-recenter
3753 @vindex wl-summary-recenter
3754 The initial setting is t.
3755 If non-nil, cursor point is moved to the center of the summary window.
3757 @item wl-summary-divide-thread-when-subject-changed
3758 @vindex wl-summary-divide-thread-when-subject-changed
3759 The initial setting is @code{nil}. If non-nil, thread is split if
3760 the subject is changed.
3762 @item wl-summary-search-via-nntp
3763 @vindex wl-summary-search-via-nntp
3764 The initial setting is @code{confirm}.
3766 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3767 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3768 from the NNTP server @code{elmo-nntp-default-server}. The value of
3769 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3770 @code{elmo-nntp-default-stream-type} are used.
3772 If @code{confirm}, server name can be specified. You can specify NNTP
3773 folder format like @samp{-:username@@servername:119!}.
3775 @item wl-summary-keep-cursor-command
3776 @vindex wl-summary-keep-cursor-command
3777 The initial setting is the list shown below:
3781 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3786 When you entered to summary by these commands and the target summary
3787 buffer already exists, summary status is not automatically updated and
3788 cursor position is saved.
3790 @item elmo-folder-update-threshold
3791 @vindex elmo-folder-update-threshold
3792 The initial setting is 500. If updated message number is larger than
3793 this value, confirm whether drop them or not (in the case where the value
3794 of @code{elmo-folder-update-confirm} is non-nil).
3796 @item elmo-folder-update-confirm
3797 @vindex elmo-folder-update-confirm
3798 The initial setting is @code{t}. If the value is non-nil, do check with
3799 @code{elmo-folder-update-threshold}.
3801 @item wl-summary-always-sticky-folder-list
3802 @vindex wl-summary-always-sticky-folder-list
3803 The initial setting is @code{nil}.
3804 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3805 are automatically stuck. Each element is regexp of folder name.
3807 @item wl-summary-reserve-mark-list
3808 @vindex wl-summary-reserve-mark-list
3809 The initial setting is the list shown below:
3818 If a message is already marked as temporal marks in this list, the
3819 message is not marked by any mark command.
3821 @item wl-summary-skip-mark-list
3822 @vindex wl-summary-skip-mark-list
3823 The initial setting is the list shown below:
3832 If a message is already marked as temporal marks in this list, the
3833 message is skipped at cursor move.
3835 @item elmo-message-fetch-threshold
3836 @vindex elmo-message-fetch-threshold
3837 The initial setting is 30000 (bytes). If displaying message has larger
3838 size than this value, Wanderlust confirms whether fetch the message or
3839 not (in the case where the value of @code{elmo-message-fetch-confirm}
3842 @item elmo-message-fetch-confirm
3843 @vindex elmo-message-fetch-confirm
3844 The initial setting is @code{t}. If the value is non-nil, do check with
3845 @code{elmo-message-fetch-threshold}.
3847 @item wl-prefetch-threshold
3848 @vindex wl-prefetch-threshold
3849 The initial setting is 30000 (bytes). If prefetching message has larger
3850 size than this value and @code{wl-prefetch-confirm} is non-nil,
3851 Wanderlust confirms whether prefetch the message or not. If
3852 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3853 without confirmation.
3855 @item wl-prefetch-confirm
3856 @vindex wl-prefetch-confirm
3857 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3858 prefetch the message or not if the message has larger size than
3859 @code{wl-prefetch-threshold}.
3861 @item elmo-imap4-use-cache
3862 @vindex elmo-imap4-use-cache
3863 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3866 @item elmo-nntp-use-cache
3867 @vindex elmo-nntp-use-cache
3868 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3871 @item elmo-pop3-use-cache
3872 @vindex elmo-pop3-use-cache
3873 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3876 @item elmo-shimbun-use-cache
3877 @vindex elmo-shimbun-use-cache
3878 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3881 @item wl-folder-process-duplicates-alist
3882 @vindex wl-folder-process-duplicates-alist
3883 The initial setting is @code{nil}.
3884 This list determines how to deal with duplicated messages in the same folder.
3885 Each item in the list is regexp of folder name and action; you can specify any
3886 one of the following in the place of action:
3889 @code{nil} : do nothing for duplicated messages.
3890 @code{hide} : hide duplicated messages from the summary.
3891 @code{read} : set duplicated messages as read.
3895 Following is an example (hide duplicated messages in multi folders)
3899 (setq wl-folder-process-duplicates-alist
3900 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3901 ("^\\*.*" . hide) (".*" . read)))
3907 @node Message, Draft, Summary, Top
3908 @chapter Message Buffer
3910 Message Buffers utilize MIME-View mode of SEMI. For operational
3911 procedures and key bindings, refer to respective documents.
3912 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3913 You can also see help by @kbd{?} in message buffer.
3915 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3916 brings you back to Summary mode. @kbd{l} toggles display of Summary
3919 @section Key Bindings
3925 @findex wl-message-toggle-disp-summary
3926 Toggles display of Summary mode buffer.
3927 (@code{wl-message-toggle-disp-summary})
3930 @findex wl-message-refer-article-or-url
3931 @kindex Button-2 (Message)
3932 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3933 corresponding message if found.
3934 (@code{wl-message-refer-article-or-url})
3936 @item Button-4 (upward movement of a wheel)
3937 @kindex Button-4 (Message)
3938 @findex wl-message-wheel-down
3939 Scrolls the message backwards. When the top of the message is hit,
3940 moves to the previous message.
3941 (@code{wl-message-wheel-down})
3943 @item Button-5 (downward movement of a wheel)
3944 @kindex Button-5 (Message)
3945 @findex wl-message-wheel-up
3946 Scrolls the message forward. When the bottom of the message is hit,
3947 moves to the next message.
3948 (@code{wl-message-wheel-up})
3951 @section Customizable Variables
3954 @item wl-message-window-size
3955 @vindex wl-message-window-size
3956 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3957 its car and cdr value corresponds to the ratio of Summary and Message
3960 @item wl-message-ignored-field-list
3961 @vindex wl-message-ignored-field-list
3962 (SEMI only) Initial setting is @code{nil}.
3963 All fields that match this list will be hidden in message buffer.
3964 Each elements are regexp of field-name.
3965 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3967 @item wl-message-visible-field-list
3968 @vindex wl-message-visible-field-list
3969 (SEMI only) Initial setting is @code{nil}.
3970 All fields that match this list will be display in message buffer.
3971 Each elements are regexp of field-name. This value precedes
3972 @code{wl-message-ignored-field-list}.
3973 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3975 @item wl-message-sort-field-list
3976 @vindex wl-message-sort-field-list
3977 (SEMI only) Initial setting is
3978 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3979 Header fields in message buffer are ordered by this value.
3980 Each elements are regexp of field-name.
3982 @item wl-message-truncate-lines
3983 @vindex wl-message-truncate-lines
3984 The initial value is the value of @code{default-truncate-lines}.
3985 If it is non-nil, truncate long lines in message buffer.
3988 @node Draft, Disconnected Operations, Message, Top
3989 @chapter Draft Buffer
3991 At Summary mode, pressing @kbd{w} and the like creates a new draft
3992 buffer. You can edit and send mail and news articles in this buffer.
3996 Basically it is Emacs-standard mail mode.
3998 @subsection Address Completion
4000 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4001 addresses. @kbd{@key{TAB}} completes them.
4003 If you want to submit a news article, add @samp{Newsgroups:} field by
4004 yourself. Field names can be completed by @kbd{@key{TAB}}.
4006 If you save the draft buffer you are editing, it is appended to the
4007 folder specified by @code{wl-draft-folder}.
4009 Using @samp{FCC:} field, you can specify the folder to which a copy of
4010 the message is saved when it is sent.
4012 @subsection Editing Messages
4014 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4015 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4016 a MIME user interface for GNU Emacs}.
4017 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4019 @subsection Dynamic Modification of Messages
4020 @vindex wl-draft-config-alist
4021 @c @cindex Change Message
4022 @c @cindex Message, Change Dynamic
4024 You can set @code{wl-draft-config-alist} so that header and body of the
4025 message will automatically modified depending on information of header
4028 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4030 In the example below, the header is modified when
4031 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4032 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4033 before sending the message.
4037 (setq wl-draft-config-alist
4038 '(((string-match "aaa\\.example\\.com$" (system-name))
4039 ;; @r{applied if the expression is non-nil}
4040 (wl-smtp-posting-server . "mailserver-B")
4041 (wl-nntp-posting-server . "newsserver-B")
4042 ;; @r{settings of temporary variables}
4044 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4045 ;; @r{applied if it matches the header of the draft buffer}
4046 ("Organization" . (format "Go %s" my-webpage)))
4047 ;; @r{you can write elisp expressions here (eval only)}
4048 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4049 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4054 The format of @code{wl-draft-config-alist} is:
4058 '(("@var{regexp of the header}" or @var{elisp expression}
4059 ("@var{Field}" . value(@var{elisp expression}))
4060 (@var{variable} . value(@var{elisp expression}))
4061 (@var{sub-function} . value(@var{elisp expression}))
4064 ("@var{regexp of the header}" or @var{elisp expression}
4065 ("@var{Field}" . value(@var{elisp expression}))
4070 Per default, there are 10 following sub-functions.
4073 'header: Inserts the specified string at the bottom of the header.
4074 'header-top: Inserts the specified string at the top of the header.
4075 'header-file: Inserts the specified file at the bottom of the header.
4076 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4077 'top: Inserts the specified string at the top of the body.
4078 'top-file: Inserts the specified file at the top of the body.
4079 'body: Replaces the body with the specified string.
4080 Specifying @code{nil} deletes the entire body string.
4081 'body-file: Replaces the body with the content of the specified file.
4082 'bottom: Inserts the specified string at the bottom of the body.
4083 'bottom-file: Inserts the specified file at the top of the body.
4084 'part-top: Inserts the specified string at the top of the current part.
4085 'part-bottom: Inserts the specified string at the bottom of the current part.
4086 'template: Applies the specified template.
4087 (refer to the next subsection)
4090 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4091 change them or add your own functions. If you read the code, you can
4092 easily find how to write the functions.
4094 At the first of each item, @var{a regular expression of the header} or
4095 an @var{elisp expression} should be specified. In the case of an elisp
4096 expression, the item is applied when the expression is evaluated
4099 Per default, when multiple items match or are evaluated non-nil, all
4100 such items are applied, but if you set a variable
4101 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4104 At the second of the item, a cons or a list of functions should be
4105 specified. The car part of the cons should be a header field, a
4106 variable, or a sub-function. When a header field is specified, the
4107 field will be modified. If a variable is specified, the value of the
4108 variable will be modified temporarily.
4110 In the cdr part of a cons, not only a variable but also an elisp
4111 expression can be specified as is. If the car part is a header field
4112 and the cdr part is @code{nil}, the field will be deleted.
4114 If you want to use name of parent folder, you can refer the buffer local
4115 variable @code{wl-draft-parent-folder}.
4117 See the next example as well:
4121 (setq wl-draft-config-alist
4123 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4124 ;; @r{applied if it matches the header of the buffer being replied}
4125 (body . " Hello.\n")
4126 (template . "default")
4131 As in the (1) above, if a header regexp is prepended with @code{reply},
4132 it is applied when the draft is prepared by @code{wl-summary-reply} for
4133 example, and when it matches the header being replied. It is ignored
4134 when there is no buffer being replied, like after @code{wl-draft} was
4137 Note that @code{wl-draft-config-alist} is applied only once when
4138 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4139 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4140 aborting transmission, execute @kbd{C-c C-e}
4141 (@code{wl-draft-config-exec}) explicitly.
4143 If you don't want to apply @code{wl-draft-config-alist} when
4144 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4148 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4151 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4152 prepared, do the following:
4155 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4158 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4159 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4163 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4166 @subsection Inserting Templates
4168 @cindex Apply Template
4170 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4171 @kbd{M-x wl-template-select} in the draft buffer.
4173 The format of @code{wl-template-alist} is almost the same as
4174 @code{wl-draft-config-alist}.
4178 (setq wl-template-alist
4181 ("Organization" . "Example Co.Ltd.")
4182 (body . "Hello.\n"))
4184 (template . "default") ;; @r{(a)}
4185 ("To" . "boss@@example.com")
4186 ("Subject" . "Report")
4187 (body-file . "~/work/report.txt")
4193 As you can see, the only difference is item (template) names such as
4194 @samp{default} and @samp{report}, instead of a regexp of header.
4195 Because definition of each item is the same as
4196 @code{wl-draft-config-alist}, you can call another template, like (a).
4198 Executing the command @code{wl-template-select} results in template
4199 selection, but the result differs depending on variable
4200 @code{wl-template-visible-select}.
4202 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4203 window is shown below the draft buffer. You can select a template by
4204 @kbd{n} and @kbd{p} seeing the buffer window.
4206 Press the @key{RET} key and the template is actually applied to the draft
4207 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4208 adjust the window size by @code{wl-template-buffer-lines}.
4210 If @code{wl-template-visible-select} is @code{nil}, you should type the
4211 name of the template in the mini buffer.
4213 As shown in the example in @code{wl-draft-config-alist}, you can select
4214 @samp{default} template by writing:
4217 (template . "default")
4220 @subsection Sending mail by POP-before-SMTP
4221 @cindex POP-before-SMTP
4223 You can send mail by POP-before-SMTP with this single line:
4226 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4230 Configure the following variables if you need.
4233 @item wl-pop-before-smtp-user
4234 The POP user name for POP-before-SMTP authentication.
4235 If unset, @code{elmo-pop3-default-user} is used.
4237 @item wl-pop-before-smtp-server
4238 The POP server name for POP-before-SMTP authentication.
4239 If unset, @code{elmo-pop3-default-server} is used.
4241 @item wl-pop-before-smtp-authenticate-type
4242 The POP authentication method for POP-before-SMTP authentication.
4243 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4245 @item wl-pop-before-smtp-port
4246 The POP port number for POP-before-SMTP authentication.
4247 If unset, @code{elmo-pop3-default-port} is used.
4249 @item wl-pop-before-smtp-stream-type
4250 If non-nil, POP connection is established using SSL. If
4251 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4252 unset, @code{elmo-pop3-default-stream-type} is used.
4255 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4256 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4258 Therefore, if SMTP server and POP server are actually the same, and if
4259 POP folder per default (such as @samp{&}) is available, no settings are
4262 Refer to the following URL about POP-before-SMTP.
4266 http://spam.ayamura.org/tools/smPbS.html
4267 http://www.iecc.com/pop-before-smtp.html
4271 @section Key Bindings
4272 @cindex Keybind, Draft Mode
4273 @cindex Keybind, Draft Buffer
4278 @kindex C-c C-y (Draft)
4279 @findex wl-draft-yank-original
4280 Cites the content of the current message buffer.
4281 (@code{wl-draft-yank-original})
4284 @kindex C-c C-p (Draft)
4285 @findex wl-draft-preview-message
4286 Previews the content of the current draft.
4287 This is useful for previewing MIME multi-part messages.
4288 (@code{wl-draft-preview-message})
4291 @kindex C-c C-s (Draft)
4292 @findex wl-draft-send
4293 Sends the content of the current draft. Does not erase the draft buffer.
4294 This is useful for sending multiple messages, which are a little different
4296 (@code{wl-draft-send})
4299 @kindex C-c C-c (Draft)
4300 @findex wl-draft-send-and-exit
4301 Sends the content of the current draft and erases the draft buffer.
4302 (@code{wl-draft-send-and-exit})
4305 @kindex C-x C-s (Draft)
4306 @findex wl-draft-save
4307 Save the current draft.
4308 (@code{wl-draft-save})
4311 @kindex C-c C-k (Draft)
4312 @findex wl-draft-kill
4313 Kills the current draft.
4314 (@code{wl-draft-kill})
4317 @kindex C-x k (Draft)
4318 @findex wl-draft-mimic-kill-buffer
4319 Kills the current draft.
4320 (@code{wl-draft-mimic-kill-buffer})
4323 @kindex C-c C-z (Draft)
4324 @findex wl-draft-save-and-exit
4325 Saves the current draft, and erases the draft buffer.
4326 This is useful if you want to suspend editing of the draft.
4327 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4328 the @samp{+draft} folder.
4329 (@code{wl-draft-save-and-exit})
4332 @kindex C-c C-r (Draft)
4333 @findex wl-caesar-region
4334 Encodes or decodes the specified region in Caesar cipher.
4335 (@code{wl-caesar-region})
4339 @findex wl-draft-highlight-and-recenter
4340 Recenter and rehighlight current draft.
4341 (@code{wl-draft-highlight-and-recenter})
4345 @findex wl-toggle-plugged
4346 Toggles off-line/on-line states of Wanderlust.
4347 (@code{wl-toggle-plugged})
4350 @kindex C-c C-o (Draft)
4351 @findex wl-jump-to-draft-buffer
4352 Jumps to the other draft buffer, if exists.
4353 With prefix argument, reads a file (if any) from the draft folder when
4354 there is no such buffer.
4355 (@code{wl-jump-to-draft-buffer})
4358 @kindex C-c C-e (Draft)
4359 @findex wl-draft-config-exec
4360 Applies @code{wl-draft-config-alist}.
4361 (@code{wl-draft-config-exec})
4364 @kindex C-c C-j (Draft)
4365 @findex wl-template-select
4367 (@code{wl-template-select})
4370 @kindex C-c C-a (Draft)
4372 Enter Address Manager.
4373 @xref{Address Manager}.
4377 @kindex C-c C-d (Draft)
4378 @findex wl-draft-elide-region
4379 Elide the text between point and mark (@code{wl-draft-elide-region}).
4380 The text is killed and replaced with the contents of the variable
4381 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4385 @section Customizable Variables
4388 @item wl-subscribed-mailing-list
4389 @vindex wl-subscribed-mailing-list
4390 The initial setting is @code{nil}. Mailing lists to which you
4391 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4392 field of a reply draft, removes your own address from
4393 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4394 contained in @samp{To:} or @samp{Cc:} field of a message to be
4395 automatically re-filed, the destination folder will be leaned in
4396 connection with the address.
4402 (setq wl-subscribed-mailing-list
4403 '("wl@@lists.airs.net"
4405 "emacs-mime-ja@@m17n.org"))
4409 @item wl-insert-mail-followup-to
4410 @vindex wl-insert-mail-followup-to
4411 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4412 field is automatically inserted in the draft buffer.
4414 @item wl-insert-mail-reply-to
4415 @vindex wl-insert-mail-reply-to
4416 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4417 field is automatically inserted in the draft buffer.
4419 @item wl-auto-insert-x-face
4420 @vindex wl-auto-insert-x-face
4421 The initial setting is @code{t}. If non-nil and there is an encoded
4422 X-Face string in a file @file{~/.xface} (the value of the variable
4423 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4424 draft buffer. If @code{nil}, it is not automatically inserted.
4426 @item wl-insert-message-id
4427 @vindex wl-insert-message-id
4428 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4429 is automatically inserted on the transmission.
4431 @item wl-message-id-use-wl-from
4432 @vindex wl-message-id-use-wl-from
4433 The initial setting is @code{nil}. If non-nil, the value of
4434 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4436 @item wl-local-domain
4437 @vindex wl-local-domain
4438 The initial setting is @code{nil}. If @code{nil}, the return value of
4439 the function @code{system-name} will be used as the domain part of
4442 If @code{system-name} does not return FQDN (i.e. the full name of the
4443 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4444 to the string of the local domain name without hostname (like
4445 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4446 @samp{.} @code{wl-local-domain} is used as domain part of the
4449 If your terminal does not have global IP, set the value of
4450 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4451 you use invalid @samp{Message-ID:}.)
4453 Moreover, concatenation of @code{system-name} @samp{.}
4454 @code{wl-local-domain} will be used as an argument to the HELO command
4457 @item wl-message-id-domain
4458 @vindex wl-message-id-domain
4459 The initial setting is @code{nil}. If non-nil, this value is used as a
4460 domain part of the @samp{Message-ID:}. If your terminal does not have
4461 global IP address, set unique string to this value (e.x. your e-mail
4464 @item wl-unique-id-suffix
4465 @vindex wl-unique-id-suffix
4466 The initial setting is @samp{.wl}. You can specify the string in generated
4467 Message-ID which appear just before @samp{@@}.
4469 @item wl-draft-config-alist
4470 @vindex wl-draft-config-alist
4471 The initial setting is @code{nil}. Modifies the draft message just
4472 before the transmission. The content of @code{wl-draft-config-alist}
4473 will be automatically applied only once on the transmission. If you
4474 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4477 @item wl-template-alist
4478 @vindex wl-template-alist
4479 The initial setting is @code{nil}.
4480 This variable specifies the template to be applied in the draft buffer.
4482 @item wl-draft-config-matchone
4483 @vindex wl-draft-config-matchone
4484 The initial setting is @code{nil}. If non-nil, only the first matching
4485 item is used when @code{wl-draft-config-alist} is applied. If
4486 @code{nil}, all matching items are used.
4488 @item wl-template-visible-select
4489 @vindex wl-template-visible-select
4490 The initial setting is @code{t}.
4491 If non-nil, you can preview the result of the template selection in
4494 @item wl-template-confirm
4495 @vindex wl-template-confirm
4496 The initial setting is @code{nil}.
4497 If non-nil, asks for confirmation when you press the enter key to select
4498 template while previewing.
4500 @item wl-template-buffer-lines
4501 @vindex wl-template-buffer-lines
4502 The initial setting is 7.
4503 If @code{wl-template-visible-select} is non-nil, this variable specifies
4504 the size of the preview window.
4506 @item wl-draft-reply-buffer-style
4507 @vindex wl-draft-reply-buffer-style
4508 The initial setting is @code{split}. @code{split} or @code{full} can be
4509 specified. In the case of @code{full}, the whole frame will be used for
4510 a reply draft buffer when it is prepared.
4512 @item wl-draft-use-frame
4513 @vindex wl-draft-use-frame
4514 The initial setting is @code{nil}.
4515 If non-nil, use new frame for the draft.
4517 @item wl-draft-truncate-lines
4518 @vindex wl-draft-truncate-lines
4519 The initial value is the value of @code{default-truncate-lines}.
4520 If it is non-nil, truncate long lines in draft buffer.
4524 The initial setting is the value of the variable
4525 @code{user-mail-address}. The value of this variable is inserted as a
4526 @samp{From:} field of the draft when it is prepared.
4528 @item wl-envelope-from
4529 @vindex wl-envelope-from
4530 The initial setting is @code{nil}.
4531 The value of this variable is used for envelope from (MAIL FROM).
4532 If @code{nil}, the address part of @code{wl-from} is used.
4534 @item wl-user-mail-address-list
4535 @vindex wl-user-mail-address-list
4536 The initial setting is @code{nil}.
4537 This is the User's address list. If you have multiple addresses,
4542 The initial setting is @code{nil}.
4543 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4544 the draft when it is prepared. If function is specified, its return
4549 The initial setting is @code{nil}.
4550 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4551 the draft when it is prepared.
4553 @item wl-reply-subject-prefix
4554 @vindex wl-reply-subject-prefix
4555 The initial setting is @samp{Re: }.
4556 In the @samp{Subject:} of the reply draft, this string is prepended to
4557 the @samp{Subject:} of being replied.
4559 @item wl-draft-reply-use-address-with-full-name
4560 @vindex wl-draft-reply-use-address-with-full-name
4561 The initial setting is @code{t}.
4562 If non-nil, insert her full name with address when prepare a draft for
4563 reply a message. If it is @code{nil}, insert her address only.
4565 @item wl-draft-enable-queuing
4566 @vindex wl-draft-enable-queuing
4567 The initial setting is @code{t}.
4568 This flag controls off-line transmission. If non-nil, the draft is
4571 @item wl-draft-use-cache
4572 @vindex wl-draft-use-cache
4573 The initial setting is @code{nil}. If the value is non-nil and
4574 @code{wl-insert-message-id} is nil, cache the message which is sent.
4576 @item wl-fcc-force-as-read
4577 @vindex wl-fcc-force-as-read
4578 The initial setting is @code{nil}. If the value is non-nil,
4579 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4581 @item wl-auto-flush-queue
4582 @vindex wl-auto-flush-queue
4583 The initial setting is t.
4584 This flag controls automatic transmission of the queue when Wanderlust
4585 becomes on-line. If non-nil, the queue is automatically transmitted
4586 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4587 manually, press @kbd{F} in the folder mode.
4589 @item wl-ignored-forwarded-headers
4590 @vindex wl-ignored-forwarded-headers
4591 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4592 All headers that match this regexp will be deleted when forwarding a message.
4594 @item wl-ignored-resent-headers
4595 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4596 All headers that match this regexp will be deleted when resending a message.
4598 @item wl-draft-always-delete-myself
4599 @vindex wl-draft-always-delete-myself
4600 If non-nil, always removes your own address from @samp{To:} and
4601 @samp{Cc:} when you are replying to the mail addressed to you.
4603 @item wl-draft-delete-myself-from-bcc-fcc
4604 @vindex wl-draft-delete-myself-from-bcc-fcc
4605 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4606 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4608 @item wl-smtp-posting-server
4609 @vindex wl-smtp-posting-server
4610 The initial setting is @code{nil}.
4611 This is the SMTP server name for mail transmission.
4613 @item wl-smtp-posting-user
4614 @vindex wl-smtp-posting-user
4615 The initial setting is @code{nil}.
4616 This is the user name for SMTP AUTH authentication. If @code{nil},
4617 @code{smtp-authenticate-user} is used.
4619 @item wl-smtp-authenticate-type
4620 @vindex wl-smtp-authenticate-type
4621 The initial setting is @code{nil}.
4622 This is the authentication method for SMTP AUTH authentication. If
4623 @code{nil}, @code{smtp-authenticate-type} is used. If
4624 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4627 @item wl-smtp-connection-type
4628 @vindex wl-smtp-connection-type
4629 The initial setting is @code{nil}.
4630 This variable specifies how to establish SMTP connections.
4631 If @code{nil}, @code{smtp-connection-type} is used.
4632 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4634 @item wl-nntp-posting-server
4635 @vindex wl-nntp-posting-server
4636 The initial setting is @code{nil}.
4637 This is the NNTP server name used for news submission.
4638 If @code{nil}, @code{elmo-nntp-default-server} is used.
4640 @item wl-nntp-posting-user
4641 @vindex wl-nntp-posting-user
4642 The initial setting is @code{nil}.
4643 This is the user name for AUTHINFO authentication on news submission.
4644 If @code{nil}, @code{elmo-nntp-default-user} is used.
4645 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4647 @item wl-nntp-posting-port
4648 @vindex wl-nntp-posting-port
4649 The initial setting is @code{nil}.
4650 This is the port number of the NNTP server used for news submission.
4651 If @code{nil}, @code{elmo-nntp-default-server} is used.
4653 @item wl-nntp-posting-stream-type
4654 @vindex wl-nntp-posting-stream-type
4655 The initial setting is @code{nil}.
4656 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4657 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4658 connection will be established.
4660 @item wl-pop-before-smtp-user
4661 @vindex wl-pop-before-smtp-user
4662 The initial setting is @code{nil}.
4663 This is the POP user name for POP-before-SMTP.
4664 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4666 @item wl-pop-before-smtp-server
4667 @vindex wl-pop-before-smtp-server
4668 The initial setting is @code{nil}.
4669 This is the POP server name for POP-before-SMTP.
4670 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4672 @item wl-pop-before-smtp-authenticate-type
4673 @vindex wl-pop-before-smtp-authenticate-type
4674 The initial setting is @code{nil}.
4675 This is the authentication method for POP-before-SMTP authentication.
4676 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4678 @item wl-pop-before-smtp-port
4679 @vindex wl-pop-before-smtp-port
4680 The initial setting is @code{nil}.
4681 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4682 @code{elmo-pop3-default-port} is used.
4684 @item wl-pop-before-smtp-stream-type
4685 @vindex wl-pop-before-smtp-stream-type
4686 The initial setting is @code{nil}.
4687 This flag controls the use of SSL for POP-before-SMTP. If it is
4688 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4689 STARTTLS (RFC2595) connection will be established.
4691 @item wl-draft-queue-save-variables
4692 @vindex wl-draft-queue-save-variables
4693 Specifies a list of variable to which queued messages are saved on the
4694 off-line transmission.
4696 @item wl-draft-sendlog
4697 @vindex wl-draft-sendlog
4698 The initial setting is @code{t}.
4699 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4703 @item drafts are sent by smtp or qmail
4704 @item saved into folders by fcc
4705 @item saved into folders by queuing
4708 (it is written even if the transmission fails).
4709 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4710 and left to the logging function of @command{imput}.
4713 @item wl-draft-sendlog-max-size
4714 @vindex wl-draft-sendlog-max-size
4715 The initial setting is 20000 (in bytes).
4716 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4717 beyond the size specified by this variable.
4721 The initial setting is @code{nil}.
4722 If non-nil, address completion uses LDAP.
4724 @item wl-ldap-server
4725 @vindex wl-ldap-server
4726 The initial setting is @samp{localhost}.
4727 LDAP server name for address completion.
4730 @vindex wl-ldap-port
4731 The initial setting is @code{nil}.
4732 If non-nil, the value is used as port number.
4735 @vindex wl-ldap-base
4736 The initial setting is @samp{c=US}.
4737 LDAP search starting point (base) for address completion.
4739 @item wl-draft-remove-group-list-contents
4740 @vindex wl-draft-remove-group-list-contents
4741 The initial setting is @code{t}.
4742 If non-nil, remove the group-lists' members in the recipients when
4743 sending the message (group-list means the description such as
4744 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4747 @node Disconnected Operations, Expire and Archive, Draft, Top
4748 @chapter Off-line Management
4749 @cindex Disconnected Operations
4751 Wanderlust has on-line and off-line states.
4754 * Off-line State:: Wanderlust has on-line and off-line states
4755 * Enable Operations:: Enable Disconnected Operations
4756 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4757 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4758 * Variables of Plugged Mode:: Customize Plugged Mode
4762 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4763 @section Off-line State
4765 Wanderlust has on-line and off-line states. In the off-line state, you
4766 cannot access messages via network, unless they are cached.
4768 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4769 in the mode line indicates the off-line state. In folder or summary
4770 modes, press @kbd{M-t} to switch between off- and on-line.
4772 You can invoke Wanderlust in the off-line state by setting
4773 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4775 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4776 ignores uncached messages.
4779 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4780 @section Enable Disconeected Operations
4782 Even in the off-line state, provided that relevant messages are cached,
4783 and the variable @code{elmo-enable-disconnected-operation} (described
4784 later) is non-nil, you can following operations:
4785 @xref{Plugged Mode}, @xref{Off-line State settings}.
4788 * Send Messages off-line:: Transmit Messages
4789 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4790 * Creation of Folders:: Create Folders off-line (IMAP4)
4791 * Marking:: Mark (IMAP4)
4792 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4795 As soon as Wanderlust becomes on-line, such operations invoked off-line
4796 are reflected in the servers via network.
4799 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4800 @subsection Transmission of Messages
4802 You can send mail/news messages off-line (if you are using
4803 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4804 accumulated in the queue folder, @samp{+queue}. These messages are
4805 transmitted at once when Wanderlust becomes on-line.
4807 You can visit @samp{+queue} in the off-line state and confirm content of
4808 messages in the queue. You can also remove messages. Removed messages
4809 are not transmitted even in the on-line state.
4812 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4813 @subsection Re-file and Copy (IMAP4)
4815 Re-file and copy operations to IMAP folders invoked during the off-line
4816 state are accumulated in the queue, and reflected in the server side
4817 when Wanderlust becomes on-line. If you visit destination folders after
4818 off-line re-file or copy, it looks as if messages were appended even in
4821 For the safety reasons, messages re-filed off-line are removed from
4822 source folders only if their @samp{Message-ID:} match messages on the
4823 servers. While the queue is processed, messages that failed to be
4824 re-filed or copied to the specified folders are appended to the folder
4828 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4829 @subsection Creation of Folders (IMAP4)
4831 You can create IMAP folders off-line. The creation of folders are
4832 reflected in the servers when Wanderlust becomes on-line. At that time,
4833 if folders failed to be created on the servers for any reasons, messages
4834 re-filed to such folders are appended to the folder @samp{+lost+found}.
4837 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4838 @subsection Marking (IMAP4)
4840 Off-line changes in unread/read and importance mark @samp{$} information
4841 are also reflected in the servers when Wanderlust becomes on-line.
4844 @node Pre-fetching Reservations, , Marking, Enable Operations
4845 @subsection Pre-fetching (IMAP4, NNTP)
4847 You can make reservations for pre-fetching messages in IMAP or NNTP
4848 folders. Reserved messages are marked with @samp{!} but not cached
4849 yet. When Wanderlust becomes on-line, they are pre-fetched from
4852 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4853 these off-line operations for IMAP4 and NNTP do not take place, and
4854 off-line re-file, copy or suchlike simply results in error.
4856 Because off-line operations use cache files, it is a bad idea to erase
4857 them by hand; it may cause Wanderlust to malfunction.
4859 If you want to remove caches, be sure to execute @kbd{M-x
4860 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4861 remove caches for messages relevant to off-line operations.
4864 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4865 @section Switching On-line/Off-line per Server/Port
4867 @kbd{M-t} described above switches networking states as a whole, but you
4868 can switch on-line/off-line per server/port.
4870 Pressing @kbd{C-t} in the folder or summary modes brings you in
4871 wl-plugged-mode shown below, in which you can change the plugged state
4876 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4879 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4880 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4882 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4883 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4889 The first line indicates status of the following three variables, and
4890 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4891 column modifies the values of these variables.
4895 "Queuing" @code{wl-draft-enable-queuing}
4896 "AutoFlushQueue" @code{wl-auto-flush-queue}
4897 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4901 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4904 The second and after lines indicate on-line/off-line states of servers
4905 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4906 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4907 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4909 @dfn{sending queue} means messages accumulated in the folder
4910 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4911 off-line operations when @code{elmo-enable-disconnected-operation} is
4913 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4914 @c off-line operations are enabled.
4916 They are displayed if there are any of them. In the example above, in
4917 the sending queue there are two messages (the first and the second in
4918 the queue folder) for smtp to hosta and one (the third) for nntp to
4919 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4922 If you change @samp{(wl-plugged)} in the second line, the variable
4923 @code{wl-plugged} is changed, so that the mode line indicator and
4924 plugged states of all ports are affected. If you change plugged states
4925 of any servers or ports, @samp{(wl-plugged)} in the second line is
4926 affected depending on @code{elmo-plugged-condition} settings and the
4927 plugged state of each port.
4930 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4931 @section Invoking Wanderlust in the Off-line State
4933 As described before, if you set @code{wl-plugged} to @code{nil} in
4934 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4935 off-line state. You can specify off-line state on a per server or port
4936 basis. Refer to @code{wl-reset-plugged-alist} also.
4938 Usually, when Wanderlust starts up, the plugged state of each port is
4939 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4940 @code{wl-nntp-posting-server} and so on. If you want to change the
4941 plugged state of these ports or to add other ports, configure
4942 @code{wl-make-plugged-hook} with a function.
4946 (add-hook 'wl-make-plugged-hook
4948 (elmo-set-plugged plugged-value(t/nil) server port)
4949 ;; @r{add or change plugged states of the port of the server}
4950 (elmo-set-plugged plugged-value(t/nil) server)
4951 ;; @r{if the port is omitted, all ports are affected}
4952 ;; @r{(you cannot omit the port if you newly add the server)}
4958 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4959 @section Customizable Variables
4964 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4965 mode from the beginning.
4967 @item wl-queue-folder
4968 @vindex wl-queue-folder
4969 The initial setting is @samp{+queue}.
4970 This is the folder in which messages in the transmission queue are
4973 @item wl-auto-flush-queue
4974 @vindex wl-auto-flush-queue
4975 The initial setting is @code{t}.
4976 This flag controls automatic transmission of the queue when Wanderlust
4977 becomes on-line. If non-nil, the queue is automatically transmitted
4978 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4979 manually, press @kbd{F} in the folder mode.
4981 @item elmo-enable-disconnected-operation
4982 @vindex elmo-enable-disconnected-operation
4983 The initial setting is @code{nil}. Controls off-line operations
4984 regarding IMAP4. If non-nil, off-line operations are carried out.
4986 @item elmo-lost+found-folder
4987 @vindex elmo-lost+found-folder
4988 The initial setting is @samp{+lost+found}.
4989 This is the folder to which messages are saved when they fails to be
4990 appended while the off-line re-file/copy queue is processed.
4992 @item elmo-plugged-condition
4993 @vindex elmo-plugged-condition
4994 The initial setting is @code{one}.
4995 The value of @code{wl-plugged} reflects the return value of the function
4996 @code{elmo-plugged-p} (without arguments).
4997 This variable @code{elmo-plugged-condition} specifies the condition on
4998 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4999 plugged state of each port.
5002 'one : plugged if one or more ports are plugged.
5003 'all : plugged if all ports are plugged.
5004 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5005 states of the ports.
5006 @var{function} : reflects the return value of the @var{function}
5007 functions available per default
5008 'elmo-plug-on-by-servers
5009 : reflects the plugged state of the servers specified by the
5010 variable elmo-plug-on-servers.
5011 'elmo-plug-on-by-exclude-servers
5012 : reflects the plugged state of the servers that are not
5013 in elmo-plug-on-exclude-servers.
5014 elmo-plug-on-exclude-servers defaults to
5017 (system-name)without the domain part)
5023 (setq elmo-plugged-condition 'all)
5025 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5026 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5028 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5029 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5033 @item wl-reset-plugged-alist
5034 @vindex wl-reset-plugged-alist
5035 The initial setting is @code{t}. If non-nil, plugged states are
5036 initialized on a per server or port basis when Wanderlust starts up.
5038 If @code{nil}, plugged states are retained while Emacs is running. In
5039 other words, they are initialized when Emacs is restarted even if the
5040 value is @code{nil}.
5044 @node Expire and Archive, Scoring, Disconnected Operations, Top
5045 @chapter Automatic Expiration and Archiving of Messages
5046 @cindex Expire and Archive
5049 * Expire:: Expiration and Archiving
5050 * Archive:: Archiving All Messages
5054 @node Expire, Archive, Expire and Archive, Expire and Archive
5056 @cindex Expire Message
5058 Expiration means deletion of old messages which have outlasted a
5059 certain period of time.
5061 @code{wl-expire} supports not only simple deletion, but also moving to
5062 specified archiving folders.
5066 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5067 or @kbd{M-e} in the summary mode.
5069 @subsection Configuring @code{wl-expire-alist}
5071 An example configuration of @code{wl-expire-alist} is shown below.
5072 Everything in this @code{wl-expire-alist} makes a great difference in
5073 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5074 to @code{t}, especially in the initial stage.
5078 (setq wl-expire-alist
5079 '(("^\\+trash$" (date 14) remove)
5081 ("^\\+tmp$" (date 7) trash)
5082 ;; @r{re-file to @code{wl-trash-folder}}
5083 ("^\\+outbox$" (number 300) "$outbox;lha")
5084 ;; @r{re-file to the specific folder}
5086 ;; @r{do not expire}
5087 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5088 ;; @r{archive by message number (retaining numbers)}
5089 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5090 ;; @r{archive by a fixed number (retaining numbers)}
5091 ("^\\+diary$" (date 30) wl-expire-archive-date)
5092 ;; @r{archive by year and month (numbers discarded)}
5097 Items in the list has the format of:
5100 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5104 The folder is examined if it matches @var{regexp-for-folders} from the
5105 beginning of the list. If you invoke expiration on the folder that does
5106 not match any of them, nothing will happen. And if either the second or
5107 the third element of the item is @code{nil}, expiration will not take
5110 You can use any one of the following for
5111 @var{specification-of-message-to-be-deleted}:
5114 @item (number @var{n1} [@var{n2}])
5115 deletes messages depending on the number of messages in the folder.
5117 @var{n1} is the number of messages which should survive deletion, for example
5118 if its value is 500, the newest 500 messages survive and the rests are
5121 @var{n2} is the number of messages in the folder on which expiration should
5122 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5123 folders with 510 or more messages are expired.
5124 If you configured automatic expiration, frequently used folders may
5125 expire every time it receive messages, and you may be annoyed with the
5126 long delay in reading mail.
5127 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5128 expiration would not take place until a certain number of messages
5131 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5132 with important/new/unread) are not deleted.
5133 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5134 will expire so as to have 500 messages including such ones.
5135 Otherwise, it will have 500 messages except such ones.
5137 @item (date @var{d1})
5138 deletes messages depending on the dates.
5140 Messages dated @var{d1} or more days ago are deleted, for example if its
5141 value is seven, messages seven days old or more are deleted. Note that
5142 the date is the one in the @samp{Date:} field of the message, not when
5143 the message entered the folder.
5145 Messages with no or invalid @samp{Date:} field does not expire; you
5146 might have to delete them by hand.
5149 You can use any one of the following in the place of @var{destination}:
5153 deletes the messages instantly.
5156 hide the messages from summary (messages are not deleted).
5159 moves the messages to @code{wl-trash-folder}.
5161 @item @var{string}(folder)
5162 moves the messages to the folder specified with @var{string}.
5164 It would be useful for specifying an archiving folder, but because this
5165 does not move important messages, it might be better to use the
5166 standard functions described below.
5168 @item @var{function}
5169 invokes the specified @var{function}.
5171 To the @var{function}, three arguments are passed: a folder name, a list
5172 of messages to be deleted, and msgdb information of the summary. You
5173 can specify function-specific arguments after the name of the
5174 @var{function}. Note that the list contains messages with marks in
5175 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5178 These are four standard functions; three of them move messages to an archive
5179 folder in the specified way. This means old messages can be compressed
5180 and saved in a file, being deleted from the original folder.
5181 The last one divides messages to some MH folders.
5184 @item wl-expire-archive-number1
5185 re-files to archiving folders corresponding to the message numbers of
5186 the messages being deleted. For example, a message numbered 102 will be
5187 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5188 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5189 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5191 The archiving folders to which messages are re-filed are determined by
5192 the name of the folder as follows (in this case, archiving folders are
5193 handled as if @code{elmo-archive-treat-file} were non-nil).
5196 @item If the folder type is localdir:
5197 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5199 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5200 (@file{~/Mail/ml/wl-00100.zip}).
5202 @item The folder type is other than localdir:
5203 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5205 For example, @samp{%#mh/ml/wl} corresponds to
5206 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5209 As you can see, in the case of localdir, the folder type is not included
5210 in the path name, but otherwise it is included.
5211 And you can control the prefix to the archiving folder name by
5212 @code{wl-expire-archive-folder-prefix}.
5213 Refer to @code{wl-expire-archive-folder-prefix} for details.
5215 @item wl-expire-archive-number2
5216 re-files every certain number of messages to archiving folders.
5218 This differs from @samp{wl-expire-archive-number1} in that this re-files
5219 to the folder up to the specified number regardless of message numbers.
5220 The archiving folders to which messages are re-filed are determined in the
5221 same way as @code{wl-expire-archive-number1}.
5223 @item wl-expire-archive-date
5224 re-files messages depending on its date (year and month) to archive
5227 For example, a message dated December 1998 is re-filed to
5228 @code{$folder-199812;zip}. The name of the archiving folders except the
5229 date part are determined in the same way as
5230 @code{wl-expire-archive-number1}.
5233 You can set the first argument to these three standard functions to non-nil
5234 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5235 For example, it can be specified just after the name of the function:
5238 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5241 If you omit the argument, consecutive numbers from 1 are assigned for
5242 each archiving folder.
5244 @item wl-expire-localdir-date
5245 divedes messages depending on its date (year and month) to MH folders
5246 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5250 @subsection Treatment for Important or Unread Messages
5252 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5253 standard function, messages with marks in
5254 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5255 messages} thereafter) are retained.
5257 Per default, this variable include the important, new, and unread marks,
5258 so that messages with these marks are not removed.
5259 Note that you cannot include the temporary mark (i.e. temporary marks
5260 are removed anyway), and be sure to process temporary marks before you
5263 @subsection Auto Expiration
5265 The following setup invokes expiration when you move into the summary
5266 mode. There will be no confirmation, so make sure you made no mistake
5267 in regexp and other settings before you set up this.
5271 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5275 In the folder mode, you can invoke expiration per group as well as per
5276 folder. Therefore, if you specify @samp{Desktop} group, all folders
5277 matching @code{wl-expire-alist} expire.
5281 @subsection Treating archive folders.
5282 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5283 you must set non-nil value to @code{elmo-archive-treat-file}.
5285 @subsection Confirming
5287 If you are to use @code{remove}, try @code{trash} at first and see
5288 messages move to @code{wl-trash-folder} as expected, then replace it
5289 with @code{remove}. It would be dangerous to use @code{remove} from the
5292 If you are to use @code{wl-expire-archive-number1} and the like, try to
5293 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5294 you can append messages to it. Even if settings in
5295 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5296 would not be saved anywhere and disappeared in case the archiver program
5299 After you make sure you can archive to the folder correctly, you can
5300 invoke expiration and utilize the log.
5302 If you set @code{wl-expire-use-log} to @code{t},
5303 @file{~/.elmo/expired-log} should contain the log, for example:
5307 delete +ml/wl (593 594 595 596 597 598 599)
5308 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5312 The first column indicates the operation, i.e. @samp{delete},
5313 @samp{copy}, or @samp{move}. The next is the name of the folder that
5314 expired. In the case of @samp{copy} and @samp{move}, the destination
5315 folder is recorded after @samp{->}. The last is the list of message
5316 numbers that are actually deleted or moved (in the case of @samp{copy}
5317 and @samp{move}, the number is the one in the source folder, rather than
5318 the destination folder).
5320 @subsection Re-filing Reserved Messages
5322 The three standard functions copy reserved messages to the archive
5323 folder, but do not delete them from the source folder. Because
5324 reserved messages and the like always remain, they are recorded in
5325 @file{~/.elmo/expired-alist} so that they are not copied over and over
5326 again. They are not recorded if copied by @code{wl-summary-archive}.
5328 If you enabled logging, usually @samp{move} is recorded for re-filing,
5329 but instead @samp{copy} and @samp{delete} are recorded separately if
5330 reserved messages are involved. This is because it actually copies
5331 messages including reserved, then deletes ones except reserved in that
5334 @section Customizable Variables
5337 @item wl-expire-alist
5338 @vindex wl-expire-alist
5339 The initial setting is @code{nil}.
5340 This variable specifies folders and methods to expire. For details,
5341 refer to @code{wl-expire-alist} settings above.
5343 @item wl-summary-expire-reserve-marks
5344 @vindex wl-summary-expire-reserve-marks
5345 The initial setting is the list below.
5349 (list wl-summary-important-mark
5351 wl-summary-unread-mark
5352 wl-summary-unread-uncached-mark
5353 wl-summary-unread-cached-mark)
5357 Messages with these marks are retained in the folder, even after
5359 Only permanent marks can be listed, not temporary marks.
5361 You can list marks one by one as in the default; you can use the
5362 following settings as well:
5366 All messages with permanent marks are retained,
5367 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5371 All messages are handled as usual ones that are already read, no matter
5372 what marks they have; even important messages are deleted.
5375 @item wl-expire-archive-files
5376 @vindex wl-expire-archive-files
5377 The initial setting is 100.
5378 This variable specifies the number of messages to be retained in one
5381 @item wl-expire-number-with-reserve-marks
5382 @vindex wl-expire-number-with-reserve-marks
5383 The initial setting is @code{nil}.
5384 If non-nil, if expiring messages are specified by @code{number},
5385 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5387 @item wl-expire-archive-get-folder-function
5388 @vindex wl-expire-archive-get-folder-function
5389 The initial setting is @code{wl-expire-archive-get-folder}.
5391 This variable specifies a function that returns the name of an archiving
5392 folder for standard functions in the place of @var{destination}.
5393 You can use the following three variables for simple modification of
5394 folder names; if you want more complex settings, define your own
5395 function in this variable.
5397 @code{wl-expire-archive-get-folder} can be customized by these
5400 @item @code{wl-expire-archive-folder-name-fmt}
5401 @item @code{wl-expire-archive-folder-type}
5402 @item @code{wl-expire-archive-folder-prefix}
5405 @item wl-expire-archive-folder-name-fmt
5406 @vindex wl-expire-archive-folder-name-fmt
5407 The initial setting is @samp{%s-%%05d;%s}.
5408 This is a @code{format} string for archiving folders used in
5409 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5410 Note that you must specify the message number by @samp{%%d}, because it
5411 is parsed twice by @code{format}.
5413 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5416 @item wl-expire-archive-date-folder-name-fmt
5417 @vindex wl-expire-archive-date-folder-name-fmt
5418 The initial setting is @samp{%s-%%04d%%02d;%s}.
5419 This is a @code{format} string for archiving folders used in
5420 @code{wl-expire-archive-date}. Note that you must specify the message
5421 number by @samp{%%d}, because it is parsed twice by @code{format}.
5422 There should be @samp{%%d} twice, one for the year and the other for the
5425 If you modify this, adjust
5426 @code{wl-expire-archive-date-folder-num-regexp} as well.
5428 @item wl-expire-archive-folder-type
5429 @vindex wl-expire-archive-folder-type
5430 The initial setting is @code{zip}.
5431 This variable specifies an archiver type of the archiving folders.
5433 @item wl-expire-archive-folder-prefix
5434 @vindex wl-expire-archive-folder-prefix
5435 The initial setting is @code{nil}.
5436 This variable specifies the prefix (directory structure) to archiving
5438 Exercise extreme caution in using this feature, as it has not been
5440 In the worst case, there is a fear of destructing archiving folders.
5444 There will be no prefix.
5447 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5448 @samp{$ml/wl-00000;zip;wl}.
5451 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5454 @samp{$ml/wl-00000;zip;ml/wl}.
5457 @item wl-expire-archive-folder-num-regexp
5458 @vindex wl-expire-archive-folder-num-regexp
5459 The initial setting is @samp{-\\([-0-9]+\\);}.
5460 This variable specifies the regular expression to be used for getting
5461 message numbers from multiple archiving folders specified by
5462 @code{elmo-list-folders}.
5463 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5465 @item wl-expire-archive-date-folder-num-regexp
5466 @vindex wl-expire-archive-date-folder-num-regexp
5467 The initial setting is @samp{-\\([-0-9]+\\);}.
5468 This is the regular expression to be used for getting message numbers
5469 from multiple archiving folders specified by @code{elmo-list-folders}.
5470 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5472 @item wl-expire-delete-oldmsg-confirm
5473 @vindex wl-expire-delete-oldmsg-confirm
5474 The initial setting is @code{t}.
5475 If non-nil, messages older than the one with the largest number will be
5476 deleted with confirmation.
5477 If @code{nil}, they are deleted without confirmation.
5479 This feature is valid only if non-nil is specified as a argument to the
5480 standard functions so as to retain numbers.
5482 @item wl-expire-use-log
5483 @vindex wl-expire-use-log
5484 The initial setting is @code{nil}.
5485 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5486 They are appended but not truncated or rotated automatically; you might
5487 need to remove it manually.
5489 @item wl-expire-add-seen-list
5490 @vindex wl-expire-add-seen-list
5491 The initial setting is @code{t}.
5493 If non-nil, when messages are re-filed by expiration, read/unread
5494 information is passed to the destination folder.
5496 However if you do not read the destination folder from Wanderlust,
5497 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5498 want to set this to @code{nil} if you are simply saving to some
5499 archiving folders. Even if its value is @code{nil}, messages in the
5500 archiving folders are simply treated as unread; it does not affect
5503 @item wl-expire-folder-update-msgdb
5504 @vindex wl-expire-folder-update-msgdb
5505 The initial setting is @code{t}.
5506 If @code{t}, in the folder mode, expiration is carried out after
5507 updating summary information. If you specified a list of regular
5508 expressions of folder names, summary information is updated for matching
5513 @node Archive, , Expire, Expire and Archive
5514 @section Archiving Messages
5516 @subsection Archiving Messages
5517 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5518 folders. If there are the archiving folders already, only new messages
5521 You can use @code{wl-archive-alist} in order to specify how messages are
5522 archived according to their folder names, as in @code{wl-expire-alist}.
5527 (setq wl-archive-alist
5528 '(("^\\+tmp$" wl-archive-date)
5529 ("^\\+outbox$" wl-archive-number2)
5530 (".*" wl-archive-number1)))
5534 Each item in the list has the following format:
5537 (@var{folders-regexp} @var{deleting-function})
5540 As you can see, you can only use a function after @var{folders-regexp}.
5541 Per default, there are three functions:
5544 @item @code{wl-archive-number1}
5545 @item @code{wl-archive-number2}
5546 @item @code{wl-archive-date}
5549 As inferred from their names, they work similarly to "expire" versions,
5550 other than the following points:
5553 @item No messages are deleted
5554 @item Message numbers are retained even if invoked without arguments
5557 These functions are good to archive all messages in a folder by their
5558 numbers or by their dates.
5559 These are also useful for backup or confirmation purposes before
5561 If you try to re-file them after they are archived, they are deleted but
5564 Per default, the archiving folders to which messages are copied are
5565 determined automatically by @code{wl-expire-archive-get-folder-function}.
5566 You can copy to a specific folder by invoking with a prefix argument,
5567 i.e. @kbd{C-u M-x wl-summary-archive}.
5569 Note that this feature has not been seriously tested, because you can
5570 simply copy to an archiving folder, for example by
5571 @code{wl-summary-copy-region}.
5573 The archiving folders are determined by the same logic as in
5574 @code{wl-summary-expire}; the following customizable variables are
5578 @item @code{wl-expire-archive-files}
5579 @item @code{wl-expire-archive-get-folder-function}
5580 @item @code{wl-expire-archive-folder-name-fmt}
5581 @item @code{wl-expire-archive-folder-type}
5582 @item @code{wl-expire-archive-folder-prefix}
5583 @item @code{wl-expire-archive-folder-num-regexp}
5586 @subsection Customizable Variables
5589 @item wl-archive-alist
5590 @vindex wl-archive-alist
5591 The initial setting is the list shown below:
5595 ((".*" wl-archive-number1))
5600 This variable specifies a function that copies to archiving folders.
5601 To the function, three arguments are passed: a folder name, a list of
5602 messages in the folder, and msgdb information of the summary.
5603 Needless to say, you can use your own function.
5607 @node Scoring, Address Book, Expire and Archive, Top
5608 @chapter Score of the Messages
5610 @c @cindex Kill File
5612 Scoring is the function that associates a score (value) with each
5613 message, and marks as read or deletes from the summary according to it.
5615 You can put target or important marks on essential messages, or read marks
5616 on the ones you do not want to read, for example spam articles.
5618 This scoring function has a capability and a format similar to the one
5619 that Gnus has, although there are some unsupported features and
5620 Wanderlust specifics.
5621 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5624 * Score Commands:: Score Commands
5625 * Score File Format:: Score File Format
5629 @node Score Commands, Score File Format, Scoring, Scoring
5630 @section Score Commands
5631 @cindex Score Commands
5633 @subsection Score File Specification
5635 @code{wl-score-folder-alist} specifies score files or variables in which
5636 scores are defined, corresponding to folder names.
5640 (setq wl-score-folder-alist
5649 If paths to the score files are omitted, the directory specified in the
5650 variable @code{wl-score-files-directory} is assumed.
5652 No matter what you write in @code{wl-score-folder-alist}, the default
5653 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5654 read (it does not have to exist).
5655 Therefore, in the example above, the three score files,
5656 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5657 the folders that matches @samp{^-.*}.
5659 @subsection Scored Messages
5661 Scores are attached to the messages that are specified by
5662 @code{wl-summary-score-marks} temporarily when the summary is updated;
5663 when you exit from the summary, the scores are removed and reverts to
5666 @subsection Creation of Score Files
5668 In the summary buffer, move to an appropriate message and type @kbd{L}.
5669 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5670 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5672 This makes @minus{}1000 are scored for messages with the same
5673 @samp{Subject:} as the string you entered. That is, such a score file
5674 is created automatically.
5676 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5677 The score file you just made appears.
5678 This buffer is called @dfn{score editing buffer} thereafter.
5679 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5680 as you are previously; type @kbd{a}. Then a score entry for "From"
5682 In this way, you can create a score file easily either in the summary
5683 buffer or in the score editing buffer.
5685 By the way, you might be aware the numbers of key strokes are different
5686 between @kbd{s s p} and @kbd{a}.
5687 This is determined by @code{wl-score-header-default-entry}.
5688 This variable specifies the default score entries corresponding to
5690 For example, for "subject" field, a type and a time limit are prompted,
5691 but for "from" field, they are fixed upon automatically as substring and
5692 permanent respectively.
5693 However, score values can be modified by the prefix argument.
5694 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5697 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5698 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5699 erasing contents of the buffer deletes the score file being edited.
5703 @subsubsection Selecting Score Files
5705 You can change score files to which scores are appended by
5706 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5707 @code{wl-score-change-score-file}.
5709 @subsubsection Summing Up the Score
5711 If you add the same entries by @code{wl-summary-increase-score},
5712 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5713 scores for the entry is summed up.
5715 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5716 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5717 @minus{}1200 will be created as a result.
5719 @subsubsection Creating Thread Key
5721 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5722 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5724 @subsubsection Creating Followup Key
5726 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5727 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5728 at the cursor to @samp{References} key.
5729 If @code{wl-score-auto-make-followup-entry} is non-nil,
5730 @samp{Message-ID} of all messages to be followed up within dates
5731 specified by @code{wl-score-expiry-days}.
5733 @subsection Key Bindings
5738 @findex wl-summary-increase-score
5739 Increases the score for the current message.
5740 And the score entry is appended to the score file at the same moment.
5741 You can specify the score value by a prefix argument.
5745 @findex wl-summary-lower-score
5746 Decreases the score for the current message.
5747 And the score entry is appended to the score file at the same moment.
5748 You can specify the score value by a prefix argument.
5751 @kindex h R (Summary)
5752 @findex wl-summary-rescore
5753 Re-applies the scoring.
5754 However, already scored messages are not scored anew.
5757 @kindex h c (Summary)
5758 @findex wl-score-change-score-file
5759 Changes the score file currently selected.
5762 @kindex h e (Summary)
5763 @findex wl-score-edit-current-scores
5764 Edits the score file currently selected.
5765 If there are multiple score files, the previously specified one is
5769 @kindex h f (Summary)
5770 @findex wl-score-edit-file
5771 Edits an arbitrary score file and selects it.
5774 @kindex h F (Summary)
5775 @findex wl-score-flush-cache
5776 Erases caches associated to the score files that are read.
5777 If you modified score files directly (from other than Wanderlust), you
5778 need to re-read them after erasing the cache.
5781 @kindex h m (Summary)
5782 @findex wl-score-set-mark-below
5783 Specifies the criterion for scores to be marked as read.
5784 Messages with scores less than this value are marked as read.
5787 @kindex h x (Summary)
5788 @findex wl-score-set-expunge-below
5789 Specifies the criterion for scores to be deleted from the summary.
5790 Messages with scores less than this value are deleted.
5791 "Deleted" means it is not shown; they are not removed from the summary
5792 information or the folder.
5793 The deleted messages can be shown by rescan-noscore again.
5796 @subsection Key Bindings in the Score Editing Buffer
5800 @kindex C-c C-k (Score Mode)
5801 @findex wl-score-edit-kill
5802 Abandons the file being edited.
5805 @kindex C-c C-c (Score Mode)
5806 @findex wl-score-edit-exit
5807 Saves the file being edited, and quits from the edit mode.
5810 @kindex C-c C-p (Score Mode)
5811 @findex wl-score-pretty-print
5815 @kindex C-c C-d (Score Mode)
5816 @findex wl-score-edit-insert-date
5817 Inserts the number of dates from Dec. 31, 1 B.C.
5818 It is used for creating the third factor of time-limited scores.
5821 @kindex C-c C-s (Score Mode)
5822 @findex wl-score-edit-insert-header
5823 Inserts the header of the message selected in the summary buffer.
5826 @kindex C-c C-e (Score Mode)
5827 @findex wl-score-edit-insert-entry
5828 Inserts the score entry of the message selected in the summary buffer.
5831 @subsection Customizable Variables
5834 @item wl-summary-default-score
5835 @vindex wl-summary-default-score
5836 The initial setting is 0 (zero).
5837 This variable specifies the default value of the score.
5838 The score is increased or decreased based upon this value.
5840 @item wl-summary-important-above
5841 @vindex wl-summary-important-above
5842 The initial setting is @code{nil}.
5843 Messages with scores larger than this value are attached with the
5844 important mark (@samp{$}).
5845 If @code{nil}, no important marks are attached.
5847 @item wl-summary-target-above
5848 @vindex wl-summary-target-above
5849 The initial setting is @code{nil}.
5850 Messages with scores larger than this value are attached with the target
5852 If @code{nil}, no target marks are attached.
5854 @item wl-summary-mark-below
5855 @vindex wl-summary-mark-below
5856 The initial setting is 0 (zero).
5857 Messages with scores smaller than this value are marked as read.
5859 @item wl-summary-expunge-below
5860 @vindex wl-summary-expunge-below
5861 The initial setting is @code{nil}.
5862 Messages with scores smaller than this value are deleted from the
5864 If @code{nil}, they are not deleted.
5866 @item wl-summary-score-marks
5867 @vindex wl-summary-score-marks
5868 The initial setting is the list shown below:
5872 (list wl-summary-new-mark)
5877 Messages with these marks are scored.
5879 @item wl-use-scoring
5880 @vindex wl-use-scoring
5881 The initial setting is t.
5882 If non-nil, scoring is enabled.
5884 @item wl-score-files-directory
5885 @vindex wl-score-files-directory
5886 The initial setting is @file{~/.elmo/}.
5887 The default directory for score files.
5889 @item wl-score-interactive-default-score
5890 @vindex wl-score-interactive-default-score
5891 The initial setting is 1000.
5892 This value is used as a score when a score factor is @code{nil} in the
5893 score file. It is also used in @code{wl-summary-increase-score} and
5894 @code{wl-summary-lower-score}, on condition that the value of
5895 @code{wl-score-header-default-entry} is @code{nil}.
5897 @item wl-score-expiry-days
5898 @vindex wl-score-expiry-days
5899 The initial setting is 7.
5900 This is the number of days before time-limited scores are deleted.
5902 @item wl-score-update-entry-dates
5903 @vindex wl-score-update-entry-dates
5904 The initial setting is @code{t}.
5905 If non-nil, it enables deletion of time-limited scores.
5907 @item wl-score-header-default-entry
5908 @vindex wl-score-header-default-entry
5909 Specifies the default value for each header field for score entries
5910 created by @code{wl-summary-increase-score},
5911 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5913 @item wl-score-simplify-fuzzy-regexp
5914 @vindex wl-score-simplify-fuzzy-regexp
5915 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5916 regular expression to be deleted from the string.
5917 Because this is usually used for Subject, the default is prefixes that
5918 are attached by mailing list programs.
5920 @item wl-summary-rescore-partial-threshold
5921 @vindex wl-summary-rescore-partial-threshold
5922 The initial setting is 200.
5923 When sync-all or rescan is executed, if there are messages more than
5924 this value, only the last same number of messages as this value are
5927 @item wl-summary-auto-sync-marks
5928 @vindex wl-summary-auto-sync-marks
5929 If non-nil, unread/important marks are synchronized when the summary
5931 Unread marks reflect information on the IMAP4 server.
5932 Important marks reflect information on the IMAP4 server (flagged or
5933 not), and contents of @samp{'mark} folder.
5934 The initial setting is @code{t}.
5938 @node Score File Format, , Score Commands, Scoring
5939 @section Score File Format
5940 @cindex Score File Format
5942 The format of score files are the same as Gnus, and basically you can
5943 use Gnus score files as they are. But they are not fully compatible
5944 because some keys are not supported and there are Wanderlust specifics.
5945 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5950 ("for sale" -1000 nil s)
5951 ("profit" -1000 nil s))
5953 ("spam@@spamspamspam" -10000 nil s))
5955 ("my@@address" 3001 nil s))
5957 (1000000 -10 nil >))
5967 If the key is a string, it is the name of the header to be matched.
5968 The following keys are available:
5969 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5970 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5971 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5972 @code{Chars} and @code{Lines} mean the size and the number of lines of
5973 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5974 are described later.
5975 The rest corresponds the field of the same name.
5977 Arbitrary numbers of core entries are specified after the key.
5978 Each score entry consists of these five factors:
5982 A factor that matches header. This should be a number in the cases of
5983 @code{lines} and @code{chars}, otherwise a string.
5986 A score factor. When the first item matches, the score of the message
5987 is increased or decreased by this value.
5990 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5991 of a number, the score is deleted if it does not match for days
5992 (@code{wl-score-expiry-days}) from the date specified by this.
5993 The date is since Dec. 31, 1 B.C.
5996 A type factor. This specifies the way the first factor matches.
5997 Available types depend on keys.
6000 @item From, Subject, References, Message-ID
6001 For these keys in string, @code{r} and @code{R} (regexp),
6002 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6003 as well as @code{f} and @code{F} (fuzzy) can be used.
6004 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6007 For these keys, the following five numerical relative operators can be
6008 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6011 This key matches @code{From} header, and scores all follow-ups to the
6013 For example, it would be useful for increasing scores for follow-ups to
6016 You can use the same types as @code{From} except for @code{f}.
6017 And a @samp{Followup} entry is automatically appended to the score file.
6020 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6021 A @samp{Thread} entry is automatically appended for each article that
6022 has @var{x} in the @code{References} header.
6023 You can make sure the whole thread including messages that does not have
6024 all ancestors @code{Message-ID} in @code{References} is scored.
6026 You can use the same types as @code{References} except for @code{f}.
6027 And a @samp{Thread} entry is automatically appended to the score file.
6031 A factor for extension header. This is meaningful only if the key is
6033 This specifies headers to be matched other than standard headers like
6034 @code{Subject} and @code{From}.
6035 Note that you should specify the header in
6036 @code{elmo-msgdb-extra-fields} also.
6037 Therefore it does not work in folders where extension headers cannot be
6042 The sum of these scores @emph{after all factors are applied} becomes the
6043 score of the message.
6045 @cindex Score File Atoms
6047 Messages with a score less than this value is marked as read.
6048 The default is @code{wl-summary-mark-below}.
6051 Messages with a score less than this value is deleted from the summary.
6052 The default is @code{wl-summary-expunge-below}.
6054 @item mark-and-expunge
6055 Both @code{mark} and @code{expunge} are applied,
6056 i.e. messages with a score less than this value is marked as read and
6057 deleted from the summary.
6060 Messages with a score greater than this value is attached with temp
6062 The default is @code{wl-summary-target-above}.
6065 Messages with a score greater than this value is attached with important
6067 The default is @code{wl-summary-important-above}.
6072 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6073 are used, you need to set @code{elmo-msgdb-extra-fields}.
6076 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6079 There are other restrictions as shown below:
6082 @item Because @samp{References} field in the summary information
6083 contains only the last @samp{Message-ID}, @code{references} key matches
6087 Keys that can be seen by folder of types:
6091 chars lines xref extra
6092 localdir,localnews Y E E E
6093 nntp (supporting xover) Y E E N
6099 N: cannot be seen (ignored)
6100 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6105 @node Address Book, Customization, Scoring, Top
6106 @chapter Address Book
6107 @cindex Address Book
6109 With address book, you can utilize address completion, and you have
6110 summary displayed with nicknames.
6113 * Mail Addresses:: Definition of Address Book
6114 * Address Manager:: Address Manager
6117 @node Mail Addresses, Address Manager, Address Book, Address Book
6118 @section Address book
6119 @cindex Address book Definition
6121 @cindex Alias, Address
6123 The file @file{~/.addresses} is a simple address book for Wanderlust.
6124 Make address file @file{~/.addresses}, and edit to suit your requirement.
6126 The data written in @file{~/.addresses} are used for address completion
6127 under draft editing mode. Furthermore, they are used when showing names
6128 in summary display mode. You can safely skip this section, if you don't
6129 want to customize address completion and summary display.
6130 It is possible to add/change/remove addresses from @file{~/.addresses} in
6131 summary buffer after Wanderlust is invoked. @refill
6133 The format is very simple. Like this. @refill
6138 # @r{Lines begin with @samp{#} are comment.}
6139 # @r{Empty lines are ignored}
6141 # @r{Format of each line:}
6142 # @var{email-address} "@var{nickname} "@var{realname}"
6144 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6145 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6146 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6151 One line defines one persons description.
6153 Actually, in default setup, @var{nickname} is used in summary-mode and
6154 @var{realname} is used in draft preparation mode. This behavior is
6155 better understood if you try it and confirmed the function first. You
6156 can write and try a small definition, so you will know the idea of the
6157 address book before writing a big one.
6159 And, if MH alias file is specified in variable @code{wl-alias-file},
6160 it is used as an address information in the draft preparation mode.
6162 If variable @code{wl-use-ldap} is non-nil (initial setting is
6163 @code{nil}), address completion in draft mode uses LDAP information.
6165 If you use LDAP, you have to set @code{wl-ldap-server},
6166 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6167 not have LDAP feature as built-in feature (Currently only XEmacs can
6168 have built-in LDAP feature), you have to set command exec @env{PATH} to
6169 the program @command{ldapsearch}.
6172 @node Address Manager, , Mail Addresses, Address Book
6173 @section Address Manager
6174 @cindex Address Manager
6176 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6177 the address book and insert address to draft buffer.
6179 @subsection Key Bindings
6183 @kindex t (Address Manager)
6184 @findex wl-addrmgr-set-to
6185 Add @samp{To:} mark.
6188 @kindex c (Address Manager)
6189 @findex wl-addrmgr-set-cc
6190 Add @samp{Cc:} mark.
6193 @kindex b (Address Manager)
6194 @findex wl-addrmgr-set-bcc
6195 Add @samp{Bcc:} mark.
6198 @kindex u (Address Manager)
6199 @findex wl-addrmgr-unmark
6203 @kindex x (Address Manager)
6204 @findex wl-addrmgr-apply
6206 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6207 buffer and quit address manager. When no draft buffer, make new draft
6208 with insert marked addresses.
6210 If no mark, quit address manager.
6214 @kindex q (Address Manager)
6215 @findex wl-addrmgr-quit
6216 Quit address manager.
6219 @kindex a (Address Manager)
6220 @findex wl-addrmgr-add
6224 @kindex d (Address Manager)
6225 @findex wl-addrmgr-delete
6229 @kindex e (Address Manager)
6230 @findex wl-addrmgr-edit
6235 @node Customization, Mailing List, Address Book, Top
6236 @chapter Customizing Wanderlust
6237 @cindex Customization
6240 * Living with other packages:: Cooperating with other packages
6241 * Highlights:: Highlights
6242 * Biff:: Notify Mail arrival
6243 * Advanced Settings:: Advanced Settings
6244 * Customizable Variables:: Customizable Variables
6249 @node Living with other packages, Highlights, Customization, Customization
6250 @section Living with other packages
6252 Examples with other packages.
6255 * imput:: imput (im-wl.el)
6257 * supercite:: supercite.el
6258 * mu-cite:: mu-cite.el
6259 * X-Face:: x-face,bitmap-mule
6260 * dired-dd:: dired-dd.el
6262 * Addrbook:: Addrbook
6263 * mime-w3m:: mime-w3m.el
6267 @node imput, BBDB, Living with other packages, Living with other packages
6272 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6275 If @command{imput} is on the @code{exec-path} at the installation,
6276 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6280 (autoload 'wl-draft-send-with-imput-async "im-wl")
6281 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6286 @node BBDB, supercite, imput, Living with other packages
6290 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6293 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6294 byte-compiled and installed.
6302 ;; @r{enable pop-ups}
6303 (setq bbdb-use-pop-up t)
6304 ;; @r{auto collection}
6305 (setq bbdb/mail-auto-create-p t)
6306 ;; @r{exceptional folders against auto collection}
6307 (setq bbdb-wl-ignore-folder-regexp "^@@")
6308 (setq signature-use-bbdb t)
6309 (setq bbdb-north-american-phone-numbers-p nil)
6310 ;; @r{shows the name of bbdb in the summary} :-)
6311 (setq wl-summary-from-function 'bbdb-wl-from-func)
6312 ;; @r{automatically add mailing list fields}
6313 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6314 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6318 You can complete address with BBDB by @kbd{M-@key{TAB}}
6322 @node supercite, mu-cite, BBDB, Living with other packages
6323 @subsection sc.el(supercite), sc-register.el
6327 The same setting as usual mailers should be OK. The following is an
6328 example of settings:
6332 (autoload 'sc-cite-original "supercite" nil t)
6333 (add-hook 'mail-citation-hook 'sc-cite-original)
6338 @node mu-cite, X-Face, supercite, Living with other packages
6339 @subsection mu-cite.el
6342 The same setting as usual mailers should be OK. The following is an
6343 example of settings.
6345 If you use mu-cite version 8.0 or earlier:
6349 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6350 (setq mail-citation-hook 'mu-cite/cite-original)
6354 If you use mu-cite version 8.1 or later:
6358 (autoload 'mu-cite-original "mu-cite" nil t)
6359 (add-hook 'mail-citation-hook (function mu-cite-original))
6363 @node X-Face, dired-dd, mu-cite, Living with other packages
6367 If you have installed one of the following, you can decode
6368 @samp{X-Face:} field in message buffer and you will see face image.
6371 * x-face-xmas:: XEmacs case
6372 * x-face-mule:: Emacs case
6375 If there is an encoded X-Face string in a file @file{~/.xface} (the
6376 value of the variable @code{wl-x-face-file}), it is inserted as a
6377 @samp{X-Face:} field in the draft buffer (if
6378 @code{wl-auto-insert-x-face} is non-nil).
6380 @node x-face-xmas, x-face-mule, X-Face, X-Face
6381 @subsubsection x-face-xmas (for XEmacs)
6384 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6385 1.3.6.13 or later, do the following:
6389 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6390 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6394 @node x-face-mule, , x-face-xmas, X-Face
6395 @subsubsection x-face-mule (for Emacs)
6399 If you use @file{x-face-mule.el} in bitmap-mule
6400 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6404 (autoload 'x-face-decode-message-header "x-face-mule")
6405 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6409 @subsubsection x-face-e21 (for Emacs 21.x)
6412 With Emacs 21.x, you can use @file{x-face-e21.el}
6413 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6414 to display X-Face. In this case, bitmap-mule is not required.
6419 (autoload 'x-face-decode-message-header "x-face-e21")
6420 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6425 @node dired-dd, MHC, X-Face, Living with other packages
6426 @subsection dired-dd(Dired-DragDrop)
6427 @pindex Dired-DragDrop
6429 @cindex Drag and Drop
6431 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6432 compose multi-part by simple Drag-and-Drop from dired to the draft
6433 buffer being edited in GNU Emacs (this feature is not Wanderlust
6434 specific, but general-purpose for SEMI).
6438 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6444 ;; @r{Set dired-x variables here.}
6445 ;; @r{To and flo@dots{}}
6447 (progn (require 'dired-dd)
6448 (require 'dired-dd-mime))))))
6452 @node MHC, Addrbook, dired-dd, Living with other packages
6456 Message Harmonized Calendaring system
6457 (@uref{http://www.quickhack.net/mhc/})
6459 By using MHC, you can make a calendar from the messages.
6465 (setq mhc-mailer-package 'wl)
6466 (autoload 'mhc-mode "mhc" nil t)
6467 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6468 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6476 (autoload 'mhc-wl-setup "mhc-wl")
6477 (add-hook 'wl-init-hook 'mhc-wl-setup)
6481 @node Addrbook, mime-w3m, MHC, Living with other packages
6482 @subsection wl-addrbook.el
6486 (@uref{http://www.mew.org/})
6488 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6489 @code{load-path} and do the following settings.
6493 (require 'wl-addrbook)
6498 @node mime-w3m, , Addrbook, Living with other packages
6499 @subsection mime-w3m.el
6502 You can display html part by using @file{mime-w3m.el}
6503 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6504 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6507 @node Highlights, Biff, Living with other packages, Customization
6510 @subsection Customizable Variables
6513 @item wl-summary-highlight
6514 @vindex wl-summary-highlight
6515 The initial setting is @code{t}.
6516 If non-nil, the summary is highlighted.
6518 @item wl-highlight-max-summary-lines
6519 @vindex wl-highlight-max-summary-lines
6520 The initial setting is 10000.
6521 The summary is not highlighted if it has more lines than this value.
6523 @item wl-summary-highlight-partial-threshold
6524 @vindex wl-summary-highlight-partial-threshold
6525 The initial setting is 1000.
6526 This is a threshold whether the whole summary is highlighted.
6527 If there are more lines of messages in the summary, it is partially
6530 @item wl-summary-partial-highlight-above-lines
6531 @vindex wl-summary-partial-highlight-above-lines
6532 The initial setting is 30. If there are more lines of messages than
6533 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6534 after the point that is the same number of lines as this value above the
6535 cursor line are highlighted partially. (If this value is @code{nil},
6536 the last same number of lines as the value of
6537 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6539 @item wl-highlight-body-too
6540 @vindex wl-highlight-body-too
6541 The initial setting is @code{t}.
6542 If non-nil, bodies of drafts and messages are also highlighted.
6544 @item wl-highlight-message-header-alist
6545 @vindex wl-highlight-message-header-alist
6546 When highlighting headers of drafts and messages, this variable
6547 specifies which faces are allocated to important
6548 (@code{wl-highlight-message-important-header-contents}), secondly
6549 important (@code{wl-highlight-message-important-header-contents2}), and
6550 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6552 Similarly, it can be used for allocating arbitrary faces to arbitrary
6553 regular expressions.
6555 @item wl-highlight-citation-prefix-regexp
6556 @vindex wl-highlight-citation-prefix-regexp
6557 Specifies a regular expression to which quoted lines in bodies of
6558 drafts and messages match.
6559 Bodies matching to this regular expression are highlighted by the faces
6560 specified by (@code{wl-highlight-message-cited-text-*}).
6562 @item wl-highlight-highlight-citation-too
6563 @vindex wl-highlight-highlight-citation-too
6564 The initial setting is @code{nil}.
6565 If non-nil, the quoting regular expression itself given by
6566 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6568 @item wl-highlight-citation-header-regexp
6569 @vindex wl-highlight-citation-header-regexp
6570 Specifies a regular expression that denotes beginning of quotation.
6571 Bodies matching to this regular expression are highlighted by the face
6572 specified by @code{wl-highlight-message-headers}.
6574 @item wl-highlight-max-header-size
6575 @vindex wl-highlight-max-header-size
6576 The initial setting is @code{nil}. If a header size is larger than this
6577 value, it will not be highlighted. If @code{nil}, always highlighted
6578 (ignore header size).
6580 @item wl-highlight-max-message-size
6581 @vindex wl-highlight-max-message-size
6582 The initial setting is 10000.
6583 If a message is larger than this value, it will not be highlighted.
6584 With this variable, highlight is suppressed for uuencode or huge digest
6587 @item wl-highlight-signature-separator
6588 @vindex wl-highlight-signature-separator
6589 Specifies regular expressions that denotes the boundary of a signature.
6590 It can be a regular expression, or a list of ones.
6591 Messages after the place that matches this regular expression are
6592 highlighted by the face specified by
6593 @code{wl-highlight-message-signature}.
6595 @item wl-max-signature-size
6596 @vindex wl-max-signature-size
6597 The initial setting is 400.
6598 This is the largest size for a signature to be highlighted.
6600 @item wl-use-highlight-mouse-line
6601 @vindex wl-use-highlight-mouse-line
6602 The initial setting is @code{t}.
6603 If non-nil, the line pointed by the mouse is highlighted in the folder
6604 mode, summary mode, and the like.
6607 @subsection Setting Colors and Fonts of the Characters
6609 If you want to change colors or fonts of the characters, you need to
6610 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6611 want to change fonts, and @code{set-face-foreground} for colors, and so
6612 on. You cannot write face settings in @file{.emacs}; write in
6615 For example, if you want to change the color for signatures to yellow,
6619 (set-face-foreground 'wl-highlight-message-signature "yellow")
6625 Faces defined in Wanderlust:
6628 @item wl-highlight-message-headers
6629 The face for field names of message headers.
6631 @item wl-highlight-message-header-contents
6632 The face for field bodies of message headers.
6634 @item wl-highlight-message-important-header-contents
6635 The face for important parts of message headers.
6636 Per default, this face is used for a body of @samp{Subject:} field.
6637 You can change its value by editing
6638 @code{wl-highlight-message-header-alist}.
6640 @item wl-highlight-message-important-header-contents2
6641 The face for secondly important parts of message headers.
6642 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6643 fields. You can change its value by editing
6644 @code{wl-highlight-message-header-alist}.
6646 @item wl-highlight-message-unimportant-header-contents
6647 The face for unimportant parts of message headers.
6648 Per default, this face is used for bodies of @samp{X-} fields
6649 @samp{User-Agent:} fields. You can change its value by editing
6650 @code{wl-highlight-message-header-alist}.
6652 @item wl-highlight-message-citation-header
6653 The face for headers of quoted messages.
6655 @item wl-highlight-message-cited-text-*
6656 The face for texts of quoted messages. The last @samp{*} is a
6657 @var{single figure} so that 10 different colors can be used according to
6660 @item wl-highlight-message-signature
6661 The face for signatures of messages. The initial settings are
6662 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6663 dark background colors.
6665 @item wl-highlight-header-separator-face
6666 The face for header separators of draft messages.
6668 @item wl-highlight-summary-important-face
6669 The face for message lines with important marks in the summary.
6671 @item wl-highlight-summary-new-face
6672 The face for message lines with new marks in the summary.
6674 @item wl-highlight-summary-displaying-face
6675 The face for the message line that is currently displayed.
6676 This face is overlaid.
6678 @item wl-highlight-thread-indent-face
6679 The face for the threads that is currently displayed.
6681 @item wl-highlight-summary-unread-face
6682 The face for message lines with unread marks in the summary.
6684 @item wl-highlight-summary-deleted-face
6685 The face for message lines with delete marks in the summary.
6687 @item wl-highlight-summary-refiled-face
6688 The face for message lines with re-file marks in the summary.
6690 @item wl-highlight-refile-destination-face
6691 The face for re-file information part of message lines with re-file
6692 marks in the summary.
6694 @item wl-highlight-summary-copied-face
6695 The face for message lines with copy marks in the summary.
6697 @item wl-highlight-summary-target-face
6698 The face for message lines with target marks @samp{*} in the summary.
6700 @item wl-highlight-summary-thread-top-face
6701 The face for message lines that are on the top of the thread in the
6704 @item wl-highlight-summary-normal-face
6705 The face for message lines that are not on top of the thread in the
6708 @item wl-highlight-folder-unknown-face
6709 The face for folders that are not known to have how many unsync messages
6712 @item wl-highlight-folder-zero-face
6713 The face for folders that have no unsync messages in the folder mode.
6715 @item wl-highlight-folder-few-face
6716 The face for folders that have some unsync messages in the folder mode.
6718 @item wl-highlight-folder-many-face
6719 The face for folders that have many unsync messages in the folder mode.
6720 The boundary between `some' and `many' is specified by the variable
6721 @code{wl-folder-many-unsync-threshold}.
6723 @item wl-highlight-folder-unread-face
6724 The face for folders that have no unsync but unread messages in the
6727 @item wl-highlight-folder-killed-face
6728 The face for folders that are deleted from the access group in the
6731 @item wl-highlight-folder-opened-face
6732 The face for open groups in the folder mode.
6733 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6734 @code{nil} or a @var{number}.
6736 @item wl-highlight-folder-closed-face
6737 The face for close groups in the folder mode.
6738 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6739 @code{nil} or a @var{number}.
6741 @item wl-highlight-folder-path-face
6742 The face for the path to the currently selected folder in the folder
6745 @item wl-highlight-logo-face
6746 The face for logo in the demo.
6748 @item wl-highlight-demo-face
6749 The face for strings (for example, a version number) in the demo.
6753 @node Biff, Advanced Settings, Highlights, Customization
6754 @section Notify Mail arrival
6757 Following setting is to notify mail arrival of @samp{%inbox}
6758 by the indicator on the modeline
6761 (setq wl-biff-check-folder-list '("%inbox"))
6764 @subsection Customizable Variables
6766 @item wl-biff-check-folder-list
6767 @vindex wl-biff-check-folder-list
6768 The initial setting is @code{nil}.
6769 This is the list of folders to check mail arrival.
6770 If @code{nil}, wl doesn't check mail arrival.
6772 @item wl-biff-check-interval
6773 @vindex wl-biff-check-interval
6774 The initial setting is 40 (in seconds).
6775 Check mail arrival in this period.
6777 @item wl-biff-notify-hook
6778 @vindex wl-biff-notify-hook
6779 This hook is run at the arrival of new mail.
6780 To beep with mail arrival(initial setting), set as follows.
6782 (setq wl-biff-notify-hook '(ding))
6784 For silence, set to @code{nil}.
6788 @node Advanced Settings, Customizable Variables, Biff, Customization
6789 @section Advanced Settings
6792 * Draft for Reply:: Draft for Reply
6793 * Thread Format:: Appearance of Thread
6794 * User-Agent Field:: @samp{User-Agent:} Header Field
6798 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6799 @subsection Draft for Replay
6800 @vindex wl-draft-reply-with-argument-list
6801 @vindex wl-draft-reply-without-argument-list
6802 @vindex wl-draft-reply-myself-with-argument-list
6803 @vindex wl-draft-reply-myself-without-argument-list
6805 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
6806 The addressee for the draft is decided by following rules.
6808 For example, you can set as follows:
6812 (setq wl-draft-reply-without-argument-list
6813 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6814 ("Followup-To" . (nil nil ("Followup-To")))
6815 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6816 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6820 Where each element of the list @code{wl-draft-reply-without-argument-list}
6824 (key . (to-list cc-list newsgroup-list))
6827 and if the field designated by @samp{key} exist in the parent message,
6828 parent's field values designated by @samp{to-list} are copied to @samp{To:}
6829 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
6830 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
6831 the draft respectively.
6836 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6839 Match if the parent has @samp{Mail-Followup-To} field.
6840 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
6841 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
6845 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6848 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
6849 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
6852 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
6855 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
6856 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
6859 These are evaluated in order and first matched one is used.
6861 Moreover, the behavior of @kbd{a} with prefix argument can
6862 be directed by @code{wl-draft-reply-with-argument-list} as well.
6864 By the way, you can use some function (will be evaluated in the parent
6865 message buffer) in the place of @samp{key} or @samp{to-list} etc.
6866 For example, if you only want to reply to mailing lists in
6867 @code{wl-subscribed-mailing-list} if the parent has some of them,
6872 (defun wl-mailing-list-addresses ()
6876 (nth 1 (std11-extract-address-components addr)))
6879 (elmo-multiple-fields-body-list (list "To" "Cc"))
6881 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
6882 (setq list-addrs (cons to list-addrs))))
6883 (nreverse list-addrs)))
6885 (setq wl-draft-reply-with-argument-list
6886 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
6887 ("Reply-To" . (("Reply-To") nil nil))
6888 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
6889 ("From" . (("From") nil nil))))
6894 Note: To set the behavior when you reply to the message written by yourself,
6895 use @code{wl-draft-reply-myself-without-argument-list} and
6896 @code{wl-draft-reply-myself-with-argument-list} instead of them.
6898 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6899 @subsection Appearance of Threads
6903 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6904 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6905 391 09/18(Fri)19:24 +-[ Murata-san ]
6906 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6907 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6908 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6909 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6910 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6911 412 09/22(Tue)09:28 | +-[ Teranishi ]
6912 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6913 416 09/22(Tue)12:38 | +-[ Teranishi ]
6914 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6915 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6919 Settings to make appearance of threads like shown above:
6923 (setq wl-thread-indent-level 2)
6924 (setq wl-thread-have-younger-brother-str "+")
6925 (setq wl-thread-youngest-child-str "+")
6926 (setq wl-thread-vertical-str "|")
6927 (setq wl-thread-horizontal-str "-")
6928 (setq wl-thread-space-str " ")
6932 If you do not want to see branches, do the following:
6936 (setq wl-thread-indent-level 2)
6937 (setq wl-thread-have-younger-brother-str " ")
6938 (setq wl-thread-youngest-child-str " ")
6939 (setq wl-thread-vertical-str " ")
6940 (setq wl-thread-horizontal-str " ")
6941 (setq wl-thread-space-str " ")
6946 @node User-Agent Field, , Thread Format, Advanced Settings
6947 @subsection User-Agent Field
6951 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6952 @samp{User-Agent:} fields, define a function that generate appropriate
6953 strings as you like, and set it to variable
6954 @code{wl-generate-mailer-string-function}.
6956 If you do not want verbose @samp{User-Agent:} field, do the following:
6960 (setq wl-generate-mailer-string-function
6963 (concat "User-Agent: "
6964 (wl-generate-user-agent-string-1 nil)))))
6968 The following is a example:
6972 (setq mime-edit-insert-user-agent-field nil)
6973 (setq wl-generate-mailer-string-function
6976 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6981 @node Customizable Variables, Hooks, Advanced Settings, Customization
6982 @section Customizable Variables
6984 Customizable variables that have not been described yet:
6987 @item wl-default-folder
6988 @vindex wl-default-folder
6989 The initial setting is @samp{%inbox}. This is the default value for moving to
6990 a folder and the like.
6992 @item wl-draft-folder
6993 @vindex wl-draft-folder
6994 The initial setting is @samp{+draft}. It is the folder to which drafts are
6995 saved. It must be a localdir folder.
6997 @item wl-trash-folder
6998 @vindex wl-trash-folder
6999 The initial setting is @samp{+trash}. It is the wastebasket folder.
7000 If you changed this variable, you had better restart Wanderlust.
7002 @item wl-interactive-exit
7003 @vindex wl-interactive-exit
7004 The initial setting is @code{t}.
7005 If non-nil, you are asked for confirmation when Wanderlust terminates.
7007 @item wl-interactive-send
7008 @vindex wl-interactive-send
7009 The initial setting is @code{t}.
7010 If non-nil, you are asked for confirmation when mail is sent.
7012 @item wl-folder-sync-range-alist
7013 @vindex wl-folder-sync-range-alist
7014 The initial setting is the alist shown below:
7019 ("^\\+draft$\\|^\\+queue$" . "all"))
7024 This is an associative list of regular expressions of folder names and
7025 update range of the summary. Update range is one of the @samp{all},
7026 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
7027 @samp{last}. If a folder do not match, @samp{update} is used.
7030 @vindex wl-ask-range
7031 The initial setting is @code{t}.
7032 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7033 for updating the summary when you changed folders.
7035 @item wl-mime-charset
7036 @vindex wl-mime-charset
7037 The initial setting is @code{x-ctext}.
7038 This is the MIME charset for messages that are not MIME (e.g. without
7039 @samp{Content-Type:}). This value also used as default charset for
7040 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7041 this value as @code{iso-2022-jp}.)
7043 @item wl-highlight-folder-with-icon
7044 @vindex wl-highlight-folder-with-icon
7045 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7046 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7048 @item wl-strict-diff-folders
7049 @vindex wl-strict-diff-folders
7050 This is a list of regular expressions of folders.
7051 Unread messages are checked, for example when you press @kbd{s} in
7052 the folder mode, usually in a brief way (rapidly processed but not
7054 The folders matching this variable are seriously checked.
7055 You may want to set this variable so as to match conditional filter
7056 folders for IMAP4 folders.
7057 The initial setting is @code{nil}.
7059 @item wl-folder-use-server-diff
7060 @vindex wl-folder-use-server-diff
7061 When unread messages are checked, for example when you press @kbd{s} in
7062 the folder mode, usually (the number of messages on the server) @minus{}
7063 (the number of local messages) will be the number of unread messages.
7064 However, if this variable is non-nil, the number of unread messages on
7065 the server is checked. This affects IMAP4 folders only, but IMAP4
7066 folders in mail boxes matching
7067 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7068 the number of unread messages on the server, even if they matches this
7069 variable. The initial setting is @code{t}.
7071 @item wl-auto-check-folder-name
7072 @vindex wl-auto-check-folder-name
7073 The initial setting is @code{nil}.
7074 You can specify a folder or a group which is checked for unread message
7075 at the start. You can also specify a list of folders (groups) to be checked.
7076 If the value is @code{nil}, whole Desktop is checked at the start.
7077 If it is @code{none}, no folders are checked.
7079 @item wl-auto-uncheck-folder-list
7080 @vindex wl-auto-uncheck-folder-list
7081 The initial setting is the list shown below:
7090 You can set a list of regular expressions to specify folders
7091 which are not automatically checked even if they are included
7092 in some groups assigned by @code{wl-auto-check-folder-name}.
7094 @item wl-auto-check-folder-list
7095 @vindex wl-auto-check-folder-list
7096 The initial setting is @code{nil}.
7097 You can set a list of regular expressions to specify exceptions
7098 for @code{wl-auto-uncheck-folder-list}.
7100 @item wl-no-save-folder-list
7101 @vindex wl-no-save-folder-list
7102 The initial setting is the list shown below:
7111 This is a list of regular expressions of folders not to be saved.
7113 @item wl-save-folder-list
7114 @vindex wl-save-folder-list
7115 The initial setting is @code{nil}.
7116 This is a list of regular expressions of folders to be saved.
7117 This takes precedence over @code{wl-no-save-folder-list}.
7119 @item wl-folder-mime-charset-alist
7120 @vindex wl-folder-mime-charset-alist
7121 The initial setting is the alist shown below:
7125 (("^-alt\\.chinese" . big5)
7126 ("^-relcom\\." . koi8-r)
7128 ("^-han\\." . euc-kr))
7133 This is an associative list of regular expressions of folder names and
7135 If a folder do not match, @code{wl-mime-charset} is used.
7137 @item wl-folder-init-load-access-folders
7138 @vindex wl-folder-init-load-access-folders
7139 The initial setting is @code{nil}.
7140 This is a list of access groups to be loaded specifically at the start.
7141 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7143 @item wl-folder-init-no-load-access-folders
7144 @vindex wl-folder-init-no-load-access-folders
7145 The initial setting is @code{nil}.
7146 This is a list of access groups not to be loaded specifically at the
7148 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7150 @item wl-delete-folder-alist
7151 @vindex wl-delete-folder-alist
7152 The initial setting is the alist shown below:
7161 This list determines disposition of messages with delete marks.
7162 Each item in the list is a folder and destination; you can specify any
7163 one of the following in the place of destination:
7166 @code{remove} or @code{null} : deletes the messages instantly.
7167 string : moves the messages to the specific folder.
7168 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7171 @item wl-refile-policy-alist
7172 @vindex wl-refile-policy-alist
7173 The initial setting is the list shown below:
7183 This list determines whether messages with re-file marks are moved or
7184 copied. Each item in the list is a cons cell of a folder and
7185 @code{copy} or @code{move}.
7187 @item wl-x-face-file
7188 @vindex wl-x-face-file
7189 The initial setting is @file{~/.xface}.
7190 The name of the file that contains encoded X-Face strings.
7193 @item wl-demo-display-logo
7194 @vindex wl-demo-display-logo
7195 If non-nil, bitmap image is shown on the opening demo. If you set
7196 @code{xpm} or @code{xbm}, (if possible) display selected image type
7199 @item elmo-use-database
7200 @vindex elmo-use-database
7201 This is meaningful for XEmacs only. The initial setting depends on
7202 XEmacs (@code{t} for XEmacs with dbm).
7203 If non-nil, Message-ID is controlled by dbm.
7205 @item elmo-passwd-alist-file-name
7206 @vindex elmo-passwd-alist-file-name
7207 The initial setting is @file{passwd}.
7208 This is the name of the file in which passwords are saved.
7209 @code{elmo-passwd-alist-save} saves current passwords to the file.
7211 @item elmo-nntp-list-folders-use-cache
7212 @vindex elmo-nntp-list-folders-use-cache
7213 The initial setting is 600 (in seconds).
7214 This is period in seconds during which results of @samp{list} and
7215 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7218 @item elmo-nntp-max-number-precedes-list-active
7219 @vindex elmo-nntp-max-number-precedes-list-active
7220 The initial setting is @code{nil}.
7221 If non-nil, the number of article obtained by @samp{list active} in NNTP
7222 are used as the maximum article number of the folder.
7223 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7224 and if the number of read messages is not correct.
7226 @item elmo-nntp-default-use-listgroup
7227 @vindex elmo-nntp-default-use-listgroup
7228 The initial setting is @code{t}.
7229 If non-nil, @samp{listgroup} is used for checking the total number of
7230 articles. If it is @code{nil}, @samp{group} is used. In the latter
7231 case, the processing will be a little faster at the sacrifice of
7234 @item elmo-pop3-send-command-synchronously
7235 @vindex elmo-pop3-send-command-synchronously
7236 The initial setting is @code{nil}.
7237 If non-nil, POP3 commands are issued synchronously. Some implementation
7238 of POP3 server fails to get summary information without this setting.
7239 You may have to set this variable to @code{t}, if the process hangs
7240 while looking up POP3.
7242 @item elmo-dop-flush-confirm
7243 @vindex elmo-dop-flush-confirm
7244 The initial setting is @code{t}.
7245 If non-nil, you are asked for confirmation if accumulated off-line
7246 operations are executed.
7248 @item elmo-display-progress-threshold
7249 @vindex elmo-display-progress-threshold
7250 The initial setting is 20.
7251 Threshold for display of progress gauge. If number of renewal is more than
7252 this value, display progress gauge.
7256 @node Hooks, , Customizable Variables, Customization
7262 @node Mailing List, Addition, Customization, Top
7263 @chapter Wanderlust Mailing List
7267 Topics related to Wanderlust are discussed in following mailing lists.
7268 The latest version is also announced there.
7271 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7274 In this list Japanese is mainly used for discussion. We also have a list
7275 for discussion in English:
7278 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7280 (Messages posted to this list are also forwarded to the former one.)
7282 A guide can be obtained automatically by sending mail to
7283 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7284 the English one) with the body
7290 Please send bug reports or patches to one of those lists. You can post to
7291 the mailing list even though you are not a member of it.
7293 If you send a bug report, please attach Backtrace with it.
7294 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7297 I would like to express my thanks to the members of the mailing list for
7298 valuable advice and many pieces of code they contributed.
7301 @node Addition, Index, Mailing List, Top
7302 @chapter Additional Information
7304 @section Brief History
7307 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7308 3/10 Made a msgdb mechanism by elisp.
7309 3/26 IMAP and NNTP can be displayed in threads.
7310 4/13 Began to assemble thread display modules as elmo.
7311 5/01 Finished 0.1.0, initial version with many defects.
7312 6/12 I made a slip of the tongue and said I was writing elisp
7313 mailer supporting IMAP
7314 6/16 0.1.3 was announced at tm-ja, elisp ML.
7315 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7316 7/01 Support for mm-backend (0.3.0).
7317 8/25 multi folder added (0.5.0).
7318 8/28 filter folder added (0.5.1).
7319 9/10 You can open/close threads (0.6.0).
7320 9/11 fldmgr by Murata-san made editing folders easy.
7321 9/18 lha folders added by Okunishi-san (0.6.3).
7322 9/24 Display of branches of threads (0.6.5).
7323 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7324 10/28 Off-line operations (0.7.4).
7325 12/09 Becomes beta version.
7326 12/21 wl-expire by Murata-san.
7327 1999 2/03 auto-refile by Tsumura-san.
7328 4/28 wl-template by Murata-san.
7329 5/18 Released 1.0.0 stable.
7330 7/05 Scoring by Murata-san (2.1.0).
7331 9/26 New plugged system by Murata-san (2.2.2).
7332 12/20 Support Modified UTF7.
7333 2000 3/24 Released 1.1.0 stable.
7334 4/03 CVS development started.
7335 5/07 Thread restoration & Its speed up with Murata-san.
7336 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7337 7/11 killed message feature.
7338 7/18 Use UIDL in POP3.
7339 9/12 biff feature with Satata-san & Yamaoka-san.
7340 10/17 expire-hide by Okada-san.
7341 11/08 Released 2.4.0 stable.
7342 2001 7/04 Released 2.6.0 stable.
7343 8/21 wl-addrmgr by Kitamoto-san.
7344 12/27 Released 2.8.1 stable.
7347 See @file{ChangeLog} for details.
7351 According to a dictionary, Wanderlust has the meaning:
7355 n eager longing for or impulse towards travelling in distant lands
7356 [Ger, fr wandern to wander + lust desire, pleasure]
7360 but I had no profound intention. (if farfetched, IMAP @result{} you can
7361 read mail anywhere @result{} desire to wander ?)
7363 Elmo is the abbreviation of @samp{Elisp Library for Message
7364 Orchestration}. At first I meant the red puppet in the Sesame Street,
7365 but you may associate it with Wandering @result{} Drifting @result{}
7366 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7370 Each versions has code names (they are almost jokes).
7371 Currently they are picked up alphabetically from the top 40 hits of
7372 U.S. Billboard magazines in 1980s.
7374 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7377 @node Index, , Addition, Top
7381 * Concept Index:: Concept Index
7382 * Key Index:: Key Index
7383 * Variable Index:: Variable Index
7384 * Function Index:: Function Index
7387 @node Concept Index, Key Index, Index, Index
7388 @unnumberedsec Concept Index
7391 @node Key Index, Variable Index, Concept Index, Index
7392 @unnumberedsec Key Index
7395 @node Variable Index, Function Index, Key Index, Index
7396 @unnumberedsec Variable Index
7399 @node Function Index, , Variable Index, Index
7400 @unnumberedsec Function Index