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 With prefix argument, enter the sticky summary.
1788 If the cursor is on the top of folder group line,
1789 the folder group is opened or closed.
1790 When the cursor is on the access group and this command is called
1791 with prefix argument, folder children list is updated to the newest one.
1792 (Children list is updated recursively if the access folder has hierarchical
1794 (@code{wl-folder-jump-to-current-entity})
1797 @kindex M-@key{RET} (Folder)
1798 @findex wl-folder-update-recursive-current-entity
1799 Folder children list of the access group at the current cursor point
1800 is updated to the newest one.
1801 (Children list is updated recursively if the access folder has hierarchical
1803 (@code{wl-folder-update-recursive-current-entity})
1808 Create a new draft message.
1813 @findex wl-folder-write-current-folder
1814 If the current cursor point is on the NNTP folder, create a new draft
1815 message which already has @samp{Newsgroups:} field. If the current
1816 cursor point is on the folder for mailing list (refile destination),
1817 create a new draft message which already has @samp{To:} field with
1818 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1820 (@code{wl-folder-write-current-folder})
1823 @kindex C-c C-o (Folder)
1824 @findex wl-jump-to-draft-buffer
1825 Move to the draft buffer if available. If multiple draft buffer exists,
1826 moved to one after another. If prefix argument is specified, load draft
1827 folder's message to the draft buffer and jump to it.
1828 (@code{wl-jump-to-draft-buffer})
1832 @findex wl-folder-check-current-entity
1833 Update new and unread number information of the folder at the current
1835 (@code{wl-folder-check-current-entity})
1839 @findex wl-folder-sync-current-entity
1840 Update summary information of the folder at the current cursor point.
1841 (@code{wl-folder-sync-current-entity})
1844 @kindex r s (Folder)
1845 @findex wl-folder-check-region
1846 Update new and unread number information of the folders in the currently
1848 (@code{wl-folder-check-region})
1851 @kindex r S (Folder)
1852 @findex wl-folder-sync-region
1853 Update summary information of the folders in the currently selected region.
1854 (@code{wl-folder-sync-region})
1858 @findex wl-status-update
1859 Sync up address book status with @file{~/.addresses}'s content.
1860 (@code{wl-status-update})
1864 @findex wl-folder-prev-unread
1865 Jump cursor to the folder which have unread messages on the upward from
1866 current cursor point.
1867 (@code{wl-folder-prev-unread})
1871 Jump cursor to the folder which have unread messages on the downward
1872 from current cursor point.
1873 (@code{wl-folder-next-unread})
1877 Move cursor to the folder on the previous line.
1878 (@code{wl-folder-prev-entity})
1882 Move cursor to the folder on the next line.
1883 (@code{wl-folder-next-entity})
1887 Jump to the folder specified by the user input.
1888 (@code{wl-folder-jump-folder})
1892 @findex wl-folder-prefetch-current-entity
1893 Prefetch new messages of the folder at the current cursor point by
1894 @code{wl-summary-incorporate}.
1895 If the cursor is on the folder group, it is executed recursively.
1896 (@code{wl-folder-prefetch-current-entity})
1900 @findex wl-folder-mark-as-read-all-current-entity
1901 Mark all unread messages of the folder at the current cursor point as read.
1902 If the cursor is on the folder group, it is executed recursively.
1903 (@code{wl-folder-mark-as-read-all-current-entity})
1907 @findex wl-folder-goto-first-unread-folder
1908 Enter summary mode of the first unread folder.
1909 (@code{wl-folder-goto-first-unread-folder})
1913 @findex wl-folder-empty-trash
1915 (@code{wl-folder-empty-trash})
1919 @findex wl-folder-flush-queue
1921 (@code{wl-folder-flush-queue})
1925 @findex wl-folder-virtual
1926 Move to the virtual folder with the condition specified.
1927 (@code{wl-folder-virtual})
1931 @findex wl-folder-pick
1932 Search the folders with the condition specified.
1933 (@code{wl-folder-pick})
1937 @findex wl-folder-open-all-unread-folder
1938 All unread folder is opened.
1939 (@code{wl-folder-open-all-unread-folder})
1943 @findex wl-folder-open-close
1944 Folder group is opened/closed.
1945 (@code{wl-thread-open-close})
1949 All folder group is opened.
1950 (@code{wl-folder-open-all})
1954 All folder group is closed.
1955 (@code{wl-folder-close-all})
1965 (@code{wl-folder-suspend})
1968 @kindex M-s (Folder)
1969 Save current folder status.
1973 @kindex M-t (Folder)
1974 Toggle Wanderlust's offline/online status.
1975 (@code{wl-toggle-plugged})
1978 @kindex C-t (Folder)
1979 Start Wanderlust's plug-status manager.
1980 (@code{wl-plugged-change})
1983 @subsection Customize variables
1986 @item wl-folders-file
1987 @vindex wl-folders-file
1988 The initial setting is @file{~/.folders}.
1989 Subscribed folders are described (saved) in this file.
1991 @item wl-folder-info-save
1992 @vindex wl-folder-info-save
1993 The initial setting is @code{t}. If non-nil, unread information is
1994 saved and used in the next Wanderlust session.
1996 @item wl-stay-folder-window
1997 @vindex wl-stay-folder-window
1998 The initial setting is @code{nil}.
1999 If non-nil, summary window is appeared on the right side of the folder buffer.
2001 @item wl-folder-window-width
2002 @vindex wl-folder-window-width
2003 The initial setting is 20.
2004 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2006 @item wl-folder-use-frame
2007 @vindex wl-folder-use-frame
2008 The initial setting is @code{nil}.
2009 If non-nil, use new frame for the folder window.
2011 @item wl-folder-many-unsync-threshold
2012 @vindex wl-folder-many-unsync-threshold
2013 The initial setting is 70.
2014 If the number of unread messages is more than this value,
2015 folder color is changed.
2017 @item wl-highlight-folder-by-numbers
2018 @vindex wl-highlight-folder-by-numbers
2019 This option controls how to highlight each line in the folder buffer.
2020 The default value is @code{t}, highlighting with various colors based on
2021 the message numbers. If it is @code{nil}, highlighting with various
2022 colors based on the folder status. In addition, if it is a number
2023 (e.g. 1), highlighting will be done based on both the message numbers
2024 and the folder status.
2026 @item wl-folder-desktop-name
2027 @vindex wl-folder-desktop-name
2028 The initial setting is @samp{Desktop}.
2029 The name of top folder group.
2031 @item wl-folder-petname-alist
2032 @vindex wl-folder-petname-alist
2033 The initial setting is @code{nil}.
2034 An alist of folder's realname and its nickname.
2036 @item wl-folder-access-subscribe-alist
2037 @vindex wl-folder-access-subscribe-alist
2038 The initial setting is @code{nil}.
2040 Control automatic subscribing and unsubscribing of the children list
2046 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2050 If @var{subscribe-flag} is non-nil, folders which have name matched to
2051 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2052 already unsubscribed folder is not displayed even when the
2053 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2060 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2061 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2062 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2063 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2067 @item wl-folder-hierarchy-access-folders
2068 @vindex wl-folder-hierarchy-access-folders
2069 The initial setting is the list shown below:
2078 A list of regular expressions for access groups which creates children
2079 folder list hierarchically.
2081 For example, if you specify
2082 @code{wl-folder-hierarchy-access-folders} like following,
2086 (setq wl-folder-hierarchy-access-folders
2087 '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
2092 such access group hierarchy is obtained.
2098 -fj.comp.announce:0/0/2
2099 -fj.comp.dev.cdrom:0/0/0
2101 [+]-japan:238/238/1688
2104 -comp.unix.admin:0/0/0
2105 -comp.unix.dos-under-unix:0/0/0
2106 -comp.unix.programmer:0/0/0
2107 [-]-comp.unix.bsd:0/0/23
2108 -comp.unix.bsd.freebsd.announce:0/0/0
2113 If you opened @samp{-} in this example, only the direct children is created
2114 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2115 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2116 is not created until the children access group is opened.
2120 @node Folder Manager, , Selecting Folder, Folder
2121 @section Editing Folders
2122 @cindex Folder Manager
2123 @cindex Folder, Edit
2124 @cindex Folder, Subscribe
2125 @cindex Folder, Unsubscribe
2127 As described before, subscribed folder list is saved in @file{~/.folders} file.
2128 But you don't have to edit @file{~/.folders} directly.
2129 You can append, delete, edit folders from folder mode.
2131 @subsection Usage (Tips)
2133 @subsubsection Append Folder
2135 @kbd{m a} appends new folder to the folder mode.
2136 @kbd{m g} appends new folder group.
2137 To append new folder to this group, firstly open it,
2138 then execute append command in the next line.
2140 @subsubsection Edit Folder
2142 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2143 Thus, you can change folder position as if you were editing a normal file.
2145 @subsubsection Create Multi Folder.
2149 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2151 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2153 Type @kbd{m m}, then you can create multi folder.
2156 @subsubsection Delete Nickname, Filter
2158 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2159 minibuffer while appending.
2161 @subsubsection Append Folder to Empty Group
2163 To append new folder to the empty folder group
2164 (after you create folder group by typing @kbd{m g}),
2165 firstly open it, then execute append command in the next line.
2166 If it is closed, folder is appended on the same level with
2167 the above folder group. It is difficult to explain by words so try it.
2168 In other words, appended position depends on the
2169 above folder group's open/close status.
2171 @subsubsection Charset of the Folders File.
2173 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2175 @subsubsection Create Filter
2177 @kbd{m f} adds filter to the folder at the current cursor point. To
2178 create new filter folder and leave the current folder unchanged, copy it
2179 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2180 filter can be specified while appending filter. If you put
2181 ``''(@var{NULL}), filter is deleted.
2183 @subsubsection Sort Folders
2185 Sorting of the folders is executed by the function specified by
2186 @code{wl-fldmgr-sort-function}.
2187 The initial setting is @code{wl-fldmgr-sort-standard},
2188 which sorts alphabetically.
2189 Sorting affects only on the current folder group. It does not
2190 affect on the child groups.
2192 @subsubsection Hiding Folders in the Access Group
2194 Usually, access group displays all children folders, but you can set
2195 some folders hidden. Following operations are only available on access
2198 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2199 (subscribe/unsubscribe) of the folder at current cursor point. Against
2200 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2203 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2204 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2205 argument and if the argument has positive number, the unsubscribe it.
2206 If the prefix argument has negative value, folder becomes visible and if
2207 zero, folder visibility is toggled.
2209 The other commands, @code{wl-fldmgr-subscribe} and
2210 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2213 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2214 executed in the access group, they have a same effect with
2215 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2216 The difference is that cut commands deletes folders from the current
2219 @subsubsection Operations in the Access Group
2221 You can insert and delete folders in the access group like usual folder
2222 group. But insert and delete commands can be only available for the
2223 children folders of the access group and they only sets the subscribe
2224 status. In other words, insertion of the folder means subscribing,
2225 deletion means unsubscribing.
2226 @footnote{In the current implementation,
2227 it is faster to delete region than to unsubscribe region.}
2229 To update the access group when children folders are inserted or deleted
2230 by other way (other than Wanderlust),
2231 open the access group by typing @kbd{C-u @key{RET}}.
2232 @xref{Selecting Folder}.
2234 The order of children folders of access group is saved after
2235 insertion/deletion/sorting.
2236 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2237 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2238 newly created folders are inserted on the top of the access group.
2240 @subsection Key bindings
2241 @cindex Keybind, Folder Mode
2242 @cindex Keybind, Folder Buffer
2244 Key bindings on the folder mode related to folder editing are shown below.
2245 All bindings starts with @kbd{m}, and primary commands are binded to
2246 one stroke key binding.
2250 @kindex m a (Folder)
2251 @findex wl-fldmgr-add
2253 (@code{wl-fldmgr-add})
2258 @kindex m g (Folder)
2259 @findex wl-fldmgr-make-group
2260 Create a folder group.
2261 (@code{wl-fldmgr-make-group})
2264 @kindex m A (Folder)
2265 @findex wl-fldmgr-make-access-group
2266 Create an access group.
2267 (@code{wl-fldmgr-make-access-group})
2270 @kindex m d (Folder)
2271 @findex wl-fldmgr-delete
2272 Delete folder itself and msgdb.
2273 If the folder itself cannot be deleted like NNTP folder,
2274 only msgdb is deleted.
2275 (@code{wl-fldmgr-delete})
2280 @kindex m R (Folder)
2281 @findex wl-fldmgr-rename
2282 Change the name of folder or folder group.
2283 msgdb's path is also changed.
2284 (@code{wl-fldmgr-rename})
2290 @findex wl-fldmgr-make-multi
2291 Create a multi folders in the cutlist (cut, copied folders).
2292 (@code{wl-fldmgr-make-multi})
2297 @kindex m f (Folder)
2298 @findex wl-fldmgr-make-filter
2299 Create a filter folder. (Put a filter on the folder).
2300 (@code{wl-fldmgr-make-filter})
2304 @kindex M-c (Folder)
2305 @kindex m c (Folder)
2306 @findex wl-fldmgr-copy
2307 Copy folder (it is not available on folder group).
2308 (@code{wl-fldmgr-copy})
2312 @kindex M-w (Folder)
2313 @kindex m W (Folder)
2314 @findex wl-fldmgr-copy-region
2315 Copy folders in the specified region.
2316 (@code{wl-fldmgr-copy-region})
2320 @kindex C-k (Folder)
2321 @kindex m k (Folder)
2322 @findex wl-fldmgr-cut
2323 Cut folder. Folder itself is not deleted.
2324 (@code{wl-fldmgr-cut})
2328 @kindex C-w (Folder)
2329 @kindex m C-w (Folder)
2330 @findex wl-fldmgr-cut-region
2331 Cut folders in the specified region.
2332 (@code{wl-fldmgr-cut-region})
2336 @kindex C-y (Folder)
2337 @kindex m y (Folder)
2338 @findex wl-fldmgr-yank
2339 Paste folders that are copied or cut (folders in the cut-list).
2340 (@code{wl-fldmgr-yank})
2343 @kindex m p (Folder)
2344 @findex wl-fldmgr-set-petname
2345 Put nickname on the folder.
2346 (@code{wl-fldmgr-set-petname})
2349 @kindex m q (Folder)
2350 @findex wl-fldmgr-clear-cut-entity-list
2351 Clear the cut-list. (cut, copied folder information is cleared,
2352 you cannot paste after this)
2353 (@code{wl-fldmgr-clear-cut-entity-list})
2356 @kindex m s (Folder)
2357 @findex wl-fldmgr-sort
2358 Sort folders in the current folder group.
2359 (@code{wl-fldmgr-sort})
2362 @kindex m C-s (Folder)
2363 @findex wl-fldmgr-save
2364 Save current folder view to the @file{wl-folders-file}.
2365 (@code{wl-fldmgr-save})
2368 [Following commands are only available on the access groups]
2374 @kindex m u (Folder)
2375 @findex wl-fldmgr-unsubscribe
2376 Set the visibility of folder (subscribe/unsubscribe).
2377 (@code{wl-fldmgr-unsubscribe})
2382 @kindex r u (Folder)
2383 @findex wl-fldmgr-unsubscribe-region
2384 Set the visibility of the folders (subscribe/unsubscribe) in the
2386 (@code{wl-fldmgr-unsubscribe-region})
2391 @kindex m l (Folder)
2392 @findex wl-fldmgr-access-display-normal
2393 List folders that are currently available.
2394 (@code{wl-fldmgr-access-display-normal})
2399 @kindex m L (Folder)
2400 @findex wl-fldmgr-access-display-all
2401 List all folders regardless of the subscription status.
2402 (@code{wl-fldmgr-access-display-all})
2406 @subsection Customize variables
2409 @item wl-interactive-save-folders
2410 @vindex wl-interactive-save-folders
2411 The initial setting is @code{t}. If non-nil and folder view is
2412 modified, confirm saving it before Wanderlust or Emacs exits. If
2413 @code{nil}, save without confirmation.
2415 @item wl-fldmgr-make-backup
2416 @vindex wl-fldmgr-make-backup
2417 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2418 created before saving the folder status.
2420 @item wl-fldmgr-sort-function
2421 @vindex wl-fldmgr-sort-function
2422 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2423 sort folders. By default function, folders are sorted alphabetically
2424 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2427 @item wl-fldmgr-sort-group-first
2428 @vindex wl-fldmgr-sort-group-first
2429 The initial setting is @code{t}. If non-nil,
2430 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2431 does not care whether it is folder group or not.
2433 @item wl-folder-check-async
2434 @vindex wl-folder-check-async
2435 The initial setting is @code{t}. If non-nil, check folder's unread
2436 status asynchronously. It boosts newsgroup checking.
2438 @item wl-folder-check-fast
2439 @vindex wl-folder-check-fast
2440 The initial setting is @code{nil}.
2441 If non-nil, it does not update folder status while checking.
2443 @item wl-folder-notify-deleted
2444 @vindex wl-folder-notify-deleted
2445 The initial setting is @code{nil}.
2447 If non-nil, negative value is displayed when the message is deleted. If
2448 @code{sync}, folder is synchronized when the message is deleted. If
2449 @code{nil}, message deletion is ignored.
2451 @item wl-fldmgr-add-complete-with-current-folder-list
2452 @vindex wl-fldmgr-add-complete-with-current-folder-list
2453 The initial setting is @code{nil}.
2454 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2455 candidate for @code{wl-fldmgr-add}.
2458 @subsection Miscellanea
2460 Following is a note for folder editing.
2464 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2465 paste(yank) command pastes the folders on one cut or copy command
2466 (If copy command is executed by region, folders in the region are pasted
2467 by one paste command)
2470 You cannot cut @samp{Desktop} group.
2471 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2474 You cannot copy folder group.
2477 Operations on the access group are only available for the folders
2478 in the same access group.
2481 You cannot create a folder which has same name with the folders already exist.
2484 You cannot insert folders which have same name in one group.
2485 You can insert them in the different groups.
2486 You cannot put same nickname to the different folders.
2490 @node Summary, Message, Folder, Top
2491 @chapter Summary Mode
2493 After you select the folder via folder mode, you enter to the summary
2497 * Usage of Summary Mode:: TIPS
2498 * Thread Operations:: Thread operations
2499 * Cache:: File cache, Buffer cache, and Prefetch
2500 * Auto Refile:: Auto refile settings
2501 * Sticky Summary:: Summary make sticky
2502 * Key Bindings of Summary:: Key bindings
2503 * Variables of Summary:: Customize Summary Mode
2507 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2508 @section Usage (Tips)
2510 @subsection Summary Content
2512 In the summary mode, messages are displayed like following.
2516 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2517 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2518 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2519 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2526 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2530 You cannot change this in the current version.
2532 @var{Message number} is the message's unique number in the folder. In
2533 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2534 in the MH folder, it is the filename of the message.
2536 @var{Temporal mark} and @var{Persistent mark} are described later.
2538 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2539 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2540 Japanese, but if you want to display it in English, set the value of
2541 @code{wl-summary-weekday-name-lang} as @samp{en}.
2543 @var{Sender}'s indentation corresponds to the depth of the thread.
2544 Sender name is displayed as nickname if it is defined in the address
2545 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2546 displaying with nickname.
2548 If number is printed at the head of @var{Sender} part like @samp{+2},
2549 that means the message have 2 follow messages.
2551 @var{Subject} is the @samp{Subject:} header field of the message. If
2552 the message have same @samp{Subject:} with the parent message, it is not
2553 displayed. Some mailing list puts its sequence number in the
2554 @samp{Subject:} field, but it is
2555 ignored. @code{wl-summary-no-subject-message} is displayed when the
2556 message has empty subject field.
2558 @subsection Temporary Marks
2559 @cindex Mark, Temporary
2561 There are four temporary marks,
2562 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2563 Temporary marks indicates message operations.
2568 You can execute a command on the all messages that have @samp{*} mark,
2569 with the key bindings which begins with @kbd{m}.
2572 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2576 After you type @kbd{o} key, prompt appears to input refile destination.
2577 Your answer is printed in the summary line.
2581 You can put this mark by typing @kbd{O} key.
2582 The difference between this mark and refile mark is,
2583 this mark does not delete the message while latter does.
2586 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2588 @subsection Persistent Marks
2590 There are five persistent marks,
2591 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2593 The persistent mark indicates the message's status and it is saved.
2594 Each persistent mark indicates:
2600 It is unread message.
2602 It is unread but cached message.
2604 It is read but it is not cached.
2606 It is important message. You can put @samp{$} mark by typing @kbd{$}
2607 key (if already exists, the mark is deleted). It is convenient to put
2608 this mark on the messages to remember (If you want to remember to write
2609 a reply for the message, for example) because this mark remains after
2610 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2611 @samp{'mark} folder even the message itself is deleted in the actual folder.
2614 If the message is read and cached (or local message),there are no
2618 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2619 cache. Messages with the marks other than these, you can read them in
2620 the offline status even they are in the IMAP folder or netnews folder.
2622 Among messages with persistent marks, ones with marks specified by
2623 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2624 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2626 @subsection How To Read
2628 Basically, you can read messages only typing space key again and again.
2630 To update summary status to the newest status (synchronize),
2633 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2634 moves cursor to the next message.
2635 Enter message buffer by typing @kbd{j} key.
2636 To operate multipart, you have to enter to the message buffer.
2639 @subsection Pack the Message Numbers
2640 You can pack the message numbers in Summary by
2641 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2642 News Spool Folder and Maildir Folder are supported folder types.
2645 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2646 @section Thread Operations
2648 For example, the following line indicates one thread (a context of a topic).
2651 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2655 If you type @kbd{/} on this line, the thread is opened and it changes
2656 the appearance like following.
2660 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2661 388 09/17(Thu)22:34 +-[ Murata san ]
2665 (Message 388 is the replied message to the message 384.)
2666 If you type @kbd{/} key once again, the thread is closed.
2667 With prefix argument, @kbd{/} opens all children threads.
2669 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2672 Commands with the key binding that begins with @kbd{t} executes commands
2673 on the messages in the thread.
2674 @xref{Key Bindings of Summary}.
2676 @subsection reconstruct thread by hand
2678 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2679 (@code{wl-summary-save-current-message}) at the corresponding message,
2680 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2681 message then you have the reconstructed thread.
2684 @node Cache, Auto Refile, Thread Operations, Summary
2687 @subsection Cache File
2689 The messages which have to access via network (e.x. IMAP, NNTP folder)
2690 are cached as a local file. The cache file is saved under the directory
2691 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2692 elmo-cache-expire-by-size}. The command deletes cache files to the
2693 specified size by the order of last accessed time.
2695 @subsection Buffer Cache and Prefetching
2697 The messages that are read are kept in the cache buffer. It is called
2698 `buffer cache'. The number of cache buffer is specified by
2699 @code{wl-message-buffer-cache-size}.
2701 There are message prefetching mechanism in the Wanderlust that
2702 prefetches next message while you are reading.
2704 You can control the message prefetching mechanism by these two
2708 @item wl-message-buffer-prefetch-folder-type-list
2709 @vindex wl-message-buffer-prefetch-folder-type-list
2710 The initial setting is @code{t}. In this case, prefetch messages in all
2712 If it is a list of folder types, it specifies the folder types in which
2713 message prefetching is enabled.
2714 Following is an example (prefetch messages in nntp and imap4 folders)
2718 (setq wl-message-buffer-prefetch-folder-type-list
2723 In this case, multi folder that contains localdir and imap4 prefetches
2724 only imap4 messages. This variable precedes the value of
2725 @code{wl-message-buffer-prefetch-folder-list}.
2727 @item wl-message-buffer-prefetch-folder-list
2728 @vindex wl-message-buffer-prefetch-folder-list
2729 The initial setting is @code{nil}.
2730 A list of regexp of folders to enable message prefetching.
2732 @item wl-message-buffer-prefetch-depth
2733 @vindex wl-message-buffer-prefetch-depth
2734 The initial setting is 3. The number of messages for automatical prefetch.
2736 @item wl-message-buffer-prefetch-idle-time
2737 @vindex wl-message-buffer-prefetch-idle-time
2738 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2740 @item wl-message-buffer-prefetch-threshold
2741 @vindex wl-message-buffer-prefetch-threshold
2742 The initial setting is 30000 (bytes). If prefetching message has larger
2743 size than this value, Wanderlust does not prefetch automatically.
2744 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2745 the message is not checked for the size.
2747 @item wl-auto-prefetch-first
2748 @vindex wl-auto-prefetch-first
2749 The initial setting is @code{nil}.
2750 If non-nil, first message is automatically prefetched to the buffer
2751 when you enter the folder.
2755 @node Auto Refile, Sticky Summary, Cache, Summary
2756 @section Auto Refile
2757 @vindex elmo-msgdb-extra-fields
2758 @vindex wl-refile-rule-alist
2759 @findex wl-summary-auto-refile
2761 You can refile messages automatically, by typing @kbd{C-o}
2762 (@code{wl-summary-auto-refile}). It decides destination of refile by
2763 the content of the message header information (information in the msgdb).
2765 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2766 available. If you want to decide destination by other header fields,
2767 set the variable @code{elmo-msgdb-extra-fields} like following.
2771 (setq elmo-msgdb-extra-fields
2781 By this setting, Wanderlust saves extra fields in the msgdb. You have
2782 to type @kbd{s all} to get extra fields for the messages that are
2783 already exists in the summary.
2785 Then, specify the refile rule. The refile target folder of auto
2786 refiling is decided by the value of @code{wl-refile-rule-alist}.
2787 @code{wl-refile-rule-alist} is a list of a rule:
2791 (@var{field} (@var{regexp} . @var{target})
2792 (@var{regexp} . @var{target})
2797 Each rule means `if @var{field} value matches @var{regexp},
2798 then refile to @var{target} folder'.
2799 The rule matched first is applied.
2801 @var{field} is a string of field name. You can specify a list of field name
2802 string, too. In this case, if one of these fields is matched, then the
2803 rule is fired (i.e. OR condition).
2805 @var{regexp} is a regular expression for field value. @var{target} is a target
2806 folder string. You can specify a rule at @var{target} part, too. In this
2807 case, If the field value of the rule and the current rule is matched,
2808 then the current rule is fired (i.e. AND condition).
2810 In @var{target} part, you can refer matched substring of @var{regexp}.
2811 To refer substring, specify following in @var{target}:
2815 means substitute original matched text.
2818 means substitute what matched the @var{N}th `\(@dots{}\)'.
2819 (@var{N} is a number.)
2822 Following is an example of @code{wl-refile-rule-alist}.
2826 (setq wl-refile-rule-alist
2828 ("^Wanderlust" . "+wl")
2829 ("^Elisp" . "+elisp"))
2831 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2833 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2834 "+from-me-to-you"))))))
2838 After these settings, refile marks are automatically put on the condition
2839 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2841 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2843 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2844 with these persistent marks are not automatically refiled.
2845 It means Wanderlust does not execute auto refile on unread messages by
2846 the default setting.
2847 To execute auto refile on all messages, set following.
2850 (setq wl-summary-auto-refile-skip-marks nil)
2854 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2855 @section Sticky Summary
2856 @cindex Summary, Sticky
2857 @cindex Sticky Summary
2859 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2861 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2862 @kbd{G} in some suummary sticky summary buffer is created.
2863 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2864 makes current one sticky.
2866 The buffer name of the sticky summary becomes like
2867 @samp{Summary:@var{folder-name}}.
2868 You can visit the sticky summary at any time by @kbd{C-x b}
2869 (@code{switch-to-buffer}), or you can go round summary buffers by
2870 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2871 (@code{wl-summary-next-buffer}) in summary mode.
2873 In sticky summary, the summary buffer is preserved after @kbd{g} or
2874 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2875 another summary by @kbd{C-u g}. Other operations in the sticky summary
2876 are same as normal summary.
2878 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2879 are automatically stuck.
2882 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2883 @section Key bindings
2884 @cindex Keybind, Summary Mode
2885 @cindex Keybind, Summary Buffer
2887 Key bindings of the summary mode are shown below.
2891 @kindex @key{SPC} (Summary)
2892 @findex wl-summary-read
2893 Proceed reading a message at the current cursor point.
2894 (@code{wl-summary-read})
2898 @findex wl-summary-redisplay
2899 Redisplay a message at the current cursor point.
2900 If this command is called with prefix argument,
2901 Redisplay message regardless of the message cache (message is re-loaded
2903 (@code{wl-summary-redisplay})
2907 @findex wl-summary-display-top
2908 Display the top message in the folder.
2909 (@code{wl-summary-display-top})
2913 @findex wl-summary-display-bottom
2914 Display the bottom message in the folder.
2915 (@code{wl-summary-display-bottom})
2919 @kindex @key{BS} (Summary)
2920 @kindex @key{DEL} (Summary)
2921 Display the previous page of the message at the current cursor point.
2922 @findex wl-summary-prev-page
2923 (@code{wl-summary-prev-page})
2926 @kindex @key{RET} (Summary)
2927 @findex wl-summary-next-line-content
2928 Display the next line of the message at the current cursor point.
2929 Display the message at the current cursor point if it is not displayed yet.
2930 (@code{wl-summary-next-line-content})
2935 @kindex M-@key{RET} (Summary)
2936 @findex wl-summary-prev-line-content
2937 Display the previous line of the message at the current cursor point.
2938 Display the message at the current cursor point if it is not displayed yet.
2939 (@code{wl-summary-prev-line-content})
2943 @findex wl-thread-open-close
2944 Toggle open or close the thread at the current cursor point.
2945 (@code{wl-thread-open-close})
2950 @findex wl-thread-open-all
2951 (@code{wl-thread-open-all})
2956 @findex wl-thread-close-all
2957 (@code{wl-thread-close-all})
2961 @findex wl-summary-goto-folder
2963 (@code{wl-summary-goto-folder})
2967 Mark all messages in the folder as read.
2968 @findex wl-summary-mark-as-read-all
2969 (@code{wl-summary-mark-as-read-all})
2973 @findex wl-summary-reply
2974 Prepare a draft for reply the message at the current cursor point.
2975 (@code{wl-summary-reply})
2979 @findex wl-summary-reply-with-citation
2980 Prepare a draft for reply the message at the current cursor point.
2981 (@code{wl-summary-reply-with-citation})
2985 @findex wl-summary-cancel-message
2986 If the message at current cursor point is your own netnews article,
2988 (@code{wl-summary-cancel-message})
2992 @findex wl-summary-reedit
2993 Prepare a draft for re-editing the message at current cursor point.
2994 If the message at current cursor point is your own netnews article,
2995 a draft for `supersedes message' for the message is prepared.
2996 (@code{wl-summary-reedit})
2999 @kindex M-e (Summary)
3000 @findex wl-summary-resend-bounced-mail
3001 If the message at current cursor point is a bounced message,
3002 a draft for re-sending original message is prepared.
3003 (@code{wl-summary-resend-bounced-mail})
3007 @findex wl-summary-forward
3008 A draft for forwarding the message at current cursor point is prepared.
3009 (@code{wl-summary-forward})
3013 @findex wl-summary-mark-as-important
3014 Put @samp{$} mark on the message at current cursor point.
3015 If already marked as @samp{$}, delete it.
3016 (@code{wl-summary-mark-as-important})
3022 Save the message at current cursor point.
3023 @findex wl-summary-save
3024 (@code{wl-summary-save})
3028 @findex wl-summary-next
3029 Move cursor to the next message.
3030 If message is marked with a temporal mark in
3031 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3032 In the offline mode, cursor is not moved to the messages which are not cached
3034 (@code{wl-summary-next})
3038 @findex wl-summary-prev
3039 Move cursor to the previous message.
3040 If message is marked with a temporal mark in
3041 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3042 In the offline mode, cursor is not moved to the messages which are not cached
3044 (@code{wl-summary-prev})
3048 @findex wl-summary-down
3049 Move cursor to the downward message which is unread or marked
3051 In the offline mode, cursor is not moved to the messages which are not cached
3053 If there are messages which have target mark @samp{*} in the summary,
3054 cursor is moved to the downward message which have a target mark.
3055 This behavior is changed according to the value of @code{wl-summary-move-order}.
3056 (@code{wl-summary-down})
3060 @findex wl-summary-up
3061 Move cursor to the upward message which is unread or marked
3063 In the offline mode, cursor is not moved to the messages which are not cached
3065 If there are messages which have target mark @samp{*} in the summary,
3066 cursor is moved to the downward message which have a target mark.
3067 This behavior is changed according to the value of @code{wl-summary-move-order}.
3068 (@code{wl-summary-up})
3072 @findex wl-summary-write
3073 Prepare a new draft.
3074 (@code{wl-summary-write})
3078 @findex wl-summary-write-current-folder
3079 Prepare a new draft. If the current folder is NNTP folder,
3080 @samp{Newsgroups:} field is completed. If the current folder is mailing
3081 list folder (refile destination), guess @samp{To:} field and completed
3082 (If @code{wl-subscribed-mailing-list} is valid list)
3083 (@code{wl-summary-write-current-folder})
3087 @findex wl-summary-redisplay-all-header
3088 Redisplay the message at current cursor point with all header fields.
3089 (@code{wl-summary-redisplay-all-header})
3093 @findex wl-summary-redisplay-no-mime
3094 Redisplay the message at current cursor point without MIME analysis.
3095 (@code{wl-summary-redisplay-no-mime})
3099 @findex wl-summary-burst
3100 If the message at current cursor point has
3101 encapsulates multiple messages using MIME,
3102 de-capsulate and extract them on the current folder.
3103 (@code{wl-summary-burst})
3106 @kindex @@ (Summary)
3107 @findex wl-summary-edit-addresses
3108 Append/change/delete the message's sender information to the address
3109 book @file{~/.addresses} interactively. If this command is called with
3110 prefix argument, arbitrary address can be edited.
3111 (@code{wl-summary-edit-petname})
3115 @findex wl-status-update
3116 Sync up address book status with @file{~/.addresses}'s content.
3117 (@code{wl-status-update})
3121 @findex wl-summary-pipe-message
3122 Pipe current message's content to the external process.
3123 (@code{wl-summary-pipe-message})
3127 @findex wl-summary-print-message
3128 Print out current message's content.
3129 It uses @code{ps-print} module in Emacs 20.x.
3130 If you don't use color printer, you might want to set
3131 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3134 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3137 (@code{wl-summary-print-message})
3141 @findex wl-summary-exit
3142 Exit current folder.
3143 (@code{wl-summary-exit})
3147 @findex wl-summary-jump-to-current-message
3148 Jump cursor to the currently displayed message's window.
3149 (@code{wl-summary-jump-to-current-message})
3153 Jump cursor to the other message.
3154 @findex wl-summary-jump-to-msg
3155 (@code{wl-summary-jump-to-msg})
3159 Update summary status and
3160 prefetch all messages which have marks included in the
3161 @code{wl-summary-incorporate-marks}.
3162 @findex wl-summary-incorporate
3163 (@code{wl-summary-incorporate})
3166 @kindex M-j (Summary)
3167 @findex wl-summary-jump-to-msg-by-message-id
3168 Jump cursor to the message which have specified @samp{Message-Id:}. If
3169 @code{elmo-use-database} is non-nil, other folder is also searched.
3170 (@code{wl-summary-jump-to-msg-by-message-id})
3174 Jump to parent message.
3175 @findex wl-summary-jump-to-parent-message
3176 (@code{wl-summary-jump-to-parent-message})
3180 @findex wl-summary-mark-as-unread
3181 Mark as unread the message at current cursor point.
3182 (@code{wl-summary-mark-as-unread})
3186 @findex wl-summary-sync
3187 Synchronize summary view after prompting the update range
3188 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3192 all ...Discard current summary and update all message.
3193 all-visible ...Discard current summary and update all visible message.
3194 update ...Update the difference between summary and the folder itself.
3195 rescan ...Rescan the msgdb and display again.
3196 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3197 cache-status ...Sync the all marks with the real status of cache.
3198 first, last ...Move to the filter folder(partial filter).
3203 (@code{wl-summary-sync})
3207 @findex wl-summary-sort
3209 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3210 (@code{wl-summary-sort})
3214 @findex wl-summary-toggle-thread
3215 Toggle the threading.
3216 Threading status is displayed on the modeline.
3217 @samp{@{S@}} means threading is off (Sequence) and
3218 @samp{@{T@}} means threading is on (Thread).
3219 (@code{wl-summary-toggle-thread})
3223 @findex wl-summary-toggle-disp-folder
3224 Toggle displaying of folder window.
3225 (@code{wl-summary-toggle-disp-folder})
3229 Toggle displaying of message window.
3230 @findex wl-summary-toggle-disp-msg
3231 (@code{wl-summary-toggle-disp-msg})
3235 Move to the virtual folder with the condition specified.
3236 If called with prefix argument and current folder is virtual, exit it.
3237 @findex wl-summary-virtual
3238 (@code{wl-summary-virtual})
3241 @kindex @key{TAB} (Summary)
3242 @findex wl-summary-goto-last-displayed-msg
3243 Jump to the message which is displayed last.
3244 (@code{wl-summary-goto-last-displayed-msg})
3248 Put @samp{*} mark on the messages that satisfies the specified condition.
3249 @findex wl-summary-pick
3250 (@code{wl-summary-pick})
3254 @findex wl-summary-mark-as-read
3255 Mark as read the message at the current cursor point.
3256 (@code{wl-summary-mark-as-read})
3260 Prefetch the message at the current cursor point.
3261 With prefix argument, prefetch the message even if it is cached.
3262 @findex wl-summary-prefetch
3263 (@code{wl-summary-prefetch})
3267 Execute @samp{D}, @samp{o} and @samp{O} marks.
3268 @findex wl-summary-exec
3269 (@code{wl-summary-exec})
3273 @findex wl-summary-target-mark-line
3274 Put target mark on the message at the current cursor point.
3275 (@code{wl-summary-target-mark-line})
3279 Put refile mark on the message at the current cursor point.
3280 @findex wl-summary-refile
3281 (@code{wl-summary-refile})
3284 @kindex C-o (Summary)
3285 Execute auto refile.
3286 @findex wl-summary-auto-refile
3287 (@code{wl-summary-auto-refile})
3291 Put copy mark on the message at the current cursor point.
3292 @findex wl-summary-copy
3293 (@code{wl-summary-copy})
3296 @kindex M-o (Summary)
3297 Put refile mark on the message at the current cursor point with the destination
3298 previously specified.
3299 @findex wl-summary-refile-prev-destination
3300 (@code{wl-summary-refile-prev-destination})
3304 @findex wl-summary-delete
3305 Put delete mark on the message at the current cursor point.
3306 (@code{wl-summary-delete})
3310 @findex wl-summary-unmark
3311 Unmark the temporal mark on the message at the current cursor point.
3312 (@code{wl-summary-unmark})
3316 Unmark all the temporal marks.
3317 @findex wl-summary-unmark-all
3318 (@code{wl-summary-unmark-all})
3321 @kindex r R (Summary)
3322 @findex wl-summary-mark-as-read-region
3323 Mark as read messages in the specified region.
3324 (@code{wl-summary-mark-as-read-region})
3327 @kindex r $ (Summary)
3328 @findex wl-summary-mark-as-important-region
3329 Mark as important @samp{$} messages in the specified region.
3330 If @samp{$} already exists, it is deleted.
3331 (@code{wl-summary-mark-as-important-region})
3334 @kindex r ! (Summary)
3335 @findex wl-summary-mark-as-unread-region
3336 Mark as unread messages in the specified region.
3337 (@code{wl-summary-mark-as-unread-region})
3340 @kindex r i (Summary)
3341 @findex wl-summary-prefetch-region
3342 Prefetch messages in the specified region.
3343 (@code{wl-summary-prefetch-region})
3346 @kindex r x (Summary)
3347 @findex wl-summary-exec-region
3348 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3350 (@code{wl-summary-exec-region})
3353 @kindex r * (Summary)
3354 @findex wl-summary-target-mark-region
3355 Put target mark on the messages in the specified region.
3356 (@code{wl-summary-target-mark-region})
3359 @kindex r o (Summary)
3360 @findex wl-summary-refile-region
3361 Put refile mark on the messages in the specified region.
3362 (@code{wl-summary-refile-region})
3365 @kindex r O (Summary)
3366 @findex wl-summary-copy-region
3367 Put copy mark on the messages in the specified region.
3368 (@code{wl-summary-copy-region})
3371 @kindex r d (Summary)
3372 @findex wl-summary-delete-region
3373 Put delete mark on the messages in the specified region.
3374 (@code{wl-summary-delete-region})
3377 @kindex r u (Summary)
3378 @findex wl-summary-unmark-region
3379 Delete temporal mark on the messages in the specified region.
3380 (@code{wl-summary-unmark-region})
3383 @kindex r y (Summary)
3384 Save messages in the specified region.
3385 @findex wl-summary-save-region
3386 (@code{wl-summary-save-region})
3389 @kindex t R (Summary)
3390 @findex wl-thread-mark-as-read
3391 Mark as read messages which are the descendant of the current thread.
3392 With prefix argument, it affects on the all messages in the thread tree.
3393 (@code{wl-thread-mark-as-read})
3396 @kindex t $ (Summary)
3397 @findex wl-thread-mark-as-important
3398 Put important mark @samp{$} on the messages which are the
3399 descendant of the current thread.
3400 If @samp{$} mark exists, it is deleted.
3401 With prefix argument, it affects on the all messages in the thread tree.
3402 (@code{wl-thread-mark-as-important})
3405 @kindex t ! (Summary)
3406 @findex wl-thread-mark-as-unread
3407 Mark as unread messages which are the descendant of the current thread.
3408 With prefix argument, it affects on the all messages in the thread tree.
3409 (@code{wl-thread-mark-as-unread})
3412 @kindex t i (Summary)
3413 @findex wl-thread-prefetch
3414 Prefetch messages which are the descendant of the current thread.
3415 With prefix argument, it affects on the all messages in the thread tree.
3416 (@code{wl-thread-prefetch})
3419 @kindex t x (Summary)
3420 @findex wl-thread-exec
3421 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3422 the descendant of the current thread. With prefix argument, it affects
3423 on the all messages in the thread tree.
3424 (@code{wl-thread-exec})
3427 @kindex t * (Summary)
3428 @findex wl-thread-target-mark
3429 Put target mark @samp{*} on the messages which are the descendant of the
3430 current thread. With prefix argument, it affects on the all messages in
3432 (@code{wl-thread-target-mark})
3435 @kindex t o (Summary)
3436 @findex wl-thread-refile
3437 Put refile mark on the messages which are the descendant of the current thread.
3438 With prefix argument, it affects on the all messages in the thread tree.
3439 (@code{wl-thread-refile})
3442 @kindex t O (Summary)
3443 @findex wl-thread-copy
3444 Put copy mark on the messages which are the descendant of the current thread.
3445 With prefix argument, it affects on the all messages in the thread tree.
3446 (@code{wl-thread-copy})
3449 @kindex t d (Summary)
3450 @findex wl-thread-delete
3451 Put delete mar on the messages which are the descendant of the current thread.
3452 With prefix argument, it affects on the all messages in the thread tree.
3453 (@code{wl-thread-delete})
3456 @kindex t u (Summary)
3457 @findex wl-thread-unmark
3458 Unmark temporal mark on the messages which are the descendant of the
3459 current thread. With prefix argument, it affects on the all messages in
3461 (@code{wl-thread-unmark})
3464 @kindex t y (Summary)
3465 @findex wl-thread-save
3466 Save messages which are the descendant of the current thread.
3467 With prefix argument, it affects on the all messages in the thread tree.
3468 (@code{wl-thread-save})
3471 @kindex m i (Summary)
3472 @findex wl-summary-target-mark-prefetch
3473 Prefetch all messages which have target mark @samp{*}.
3474 With prefix argument, prefetch all targets even if some of them are cached.
3475 (@code{wl-summary-target-mark-prefetch})
3478 @kindex m R (Summary)
3479 @findex wl-summary-target-mark-mark-as-read
3480 Mark as read all messages which have target mark @samp{*}.
3481 (@code{wl-summary-target-mark-mark-as-read})
3484 @kindex m $ (Summary)
3485 @findex wl-summary-target-mark-mark-as-important
3486 Mark as important all messages which have target mark @samp{*}.
3487 If already marked as @samp{$}, it is deleted.
3488 (@code{wl-summary-target-mark-mark-as-important})
3491 @kindex m ! (Summary)
3492 @findex wl-summary-target-mark-mark-as-unread
3493 Mark as unread all messages which have target mark @samp{*}.
3494 (@code{wl-summary-target-mark-mark-as-unread})
3497 @kindex m o (Summary)
3498 @findex wl-summary-target-mark-refile
3499 Put refile mark on the messages which have target mark @samp{*}.
3500 (@code{wl-summary-target-mark-refile})
3503 @kindex m O (Summary)
3504 @findex wl-summary-target-mark-copy
3505 Put copy mark on the messages which have target mark @samp{*}.
3506 (@code{wl-summary-target-mark-copy})
3509 @kindex m d (Summary)
3510 @findex wl-summary-target-mark-delete
3511 Put delete mark on the messages which have target mark @samp{*}.
3512 (@code{wl-summary-target-mark-delete})
3515 @kindex m y (Summary)
3516 @findex wl-summary-target-mark-save
3517 Save messages which have target mark @samp{*}.
3518 (@code{wl-summary-target-mark-save})
3521 @kindex m u (Summary)
3522 Unmark all temporal marks.
3523 (@code{wl-summary-delete-all-temp-marks})
3524 @findex wl-summary-delete-all-temp-marks
3527 @kindex m a (Summary)
3528 Put target mark @samp{*} on the all messages.
3529 (@code{wl-summary-target-mark-all})
3530 @findex wl-summary-target-mark-all
3533 @kindex m t (Summary)
3534 Put target mark @samp{*} on the messages in the current thread.
3535 @findex wl-summary-target-mark-thread
3536 (@code{wl-summary-target-mark-thread})
3539 @kindex m r (Summary)
3540 @findex wl-summary-target-mark-region
3541 Put target mark @samp{*} on the messages in the specified region.
3542 (@code{wl-summary-target-mark-region})
3545 @kindex m A (Summary)
3546 @findex wl-summary-target-mark-reply-with-citation
3547 Prepare a draft which cites all messages which have target mark @samp{*}.
3548 (@code{wl-summary-target-mark-reply-with-citation})
3551 @kindex m f (Summary)
3552 @findex wl-summary-target-mark-forward
3553 Prepare a draft which forwards all messages which have target mark @samp{*}.
3554 (@code{wl-summary-target-mark-forward})
3557 @kindex m U (Summary)
3558 @findex wl-summary-target-mark-uudecode
3559 Uudecode the messages which have target mark @samp{*}.
3560 (@code{wl-summary-target-mark-uudecode})
3563 @kindex m ? (Summary)
3564 @findex wl-summary-target-mark-pick
3565 Pick messages from the @samp{*} marked messages.
3566 That is, @samp{*} marks on the messages are remained
3567 if the specified condition is satisfied.
3568 (@code{wl-summary-target-mark-pick})
3571 @kindex M-t (Summary)
3572 @findex wl-toggle-plugged
3573 Toggle offline/online status of Wanderlust.
3574 (@code{wl-toggle-plugged})
3577 @kindex C-t (Summary)
3578 Start Wanderlust's plug-status manager.
3579 (@code{wl-plugged-change})
3582 @kindex C-c C-o (Summary)
3583 @findex wl-jump-to-draft-buffer
3584 Move to the draft buffer if available. If multiple draft buffer exists,
3585 moved to one after another. If prefix argument is specified, load draft
3586 folder's message to the draft buffer and jump to it.
3587 (@code{wl-jump-to-draft-buffer})
3590 @kindex M-w (Summary)
3591 @findex wl-summary-save-current-message
3592 Save the message at the current cursor point.
3593 (@code{wl-summary-save-current-message})
3596 @kindex C-y (Summary)
3597 @findex wl-summary-yank-saved-message
3598 Regard the message at the current cursor point as
3599 parent, connect the message saved by
3600 @code{wl-summary-save-current-message}
3602 (@code{wl-summary-yank-saved-message})
3605 @kindex C-x C-s (Summary)
3606 @findex wl-summary-save-status
3607 Save the current summary.
3608 (@code{wl-summary-save-status})
3612 @node Variables of Summary, , Key Bindings of Summary, Summary
3613 @section Customiziable variables
3616 @item wl-summary-move-order
3617 @vindex wl-summary-move-order
3618 The initial setting is @code{unread}. Specify cursor moving policy. If
3619 you want to precede new messages, set @code{new}. If you want to
3620 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3623 @item wl-auto-select-first
3624 @vindex wl-auto-select-first
3625 The initial setting is @code{nil}.
3626 If non-nil, first message is automatically displayed when you enter
3629 @item wl-auto-select-next
3630 @vindex wl-auto-select-next
3631 The initial setting is @code{nil}. This controls behavior when there is
3632 no unread message in current summary.
3635 nil: asks whether you want to go back to folder mode
3636 'unread: asks whether you want to go to next unread folder
3637 If the next one comes to be possessing no unread message
3638 by treatment of cross-posted messages or Scoring, then
3639 asks whether you want to go to next to next folder.
3640 'skip-no-unread: similar as unread
3641 But does not ask before going to next to next folder.
3642 otherwise: asks whether you want to go to next unread folder
3645 It might be useful to set @code{'skip-no-unread} for people who
3646 want to continue reading by just pressing and pressing space key.
3648 @item wl-thread-insert-opened
3649 @vindex wl-thread-insert-opened
3650 The initial setting is @code{nil}.
3651 If non-nil, thread is inserted as opened.
3653 @item wl-thread-open-reading-thread
3654 @vindex wl-thread-open-reading-thread
3655 The initial setting is @code{t}. If non-nil, reading thread is
3656 automatically opened though it is closed thread.
3658 @item wl-summary-exit-next-move
3659 @vindex wl-summary-exit-next-move
3660 The initial setting is @code{t}. If non-nil, move to next folder at
3663 @item wl-folder-move-cur-folder
3664 @vindex wl-folder-move-cur-folder
3665 The initial setting is @code{nil}. If non-nil, cursor position on the
3668 @item wl-summary-weekday-name-lang
3669 @vindex wl-summary-weekday-name-lang
3670 The initial setting is @samp{ja}. Specify language of the weekday.
3671 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3672 displays Deutsch. You should rescan summary view after changing this value.
3674 @item wl-summary-fix-timezone
3675 @vindex wl-summary-fix-timezone
3676 The initial setting is @code{nil}.
3677 Time zone of the date string in summary mode is adjusted using this value.
3678 If @code{nil}, it is adjust to the default time zone information
3679 (system's default time zone or environment variable @samp{TZ}).
3681 @item wl-use-petname
3682 @vindex wl-use-petname
3683 The initial setting is @code{t}.
3684 If non-nil, sender part displays nickname.
3686 @item wl-break-pages
3687 @vindex wl-break-pages
3688 The initial setting is @code{t}.
3689 If non-nil, message is split as pages by @samp{^L}.
3691 @item wl-message-window-size
3692 @vindex wl-message-window-size
3693 The initial setting is '(1 . 4).
3694 A cons cell to specify the rate of summary and message window.
3695 car:cdr corresponds summary:message.
3697 @item wl-summary-no-from-message
3698 @vindex wl-summary-no-from-message
3699 The initial setting is @samp{nobody@@nowhere?}. A string which is
3700 displayed when there's no @samp{From:} field in the message.
3702 @item wl-summary-no-subject-message
3703 @vindex wl-summary-no-subject-message
3704 The initial setting is @samp{(WL:No Subject in original.)}. A string
3705 which is displayed when there's no @samp{Subject:} field in the message.
3707 @item wl-summary-use-frame
3708 @vindex wl-summary-use-frame
3709 The initial setting is @code{nil}.
3710 If non-nil, use new frame for the summary.
3712 @item wl-use-folder-petname
3713 @vindex wl-use-folder-petname
3714 The initial setting is the list shown below:
3723 A list of display policy (symbol) of folder nickname. Available symbols
3728 Display folder petname on modeline.
3730 Destination folder is notified as nickname if
3731 @code{wl-auto-select-next} is non-nil.
3733 You can input folder name by nickname in the function
3734 @code{wl-summary-read-folder}.
3737 @item wl-summary-move-direction-toggle
3738 @vindex wl-summary-move-direction-toggle
3739 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3740 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3741 want to aware of reading direction, set this to @code{t}.
3743 @item wl-summary-width
3744 @vindex wl-summary-width
3745 The initial setting is 80.
3746 Width of summary line. If @code{nil}, summary line's width is as is.
3748 @item wl-summary-from-width
3749 @vindex wl-summary-from-width
3750 The initial setting is 17.
3751 Width of sender part of summary line.
3753 @item wl-summary-subject-length-limit
3754 @vindex wl-summary-subject-length-limit
3755 The initial setting is @code{nil}. Specify the limit for the length of
3756 subject parts in summary. @code{nil} means unlimited.
3758 @item wl-summary-indent-length-limit
3759 @vindex wl-summary-indent-length-limit
3760 The initial setting is 46.
3761 Specify the limit of thread indent level. @code{nil} means unlimited
3763 If you set this to @code{nil} you should set @code{wl-summary-width}
3766 @item wl-summary-recenter
3767 @vindex wl-summary-recenter
3768 The initial setting is t.
3769 If non-nil, cursor point is moved to the center of the summary window.
3771 @item wl-summary-divide-thread-when-subject-changed
3772 @vindex wl-summary-divide-thread-when-subject-changed
3773 The initial setting is @code{nil}. If non-nil, thread is split if
3774 the subject is changed.
3776 @item wl-summary-search-via-nntp
3777 @vindex wl-summary-search-via-nntp
3778 The initial setting is @code{confirm}.
3780 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3781 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3782 from the NNTP server @code{elmo-nntp-default-server}. The value of
3783 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3784 @code{elmo-nntp-default-stream-type} are used.
3786 If @code{confirm}, server name can be specified. You can specify NNTP
3787 folder format like @samp{-:username@@servername:119!}.
3789 @item wl-summary-keep-cursor-command
3790 @vindex wl-summary-keep-cursor-command
3791 The initial setting is the list shown below:
3795 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3800 When you entered to summary by these commands and the target summary
3801 buffer already exists, summary status is not automatically updated and
3802 cursor position is saved.
3804 @item elmo-folder-update-threshold
3805 @vindex elmo-folder-update-threshold
3806 The initial setting is 500. If updated message number is larger than
3807 this value, confirm whether drop them or not (in the case where the value
3808 of @code{elmo-folder-update-confirm} is non-nil).
3810 @item elmo-folder-update-confirm
3811 @vindex elmo-folder-update-confirm
3812 The initial setting is @code{t}. If the value is non-nil, do check with
3813 @code{elmo-folder-update-threshold}.
3815 @item wl-summary-always-sticky-folder-list
3816 @vindex wl-summary-always-sticky-folder-list
3817 The initial setting is @code{nil}.
3818 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3819 are automatically stuck. Each element is regexp of folder name.
3821 @item wl-summary-reserve-mark-list
3822 @vindex wl-summary-reserve-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 not marked by any mark command.
3835 @item wl-summary-skip-mark-list
3836 @vindex wl-summary-skip-mark-list
3837 The initial setting is the list shown below:
3846 If a message is already marked as temporal marks in this list, the
3847 message is skipped at cursor move.
3849 @item elmo-message-fetch-threshold
3850 @vindex elmo-message-fetch-threshold
3851 The initial setting is 30000 (bytes). If displaying message has larger
3852 size than this value, Wanderlust confirms whether fetch the message or
3853 not (in the case where the value of @code{elmo-message-fetch-confirm}
3856 @item elmo-message-fetch-confirm
3857 @vindex elmo-message-fetch-confirm
3858 The initial setting is @code{t}. If the value is non-nil, do check with
3859 @code{elmo-message-fetch-threshold}.
3861 @item wl-prefetch-threshold
3862 @vindex wl-prefetch-threshold
3863 The initial setting is 30000 (bytes). If prefetching message has larger
3864 size than this value and @code{wl-prefetch-confirm} is non-nil,
3865 Wanderlust confirms whether prefetch the message or not. If
3866 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3867 without confirmation.
3869 @item wl-prefetch-confirm
3870 @vindex wl-prefetch-confirm
3871 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3872 prefetch the message or not if the message has larger size than
3873 @code{wl-prefetch-threshold}.
3875 @item elmo-imap4-use-cache
3876 @vindex elmo-imap4-use-cache
3877 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3880 @item elmo-nntp-use-cache
3881 @vindex elmo-nntp-use-cache
3882 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3885 @item elmo-pop3-use-cache
3886 @vindex elmo-pop3-use-cache
3887 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3890 @item elmo-shimbun-use-cache
3891 @vindex elmo-shimbun-use-cache
3892 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3895 @item wl-folder-process-duplicates-alist
3896 @vindex wl-folder-process-duplicates-alist
3897 The initial setting is @code{nil}.
3898 This list determines how to deal with duplicated messages in the same folder.
3899 Each item in the list is regexp of folder name and action; you can specify any
3900 one of the following in the place of action:
3903 @code{nil} : do nothing for duplicated messages.
3904 @code{hide} : hide duplicated messages from the summary.
3905 @code{read} : set duplicated messages as read.
3909 Following is an example (hide duplicated messages in multi folders)
3913 (setq wl-folder-process-duplicates-alist
3914 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3915 ("^\\*.*" . hide) (".*" . read)))
3921 @node Message, Draft, Summary, Top
3922 @chapter Message Buffer
3924 Message Buffers utilize MIME-View mode of SEMI. For operational
3925 procedures and key bindings, refer to respective documents.
3926 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3927 You can also see help by @kbd{?} in message buffer.
3929 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3930 brings you back to Summary mode. @kbd{l} toggles display of Summary
3933 @section Key Bindings
3939 @findex wl-message-toggle-disp-summary
3940 Toggles display of Summary mode buffer.
3941 (@code{wl-message-toggle-disp-summary})
3944 @findex wl-message-refer-article-or-url
3945 @kindex Button-2 (Message)
3946 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3947 corresponding message if found.
3948 (@code{wl-message-refer-article-or-url})
3950 @item Button-4 (upward movement of a wheel)
3951 @kindex Button-4 (Message)
3952 @findex wl-message-wheel-down
3953 Scrolls the message backwards. When the top of the message is hit,
3954 moves to the previous message.
3955 (@code{wl-message-wheel-down})
3957 @item Button-5 (downward movement of a wheel)
3958 @kindex Button-5 (Message)
3959 @findex wl-message-wheel-up
3960 Scrolls the message forward. When the bottom of the message is hit,
3961 moves to the next message.
3962 (@code{wl-message-wheel-up})
3965 @section Customizable Variables
3968 @item wl-message-window-size
3969 @vindex wl-message-window-size
3970 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3971 its car and cdr value corresponds to the ratio of Summary and Message
3974 @item wl-message-ignored-field-list
3975 @vindex wl-message-ignored-field-list
3976 (SEMI only) Initial setting is @code{nil}.
3977 All fields that match this list will be hidden in message buffer.
3978 Each elements are regexp of field-name.
3979 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3981 @item wl-message-visible-field-list
3982 @vindex wl-message-visible-field-list
3983 (SEMI only) Initial setting is @code{nil}.
3984 All fields that match this list will be display in message buffer.
3985 Each elements are regexp of field-name. This value precedes
3986 @code{wl-message-ignored-field-list}.
3987 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3989 @item wl-message-sort-field-list
3990 @vindex wl-message-sort-field-list
3991 (SEMI only) Initial setting is
3992 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3993 Header fields in message buffer are ordered by this value.
3994 Each elements are regexp of field-name.
3996 @item wl-message-truncate-lines
3997 @vindex wl-message-truncate-lines
3998 The initial value is the value of @code{default-truncate-lines}.
3999 If it is non-nil, truncate long lines in message buffer.
4002 @node Draft, Disconnected Operations, Message, Top
4003 @chapter Draft Buffer
4005 At Summary mode, pressing @kbd{w} and the like creates a new draft
4006 buffer. You can edit and send mail and news articles in this buffer.
4010 Basically it is Emacs-standard mail mode.
4012 @subsection Address Completion
4014 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4015 addresses. @kbd{@key{TAB}} completes them.
4017 If you want to submit a news article, add @samp{Newsgroups:} field by
4018 yourself. Field names can be completed by @kbd{@key{TAB}}.
4020 If you save the draft buffer you are editing, it is appended to the
4021 folder specified by @code{wl-draft-folder}.
4023 Using @samp{FCC:} field, you can specify the folder to which a copy of
4024 the message is saved when it is sent.
4026 @subsection Editing Messages
4028 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4029 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4030 a MIME user interface for GNU Emacs}.
4031 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4033 @subsection Dynamic Modification of Messages
4034 @vindex wl-draft-config-alist
4035 @c @cindex Change Message
4036 @c @cindex Message, Change Dynamic
4038 You can set @code{wl-draft-config-alist} so that header and body of the
4039 message will automatically modified depending on information of header
4042 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4044 In the example below, the header is modified when
4045 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4046 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4047 before sending the message.
4051 (setq wl-draft-config-alist
4052 '(((string-match "aaa\\.example\\.com$" (system-name))
4053 ;; @r{applied if the expression is non-nil}
4054 (wl-smtp-posting-server . "mailserver-B")
4055 (wl-nntp-posting-server . "newsserver-B")
4056 ;; @r{settings of temporary variables}
4058 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4059 ;; @r{applied if it matches the header of the draft buffer}
4060 ("Organization" . (format "Go %s" my-webpage)))
4061 ;; @r{you can write elisp expressions here (eval only)}
4062 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4063 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4068 The format of @code{wl-draft-config-alist} is:
4072 '(("@var{regexp of the header}" or @var{elisp expression}
4073 ("@var{Field}" . value(@var{elisp expression}))
4074 (@var{variable} . value(@var{elisp expression}))
4075 (@var{sub-function} . value(@var{elisp expression}))
4078 ("@var{regexp of the header}" or @var{elisp expression}
4079 ("@var{Field}" . value(@var{elisp expression}))
4084 Per default, there are 10 following sub-functions.
4087 'header: Inserts the specified string at the bottom of the header.
4088 'header-top: Inserts the specified string at the top of the header.
4089 'header-file: Inserts the specified file at the bottom of the header.
4090 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4091 'top: Inserts the specified string at the top of the body.
4092 'top-file: Inserts the specified file at the top of the body.
4093 'body: Replaces the body with the specified string.
4094 Specifying @code{nil} deletes the entire body string.
4095 'body-file: Replaces the body with the content of the specified file.
4096 'bottom: Inserts the specified string at the bottom of the body.
4097 'bottom-file: Inserts the specified file at the top of the body.
4098 'part-top: Inserts the specified string at the top of the current part.
4099 'part-bottom: Inserts the specified string at the bottom of the current part.
4100 'template: Applies the specified template.
4101 (refer to the next subsection)
4104 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4105 change them or add your own functions. If you read the code, you can
4106 easily find how to write the functions.
4108 At the first of each item, @var{a regular expression of the header} or
4109 an @var{elisp expression} should be specified. In the case of an elisp
4110 expression, the item is applied when the expression is evaluated
4113 Per default, when multiple items match or are evaluated non-nil, all
4114 such items are applied, but if you set a variable
4115 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4118 At the second of the item, a cons or a list of functions should be
4119 specified. The car part of the cons should be a header field, a
4120 variable, or a sub-function. When a header field is specified, the
4121 field will be modified. If a variable is specified, the value of the
4122 variable will be modified temporarily.
4124 In the cdr part of a cons, not only a variable but also an elisp
4125 expression can be specified as is. If the car part is a header field
4126 and the cdr part is @code{nil}, the field will be deleted.
4128 If you want to use name of parent folder, you can refer the buffer local
4129 variable @code{wl-draft-parent-folder}.
4131 See the next example as well:
4135 (setq wl-draft-config-alist
4137 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4138 ;; @r{applied if it matches the header of the buffer being replied}
4139 (body . " Hello.\n")
4140 (template . "default")
4145 As in the (1) above, if a header regexp is prepended with @code{reply},
4146 it is applied when the draft is prepared by @code{wl-summary-reply} for
4147 example, and when it matches the header being replied. It is ignored
4148 when there is no buffer being replied, like after @code{wl-draft} was
4151 Note that @code{wl-draft-config-alist} is applied only once when
4152 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4153 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4154 aborting transmission, execute @kbd{C-c C-e}
4155 (@code{wl-draft-config-exec}) explicitly.
4157 If you don't want to apply @code{wl-draft-config-alist} when
4158 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4162 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4165 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4166 prepared, do the following:
4169 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4172 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4173 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4177 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4180 @subsection Inserting Templates
4182 @cindex Apply Template
4184 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4185 @kbd{M-x wl-template-select} in the draft buffer.
4187 The format of @code{wl-template-alist} is almost the same as
4188 @code{wl-draft-config-alist}.
4192 (setq wl-template-alist
4195 ("Organization" . "Example Co.Ltd.")
4196 (body . "Hello.\n"))
4198 (template . "default") ;; @r{(a)}
4199 ("To" . "boss@@example.com")
4200 ("Subject" . "Report")
4201 (body-file . "~/work/report.txt")
4207 As you can see, the only difference is item (template) names such as
4208 @samp{default} and @samp{report}, instead of a regexp of header.
4209 Because definition of each item is the same as
4210 @code{wl-draft-config-alist}, you can call another template, like (a).
4212 Executing the command @code{wl-template-select} results in template
4213 selection, but the result differs depending on variable
4214 @code{wl-template-visible-select}.
4216 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4217 window is shown below the draft buffer. You can select a template by
4218 @kbd{n} and @kbd{p} seeing the buffer window.
4220 Press the @key{RET} key and the template is actually applied to the draft
4221 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4222 adjust the window size by @code{wl-template-buffer-lines}.
4224 If @code{wl-template-visible-select} is @code{nil}, you should type the
4225 name of the template in the mini buffer.
4227 As shown in the example in @code{wl-draft-config-alist}, you can select
4228 @samp{default} template by writing:
4231 (template . "default")
4234 @subsection Sending mail by POP-before-SMTP
4235 @cindex POP-before-SMTP
4237 You can send mail by POP-before-SMTP with this single line:
4240 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4244 Configure the following variables if you need.
4247 @item wl-pop-before-smtp-user
4248 The POP user name for POP-before-SMTP authentication.
4249 If unset, @code{elmo-pop3-default-user} is used.
4251 @item wl-pop-before-smtp-server
4252 The POP server name for POP-before-SMTP authentication.
4253 If unset, @code{elmo-pop3-default-server} is used.
4255 @item wl-pop-before-smtp-authenticate-type
4256 The POP authentication method for POP-before-SMTP authentication.
4257 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4259 @item wl-pop-before-smtp-port
4260 The POP port number for POP-before-SMTP authentication.
4261 If unset, @code{elmo-pop3-default-port} is used.
4263 @item wl-pop-before-smtp-stream-type
4264 If non-nil, POP connection is established using SSL. If
4265 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4266 unset, @code{elmo-pop3-default-stream-type} is used.
4269 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4270 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4272 Therefore, if SMTP server and POP server are actually the same, and if
4273 POP folder per default (such as @samp{&}) is available, no settings are
4276 Refer to the following URL about POP-before-SMTP.
4280 http://spam.ayamura.org/tools/smPbS.html
4281 http://www.iecc.com/pop-before-smtp.html
4285 @section Key Bindings
4286 @cindex Keybind, Draft Mode
4287 @cindex Keybind, Draft Buffer
4292 @kindex C-c C-y (Draft)
4293 @findex wl-draft-yank-original
4294 Cites the content of the current message buffer.
4295 (@code{wl-draft-yank-original})
4298 @kindex C-c C-p (Draft)
4299 @findex wl-draft-preview-message
4300 Previews the content of the current draft.
4301 This is useful for previewing MIME multi-part messages.
4302 (@code{wl-draft-preview-message})
4305 @kindex C-c C-s (Draft)
4306 @findex wl-draft-send
4307 Sends the content of the current draft. Does not erase the draft buffer.
4308 This is useful for sending multiple messages, which are a little different
4310 (@code{wl-draft-send})
4313 @kindex C-c C-c (Draft)
4314 @findex wl-draft-send-and-exit
4315 Sends the content of the current draft and erases the draft buffer.
4316 (@code{wl-draft-send-and-exit})
4319 @kindex C-x C-s (Draft)
4320 @findex wl-draft-save
4321 Save the current draft.
4322 (@code{wl-draft-save})
4325 @kindex C-c C-k (Draft)
4326 @findex wl-draft-kill
4327 Kills the current draft.
4328 (@code{wl-draft-kill})
4331 @kindex C-x k (Draft)
4332 @findex wl-draft-mimic-kill-buffer
4333 Kills the current draft.
4334 (@code{wl-draft-mimic-kill-buffer})
4337 @kindex C-c C-z (Draft)
4338 @findex wl-draft-save-and-exit
4339 Saves the current draft, and erases the draft buffer.
4340 This is useful if you want to suspend editing of the draft.
4341 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4342 the @samp{+draft} folder.
4343 (@code{wl-draft-save-and-exit})
4346 @kindex C-c C-r (Draft)
4347 @findex wl-caesar-region
4348 Encodes or decodes the specified region in Caesar cipher.
4349 (@code{wl-caesar-region})
4353 @findex wl-draft-highlight-and-recenter
4354 Recenter and rehighlight current draft.
4355 (@code{wl-draft-highlight-and-recenter})
4359 @findex wl-toggle-plugged
4360 Toggles off-line/on-line states of Wanderlust.
4361 (@code{wl-toggle-plugged})
4364 @kindex C-c C-o (Draft)
4365 @findex wl-jump-to-draft-buffer
4366 Jumps to the other draft buffer, if exists.
4367 With prefix argument, reads a file (if any) from the draft folder when
4368 there is no such buffer.
4369 (@code{wl-jump-to-draft-buffer})
4372 @kindex C-c C-e (Draft)
4373 @findex wl-draft-config-exec
4374 Applies @code{wl-draft-config-alist}.
4375 (@code{wl-draft-config-exec})
4378 @kindex C-c C-j (Draft)
4379 @findex wl-template-select
4381 (@code{wl-template-select})
4384 @kindex C-c C-a (Draft)
4386 Enter Address Manager.
4387 @xref{Address Manager}.
4391 @kindex C-c C-d (Draft)
4392 @findex wl-draft-elide-region
4393 Elide the text between point and mark (@code{wl-draft-elide-region}).
4394 The text is killed and replaced with the contents of the variable
4395 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4399 @section Customizable Variables
4402 @item wl-subscribed-mailing-list
4403 @vindex wl-subscribed-mailing-list
4404 The initial setting is @code{nil}. Mailing lists to which you
4405 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4406 field of a reply draft, removes your own address from
4407 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4408 contained in @samp{To:} or @samp{Cc:} field of a message to be
4409 automatically re-filed, the destination folder will be leaned in
4410 connection with the address.
4416 (setq wl-subscribed-mailing-list
4417 '("wl@@lists.airs.net"
4419 "emacs-mime-ja@@m17n.org"))
4423 @item wl-insert-mail-followup-to
4424 @vindex wl-insert-mail-followup-to
4425 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4426 field is automatically inserted in the draft buffer.
4428 @item wl-insert-mail-reply-to
4429 @vindex wl-insert-mail-reply-to
4430 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4431 field is automatically inserted in the draft buffer.
4433 @item wl-auto-insert-x-face
4434 @vindex wl-auto-insert-x-face
4435 The initial setting is @code{t}. If non-nil and there is an encoded
4436 X-Face string in a file @file{~/.xface} (the value of the variable
4437 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4438 draft buffer. If @code{nil}, it is not automatically inserted.
4440 @item wl-insert-message-id
4441 @vindex wl-insert-message-id
4442 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4443 is automatically inserted on the transmission.
4445 @item wl-message-id-use-wl-from
4446 @vindex wl-message-id-use-wl-from
4447 The initial setting is @code{nil}. If non-nil, the value of
4448 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4450 @item wl-local-domain
4451 @vindex wl-local-domain
4452 The initial setting is @code{nil}. If @code{nil}, the return value of
4453 the function @code{system-name} will be used as the domain part of
4456 If @code{system-name} does not return FQDN (i.e. the full name of the
4457 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4458 to the string of the local domain name without hostname (like
4459 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4460 @samp{.} @code{wl-local-domain} is used as domain part of the
4463 If your terminal does not have global IP, set the value of
4464 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4465 you use invalid @samp{Message-ID:}.)
4467 Moreover, concatenation of @code{system-name} @samp{.}
4468 @code{wl-local-domain} will be used as an argument to the HELO command
4471 @item wl-message-id-domain
4472 @vindex wl-message-id-domain
4473 The initial setting is @code{nil}. If non-nil, this value is used as a
4474 domain part of the @samp{Message-ID:}. If your terminal does not have
4475 global IP address, set unique string to this value (e.x. your e-mail
4478 @item wl-unique-id-suffix
4479 @vindex wl-unique-id-suffix
4480 The initial setting is @samp{.wl}. You can specify the string in generated
4481 Message-ID which appear just before @samp{@@}.
4483 @item wl-draft-config-alist
4484 @vindex wl-draft-config-alist
4485 The initial setting is @code{nil}. Modifies the draft message just
4486 before the transmission. The content of @code{wl-draft-config-alist}
4487 will be automatically applied only once on the transmission. If you
4488 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4491 @item wl-template-alist
4492 @vindex wl-template-alist
4493 The initial setting is @code{nil}.
4494 This variable specifies the template to be applied in the draft buffer.
4496 @item wl-draft-config-matchone
4497 @vindex wl-draft-config-matchone
4498 The initial setting is @code{nil}. If non-nil, only the first matching
4499 item is used when @code{wl-draft-config-alist} is applied. If
4500 @code{nil}, all matching items are used.
4502 @item wl-template-visible-select
4503 @vindex wl-template-visible-select
4504 The initial setting is @code{t}.
4505 If non-nil, you can preview the result of the template selection in
4508 @item wl-template-confirm
4509 @vindex wl-template-confirm
4510 The initial setting is @code{nil}.
4511 If non-nil, asks for confirmation when you press the enter key to select
4512 template while previewing.
4514 @item wl-template-buffer-lines
4515 @vindex wl-template-buffer-lines
4516 The initial setting is 7.
4517 If @code{wl-template-visible-select} is non-nil, this variable specifies
4518 the size of the preview window.
4520 @item wl-draft-reply-buffer-style
4521 @vindex wl-draft-reply-buffer-style
4522 The initial setting is @code{split}. @code{split} or @code{full} can be
4523 specified. In the case of @code{full}, the whole frame will be used for
4524 a reply draft buffer when it is prepared.
4526 @item wl-draft-use-frame
4527 @vindex wl-draft-use-frame
4528 The initial setting is @code{nil}.
4529 If non-nil, use new frame for the draft.
4531 @item wl-draft-truncate-lines
4532 @vindex wl-draft-truncate-lines
4533 The initial value is the value of @code{default-truncate-lines}.
4534 If it is non-nil, truncate long lines in draft buffer.
4538 The initial setting is the value of the variable
4539 @code{user-mail-address}. The value of this variable is inserted as a
4540 @samp{From:} field of the draft when it is prepared.
4542 @item wl-envelope-from
4543 @vindex wl-envelope-from
4544 The initial setting is @code{nil}.
4545 The value of this variable is used for envelope from (MAIL FROM).
4546 If @code{nil}, the address part of @code{wl-from} is used.
4548 @item wl-user-mail-address-list
4549 @vindex wl-user-mail-address-list
4550 The initial setting is @code{nil}.
4551 This is the User's address list. If you have multiple addresses,
4556 The initial setting is @code{nil}.
4557 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4558 the draft when it is prepared. If function is specified, its return
4563 The initial setting is @code{nil}.
4564 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4565 the draft when it is prepared.
4567 @item wl-reply-subject-prefix
4568 @vindex wl-reply-subject-prefix
4569 The initial setting is @samp{Re: }.
4570 In the @samp{Subject:} of the reply draft, this string is prepended to
4571 the @samp{Subject:} of being replied.
4573 @item wl-draft-reply-use-address-with-full-name
4574 @vindex wl-draft-reply-use-address-with-full-name
4575 The initial setting is @code{t}.
4576 If non-nil, insert her full name with address when prepare a draft for
4577 reply a message. If it is @code{nil}, insert her address only.
4579 @item wl-draft-enable-queuing
4580 @vindex wl-draft-enable-queuing
4581 The initial setting is @code{t}.
4582 This flag controls off-line transmission. If non-nil, the draft is
4585 @item wl-draft-use-cache
4586 @vindex wl-draft-use-cache
4587 The initial setting is @code{nil}. If the value is non-nil and
4588 @code{wl-insert-message-id} is nil, cache the message which is sent.
4590 @item wl-fcc-force-as-read
4591 @vindex wl-fcc-force-as-read
4592 The initial setting is @code{nil}. If the value is non-nil,
4593 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4595 @item wl-auto-flush-queue
4596 @vindex wl-auto-flush-queue
4597 The initial setting is t.
4598 This flag controls automatic transmission of the queue when Wanderlust
4599 becomes on-line. If non-nil, the queue is automatically transmitted
4600 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4601 manually, press @kbd{F} in the folder mode.
4603 @item wl-ignored-forwarded-headers
4604 @vindex wl-ignored-forwarded-headers
4605 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4606 All headers that match this regexp will be deleted when forwarding a message.
4608 @item wl-ignored-resent-headers
4609 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4610 All headers that match this regexp will be deleted when resending a message.
4612 @item wl-draft-always-delete-myself
4613 @vindex wl-draft-always-delete-myself
4614 If non-nil, always removes your own address from @samp{To:} and
4615 @samp{Cc:} when you are replying to the mail addressed to you.
4617 @item wl-draft-delete-myself-from-bcc-fcc
4618 @vindex wl-draft-delete-myself-from-bcc-fcc
4619 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4620 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4622 @item wl-smtp-posting-server
4623 @vindex wl-smtp-posting-server
4624 The initial setting is @code{nil}.
4625 This is the SMTP server name for mail transmission.
4627 @item wl-smtp-posting-user
4628 @vindex wl-smtp-posting-user
4629 The initial setting is @code{nil}.
4630 This is the user name for SMTP AUTH authentication. If @code{nil},
4631 @code{smtp-authenticate-user} is used.
4633 @item wl-smtp-authenticate-type
4634 @vindex wl-smtp-authenticate-type
4635 The initial setting is @code{nil}.
4636 This is the authentication method for SMTP AUTH authentication. If
4637 @code{nil}, @code{smtp-authenticate-type} is used. If
4638 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4641 @item wl-smtp-connection-type
4642 @vindex wl-smtp-connection-type
4643 The initial setting is @code{nil}.
4644 This variable specifies how to establish SMTP connections.
4645 If @code{nil}, @code{smtp-connection-type} is used.
4646 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4648 @item wl-nntp-posting-server
4649 @vindex wl-nntp-posting-server
4650 The initial setting is @code{nil}.
4651 This is the NNTP server name used for news submission.
4652 If @code{nil}, @code{elmo-nntp-default-server} is used.
4654 @item wl-nntp-posting-user
4655 @vindex wl-nntp-posting-user
4656 The initial setting is @code{nil}.
4657 This is the user name for AUTHINFO authentication on news submission.
4658 If @code{nil}, @code{elmo-nntp-default-user} is used.
4659 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4661 @item wl-nntp-posting-port
4662 @vindex wl-nntp-posting-port
4663 The initial setting is @code{nil}.
4664 This is the port number of the NNTP server used for news submission.
4665 If @code{nil}, @code{elmo-nntp-default-server} is used.
4667 @item wl-nntp-posting-stream-type
4668 @vindex wl-nntp-posting-stream-type
4669 The initial setting is @code{nil}.
4670 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4671 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4672 connection will be established.
4674 @item wl-pop-before-smtp-user
4675 @vindex wl-pop-before-smtp-user
4676 The initial setting is @code{nil}.
4677 This is the POP user name for POP-before-SMTP.
4678 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4680 @item wl-pop-before-smtp-server
4681 @vindex wl-pop-before-smtp-server
4682 The initial setting is @code{nil}.
4683 This is the POP server name for POP-before-SMTP.
4684 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4686 @item wl-pop-before-smtp-authenticate-type
4687 @vindex wl-pop-before-smtp-authenticate-type
4688 The initial setting is @code{nil}.
4689 This is the authentication method for POP-before-SMTP authentication.
4690 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4692 @item wl-pop-before-smtp-port
4693 @vindex wl-pop-before-smtp-port
4694 The initial setting is @code{nil}.
4695 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4696 @code{elmo-pop3-default-port} is used.
4698 @item wl-pop-before-smtp-stream-type
4699 @vindex wl-pop-before-smtp-stream-type
4700 The initial setting is @code{nil}.
4701 This flag controls the use of SSL for POP-before-SMTP. If it is
4702 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4703 STARTTLS (RFC2595) connection will be established.
4705 @item wl-draft-queue-save-variables
4706 @vindex wl-draft-queue-save-variables
4707 Specifies a list of variable to which queued messages are saved on the
4708 off-line transmission.
4710 @item wl-draft-sendlog
4711 @vindex wl-draft-sendlog
4712 The initial setting is @code{t}.
4713 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4717 @item drafts are sent by smtp or qmail
4718 @item saved into folders by fcc
4719 @item saved into folders by queuing
4722 (it is written even if the transmission fails).
4723 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4724 and left to the logging function of @command{imput}.
4727 @item wl-draft-sendlog-max-size
4728 @vindex wl-draft-sendlog-max-size
4729 The initial setting is 20000 (in bytes).
4730 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4731 beyond the size specified by this variable.
4735 The initial setting is @code{nil}.
4736 If non-nil, address completion uses LDAP.
4738 @item wl-ldap-server
4739 @vindex wl-ldap-server
4740 The initial setting is @samp{localhost}.
4741 LDAP server name for address completion.
4744 @vindex wl-ldap-port
4745 The initial setting is @code{nil}.
4746 If non-nil, the value is used as port number.
4749 @vindex wl-ldap-base
4750 The initial setting is @samp{c=US}.
4751 LDAP search starting point (base) for address completion.
4753 @item wl-draft-remove-group-list-contents
4754 @vindex wl-draft-remove-group-list-contents
4755 The initial setting is @code{t}.
4756 If non-nil, remove the group-lists' members in the recipients when
4757 sending the message (group-list means the description such as
4758 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4761 @node Disconnected Operations, Expire and Archive, Draft, Top
4762 @chapter Off-line Management
4763 @cindex Disconnected Operations
4765 Wanderlust has on-line and off-line states.
4768 * Off-line State:: Wanderlust has on-line and off-line states
4769 * Enable Operations:: Enable Disconnected Operations
4770 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4771 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4772 * Variables of Plugged Mode:: Customize Plugged Mode
4776 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4777 @section Off-line State
4779 Wanderlust has on-line and off-line states. In the off-line state, you
4780 cannot access messages via network, unless they are cached.
4782 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4783 in the mode line indicates the off-line state. In folder or summary
4784 modes, press @kbd{M-t} to switch between off- and on-line.
4786 You can invoke Wanderlust in the off-line state by setting
4787 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4789 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4790 ignores uncached messages.
4793 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4794 @section Enable Disconeected Operations
4796 Even in the off-line state, provided that relevant messages are cached,
4797 and the variable @code{elmo-enable-disconnected-operation} (described
4798 later) is non-nil, you can following operations:
4799 @xref{Plugged Mode}, @xref{Off-line State settings}.
4802 * Send Messages off-line:: Transmit Messages
4803 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4804 * Creation of Folders:: Create Folders off-line (IMAP4)
4805 * Marking:: Mark (IMAP4)
4806 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4809 As soon as Wanderlust becomes on-line, such operations invoked off-line
4810 are reflected in the servers via network.
4813 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4814 @subsection Transmission of Messages
4816 You can send mail/news messages off-line (if you are using
4817 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4818 accumulated in the queue folder, @samp{+queue}. These messages are
4819 transmitted at once when Wanderlust becomes on-line.
4821 You can visit @samp{+queue} in the off-line state and confirm content of
4822 messages in the queue. You can also remove messages. Removed messages
4823 are not transmitted even in the on-line state.
4826 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4827 @subsection Re-file and Copy (IMAP4)
4829 Re-file and copy operations to IMAP folders invoked during the off-line
4830 state are accumulated in the queue, and reflected in the server side
4831 when Wanderlust becomes on-line. If you visit destination folders after
4832 off-line re-file or copy, it looks as if messages were appended even in
4835 For the safety reasons, messages re-filed off-line are removed from
4836 source folders only if their @samp{Message-ID:} match messages on the
4837 servers. While the queue is processed, messages that failed to be
4838 re-filed or copied to the specified folders are appended to the folder
4842 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4843 @subsection Creation of Folders (IMAP4)
4845 You can create IMAP folders off-line. The creation of folders are
4846 reflected in the servers when Wanderlust becomes on-line. At that time,
4847 if folders failed to be created on the servers for any reasons, messages
4848 re-filed to such folders are appended to the folder @samp{+lost+found}.
4851 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4852 @subsection Marking (IMAP4)
4854 Off-line changes in unread/read and importance mark @samp{$} information
4855 are also reflected in the servers when Wanderlust becomes on-line.
4858 @node Pre-fetching Reservations, , Marking, Enable Operations
4859 @subsection Pre-fetching (IMAP4, NNTP)
4861 You can make reservations for pre-fetching messages in IMAP or NNTP
4862 folders. Reserved messages are marked with @samp{!} but not cached
4863 yet. When Wanderlust becomes on-line, they are pre-fetched from
4866 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4867 these off-line operations for IMAP4 and NNTP do not take place, and
4868 off-line re-file, copy or suchlike simply results in error.
4870 Because off-line operations use cache files, it is a bad idea to erase
4871 them by hand; it may cause Wanderlust to malfunction.
4873 If you want to remove caches, be sure to execute @kbd{M-x
4874 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4875 remove caches for messages relevant to off-line operations.
4878 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4879 @section Switching On-line/Off-line per Server/Port
4881 @kbd{M-t} described above switches networking states as a whole, but you
4882 can switch on-line/off-line per server/port.
4884 Pressing @kbd{C-t} in the folder or summary modes brings you in
4885 wl-plugged-mode shown below, in which you can change the plugged state
4890 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4893 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4894 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4896 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4897 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4903 The first line indicates status of the following three variables, and
4904 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4905 column modifies the values of these variables.
4909 "Queuing" @code{wl-draft-enable-queuing}
4910 "AutoFlushQueue" @code{wl-auto-flush-queue}
4911 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4915 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4918 The second and after lines indicate on-line/off-line states of servers
4919 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4920 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4921 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4923 @dfn{sending queue} means messages accumulated in the folder
4924 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4925 off-line operations when @code{elmo-enable-disconnected-operation} is
4927 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4928 @c off-line operations are enabled.
4930 They are displayed if there are any of them. In the example above, in
4931 the sending queue there are two messages (the first and the second in
4932 the queue folder) for smtp to hosta and one (the third) for nntp to
4933 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4936 If you change @samp{(wl-plugged)} in the second line, the variable
4937 @code{wl-plugged} is changed, so that the mode line indicator and
4938 plugged states of all ports are affected. If you change plugged states
4939 of any servers or ports, @samp{(wl-plugged)} in the second line is
4940 affected depending on @code{elmo-plugged-condition} settings and the
4941 plugged state of each port.
4944 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4945 @section Invoking Wanderlust in the Off-line State
4947 As described before, if you set @code{wl-plugged} to @code{nil} in
4948 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4949 off-line state. You can specify off-line state on a per server or port
4950 basis. Refer to @code{wl-reset-plugged-alist} also.
4952 Usually, when Wanderlust starts up, the plugged state of each port is
4953 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4954 @code{wl-nntp-posting-server} and so on. If you want to change the
4955 plugged state of these ports or to add other ports, configure
4956 @code{wl-make-plugged-hook} with a function.
4960 (add-hook 'wl-make-plugged-hook
4962 (elmo-set-plugged plugged-value(t/nil) server port)
4963 ;; @r{add or change plugged states of the port of the server}
4964 (elmo-set-plugged plugged-value(t/nil) server)
4965 ;; @r{if the port is omitted, all ports are affected}
4966 ;; @r{(you cannot omit the port if you newly add the server)}
4972 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4973 @section Customizable Variables
4978 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4979 mode from the beginning.
4981 @item wl-queue-folder
4982 @vindex wl-queue-folder
4983 The initial setting is @samp{+queue}.
4984 This is the folder in which messages in the transmission queue are
4987 @item wl-auto-flush-queue
4988 @vindex wl-auto-flush-queue
4989 The initial setting is @code{t}.
4990 This flag controls automatic transmission of the queue when Wanderlust
4991 becomes on-line. If non-nil, the queue is automatically transmitted
4992 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4993 manually, press @kbd{F} in the folder mode.
4995 @item elmo-enable-disconnected-operation
4996 @vindex elmo-enable-disconnected-operation
4997 The initial setting is @code{nil}. Controls off-line operations
4998 regarding IMAP4. If non-nil, off-line operations are carried out.
5000 @item elmo-lost+found-folder
5001 @vindex elmo-lost+found-folder
5002 The initial setting is @samp{+lost+found}.
5003 This is the folder to which messages are saved when they fails to be
5004 appended while the off-line re-file/copy queue is processed.
5006 @item elmo-plugged-condition
5007 @vindex elmo-plugged-condition
5008 The initial setting is @code{one}.
5009 The value of @code{wl-plugged} reflects the return value of the function
5010 @code{elmo-plugged-p} (without arguments).
5011 This variable @code{elmo-plugged-condition} specifies the condition on
5012 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5013 plugged state of each port.
5016 'one : plugged if one or more ports are plugged.
5017 'all : plugged if all ports are plugged.
5018 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5019 states of the ports.
5020 @var{function} : reflects the return value of the @var{function}
5021 functions available per default
5022 'elmo-plug-on-by-servers
5023 : reflects the plugged state of the servers specified by the
5024 variable elmo-plug-on-servers.
5025 'elmo-plug-on-by-exclude-servers
5026 : reflects the plugged state of the servers that are not
5027 in elmo-plug-on-exclude-servers.
5028 elmo-plug-on-exclude-servers defaults to
5031 (system-name)without the domain part)
5037 (setq elmo-plugged-condition 'all)
5039 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5040 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5042 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5043 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5047 @item wl-reset-plugged-alist
5048 @vindex wl-reset-plugged-alist
5049 The initial setting is @code{t}. If non-nil, plugged states are
5050 initialized on a per server or port basis when Wanderlust starts up.
5052 If @code{nil}, plugged states are retained while Emacs is running. In
5053 other words, they are initialized when Emacs is restarted even if the
5054 value is @code{nil}.
5058 @node Expire and Archive, Scoring, Disconnected Operations, Top
5059 @chapter Automatic Expiration and Archiving of Messages
5060 @cindex Expire and Archive
5063 * Expire:: Expiration and Archiving
5064 * Archive:: Archiving All Messages
5068 @node Expire, Archive, Expire and Archive, Expire and Archive
5070 @cindex Expire Message
5072 Expiration means deletion of old messages which have outlasted a
5073 certain period of time.
5075 @code{wl-expire} supports not only simple deletion, but also moving to
5076 specified archiving folders.
5080 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5081 or @kbd{M-e} in the summary mode.
5083 @subsection Configuring @code{wl-expire-alist}
5085 An example configuration of @code{wl-expire-alist} is shown below.
5086 Everything in this @code{wl-expire-alist} makes a great difference in
5087 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5088 to @code{t}, especially in the initial stage.
5092 (setq wl-expire-alist
5093 '(("^\\+trash$" (date 14) remove)
5095 ("^\\+tmp$" (date 7) trash)
5096 ;; @r{re-file to @code{wl-trash-folder}}
5097 ("^\\+outbox$" (number 300) "$outbox;lha")
5098 ;; @r{re-file to the specific folder}
5100 ;; @r{do not expire}
5101 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5102 ;; @r{archive by message number (retaining numbers)}
5103 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5104 ;; @r{archive by a fixed number (retaining numbers)}
5105 ("^\\+diary$" (date 30) wl-expire-archive-date)
5106 ;; @r{archive by year and month (numbers discarded)}
5111 Items in the list has the format of:
5114 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5118 The folder is examined if it matches @var{regexp-for-folders} from the
5119 beginning of the list. If you invoke expiration on the folder that does
5120 not match any of them, nothing will happen. And if either the second or
5121 the third element of the item is @code{nil}, expiration will not take
5124 You can use any one of the following for
5125 @var{specification-of-message-to-be-deleted}:
5128 @item (number @var{n1} [@var{n2}])
5129 deletes messages depending on the number of messages in the folder.
5131 @var{n1} is the number of messages which should survive deletion, for example
5132 if its value is 500, the newest 500 messages survive and the rests are
5135 @var{n2} is the number of messages in the folder on which expiration should
5136 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5137 folders with 510 or more messages are expired.
5138 If you configured automatic expiration, frequently used folders may
5139 expire every time it receive messages, and you may be annoyed with the
5140 long delay in reading mail.
5141 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5142 expiration would not take place until a certain number of messages
5145 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5146 with important/new/unread) are not deleted.
5147 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5148 will expire so as to have 500 messages including such ones.
5149 Otherwise, it will have 500 messages except such ones.
5151 @item (date @var{d1})
5152 deletes messages depending on the dates.
5154 Messages dated @var{d1} or more days ago are deleted, for example if its
5155 value is seven, messages seven days old or more are deleted. Note that
5156 the date is the one in the @samp{Date:} field of the message, not when
5157 the message entered the folder.
5159 Messages with no or invalid @samp{Date:} field does not expire; you
5160 might have to delete them by hand.
5163 You can use any one of the following in the place of @var{destination}:
5167 deletes the messages instantly.
5170 hide the messages from summary (messages are not deleted).
5173 moves the messages to @code{wl-trash-folder}.
5175 @item @var{string}(folder)
5176 moves the messages to the folder specified with @var{string}.
5178 It would be useful for specifying an archiving folder, but because this
5179 does not move important messages, it might be better to use the
5180 standard functions described below.
5182 @item @var{function}
5183 invokes the specified @var{function}.
5185 To the @var{function}, three arguments are passed: a folder name, a list
5186 of messages to be deleted, and msgdb information of the summary. You
5187 can specify function-specific arguments after the name of the
5188 @var{function}. Note that the list contains messages with marks in
5189 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5192 These are four standard functions; three of them move messages to an archive
5193 folder in the specified way. This means old messages can be compressed
5194 and saved in a file, being deleted from the original folder.
5195 The last one divides messages to some MH folders.
5198 @item wl-expire-archive-number1
5199 re-files to archiving folders corresponding to the message numbers of
5200 the messages being deleted. For example, a message numbered 102 will be
5201 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5202 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5203 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5205 The archiving folders to which messages are re-filed are determined by
5206 the name of the folder as follows (in this case, archiving folders are
5207 handled as if @code{elmo-archive-treat-file} were non-nil).
5210 @item If the folder type is localdir:
5211 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5213 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5214 (@file{~/Mail/ml/wl-00100.zip}).
5216 @item The folder type is other than localdir:
5217 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5219 For example, @samp{%#mh/ml/wl} corresponds to
5220 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5223 As you can see, in the case of localdir, the folder type is not included
5224 in the path name, but otherwise it is included.
5225 And you can control the prefix to the archiving folder name by
5226 @code{wl-expire-archive-folder-prefix}.
5227 Refer to @code{wl-expire-archive-folder-prefix} for details.
5229 @item wl-expire-archive-number2
5230 re-files every certain number of messages to archiving folders.
5232 This differs from @samp{wl-expire-archive-number1} in that this re-files
5233 to the folder up to the specified number regardless of message numbers.
5234 The archiving folders to which messages are re-filed are determined in the
5235 same way as @code{wl-expire-archive-number1}.
5237 @item wl-expire-archive-date
5238 re-files messages depending on its date (year and month) to archive
5241 For example, a message dated December 1998 is re-filed to
5242 @code{$folder-199812;zip}. The name of the archiving folders except the
5243 date part are determined in the same way as
5244 @code{wl-expire-archive-number1}.
5247 You can set the first argument to these three standard functions to non-nil
5248 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5249 For example, it can be specified just after the name of the function:
5252 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5255 If you omit the argument, consecutive numbers from 1 are assigned for
5256 each archiving folder.
5258 @item wl-expire-localdir-date
5259 divedes messages depending on its date (year and month) to MH folders
5260 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5264 @subsection Treatment for Important or Unread Messages
5266 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5267 standard function, messages with marks in
5268 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5269 messages} thereafter) are retained.
5271 Per default, this variable include the important, new, and unread marks,
5272 so that messages with these marks are not removed.
5273 Note that you cannot include the temporary mark (i.e. temporary marks
5274 are removed anyway), and be sure to process temporary marks before you
5277 @subsection Auto Expiration
5279 The following setup invokes expiration when you move into the summary
5280 mode. There will be no confirmation, so make sure you made no mistake
5281 in regexp and other settings before you set up this.
5285 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5289 In the folder mode, you can invoke expiration per group as well as per
5290 folder. Therefore, if you specify @samp{Desktop} group, all folders
5291 matching @code{wl-expire-alist} expire.
5295 @subsection Treating archive folders.
5296 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5297 you must set non-nil value to @code{elmo-archive-treat-file}.
5299 @subsection Confirming
5301 If you are to use @code{remove}, try @code{trash} at first and see
5302 messages move to @code{wl-trash-folder} as expected, then replace it
5303 with @code{remove}. It would be dangerous to use @code{remove} from the
5306 If you are to use @code{wl-expire-archive-number1} and the like, try to
5307 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5308 you can append messages to it. Even if settings in
5309 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5310 would not be saved anywhere and disappeared in case the archiver program
5313 After you make sure you can archive to the folder correctly, you can
5314 invoke expiration and utilize the log.
5316 If you set @code{wl-expire-use-log} to @code{t},
5317 @file{~/.elmo/expired-log} should contain the log, for example:
5321 delete +ml/wl (593 594 595 596 597 598 599)
5322 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5326 The first column indicates the operation, i.e. @samp{delete},
5327 @samp{copy}, or @samp{move}. The next is the name of the folder that
5328 expired. In the case of @samp{copy} and @samp{move}, the destination
5329 folder is recorded after @samp{->}. The last is the list of message
5330 numbers that are actually deleted or moved (in the case of @samp{copy}
5331 and @samp{move}, the number is the one in the source folder, rather than
5332 the destination folder).
5334 @subsection Re-filing Reserved Messages
5336 The three standard functions copy reserved messages to the archive
5337 folder, but do not delete them from the source folder. Because
5338 reserved messages and the like always remain, they are recorded in
5339 @file{~/.elmo/expired-alist} so that they are not copied over and over
5340 again. They are not recorded if copied by @code{wl-summary-archive}.
5342 If you enabled logging, usually @samp{move} is recorded for re-filing,
5343 but instead @samp{copy} and @samp{delete} are recorded separately if
5344 reserved messages are involved. This is because it actually copies
5345 messages including reserved, then deletes ones except reserved in that
5348 @section Customizable Variables
5351 @item wl-expire-alist
5352 @vindex wl-expire-alist
5353 The initial setting is @code{nil}.
5354 This variable specifies folders and methods to expire. For details,
5355 refer to @code{wl-expire-alist} settings above.
5357 @item wl-summary-expire-reserve-marks
5358 @vindex wl-summary-expire-reserve-marks
5359 The initial setting is the list below.
5363 (list wl-summary-important-mark
5365 wl-summary-unread-mark
5366 wl-summary-unread-uncached-mark
5367 wl-summary-unread-cached-mark)
5371 Messages with these marks are retained in the folder, even after
5373 Only permanent marks can be listed, not temporary marks.
5375 You can list marks one by one as in the default; you can use the
5376 following settings as well:
5380 All messages with permanent marks are retained,
5381 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5385 All messages are handled as usual ones that are already read, no matter
5386 what marks they have; even important messages are deleted.
5389 @item wl-expire-archive-files
5390 @vindex wl-expire-archive-files
5391 The initial setting is 100.
5392 This variable specifies the number of messages to be retained in one
5395 @item wl-expire-number-with-reserve-marks
5396 @vindex wl-expire-number-with-reserve-marks
5397 The initial setting is @code{nil}.
5398 If non-nil, if expiring messages are specified by @code{number},
5399 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5401 @item wl-expire-archive-get-folder-function
5402 @vindex wl-expire-archive-get-folder-function
5403 The initial setting is @code{wl-expire-archive-get-folder}.
5405 This variable specifies a function that returns the name of an archiving
5406 folder for standard functions in the place of @var{destination}.
5407 You can use the following three variables for simple modification of
5408 folder names; if you want more complex settings, define your own
5409 function in this variable.
5411 @code{wl-expire-archive-get-folder} can be customized by these
5414 @item @code{wl-expire-archive-folder-name-fmt}
5415 @item @code{wl-expire-archive-folder-type}
5416 @item @code{wl-expire-archive-folder-prefix}
5419 @item wl-expire-archive-folder-name-fmt
5420 @vindex wl-expire-archive-folder-name-fmt
5421 The initial setting is @samp{%s-%%05d;%s}.
5422 This is a @code{format} string for archiving folders used in
5423 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5424 Note that you must specify the message number by @samp{%%d}, because it
5425 is parsed twice by @code{format}.
5427 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5430 @item wl-expire-archive-date-folder-name-fmt
5431 @vindex wl-expire-archive-date-folder-name-fmt
5432 The initial setting is @samp{%s-%%04d%%02d;%s}.
5433 This is a @code{format} string for archiving folders used in
5434 @code{wl-expire-archive-date}. Note that you must specify the message
5435 number by @samp{%%d}, because it is parsed twice by @code{format}.
5436 There should be @samp{%%d} twice, one for the year and the other for the
5439 If you modify this, adjust
5440 @code{wl-expire-archive-date-folder-num-regexp} as well.
5442 @item wl-expire-archive-folder-type
5443 @vindex wl-expire-archive-folder-type
5444 The initial setting is @code{zip}.
5445 This variable specifies an archiver type of the archiving folders.
5447 @item wl-expire-archive-folder-prefix
5448 @vindex wl-expire-archive-folder-prefix
5449 The initial setting is @code{nil}.
5450 This variable specifies the prefix (directory structure) to archiving
5452 Exercise extreme caution in using this feature, as it has not been
5454 In the worst case, there is a fear of destructing archiving folders.
5458 There will be no prefix.
5461 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5462 @samp{$ml/wl-00000;zip;wl}.
5465 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5468 @samp{$ml/wl-00000;zip;ml/wl}.
5471 @item wl-expire-archive-folder-num-regexp
5472 @vindex wl-expire-archive-folder-num-regexp
5473 The initial setting is @samp{-\\([-0-9]+\\);}.
5474 This variable specifies the regular expression to be used for getting
5475 message numbers from multiple archiving folders specified by
5476 @code{elmo-list-folders}.
5477 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5479 @item wl-expire-archive-date-folder-num-regexp
5480 @vindex wl-expire-archive-date-folder-num-regexp
5481 The initial setting is @samp{-\\([-0-9]+\\);}.
5482 This is the regular expression to be used for getting message numbers
5483 from multiple archiving folders specified by @code{elmo-list-folders}.
5484 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5486 @item wl-expire-delete-oldmsg-confirm
5487 @vindex wl-expire-delete-oldmsg-confirm
5488 The initial setting is @code{t}.
5489 If non-nil, messages older than the one with the largest number will be
5490 deleted with confirmation.
5491 If @code{nil}, they are deleted without confirmation.
5493 This feature is valid only if non-nil is specified as a argument to the
5494 standard functions so as to retain numbers.
5496 @item wl-expire-use-log
5497 @vindex wl-expire-use-log
5498 The initial setting is @code{nil}.
5499 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5500 They are appended but not truncated or rotated automatically; you might
5501 need to remove it manually.
5503 @item wl-expire-add-seen-list
5504 @vindex wl-expire-add-seen-list
5505 The initial setting is @code{t}.
5507 If non-nil, when messages are re-filed by expiration, read/unread
5508 information is passed to the destination folder.
5510 However if you do not read the destination folder from Wanderlust,
5511 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5512 want to set this to @code{nil} if you are simply saving to some
5513 archiving folders. Even if its value is @code{nil}, messages in the
5514 archiving folders are simply treated as unread; it does not affect
5517 @item wl-expire-folder-update-msgdb
5518 @vindex wl-expire-folder-update-msgdb
5519 The initial setting is @code{t}.
5520 If @code{t}, in the folder mode, expiration is carried out after
5521 updating summary information. If you specified a list of regular
5522 expressions of folder names, summary information is updated for matching
5527 @node Archive, , Expire, Expire and Archive
5528 @section Archiving Messages
5530 @subsection Archiving Messages
5531 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5532 folders. If there are the archiving folders already, only new messages
5535 You can use @code{wl-archive-alist} in order to specify how messages are
5536 archived according to their folder names, as in @code{wl-expire-alist}.
5541 (setq wl-archive-alist
5542 '(("^\\+tmp$" wl-archive-date)
5543 ("^\\+outbox$" wl-archive-number2)
5544 (".*" wl-archive-number1)))
5548 Each item in the list has the following format:
5551 (@var{folders-regexp} @var{deleting-function})
5554 As you can see, you can only use a function after @var{folders-regexp}.
5555 Per default, there are three functions:
5558 @item @code{wl-archive-number1}
5559 @item @code{wl-archive-number2}
5560 @item @code{wl-archive-date}
5563 As inferred from their names, they work similarly to "expire" versions,
5564 other than the following points:
5567 @item No messages are deleted
5568 @item Message numbers are retained even if invoked without arguments
5571 These functions are good to archive all messages in a folder by their
5572 numbers or by their dates.
5573 These are also useful for backup or confirmation purposes before
5575 If you try to re-file them after they are archived, they are deleted but
5578 Per default, the archiving folders to which messages are copied are
5579 determined automatically by @code{wl-expire-archive-get-folder-function}.
5580 You can copy to a specific folder by invoking with a prefix argument,
5581 i.e. @kbd{C-u M-x wl-summary-archive}.
5583 Note that this feature has not been seriously tested, because you can
5584 simply copy to an archiving folder, for example by
5585 @code{wl-summary-copy-region}.
5587 The archiving folders are determined by the same logic as in
5588 @code{wl-summary-expire}; the following customizable variables are
5592 @item @code{wl-expire-archive-files}
5593 @item @code{wl-expire-archive-get-folder-function}
5594 @item @code{wl-expire-archive-folder-name-fmt}
5595 @item @code{wl-expire-archive-folder-type}
5596 @item @code{wl-expire-archive-folder-prefix}
5597 @item @code{wl-expire-archive-folder-num-regexp}
5600 @subsection Customizable Variables
5603 @item wl-archive-alist
5604 @vindex wl-archive-alist
5605 The initial setting is the list shown below:
5609 ((".*" wl-archive-number1))
5614 This variable specifies a function that copies to archiving folders.
5615 To the function, three arguments are passed: a folder name, a list of
5616 messages in the folder, and msgdb information of the summary.
5617 Needless to say, you can use your own function.
5621 @node Scoring, Address Book, Expire and Archive, Top
5622 @chapter Score of the Messages
5624 @c @cindex Kill File
5626 Scoring is the function that associates a score (value) with each
5627 message, and marks as read or deletes from the summary according to it.
5629 You can put target or important marks on essential messages, or read marks
5630 on the ones you do not want to read, for example spam articles.
5632 This scoring function has a capability and a format similar to the one
5633 that Gnus has, although there are some unsupported features and
5634 Wanderlust specifics.
5635 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5638 * Score Commands:: Score Commands
5639 * Score File Format:: Score File Format
5643 @node Score Commands, Score File Format, Scoring, Scoring
5644 @section Score Commands
5645 @cindex Score Commands
5647 @subsection Score File Specification
5649 @code{wl-score-folder-alist} specifies score files or variables in which
5650 scores are defined, corresponding to folder names.
5654 (setq wl-score-folder-alist
5663 If paths to the score files are omitted, the directory specified in the
5664 variable @code{wl-score-files-directory} is assumed.
5666 No matter what you write in @code{wl-score-folder-alist}, the default
5667 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5668 read (it does not have to exist).
5669 Therefore, in the example above, the three score files,
5670 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5671 the folders that matches @samp{^-.*}.
5673 @subsection Scored Messages
5675 Scores are attached to the messages that are specified by
5676 @code{wl-summary-score-marks} temporarily when the summary is updated;
5677 when you exit from the summary, the scores are removed and reverts to
5680 @subsection Creation of Score Files
5682 In the summary buffer, move to an appropriate message and type @kbd{L}.
5683 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5684 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5686 This makes @minus{}1000 are scored for messages with the same
5687 @samp{Subject:} as the string you entered. That is, such a score file
5688 is created automatically.
5690 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5691 The score file you just made appears.
5692 This buffer is called @dfn{score editing buffer} thereafter.
5693 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5694 as you are previously; type @kbd{a}. Then a score entry for "From"
5696 In this way, you can create a score file easily either in the summary
5697 buffer or in the score editing buffer.
5699 By the way, you might be aware the numbers of key strokes are different
5700 between @kbd{s s p} and @kbd{a}.
5701 This is determined by @code{wl-score-header-default-entry}.
5702 This variable specifies the default score entries corresponding to
5704 For example, for "subject" field, a type and a time limit are prompted,
5705 but for "from" field, they are fixed upon automatically as substring and
5706 permanent respectively.
5707 However, score values can be modified by the prefix argument.
5708 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5711 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5712 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5713 erasing contents of the buffer deletes the score file being edited.
5717 @subsubsection Selecting Score Files
5719 You can change score files to which scores are appended by
5720 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5721 @code{wl-score-change-score-file}.
5723 @subsubsection Summing Up the Score
5725 If you add the same entries by @code{wl-summary-increase-score},
5726 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5727 scores for the entry is summed up.
5729 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5730 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5731 @minus{}1200 will be created as a result.
5733 @subsubsection Creating Thread Key
5735 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5736 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5738 @subsubsection Creating Followup Key
5740 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5741 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5742 at the cursor to @samp{References} key.
5743 If @code{wl-score-auto-make-followup-entry} is non-nil,
5744 @samp{Message-ID} of all messages to be followed up within dates
5745 specified by @code{wl-score-expiry-days}.
5747 @subsection Key Bindings
5752 @findex wl-summary-increase-score
5753 Increases the score for the current message.
5754 And the score entry is appended to the score file at the same moment.
5755 You can specify the score value by a prefix argument.
5759 @findex wl-summary-lower-score
5760 Decreases the score for the current message.
5761 And the score entry is appended to the score file at the same moment.
5762 You can specify the score value by a prefix argument.
5765 @kindex h R (Summary)
5766 @findex wl-summary-rescore
5767 Re-applies the scoring.
5768 However, already scored messages are not scored anew.
5771 @kindex h c (Summary)
5772 @findex wl-score-change-score-file
5773 Changes the score file currently selected.
5776 @kindex h e (Summary)
5777 @findex wl-score-edit-current-scores
5778 Edits the score file currently selected.
5779 If there are multiple score files, the previously specified one is
5783 @kindex h f (Summary)
5784 @findex wl-score-edit-file
5785 Edits an arbitrary score file and selects it.
5788 @kindex h F (Summary)
5789 @findex wl-score-flush-cache
5790 Erases caches associated to the score files that are read.
5791 If you modified score files directly (from other than Wanderlust), you
5792 need to re-read them after erasing the cache.
5795 @kindex h m (Summary)
5796 @findex wl-score-set-mark-below
5797 Specifies the criterion for scores to be marked as read.
5798 Messages with scores less than this value are marked as read.
5801 @kindex h x (Summary)
5802 @findex wl-score-set-expunge-below
5803 Specifies the criterion for scores to be deleted from the summary.
5804 Messages with scores less than this value are deleted.
5805 "Deleted" means it is not shown; they are not removed from the summary
5806 information or the folder.
5807 The deleted messages can be shown by rescan-noscore again.
5810 @subsection Key Bindings in the Score Editing Buffer
5814 @kindex C-c C-k (Score Mode)
5815 @findex wl-score-edit-kill
5816 Abandons the file being edited.
5819 @kindex C-c C-c (Score Mode)
5820 @findex wl-score-edit-exit
5821 Saves the file being edited, and quits from the edit mode.
5824 @kindex C-c C-p (Score Mode)
5825 @findex wl-score-pretty-print
5829 @kindex C-c C-d (Score Mode)
5830 @findex wl-score-edit-insert-date
5831 Inserts the number of dates from Dec. 31, 1 B.C.
5832 It is used for creating the third factor of time-limited scores.
5835 @kindex C-c C-s (Score Mode)
5836 @findex wl-score-edit-insert-header
5837 Inserts the header of the message selected in the summary buffer.
5840 @kindex C-c C-e (Score Mode)
5841 @findex wl-score-edit-insert-entry
5842 Inserts the score entry of the message selected in the summary buffer.
5845 @subsection Customizable Variables
5848 @item wl-summary-default-score
5849 @vindex wl-summary-default-score
5850 The initial setting is 0 (zero).
5851 This variable specifies the default value of the score.
5852 The score is increased or decreased based upon this value.
5854 @item wl-summary-important-above
5855 @vindex wl-summary-important-above
5856 The initial setting is @code{nil}.
5857 Messages with scores larger than this value are attached with the
5858 important mark (@samp{$}).
5859 If @code{nil}, no important marks are attached.
5861 @item wl-summary-target-above
5862 @vindex wl-summary-target-above
5863 The initial setting is @code{nil}.
5864 Messages with scores larger than this value are attached with the target
5866 If @code{nil}, no target marks are attached.
5868 @item wl-summary-mark-below
5869 @vindex wl-summary-mark-below
5870 The initial setting is 0 (zero).
5871 Messages with scores smaller than this value are marked as read.
5873 @item wl-summary-expunge-below
5874 @vindex wl-summary-expunge-below
5875 The initial setting is @code{nil}.
5876 Messages with scores smaller than this value are deleted from the
5878 If @code{nil}, they are not deleted.
5880 @item wl-summary-score-marks
5881 @vindex wl-summary-score-marks
5882 The initial setting is the list shown below:
5886 (list wl-summary-new-mark)
5891 Messages with these marks are scored.
5893 @item wl-use-scoring
5894 @vindex wl-use-scoring
5895 The initial setting is t.
5896 If non-nil, scoring is enabled.
5898 @item wl-score-files-directory
5899 @vindex wl-score-files-directory
5900 The initial setting is @file{~/.elmo/}.
5901 The default directory for score files.
5903 @item wl-score-interactive-default-score
5904 @vindex wl-score-interactive-default-score
5905 The initial setting is 1000.
5906 This value is used as a score when a score factor is @code{nil} in the
5907 score file. It is also used in @code{wl-summary-increase-score} and
5908 @code{wl-summary-lower-score}, on condition that the value of
5909 @code{wl-score-header-default-entry} is @code{nil}.
5911 @item wl-score-expiry-days
5912 @vindex wl-score-expiry-days
5913 The initial setting is 7.
5914 This is the number of days before time-limited scores are deleted.
5916 @item wl-score-update-entry-dates
5917 @vindex wl-score-update-entry-dates
5918 The initial setting is @code{t}.
5919 If non-nil, it enables deletion of time-limited scores.
5921 @item wl-score-header-default-entry
5922 @vindex wl-score-header-default-entry
5923 Specifies the default value for each header field for score entries
5924 created by @code{wl-summary-increase-score},
5925 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5927 @item wl-score-simplify-fuzzy-regexp
5928 @vindex wl-score-simplify-fuzzy-regexp
5929 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5930 regular expression to be deleted from the string.
5931 Because this is usually used for Subject, the default is prefixes that
5932 are attached by mailing list programs.
5934 @item wl-summary-rescore-partial-threshold
5935 @vindex wl-summary-rescore-partial-threshold
5936 The initial setting is 200.
5937 When sync-all or rescan is executed, if there are messages more than
5938 this value, only the last same number of messages as this value are
5941 @item wl-summary-auto-sync-marks
5942 @vindex wl-summary-auto-sync-marks
5943 If non-nil, unread/important marks are synchronized when the summary
5945 Unread marks reflect information on the IMAP4 server.
5946 Important marks reflect information on the IMAP4 server (flagged or
5947 not), and contents of @samp{'mark} folder.
5948 The initial setting is @code{t}.
5952 @node Score File Format, , Score Commands, Scoring
5953 @section Score File Format
5954 @cindex Score File Format
5956 The format of score files are the same as Gnus, and basically you can
5957 use Gnus score files as they are. But they are not fully compatible
5958 because some keys are not supported and there are Wanderlust specifics.
5959 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5964 ("for sale" -1000 nil s)
5965 ("profit" -1000 nil s))
5967 ("spam@@spamspamspam" -10000 nil s))
5969 ("my@@address" 3001 nil s))
5971 (1000000 -10 nil >))
5981 If the key is a string, it is the name of the header to be matched.
5982 The following keys are available:
5983 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5984 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5985 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5986 @code{Chars} and @code{Lines} mean the size and the number of lines of
5987 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5988 are described later.
5989 The rest corresponds the field of the same name.
5991 Arbitrary numbers of core entries are specified after the key.
5992 Each score entry consists of these five factors:
5996 A factor that matches header. This should be a number in the cases of
5997 @code{lines} and @code{chars}, otherwise a string.
6000 A score factor. When the first item matches, the score of the message
6001 is increased or decreased by this value.
6004 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6005 of a number, the score is deleted if it does not match for days
6006 (@code{wl-score-expiry-days}) from the date specified by this.
6007 The date is since Dec. 31, 1 B.C.
6010 A type factor. This specifies the way the first factor matches.
6011 Available types depend on keys.
6014 @item From, Subject, References, Message-ID
6015 For these keys in string, @code{r} and @code{R} (regexp),
6016 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6017 as well as @code{f} and @code{F} (fuzzy) can be used.
6018 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6021 For these keys, the following five numerical relative operators can be
6022 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6025 This key matches @code{From} header, and scores all follow-ups to the
6027 For example, it would be useful for increasing scores for follow-ups to
6030 You can use the same types as @code{From} except for @code{f}.
6031 And a @samp{Followup} entry is automatically appended to the score file.
6034 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6035 A @samp{Thread} entry is automatically appended for each article that
6036 has @var{x} in the @code{References} header.
6037 You can make sure the whole thread including messages that does not have
6038 all ancestors @code{Message-ID} in @code{References} is scored.
6040 You can use the same types as @code{References} except for @code{f}.
6041 And a @samp{Thread} entry is automatically appended to the score file.
6045 A factor for extension header. This is meaningful only if the key is
6047 This specifies headers to be matched other than standard headers like
6048 @code{Subject} and @code{From}.
6049 Note that you should specify the header in
6050 @code{elmo-msgdb-extra-fields} also.
6051 Therefore it does not work in folders where extension headers cannot be
6056 The sum of these scores @emph{after all factors are applied} becomes the
6057 score of the message.
6059 @cindex Score File Atoms
6061 Messages with a score less than this value is marked as read.
6062 The default is @code{wl-summary-mark-below}.
6065 Messages with a score less than this value is deleted from the summary.
6066 The default is @code{wl-summary-expunge-below}.
6068 @item mark-and-expunge
6069 Both @code{mark} and @code{expunge} are applied,
6070 i.e. messages with a score less than this value is marked as read and
6071 deleted from the summary.
6074 Messages with a score greater than this value is attached with temp
6076 The default is @code{wl-summary-target-above}.
6079 Messages with a score greater than this value is attached with important
6081 The default is @code{wl-summary-important-above}.
6086 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6087 are used, you need to set @code{elmo-msgdb-extra-fields}.
6090 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6093 There are other restrictions as shown below:
6096 @item Because @samp{References} field in the summary information
6097 contains only the last @samp{Message-ID}, @code{references} key matches
6101 Keys that can be seen by folder of types:
6105 chars lines xref extra
6106 localdir,localnews Y E E E
6107 nntp (supporting xover) Y E E N
6113 N: cannot be seen (ignored)
6114 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6119 @node Address Book, Customization, Scoring, Top
6120 @chapter Address Book
6121 @cindex Address Book
6123 With address book, you can utilize address completion, and you have
6124 summary displayed with nicknames.
6127 * Mail Addresses:: Definition of Address Book
6128 * Address Manager:: Address Manager
6131 @node Mail Addresses, Address Manager, Address Book, Address Book
6132 @section Address book
6133 @cindex Address book Definition
6135 @cindex Alias, Address
6137 The file @file{~/.addresses} is a simple address book for Wanderlust.
6138 Make address file @file{~/.addresses}, and edit to suit your requirement.
6140 The data written in @file{~/.addresses} are used for address completion
6141 under draft editing mode. Furthermore, they are used when showing names
6142 in summary display mode. You can safely skip this section, if you don't
6143 want to customize address completion and summary display.
6144 It is possible to add/change/remove addresses from @file{~/.addresses} in
6145 summary buffer after Wanderlust is invoked. @refill
6147 The format is very simple. Like this. @refill
6152 # @r{Lines begin with @samp{#} are comment.}
6153 # @r{Empty lines are ignored}
6155 # @r{Format of each line:}
6156 # @var{email-address} "@var{nickname} "@var{realname}"
6158 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6159 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6160 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6165 One line defines one persons description.
6167 Actually, in default setup, @var{nickname} is used in summary-mode and
6168 @var{realname} is used in draft preparation mode. This behavior is
6169 better understood if you try it and confirmed the function first. You
6170 can write and try a small definition, so you will know the idea of the
6171 address book before writing a big one.
6173 And, if MH alias file is specified in variable @code{wl-alias-file},
6174 it is used as an address information in the draft preparation mode.
6176 If variable @code{wl-use-ldap} is non-nil (initial setting is
6177 @code{nil}), address completion in draft mode uses LDAP information.
6179 If you use LDAP, you have to set @code{wl-ldap-server},
6180 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6181 not have LDAP feature as built-in feature (Currently only XEmacs can
6182 have built-in LDAP feature), you have to set command exec @env{PATH} to
6183 the program @command{ldapsearch}.
6186 @node Address Manager, , Mail Addresses, Address Book
6187 @section Address Manager
6188 @cindex Address Manager
6190 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6191 the address book and insert address to draft buffer.
6193 @subsection Key Bindings
6197 @kindex t (Address Manager)
6198 @findex wl-addrmgr-set-to
6199 Add @samp{To:} mark.
6202 @kindex c (Address Manager)
6203 @findex wl-addrmgr-set-cc
6204 Add @samp{Cc:} mark.
6207 @kindex b (Address Manager)
6208 @findex wl-addrmgr-set-bcc
6209 Add @samp{Bcc:} mark.
6212 @kindex u (Address Manager)
6213 @findex wl-addrmgr-unmark
6217 @kindex x (Address Manager)
6218 @findex wl-addrmgr-apply
6220 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6221 buffer and quit address manager. When no draft buffer, make new draft
6222 with insert marked addresses.
6224 If no mark, quit address manager.
6228 @kindex q (Address Manager)
6229 @findex wl-addrmgr-quit
6230 Quit address manager.
6233 @kindex a (Address Manager)
6234 @findex wl-addrmgr-add
6238 @kindex d (Address Manager)
6239 @findex wl-addrmgr-delete
6243 @kindex e (Address Manager)
6244 @findex wl-addrmgr-edit
6249 @node Customization, Mailing List, Address Book, Top
6250 @chapter Customizing Wanderlust
6251 @cindex Customization
6254 * Living with other packages:: Cooperating with other packages
6255 * Highlights:: Highlights
6256 * Biff:: Notify Mail arrival
6257 * Advanced Settings:: Advanced Settings
6258 * Customizable Variables:: Customizable Variables
6263 @node Living with other packages, Highlights, Customization, Customization
6264 @section Living with other packages
6266 Examples with other packages.
6269 * imput:: imput (im-wl.el)
6271 * supercite:: supercite.el
6272 * mu-cite:: mu-cite.el
6273 * X-Face:: x-face,bitmap-mule
6274 * dired-dd:: dired-dd.el
6276 * Addrbook:: Addrbook
6277 * mime-w3m:: mime-w3m.el
6281 @node imput, BBDB, Living with other packages, Living with other packages
6286 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6289 If @command{imput} is on the @code{exec-path} at the installation,
6290 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6294 (autoload 'wl-draft-send-with-imput-async "im-wl")
6295 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6300 @node BBDB, supercite, imput, Living with other packages
6304 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6307 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6308 byte-compiled and installed.
6316 ;; @r{enable pop-ups}
6317 (setq bbdb-use-pop-up t)
6318 ;; @r{auto collection}
6319 (setq bbdb/mail-auto-create-p t)
6320 ;; @r{exceptional folders against auto collection}
6321 (setq bbdb-wl-ignore-folder-regexp "^@@")
6322 (setq signature-use-bbdb t)
6323 (setq bbdb-north-american-phone-numbers-p nil)
6324 ;; @r{shows the name of bbdb in the summary} :-)
6325 (setq wl-summary-from-function 'bbdb-wl-from-func)
6326 ;; @r{automatically add mailing list fields}
6327 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6328 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6332 You can complete address with BBDB by @kbd{M-@key{TAB}}
6336 @node supercite, mu-cite, BBDB, Living with other packages
6337 @subsection sc.el(supercite), sc-register.el
6341 The same setting as usual mailers should be OK. The following is an
6342 example of settings:
6346 (autoload 'sc-cite-original "supercite" nil t)
6347 (add-hook 'mail-citation-hook 'sc-cite-original)
6352 @node mu-cite, X-Face, supercite, Living with other packages
6353 @subsection mu-cite.el
6356 The same setting as usual mailers should be OK. The following is an
6357 example of settings.
6359 If you use mu-cite version 8.0 or earlier:
6363 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6364 (setq mail-citation-hook 'mu-cite/cite-original)
6368 If you use mu-cite version 8.1 or later:
6372 (autoload 'mu-cite-original "mu-cite" nil t)
6373 (add-hook 'mail-citation-hook (function mu-cite-original))
6377 @node X-Face, dired-dd, mu-cite, Living with other packages
6381 If you have installed one of the following, you can decode
6382 @samp{X-Face:} field in message buffer and you will see face image.
6385 * x-face-xmas:: XEmacs case
6386 * x-face-mule:: Emacs case
6389 If there is an encoded X-Face string in a file @file{~/.xface} (the
6390 value of the variable @code{wl-x-face-file}), it is inserted as a
6391 @samp{X-Face:} field in the draft buffer (if
6392 @code{wl-auto-insert-x-face} is non-nil).
6394 @node x-face-xmas, x-face-mule, X-Face, X-Face
6395 @subsubsection x-face-xmas (for XEmacs)
6398 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6399 1.3.6.13 or later, do the following:
6403 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6404 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6408 @node x-face-mule, , x-face-xmas, X-Face
6409 @subsubsection x-face-mule (for Emacs)
6413 If you use @file{x-face-mule.el} in bitmap-mule
6414 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6418 (autoload 'x-face-decode-message-header "x-face-mule")
6419 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6423 @subsubsection x-face-e21 (for Emacs 21.x)
6426 With Emacs 21.x, you can use @file{x-face-e21.el}
6427 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6428 to display X-Face. In this case, bitmap-mule is not required.
6433 (autoload 'x-face-decode-message-header "x-face-e21")
6434 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6439 @node dired-dd, MHC, X-Face, Living with other packages
6440 @subsection dired-dd(Dired-DragDrop)
6441 @pindex Dired-DragDrop
6443 @cindex Drag and Drop
6445 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6446 compose multi-part by simple Drag-and-Drop from dired to the draft
6447 buffer being edited in GNU Emacs (this feature is not Wanderlust
6448 specific, but general-purpose for SEMI).
6452 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6458 ;; @r{Set dired-x variables here.}
6459 ;; @r{To and flo@dots{}}
6461 (progn (require 'dired-dd)
6462 (require 'dired-dd-mime))))))
6466 @node MHC, Addrbook, dired-dd, Living with other packages
6470 Message Harmonized Calendaring system
6471 (@uref{http://www.quickhack.net/mhc/})
6473 By using MHC, you can make a calendar from the messages.
6479 (setq mhc-mailer-package 'wl)
6480 (autoload 'mhc-mode "mhc" nil t)
6481 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6482 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6490 (autoload 'mhc-wl-setup "mhc-wl")
6491 (add-hook 'wl-init-hook 'mhc-wl-setup)
6495 @node Addrbook, mime-w3m, MHC, Living with other packages
6496 @subsection wl-addrbook.el
6500 (@uref{http://www.mew.org/})
6502 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6503 @code{load-path} and do the following settings.
6507 (require 'wl-addrbook)
6512 @node mime-w3m, , Addrbook, Living with other packages
6513 @subsection mime-w3m.el
6516 You can display html part by using @file{mime-w3m.el}
6517 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6518 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6521 @node Highlights, Biff, Living with other packages, Customization
6524 @subsection Customizable Variables
6527 @item wl-summary-highlight
6528 @vindex wl-summary-highlight
6529 The initial setting is @code{t}.
6530 If non-nil, the summary is highlighted.
6532 @item wl-highlight-max-summary-lines
6533 @vindex wl-highlight-max-summary-lines
6534 The initial setting is 10000.
6535 The summary is not highlighted if it has more lines than this value.
6537 @item wl-summary-highlight-partial-threshold
6538 @vindex wl-summary-highlight-partial-threshold
6539 The initial setting is 1000.
6540 This is a threshold whether the whole summary is highlighted.
6541 If there are more lines of messages in the summary, it is partially
6544 @item wl-summary-partial-highlight-above-lines
6545 @vindex wl-summary-partial-highlight-above-lines
6546 The initial setting is 30. If there are more lines of messages than
6547 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6548 after the point that is the same number of lines as this value above the
6549 cursor line are highlighted partially. (If this value is @code{nil},
6550 the last same number of lines as the value of
6551 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6553 @item wl-highlight-body-too
6554 @vindex wl-highlight-body-too
6555 The initial setting is @code{t}.
6556 If non-nil, bodies of drafts and messages are also highlighted.
6558 @item wl-highlight-message-header-alist
6559 @vindex wl-highlight-message-header-alist
6560 When highlighting headers of drafts and messages, this variable
6561 specifies which faces are allocated to important
6562 (@code{wl-highlight-message-important-header-contents}), secondly
6563 important (@code{wl-highlight-message-important-header-contents2}), and
6564 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6566 Similarly, it can be used for allocating arbitrary faces to arbitrary
6567 regular expressions.
6569 @item wl-highlight-citation-prefix-regexp
6570 @vindex wl-highlight-citation-prefix-regexp
6571 Specifies a regular expression to which quoted lines in bodies of
6572 drafts and messages match.
6573 Bodies matching to this regular expression are highlighted by the faces
6574 specified by (@code{wl-highlight-message-cited-text-*}).
6576 @item wl-highlight-highlight-citation-too
6577 @vindex wl-highlight-highlight-citation-too
6578 The initial setting is @code{nil}.
6579 If non-nil, the quoting regular expression itself given by
6580 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6582 @item wl-highlight-citation-header-regexp
6583 @vindex wl-highlight-citation-header-regexp
6584 Specifies a regular expression that denotes beginning of quotation.
6585 Bodies matching to this regular expression are highlighted by the face
6586 specified by @code{wl-highlight-message-headers}.
6588 @item wl-highlight-max-header-size
6589 @vindex wl-highlight-max-header-size
6590 The initial setting is @code{nil}. If a header size is larger than this
6591 value, it will not be highlighted. If @code{nil}, always highlighted
6592 (ignore header size).
6594 @item wl-highlight-max-message-size
6595 @vindex wl-highlight-max-message-size
6596 The initial setting is 10000.
6597 If a message is larger than this value, it will not be highlighted.
6598 With this variable, highlight is suppressed for uuencode or huge digest
6601 @item wl-highlight-signature-separator
6602 @vindex wl-highlight-signature-separator
6603 Specifies regular expressions that denotes the boundary of a signature.
6604 It can be a regular expression, or a list of ones.
6605 Messages after the place that matches this regular expression are
6606 highlighted by the face specified by
6607 @code{wl-highlight-message-signature}.
6609 @item wl-max-signature-size
6610 @vindex wl-max-signature-size
6611 The initial setting is 400.
6612 This is the largest size for a signature to be highlighted.
6614 @item wl-use-highlight-mouse-line
6615 @vindex wl-use-highlight-mouse-line
6616 The initial setting is @code{t}.
6617 If non-nil, the line pointed by the mouse is highlighted in the folder
6618 mode, summary mode, and the like.
6621 @subsection Setting Colors and Fonts of the Characters
6623 If you want to change colors or fonts of the characters, you need to
6624 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6625 want to change fonts, and @code{set-face-foreground} for colors, and so
6626 on. You cannot write face settings in @file{.emacs}; write in
6629 For example, if you want to change the color for signatures to yellow,
6633 (set-face-foreground 'wl-highlight-message-signature "yellow")
6639 Faces defined in Wanderlust:
6642 @item wl-highlight-message-headers
6643 The face for field names of message headers.
6645 @item wl-highlight-message-header-contents
6646 The face for field bodies of message headers.
6648 @item wl-highlight-message-important-header-contents
6649 The face for important parts of message headers.
6650 Per default, this face is used for a body of @samp{Subject:} field.
6651 You can change its value by editing
6652 @code{wl-highlight-message-header-alist}.
6654 @item wl-highlight-message-important-header-contents2
6655 The face for secondly important parts of message headers.
6656 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6657 fields. You can change its value by editing
6658 @code{wl-highlight-message-header-alist}.
6660 @item wl-highlight-message-unimportant-header-contents
6661 The face for unimportant parts of message headers.
6662 Per default, this face is used for bodies of @samp{X-} fields
6663 @samp{User-Agent:} fields. You can change its value by editing
6664 @code{wl-highlight-message-header-alist}.
6666 @item wl-highlight-message-citation-header
6667 The face for headers of quoted messages.
6669 @item wl-highlight-message-cited-text-*
6670 The face for texts of quoted messages. The last @samp{*} is a
6671 @var{single figure} so that 10 different colors can be used according to
6674 @item wl-highlight-message-signature
6675 The face for signatures of messages. The initial settings are
6676 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6677 dark background colors.
6679 @item wl-highlight-header-separator-face
6680 The face for header separators of draft messages.
6682 @item wl-highlight-summary-important-face
6683 The face for message lines with important marks in the summary.
6685 @item wl-highlight-summary-new-face
6686 The face for message lines with new marks in the summary.
6688 @item wl-highlight-summary-displaying-face
6689 The face for the message line that is currently displayed.
6690 This face is overlaid.
6692 @item wl-highlight-thread-indent-face
6693 The face for the threads that is currently displayed.
6695 @item wl-highlight-summary-unread-face
6696 The face for message lines with unread marks in the summary.
6698 @item wl-highlight-summary-deleted-face
6699 The face for message lines with delete marks in the summary.
6701 @item wl-highlight-summary-refiled-face
6702 The face for message lines with re-file marks in the summary.
6704 @item wl-highlight-refile-destination-face
6705 The face for re-file information part of message lines with re-file
6706 marks in the summary.
6708 @item wl-highlight-summary-copied-face
6709 The face for message lines with copy marks in the summary.
6711 @item wl-highlight-summary-target-face
6712 The face for message lines with target marks @samp{*} in the summary.
6714 @item wl-highlight-summary-thread-top-face
6715 The face for message lines that are on the top of the thread in the
6718 @item wl-highlight-summary-normal-face
6719 The face for message lines that are not on top of the thread in the
6722 @item wl-highlight-folder-unknown-face
6723 The face for folders that are not known to have how many unsync messages
6726 @item wl-highlight-folder-zero-face
6727 The face for folders that have no unsync messages in the folder mode.
6729 @item wl-highlight-folder-few-face
6730 The face for folders that have some unsync messages in the folder mode.
6732 @item wl-highlight-folder-many-face
6733 The face for folders that have many unsync messages in the folder mode.
6734 The boundary between `some' and `many' is specified by the variable
6735 @code{wl-folder-many-unsync-threshold}.
6737 @item wl-highlight-folder-unread-face
6738 The face for folders that have no unsync but unread messages in the
6741 @item wl-highlight-folder-killed-face
6742 The face for folders that are deleted from the access group in the
6745 @item wl-highlight-folder-opened-face
6746 The face for open groups in the folder mode.
6747 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6748 @code{nil} or a @var{number}.
6750 @item wl-highlight-folder-closed-face
6751 The face for close groups in the folder mode.
6752 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6753 @code{nil} or a @var{number}.
6755 @item wl-highlight-folder-path-face
6756 The face for the path to the currently selected folder in the folder
6759 @item wl-highlight-logo-face
6760 The face for logo in the demo.
6762 @item wl-highlight-demo-face
6763 The face for strings (for example, a version number) in the demo.
6767 @node Biff, Advanced Settings, Highlights, Customization
6768 @section Notify Mail arrival
6771 Following setting is to notify mail arrival of @samp{%inbox}
6772 by the indicator on the modeline
6775 (setq wl-biff-check-folder-list '("%inbox"))
6778 @subsection Customizable Variables
6780 @item wl-biff-check-folder-list
6781 @vindex wl-biff-check-folder-list
6782 The initial setting is @code{nil}.
6783 This is the list of folders to check mail arrival.
6784 If @code{nil}, wl doesn't check mail arrival.
6786 @item wl-biff-check-interval
6787 @vindex wl-biff-check-interval
6788 The initial setting is 40 (in seconds).
6789 Check mail arrival in this period.
6791 @item wl-biff-notify-hook
6792 @vindex wl-biff-notify-hook
6793 This hook is run at the arrival of new mail.
6794 To beep with mail arrival(initial setting), set as follows.
6796 (setq wl-biff-notify-hook '(ding))
6798 For silence, set to @code{nil}.
6802 @node Advanced Settings, Customizable Variables, Biff, Customization
6803 @section Advanced Settings
6806 * Draft for Reply:: Draft for Reply
6807 * Thread Format:: Appearance of Thread
6808 * User-Agent Field:: @samp{User-Agent:} Header Field
6812 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6813 @subsection Draft for Replay
6814 @vindex wl-draft-reply-with-argument-list
6815 @vindex wl-draft-reply-without-argument-list
6816 @vindex wl-draft-reply-myself-with-argument-list
6817 @vindex wl-draft-reply-myself-without-argument-list
6819 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
6820 The addressee for the draft is decided by following rules.
6822 For example, you can set as follows:
6826 (setq wl-draft-reply-without-argument-list
6827 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6828 ("Followup-To" . (nil nil ("Followup-To")))
6829 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6830 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6834 Where each element of the list @code{wl-draft-reply-without-argument-list}
6838 (key . (to-list cc-list newsgroup-list))
6841 and if the field designated by @samp{key} exist in the parent message,
6842 parent's field values designated by @samp{to-list} are copied to @samp{To:}
6843 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
6844 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
6845 the draft respectively.
6850 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6853 Match if the parent has @samp{Mail-Followup-To} field.
6854 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
6855 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
6859 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6862 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
6863 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
6866 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
6869 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
6870 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
6873 These are evaluated in order and first matched one is used.
6875 Moreover, the behavior of @kbd{a} with prefix argument can
6876 be directed by @code{wl-draft-reply-with-argument-list} as well.
6878 By the way, you can use some function (will be evaluated in the parent
6879 message buffer) in the place of @samp{key} or @samp{to-list} etc.
6880 For example, if you only want to reply to mailing lists in
6881 @code{wl-subscribed-mailing-list} if the parent has some of them,
6886 (defun wl-mailing-list-addresses ()
6890 (nth 1 (std11-extract-address-components addr)))
6893 (elmo-multiple-fields-body-list (list "To" "Cc"))
6895 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
6896 (setq list-addrs (cons to list-addrs))))
6897 (nreverse list-addrs)))
6899 (setq wl-draft-reply-with-argument-list
6900 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
6901 ("Reply-To" . (("Reply-To") nil nil))
6902 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
6903 ("From" . (("From") nil nil))))
6908 Note: To set the behavior when you reply to the message written by yourself,
6909 use @code{wl-draft-reply-myself-without-argument-list} and
6910 @code{wl-draft-reply-myself-with-argument-list} instead of them.
6912 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6913 @subsection Appearance of Threads
6917 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6918 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6919 391 09/18(Fri)19:24 +-[ Murata-san ]
6920 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6921 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6922 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6923 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6924 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6925 412 09/22(Tue)09:28 | +-[ Teranishi ]
6926 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6927 416 09/22(Tue)12:38 | +-[ Teranishi ]
6928 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6929 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6933 Settings to make appearance of threads like shown above:
6937 (setq wl-thread-indent-level 2)
6938 (setq wl-thread-have-younger-brother-str "+")
6939 (setq wl-thread-youngest-child-str "+")
6940 (setq wl-thread-vertical-str "|")
6941 (setq wl-thread-horizontal-str "-")
6942 (setq wl-thread-space-str " ")
6946 If you do not want to see branches, do the following:
6950 (setq wl-thread-indent-level 2)
6951 (setq wl-thread-have-younger-brother-str " ")
6952 (setq wl-thread-youngest-child-str " ")
6953 (setq wl-thread-vertical-str " ")
6954 (setq wl-thread-horizontal-str " ")
6955 (setq wl-thread-space-str " ")
6960 @node User-Agent Field, , Thread Format, Advanced Settings
6961 @subsection User-Agent Field
6965 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6966 @samp{User-Agent:} fields, define a function that generate appropriate
6967 strings as you like, and set it to variable
6968 @code{wl-generate-mailer-string-function}.
6970 If you do not want verbose @samp{User-Agent:} field, do the following:
6974 (setq wl-generate-mailer-string-function
6977 (concat "User-Agent: "
6978 (wl-generate-user-agent-string-1 nil)))))
6982 The following is a example:
6986 (setq mime-edit-insert-user-agent-field nil)
6987 (setq wl-generate-mailer-string-function
6990 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6995 @node Customizable Variables, Hooks, Advanced Settings, Customization
6996 @section Customizable Variables
6998 Customizable variables that have not been described yet:
7001 @item wl-default-folder
7002 @vindex wl-default-folder
7003 The initial setting is @samp{%inbox}. This is the default value for moving to
7004 a folder and the like.
7006 @item wl-draft-folder
7007 @vindex wl-draft-folder
7008 The initial setting is @samp{+draft}. It is the folder to which drafts are
7009 saved. It must be a localdir folder.
7011 @item wl-trash-folder
7012 @vindex wl-trash-folder
7013 The initial setting is @samp{+trash}. It is the wastebasket folder.
7014 If you changed this variable, you had better restart Wanderlust.
7016 @item wl-interactive-exit
7017 @vindex wl-interactive-exit
7018 The initial setting is @code{t}.
7019 If non-nil, you are asked for confirmation when Wanderlust terminates.
7021 @item wl-interactive-send
7022 @vindex wl-interactive-send
7023 The initial setting is @code{t}.
7024 If non-nil, you are asked for confirmation when mail is sent.
7026 @item wl-folder-sync-range-alist
7027 @vindex wl-folder-sync-range-alist
7028 The initial setting is the alist shown below:
7033 ("^\\+draft$\\|^\\+queue$" . "all"))
7038 This is an associative list of regular expressions of folder names and
7039 update range of the summary. Update range is one of the @samp{all},
7040 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
7041 @samp{last}. If a folder do not match, @samp{update} is used.
7044 @vindex wl-ask-range
7045 The initial setting is @code{t}.
7046 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7047 for updating the summary when you changed folders.
7049 @item wl-mime-charset
7050 @vindex wl-mime-charset
7051 The initial setting is @code{x-ctext}.
7052 This is the MIME charset for messages that are not MIME (e.g. without
7053 @samp{Content-Type:}). This value also used as default charset for
7054 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7055 this value as @code{iso-2022-jp}.)
7057 @item wl-highlight-folder-with-icon
7058 @vindex wl-highlight-folder-with-icon
7059 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7060 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7062 @item wl-strict-diff-folders
7063 @vindex wl-strict-diff-folders
7064 This is a list of regular expressions of folders.
7065 Unread messages are checked, for example when you press @kbd{s} in
7066 the folder mode, usually in a brief way (rapidly processed but not
7068 The folders matching this variable are seriously checked.
7069 You may want to set this variable so as to match conditional filter
7070 folders for IMAP4 folders.
7071 The initial setting is @code{nil}.
7073 @item wl-folder-use-server-diff
7074 @vindex wl-folder-use-server-diff
7075 When unread messages are checked, for example when you press @kbd{s} in
7076 the folder mode, usually (the number of messages on the server) @minus{}
7077 (the number of local messages) will be the number of unread messages.
7078 However, if this variable is non-nil, the number of unread messages on
7079 the server is checked. This affects IMAP4 folders only, but IMAP4
7080 folders in mail boxes matching
7081 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7082 the number of unread messages on the server, even if they matches this
7083 variable. The initial setting is @code{t}.
7085 @item wl-auto-check-folder-name
7086 @vindex wl-auto-check-folder-name
7087 The initial setting is @code{nil}.
7088 You can specify a folder or a group which is checked for unread message
7089 at the start. You can also specify a list of folders (groups) to be checked.
7090 If the value is @code{nil}, whole Desktop is checked at the start.
7091 If it is @code{none}, no folders are checked.
7093 @item wl-auto-uncheck-folder-list
7094 @vindex wl-auto-uncheck-folder-list
7095 The initial setting is the list shown below:
7104 You can set a list of regular expressions to specify folders
7105 which are not automatically checked even if they are included
7106 in some groups assigned by @code{wl-auto-check-folder-name}.
7108 @item wl-auto-check-folder-list
7109 @vindex wl-auto-check-folder-list
7110 The initial setting is @code{nil}.
7111 You can set a list of regular expressions to specify exceptions
7112 for @code{wl-auto-uncheck-folder-list}.
7114 @item wl-no-save-folder-list
7115 @vindex wl-no-save-folder-list
7116 The initial setting is the list shown below:
7125 This is a list of regular expressions of folders not to be saved.
7127 @item wl-save-folder-list
7128 @vindex wl-save-folder-list
7129 The initial setting is @code{nil}.
7130 This is a list of regular expressions of folders to be saved.
7131 This takes precedence over @code{wl-no-save-folder-list}.
7133 @item wl-folder-mime-charset-alist
7134 @vindex wl-folder-mime-charset-alist
7135 The initial setting is the alist shown below:
7139 (("^-alt\\.chinese" . big5)
7140 ("^-relcom\\." . koi8-r)
7142 ("^-han\\." . euc-kr))
7147 This is an associative list of regular expressions of folder names and
7149 If a folder do not match, @code{wl-mime-charset} is used.
7151 @item wl-folder-init-load-access-folders
7152 @vindex wl-folder-init-load-access-folders
7153 The initial setting is @code{nil}.
7154 This is a list of access groups to be loaded specifically at the start.
7155 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7157 @item wl-folder-init-no-load-access-folders
7158 @vindex wl-folder-init-no-load-access-folders
7159 The initial setting is @code{nil}.
7160 This is a list of access groups not to be loaded specifically at the
7162 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7164 @item wl-delete-folder-alist
7165 @vindex wl-delete-folder-alist
7166 The initial setting is the alist shown below:
7175 This list determines disposition of messages with delete marks.
7176 Each item in the list is a folder and destination; you can specify any
7177 one of the following in the place of destination:
7180 @code{remove} or @code{null} : deletes the messages instantly.
7181 string : moves the messages to the specific folder.
7182 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7185 @item wl-refile-policy-alist
7186 @vindex wl-refile-policy-alist
7187 The initial setting is the list shown below:
7197 This list determines whether messages with re-file marks are moved or
7198 copied. Each item in the list is a cons cell of a folder and
7199 @code{copy} or @code{move}.
7201 @item wl-x-face-file
7202 @vindex wl-x-face-file
7203 The initial setting is @file{~/.xface}.
7204 The name of the file that contains encoded X-Face strings.
7207 @item wl-demo-display-logo
7208 @vindex wl-demo-display-logo
7209 If non-nil, bitmap image is shown on the opening demo. If you set
7210 @code{xpm} or @code{xbm}, (if possible) display selected image type
7213 @item elmo-use-database
7214 @vindex elmo-use-database
7215 This is meaningful for XEmacs only. The initial setting depends on
7216 XEmacs (@code{t} for XEmacs with dbm).
7217 If non-nil, Message-ID is controlled by dbm.
7219 @item elmo-passwd-alist-file-name
7220 @vindex elmo-passwd-alist-file-name
7221 The initial setting is @file{passwd}.
7222 This is the name of the file in which passwords are saved.
7223 @code{elmo-passwd-alist-save} saves current passwords to the file.
7225 @item elmo-nntp-list-folders-use-cache
7226 @vindex elmo-nntp-list-folders-use-cache
7227 The initial setting is 600 (in seconds).
7228 This is period in seconds during which results of @samp{list} and
7229 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7232 @item elmo-nntp-max-number-precedes-list-active
7233 @vindex elmo-nntp-max-number-precedes-list-active
7234 The initial setting is @code{nil}.
7235 If non-nil, the number of article obtained by @samp{list active} in NNTP
7236 are used as the maximum article number of the folder.
7237 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7238 and if the number of read messages is not correct.
7240 @item elmo-nntp-default-use-listgroup
7241 @vindex elmo-nntp-default-use-listgroup
7242 The initial setting is @code{t}.
7243 If non-nil, @samp{listgroup} is used for checking the total number of
7244 articles. If it is @code{nil}, @samp{group} is used. In the latter
7245 case, the processing will be a little faster at the sacrifice of
7248 @item elmo-pop3-send-command-synchronously
7249 @vindex elmo-pop3-send-command-synchronously
7250 The initial setting is @code{nil}.
7251 If non-nil, POP3 commands are issued synchronously. Some implementation
7252 of POP3 server fails to get summary information without this setting.
7253 You may have to set this variable to @code{t}, if the process hangs
7254 while looking up POP3.
7256 @item elmo-dop-flush-confirm
7257 @vindex elmo-dop-flush-confirm
7258 The initial setting is @code{t}.
7259 If non-nil, you are asked for confirmation if accumulated off-line
7260 operations are executed.
7262 @item elmo-display-progress-threshold
7263 @vindex elmo-display-progress-threshold
7264 The initial setting is 20.
7265 Threshold for display of progress gauge. If number of renewal is more than
7266 this value, display progress gauge.
7270 @node Hooks, , Customizable Variables, Customization
7276 @node Mailing List, Addition, Customization, Top
7277 @chapter Wanderlust Mailing List
7281 Topics related to Wanderlust are discussed in following mailing lists.
7282 The latest version is also announced there.
7285 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7288 In this list Japanese is mainly used for discussion. We also have a list
7289 for discussion in English:
7292 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7294 (Messages posted to this list are also forwarded to the former one.)
7296 A guide can be obtained automatically by sending mail to
7297 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7298 the English one) with the body
7304 Please send bug reports or patches to one of those lists. You can post to
7305 the mailing list even though you are not a member of it.
7307 If you send a bug report, please attach Backtrace with it.
7308 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7311 I would like to express my thanks to the members of the mailing list for
7312 valuable advice and many pieces of code they contributed.
7315 @node Addition, Index, Mailing List, Top
7316 @chapter Additional Information
7318 @section Brief History
7321 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7322 3/10 Made a msgdb mechanism by elisp.
7323 3/26 IMAP and NNTP can be displayed in threads.
7324 4/13 Began to assemble thread display modules as elmo.
7325 5/01 Finished 0.1.0, initial version with many defects.
7326 6/12 I made a slip of the tongue and said I was writing elisp
7327 mailer supporting IMAP
7328 6/16 0.1.3 was announced at tm-ja, elisp ML.
7329 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7330 7/01 Support for mm-backend (0.3.0).
7331 8/25 multi folder added (0.5.0).
7332 8/28 filter folder added (0.5.1).
7333 9/10 You can open/close threads (0.6.0).
7334 9/11 fldmgr by Murata-san made editing folders easy.
7335 9/18 lha folders added by Okunishi-san (0.6.3).
7336 9/24 Display of branches of threads (0.6.5).
7337 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7338 10/28 Off-line operations (0.7.4).
7339 12/09 Becomes beta version.
7340 12/21 wl-expire by Murata-san.
7341 1999 2/03 auto-refile by Tsumura-san.
7342 4/28 wl-template by Murata-san.
7343 5/18 Released 1.0.0 stable.
7344 7/05 Scoring by Murata-san (2.1.0).
7345 9/26 New plugged system by Murata-san (2.2.2).
7346 12/20 Support Modified UTF7.
7347 2000 3/24 Released 1.1.0 stable.
7348 4/03 CVS development started.
7349 5/07 Thread restoration & Its speed up with Murata-san.
7350 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7351 7/11 killed message feature.
7352 7/18 Use UIDL in POP3.
7353 9/12 biff feature with Satata-san & Yamaoka-san.
7354 10/17 expire-hide by Okada-san.
7355 11/08 Released 2.4.0 stable.
7356 2001 7/04 Released 2.6.0 stable.
7357 8/21 wl-addrmgr by Kitamoto-san.
7358 12/27 Released 2.8.1 stable.
7361 See @file{ChangeLog} for details.
7365 According to a dictionary, Wanderlust has the meaning:
7369 n eager longing for or impulse towards travelling in distant lands
7370 [Ger, fr wandern to wander + lust desire, pleasure]
7374 but I had no profound intention. (if farfetched, IMAP @result{} you can
7375 read mail anywhere @result{} desire to wander ?)
7377 Elmo is the abbreviation of @samp{Elisp Library for Message
7378 Orchestration}. At first I meant the red puppet in the Sesame Street,
7379 but you may associate it with Wandering @result{} Drifting @result{}
7380 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7384 Each versions has code names (they are almost jokes).
7385 Currently they are picked up alphabetically from the top 40 hits of
7386 U.S. Billboard magazines in 1980s.
7388 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7391 @node Index, , Addition, Top
7395 * Concept Index:: Concept Index
7396 * Key Index:: Key Index
7397 * Variable Index:: Variable Index
7398 * Function Index:: Function Index
7401 @node Concept Index, Key Index, Index, Index
7402 @unnumberedsec Concept Index
7405 @node Key Index, Variable Index, Concept Index, Index
7406 @unnumberedsec Key Index
7409 @node Variable Index, Function Index, Key Index, Index
7410 @unnumberedsec Variable Index
7413 @node Function Index, , Variable Index, Index
7414 @unnumberedsec Function Index