1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
25 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
27 This edition is for Wanderlust version @value{VERSION}.
29 Permission is granted to make and distribute verbatim copies of this
30 manual provided the copyright notice and this permission notice are
31 preserved on all copies.
34 Permission is granted to process this file through TeX and print the
35 results, provided the printed document carries copying permission notice
36 identical to this one except for the removal of this paragraph (this
37 paragraph not being relevant to the printed manual).
40 Permission is granted to copy and distribute modified versions of this
41 manual under the conditions for verbatim copying, provided that the
42 entire resulting derived work is distributed under the terms of a
43 permission notice identical to this one.
45 Permission is granted to copy and distribute translations of this manual
46 into another language, under the above conditions for modified versions.
52 @title Wanderlust User's Manual
53 @subtitle Yet another message interface on Emacsen
54 @subtitle for Wanderlust version @value{VERSION}
55 @author Yuuichi Teranishi
56 @author Fujikazu Okunishi
57 @author Masahiro Murata
59 @author Kaoru Takahashi
61 @author Masayuki Osada
62 @author Katsumi Yamaoka
64 @author Yoichi Nakayama
67 @vskip 0pt plus 1filll
68 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
69 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
70 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
71 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
73 This manual is for Wanderlust version @value{VERSION}.
75 Permission is granted to make and distribute verbatim copies of this
76 manual provided the copyright notice and this permission notice are
77 preserved on all copies.
79 Permission is granted to copy and distribute modified versions of this
80 manual under the conditions for verbatim copying, provided that the
81 entire resulting derived work is distributed under the terms of a
82 permission notice identical to this one.
84 Permission is granted to copy and distribute translations of this manual
85 into another language, under the above conditions for modified versions.
91 @node Top, Introduction, (dir), (dir)
92 @top Wanderlust User's Manual
107 This manual is for Wanderlust @value{VERSION}.
112 * Introduction:: Read this first
113 * Start Me Up:: Invoking Wanderlust
114 * Folders:: How to specify folders
115 * Folder:: Selecting and editing folders
116 * Summary:: Reading and refiling messages
117 * Message:: Saving and playing MIME multipart entities
118 * Draft:: Draft buffer, sending mail and news
119 * Disconnected Operations:: Off-Line management
120 * Expire and Archive:: Automatic expiration and archiving of messages
121 * Scoring:: Score of the messages
122 * Address Book:: Management of Address Book
123 * Customization:: Customizing Wanderlust
124 * Mailing List:: Wanderlust mailing list
125 * Addition:: Additional Information
130 @node Introduction, Start Me Up, Top, Top
131 @chapter Introduction of Wanderlust
134 Wanderlust is an mail/news management system on Emacsen.
135 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
137 The main features of Wanderlust:
140 @item Pure elisp implementation.
141 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
142 @item Unified access method to messages based on Mew-like Folder Specification.
143 @item Mew-like Key-bind and mark handling.
144 @item Manages unread messages.
145 @item Interactive thread display.
146 @item Folder Mode shows the list of subscribed folders.
147 @item Message Cache, Disconnected Operation (Read Only).
148 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
149 @item MIME compliant (by SEMI).
150 @item Transmission of news and mail are unified by Message transmitting draft.
151 @item Graphical list of folders (XEmacs and Emacs 21).
152 @item View a part of message without retrieving the whole message (IMAP4).
153 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
154 @item Virtual Folders.
155 @item Supports compressed folder using common archiving utilities.
156 @item Old articles in folders are automatically removed/archived (Expiration).
157 @item Automatic re-file.
158 @item Template function makes it convenient to send fixed form messages.
164 Wanderlust is supposed to run on following Emacsen:
167 @item Mule 2.3 based on Emacs 19.34
168 @item Emacs 20.2 or later
169 @item XEmacs 20.4 or later
170 @item Meadow 1.00 or later
171 @item NTEmacs 20.4 or later
175 IMAP4 connectivity with following imapd are confirmed to work with
179 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
180 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
181 @item Courier-IMAP 1.3.2 or later
182 @item AIR MAIL (AIRC imapd release 2.00)
184 @item Microsoft Exchange Server 5.5
185 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
188 LDAP connectivity with following LDAPd are confirmed to work with
192 @item OpenLDAP 2.0.6 or later
196 @node Start Me Up, Folders, Introduction, Top
197 @chapter Start up Wanderlust
200 The necessary procedure for starting Wanderlust is explained in steps
203 (Of course, you need a mail/news readable environment in advance)
206 * MIME Modules:: Installing the MIME modules
207 * Download:: Download and extract the packages
208 * Install:: Byte-compile and install
209 * Minimal Settings:: @file{.emacs} setup
210 * Folder Definition:: Folder definition
211 * Start Wanderlust:: Starting Wanderlust
215 @node MIME Modules, Download, Start Me Up, Start Me Up
216 @section Installing MIME modules
222 SEMI must be installed to make Wanderlust work correctly.
224 SEMI can be downloaded from these sites:
228 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
232 You need packages named APEL and FLIM to use SEMI.
233 You can download APEL and FLIM from following URLs:
237 APEL: ftp://ftp.m17n.org/pub/mule/apel/
238 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
242 You have to install APEL, FLIM and SEMI in this order. Generally,
243 @samp{make install} will do the job. (In XEmacs 21, @samp{make
246 Refer to the documents of each package for detailed installation
247 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
248 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
252 Recommended combination of APEL, FLIM and SEMI are following:
255 @item APEL 10.3, FLIM 1.14.3 and SEMI 1.14.3
258 You can also use many other FLIM/SEMI variants. Combination of the
259 latest versions should work. For example, the following combination are
263 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
264 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
267 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
270 @node Download, Install, MIME Modules, Start Me Up
271 @section Download and Extract the Package
274 You can download Wanderlust package from following sites:
278 ftp://ftp.gohome.org/wl/
281 Mirrored ftp/http sites:
285 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
286 http://www.jpl.org/elips/wl/
287 http://www.ring.gr.jp/archives/text/elisp/wl/
288 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
289 ftp://opaopa.org/pub/mirror/elisp/wl/
290 @c ftp://roguelife.org/pub/tsumura/wl/
294 Extract the obtained package to your working directory:
299 % tar zxvf wl-@var{version}.tar.gz
300 % cd wl-@var{version}
304 @subsection To use SSL (Secure Socket Layer)
309 SSL (Secure Socket Layer) can be used for
310 SMTP, IMAP, NNTP and POP connections in Wanderlust.
312 There are two ways to use SSL. One is to start SSL negotiation just
313 after the connection establishment (generic way). The other one is to
314 start SSL negotiation by invoking STARTTLS command in the each session.
316 To use the formal SSL (generic SSL), you must set @env{PATH} to the
317 directory that OpenSSL commands are installed.
319 To use the latter SSL(STARTTLS), you must install starttls package in
321 You can download starttls package from the following site.
324 ftp://opaopa.org/pub/elisp/
327 @node Install, Minimal Settings, Download, Start Me Up
328 @section Byte-compile and install
335 @subsection Installation
337 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
338 Set the Emacs's command name to @code{EMACS}.
339 Set package installation directory to @code{LISPDIR}.
340 Then, please execute following commands.
349 Destination directory is auto-probed if you leave @code{LISPDIR}
350 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
352 If you are using an Emacs variant which does not merge specified directory
353 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
354 then you will see the error message:
357 Cannot open load file: mime-setup
361 In this case, either add destination directories of custom, APEL, FLIM
362 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
363 @code{load-path} in @file{WL-CFG} in extracted directory.
365 If you want to use BBDB, then the necessary modules are byte-compiled
366 and installed when BBDB directory is added to @code{load-path}.
369 @subsection @file{WL-CFG}
371 Contents of the file @file{WL-CFG} is loaded under installation if a file
372 with that name exists in extracted directory. You can use @file{WL-CFG} to
373 configure @code{load-path} to extra packages such as SEMI if needed.
375 If you want to specify the install directory of Wanderlust related
376 files, then set following variables in @file{WL-CFG}
380 A directory to install WL modules.
381 This directory is relative directory from @code{LISPDIR}.
382 WL modules include @file{wl*.el}, @file{wl*.elc} files.
383 @c Modules under the directory @file{util/} are also installed if
384 @c it detected as necessary.
387 A directory to install ELMO modules.
388 This directory is relative directory from @code{LISPDIR}.
389 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
390 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
394 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
396 If you want to install ELMO related files under a sub-directory
397 such as "elmo" then add following to @file{WL-CFG}:
400 (setq ELMO_PREFIX "elmo")
403 @subsection Install as a XEmacs package
404 @cindex XEmacs package
405 @cindex XEmacs package install
406 @cindex Package, XEmacs
407 @cindex Package install, XEmacs
408 @c @cindex install-package
410 It is possible to install Wanderlust as one of packages of XEmacs (21.0
411 or later). Configuration for autoload and icon-path in local
412 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
415 Follow the next example to install Wanderlust as an XEmacs package.
421 % make install-package
425 package directory is auto-probed, if SEMI is installed.
426 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
428 @subsection Run in place
430 If wl and elmo directories are defined in @code{load-path}, then
431 byte-compilation and installation are not necessary to start Wanderlust.
432 For example, if package is extracted in @file{~/work}, Wanderlust can be
433 invoked with following setting in @file{~/.emacs}.
437 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
438 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
444 Manual is described in Info format. Please do following.
453 If you install Wanderlust as a XEmacs package, Info file is already
454 installed too, so there are no need of these commands.
456 Manual directory is automatically detected. Of course, it can be
457 configured by @code{INFODIR} in @file{Makefile}.
459 You can read manual at the following URL:
462 http://www.gohome.org/wl/doc/wl_toc.html
465 @node Minimal Settings, Folder Definition, Install, Start Me Up
466 @section Set up .emacs
467 @cindex Minimal Settings
469 @cindex Configuration
473 The Wanderlust package contains two module groups.
476 @item ELMO (elmo-*.el)
477 These modules show everything as folders. This is the back-end for WL.
479 These modules controls the behavior of main body of Wanderlust.
480 They are also the front-end for ELMO.
483 You can customize the behavior of Wanderlust by changing the value
484 of environmental variables which begins with @code{elmo-} and @code{wl-}.
486 The minimal requirement for settings is as the following.
490 ;; @r{The setting to use SEMI}
491 (require 'mime-setup)
493 ;; @r{autoload configuration}
494 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
495 (autoload 'wl "wl" "Wanderlust" t)
496 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
497 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
499 ;; @r{Directory where icons are placed.}
500 ;; @r{Default: the peculiar value to the running version of Emacs.}
501 ;; @r{(This is not required if the default value has been set properly)}
502 (setq wl-icon-directory "~/work/wl/etc")
504 ;; @r{SMTP server for mail posting. Default: @code{nil}}
505 (setq wl-smtp-posting-server "your.smtp.example.com")
506 ;; @r{NNTP server for news posting. Default: @code{nil}}
507 (setq wl-nntp-posting-server "your.nntp.example.com")
511 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
512 file exists). So it is convenient to gather Wanderlust specific settings
513 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
514 because you can't write them in @file{.emacs}
515 (if you write it to @file{.emacs}, you'll get an error).
518 All above described settings except @samp{(require 'mime-setup)} and autoload
519 configuration can be written in
522 @subsection @code{mail-user-agent}
523 @cindex Default Mailer
524 @cindex Mailer, Default
525 @vindex mail-user-agent
528 If you write following setting in you @file{.emacs}, you can
529 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
530 This means it enables you to run Wanderlust as a default mail composer
533 It is effective only when your Emacs can define @code{mail-user-agent}.
534 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
538 (autoload 'wl-user-agent-compose "wl-draft" nil t)
539 (if (boundp 'mail-user-agent)
540 (setq mail-user-agent 'wl-user-agent))
541 (if (fboundp 'define-mail-user-agent)
542 (define-mail-user-agent
544 'wl-user-agent-compose
553 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
554 @section Folder Definition
555 @cindex Folder Definition
558 You can skip this section because it is possible to add/edit the
559 subscribe folders from the buffer for list of folders.
560 @xref{Folder Manager}.
562 Define the folders you want to subscribe in file @file{~/.folders}. The
563 contents written in @file{~/.folders} become the folders which you
564 subscribe to as it is.
566 Format for @file{~/.folders} is very simple. Here is an example:
571 # @r{Lines begin with @samp{#} are comment.}
572 # @r{Empty lines are ignored}
574 # @var{folder name} "@var{folder nickname}"
575 # @r{(nicknames are not necessary)}
580 %#mh/Backup@@my.imap.example.com "Sent"
583 %#mh/spool/wl "Wanderlust ML"
584 %#mh/spool/elips "ELIPS ML"
585 %#mh/spool/apel-ja "APEL Japanese ML"
586 %#mh/spool/xemacs-beta "XEmacs beta"
587 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
588 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
591 # @r{If folder name ends with @samp{/}, that means an `access group',}
592 # @r{all subfolders automatically included in one folder group.}
594 %#mh/expire@@localhost /
595 # @r{All MH folders are included in one folder group.}
600 Each line contains one folder you want to read. The definition of
601 folders will be explained in detail in the next section.
603 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
604 become one folder group. One folder group is treated as a directory
605 which can be opened and closed in folder mode. It is convenient for
606 collecting some folders and putting them in order.
608 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
609 line and you have to write it that way (It is because the parser sucks).
611 There are two types of groups. One is like @samp{Emacsen} from above
612 example which the user chooses his favorite folders as a group.
614 The other one is @dfn{access group} like @samp{+ /} from above example.
615 It makes all the sub-folders in a folder to a group. (It differs from
616 the type of the folder. For example, @samp{+} followed by @samp{/}
617 makes entire MH sub-directories to one group)
619 This behavior is better understood if you try it and confirmed the
620 function first. You can write and try a small folder definition, so you
621 will know the idea of the folder function before writing the real one.
623 @node Start Wanderlust, , Folder Definition, Start Me Up
624 @section Start Wanderlust
625 @cindex Start Wanderlust
627 If installation and configuration worked well, you can invoke Wanderlust by
628 typing following command in Emacs.
635 After initialization, Folder Mode which shows the list of folders will appear.
636 That means the folders you defined in the @file{~/.folders} are listed
637 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
638 can skip folder checking.
640 Basically, you will handle messages in wanderlust while you come and go
641 from/to each of the following buffers.
645 You can see the list of folders. You can select some folder and go into the summary
646 of it. You can subscribe new folder or edit subscription list.
648 You can see the list of messages in the folder. You can select message and view its
649 contents, and reply to some message. You can delete ones or move ones to another
652 You can see the contents of the message. You can save part to disk or open in external
655 You can edit message.
658 Details of each ones are explained later.
661 @node Folders, Folder, Start Me Up, Top
662 @chapter Wanderlust's folders
665 This chapter describes the folder types which Wanderlust is able to handle.
667 Wanderlust uses ELMO as it's interface, so every folder types supported
668 by ELMO is usable in Wanderlust.
670 As of version @value{VERSION}, 11 types of folders are predefined. These are
671 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
672 Pipe and Internal folder types.
675 * IMAP Folder:: @samp{%} -- IMAP folder
676 * NNTP Folder:: @samp{-} -- NNTP folder
677 * MH Folder:: @samp{+} -- MH folder
678 * Maildir Folder:: @samp{.} -- Maildir folder
679 * News Spool Folder:: @samp{=} -- News spool folder
680 * Archive Folder:: @samp{$} -- Archive folder
681 * POP Folder:: @samp{&} -- POP folder
682 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
683 * Namazu Folder:: @samp{[} -- Namazu Folder
684 * Multi Folder:: @samp{*} -- Multi folder
685 * Filter Folder:: @samp{/} -- Filter folder
686 * Pipe Folder:: @samp{|} -- Pipe folder
687 * Internal Folder:: @samp{'} -- Internal folder
691 @node IMAP Folder, NNTP Folder, Folders, Folders
699 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
705 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
709 You can specify @code{login} (encoded password transmission),
710 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
711 authentication) or @code{clear} (or @code{nil}, plain password
712 transmission) as @var{authenticate-type}.
717 @var{username} -> The value of @code{elmo-imap4-default-user}.
718 Initial setting is @env{USER} environment variable or
719 @env{LOGNAME} environment variable or return value of
720 @code{(user-login-name)}.
721 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
722 Initial setting is "auth".
723 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
724 Initial setting is "localhost".
725 @var{port} -> The value of @code{elmo-imap4-default-port}.
726 Initial setting is 143.
729 You can omit the @var{hostname} from folder names if you set
730 @code{elmo-imap4-default-server} as your main IMAP server.
731 For example, you can specify a folder as @samp{foo%imap@@gateway} even
732 if you have to go through a firewall.
736 ;; @r{Example: imap4.exaple.org as main IMAP server}
737 (setq elmo-imap4-default-server "imap4.example.org")
741 SSL (Secure Socket Layer) connection will be used if a folder name ends
742 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
743 is @code{ssl}, SSL will be the default connection. If a folder name
744 ends with @samp{!!}, STARTTLS connection will be established. If the
745 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
746 STARTTLS will be the default connection.
750 ;; @r{Example: Use SSL connection}
751 (setq elmo-imap4-default-stream-type 'ssl)
755 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
756 authentication method, the password is sent in encoded form. But, if
757 your server is unable to receive an encoded password, authentication
758 will fall back to @code{clear} (that is, sending password in raw format)
759 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
760 authentication will fall back to @code{clear} without confirmation
761 (default value is @code{nil}).
765 ;; @r{Example: password in raw format}
766 (setq elmo-imap4-default-authenticate-type 'clear)
774 %inbox -> IMAP mailbox "inbox"
775 %#mh/inbox -> IMAP mailbox "#mh/inbox"
777 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
778 %inbox:hoge/clear@@server1
779 -> server1's IMAP mailbox "inbox"
780 of user "hoge", with plain password authentication
785 @subsection International mailbox names (Modified UTF7)
786 @cindex Modified UTF7
793 You can use international mailbox names in @var{mailbox} part, if you
794 are using Emacs which can treat unicode and
795 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
796 value is @code{nil}).
798 Currently, following Emacsen can treat unicode.
801 @item Emacs 20.3 or later + Mule-UCS
803 If you installed Mule-UCS package, Emacs can treat unicode.
804 You can obtain Mule-UCS package from following URL.
807 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
810 @item XEmacs 21.2.13 or later + ucs-conv package
812 By default, XEmacs 21 cannot treat unicodes, but if you installed
813 ucs-conv package, it can.
814 You can obtain ucs-conv package from following anonymous CVS.
818 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
819 Password: @var{NULL} (Just enter return key)
820 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
824 You also need utf7 conversion programs, @command{u7tou8} and
825 @command{u8tou7} to use international mailbox name in the current
826 XEmacs. These programs are included in the UTF7 package which can be
827 obtained from following URL.
830 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
835 @node NNTP Folder, MH Folder, IMAP Folder, Folders
846 A folder to access USENET news via NNTP protocol (RFC 977).
847 One newsgroup is treated as a folder.
853 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
859 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
860 Initial setting is @samp{localhost}.
861 @var{username} -> The value of @code{elmo-nntp-default-user}.
862 Initial setting is @code{nil}.
863 @var{port} -> The value of @code{elmo-nntp-default-port}.
864 Initial setting is 119.
867 AUTHINFO is used as authentication method if the @var{username} is
868 non-nil. SSL will be default method if
869 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
870 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
871 STARTTLS connection will be established. if the value of
872 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
873 be the default connection.
879 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
880 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
885 @node MH Folder, Maildir Folder, NNTP Folder, Folders
892 A folder to access MH format mail (1 file is 1 mail).
897 @samp{+} @var{directory-name}
900 Normally, @var{directory-name} is an relative path to the variable
901 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
902 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
903 (this is also true for drive-letters).
905 Message number is used for the name of the message file.
911 +inbox -> @file{~/Mail/inbox}
912 +from/teranisi -> @file{~/Mail/from/teranisi}
913 +~/test -> @file{~/test}
918 @node Maildir Folder, News Spool Folder, MH Folder, Folders
919 @section Maildir Folder
921 @cindex Maildir Folder
925 A folder to access Maildir format (1 file is 1 mail).
930 @samp{.} [@var{directory-name}]
933 Normally, @var{directory-name} is a relative path to the variable
934 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
935 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
936 (this is also true for drive-letters).
938 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
939 Messages are contained in the @file{cur} directory. All message files
940 in the @file{new} directory are moved to @file{cur} directory when you
941 access the folder. All message files contained in the @file{tmp}
942 directory and not accessed for 36 hours are deleted.
944 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
950 . -> @file{~/Maildir}
951 .inbox -> @file{~/Maildir/inbox}
952 .from/teranisi -> @file{~/Maildir/from/teranisi}
953 .~/test -> @file{~/test}
958 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
959 @section News Spool Folder
961 @cindex News spool Folder
964 This folder handles locally saved news articles which are proposed by
965 Mew/IM. You can also read articles directly from a spool-file which is
966 retrieved by an utility like @command{gnspool}.
971 @samp{=} @var{directory-name}
974 @var{directory-name} is a sub-directory to the directory defined by
975 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
976 You can use @samp{.} as directory delimiter as well as @samp{/}.
982 =fj/os/os2 -> @file{~/News/fj/os/os2}
983 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
988 @node Archive Folder, POP Folder, News Spool Folder, Folders
989 @section Archive Folder
991 @cindex Archive Folder
994 This method can handle archive files, which are compressed by utilities
995 such as Info-ZIP or LHA, as one folder.
1001 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1005 @var{path-name} is the relative path from
1006 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1007 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1008 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1009 also permitted under the environment of ange-ftp, efs.
1011 The actual file name of the archive folder is
1012 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1013 under the @var{path-name}. If a file named @var{path-name} exists, it is
1014 treated as folder. The suffix is automatically decided for
1015 @var{archiver-type}.
1017 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1018 (Initial setting is @code{zip}) is referred.
1020 @var{prefix} specifies the internal directory structure of the archive.
1021 For example, if the ML server is fml, @file{msend.tar.gz} has a
1022 structure like @file{spool/1}, so you have to specify @samp{spool} as
1029 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1030 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1031 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1032 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1037 * Archiver:: Supported Archivers
1038 * Archive Tips:: TIPS
1039 * Archive Vars:: Customization
1043 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1044 @subsection Supported Archives
1054 By default, following archives are supported.
1058 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1059 GNU TAR('tgz, 'tar) ;; read-only
1063 If your archiver can include multiple files in one archive, you have a
1064 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1065 of the candidate. TAR is supported read-only because it cannot delete
1066 file in the archive (@code{mv})).
1068 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1069 archiver of Wanderlust because they cannot include multiple
1070 files. Archivers that cannot extract files to standard output are also
1073 @subsection OS specific information about archiver.
1075 Behaviors of the following archivers are confirmed by further experiences.
1076 (@samp{*} mark means recommended archiver).
1079 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1080 LHA OS/2 version Rel.2.06b Feb 18, 1998
1081 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1082 *Zip 2.2 (November 3rd 1997).
1083 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1084 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1085 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1087 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1088 LHa for UNIX V 1.14c
1089 UnZip 5.32 of 3 November 1997
1090 Zip 2.2 (November 3rd 1997)
1091 GNU tar 1.12 (1.11.x is no good)
1092 gzip 1.2.4 (18 Aug 93)
1094 [Win32] Win.98/Meadow
1098 GNU tar 1.11.8 + 1.5(WIN32)
1105 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1106 Hiramatsu version of LHA is only supported.
1107 In Win32, LHa32 is only supported (DOS version is no good).
1109 * Caution about GNU tar
1111 You have to take care about GNU tar's version because many version has
1112 problem on deleting file from archive.
1114 Please test @option{--delete} @option{-f} options work. Otherwise, your
1115 archive will be destroyed. No problem is reported on above versions of
1119 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1121 @cindex Archive Tips
1123 For comfortable migration, usage of @code{wl-summary-archive}
1124 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1125 archive folders created by expiration, you must set non-nil value to
1126 @code{elmo-archive-treat-file}.
1128 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1129 in processing speed. For comfortable use, Emacs20 is recommended.
1130 (If re-search's performance is the problem, 19.3x or later may be okay.)
1132 If many files are included in one archive,
1133 it takes long time to access the archive folder because
1134 archiver starting overhead is increased (especially LHA).
1135 150-200 messages in one archive is recommended.
1137 Of course, following is possible @t{:-)}
1138 (meanings of these variables are described later.)
1142 (setq wl-fcc "$backup")
1143 (setq wl-trash-folder "$trash;lha")
1147 @node Archive Vars, , Archive Tips, Archive Folder
1148 @subsection Variables About Archive Folder
1149 @cindex Archive variables
1152 @item elmo-archive-default-type
1153 @vindex elmo-archive-default-type
1154 The initial setting is @code{zip}.
1155 Set archiver type by symbol.
1157 @item elmo-archive-@var{type}-method-alist
1158 @vindex elmo-archive-TYPE-method-alist
1159 Define archiver @var{type}'s methods.
1160 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1161 Each element of the alist is following.
1165 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1166 (@var{action} . @var{function}) ;; function
1170 Currently available actions are following.
1174 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1175 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1182 actions enclosed with braces are optional (They are used for better
1185 @item elmo-archive-suffix-alist
1186 @vindex elmo-archive-suffix-alist
1187 An alist of archiver-type (symbol) and suffix.
1189 @item elmo-archive-file-regexp-alist
1190 @vindex elmo-archive-file-regexp-alist
1191 An alist of a regexp to get file number from list output of archiver
1192 and archiver-type (symbol).
1194 @item elmo-archive-method-list
1195 @vindex elmo-archive-method-list
1196 A list of elmo-archive-@var{type}-method-alist
1197 (@var{type} is a symbol of archiver-type).
1199 @item elmo-archive-lha-dos-compatible
1200 @vindex elmo-archive-lha-dos-compatible
1201 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1202 DOS (Mr. Yoshizaki original) compatible.
1204 @item elmo-archive-cmdstr-max-length
1205 @vindex elmo-archive-cmdstr-max-length
1206 The initial setting is 8000.
1208 Max length of command line argument for external archiver program.
1209 Emacs does not have a limit of command line byte length, but some OS
1210 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1211 this limit because it calls external archiver program directly (not
1212 called via shell). For example, you cannot delete messages if archiver
1213 program must receive larger bytes of arguments to delete. OS/2 have a
1214 command line argument limit of 8190 bytes, so we defined default as 8000
1217 However, you don't have an influence of command line argument limit
1218 if the archiver has `actions' to receive target file information from
1219 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1223 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1231 A folder to access e-mails via POP3 protocol (RFC 1939).
1237 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1242 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1243 as @var{authenticate-type}.
1245 You can specify @samp{uidl} (use UIDL command for message numbering) or
1246 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1250 @var{username} -> The value of @code{elmo-pop3-default-user}.
1251 Initial setting is @env{USER} environment variable or
1252 @env{LOGNAME} environment variable or return value of
1253 @code{(user-login-name)}.
1254 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1255 Initial setting is @samp{user}.
1256 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1257 If t, use UIDL for numbering. Initial setting is t.
1258 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1259 Initial setting is @samp{localhost}.
1260 @var{port} -> The value of @code{elmo-pop3-default-port}.
1261 Initial setting is 110.
1268 &hoge@@localhost -> access localhost as user @samp{hoge}.
1269 &hoge@@popserver:109 -> access the server "popserver" on port 109
1270 as user @samp{hoge}.
1274 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1275 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1276 @file{utils/sasl/lisp/} or Emacs/W3 package
1277 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1280 If the last character of the folder name is @samp{!}, Wanderlust
1281 connects to the POP server via SSL (Secure Socket Layer). If you set
1282 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1283 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1284 with @samp{!!}, STARTTLS connection will be established. if the value
1285 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1289 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1290 @section Shimbun Folder
1292 @cindex Shimbun Folder
1293 @cindex Folder, Shimbun
1298 A folder for watching "shimbun" (means "newspaper" in Japanese),
1299 news site and mailing list archives on WWW by using emacs-w3m
1300 (@uref{http://emacs-w3m.namazu.org/}).
1302 You should possess w3m and emacs-w3m to use this.
1308 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1312 Admissible values of @var{module-name} and @var{folder-name} are
1313 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1319 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1320 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1324 @subsection Variables About Shimbun Folder
1327 @item elmo-shimbun-update-overview-folder-list
1328 @vindex elmo-shimbun-update-overview-folder-list
1329 The initial setting is @code{nil}. You can specify a list of regular
1330 expressions of shimbun folder names. The overview of matched shimbun
1331 folder is updated when messages are fetched.
1332 You should @kbd{s rescan} after fetching to update summary.
1336 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1337 @section Namazu Folder
1339 @cindex Namazu Folder
1340 @cindex Folder, Namazu
1341 @cindex Folder, Text Search
1344 A folder to access messages found in namazu-index with some condition.
1345 It uses namazu (@uref{http://www.namazu.org/}) for search.
1351 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1355 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1361 [wanderlust] -> search messages matched with
1362 "wanderlust" from the default index
1363 [semi flim]~/Mail/semi -> search "semi flim" from the index
1364 in the directory "~/Mail/semi"
1370 @subsubsection Enter space to separate keywords
1372 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1374 @subsubsection Alias name for index
1376 You can define an alias name for index.
1381 (setq elmo-nmz-index-alias-alist
1382 '(("cache" . "~/.elmo/cache")
1383 ("docs" . "~/documents")))
1386 Above definition defines two index aliases.
1393 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1394 directory @file{~/.elmo/cache}.
1396 @subsubsection Multiple indices
1398 You can specify a list for @code{elmo-nmz-default-index-path} and
1399 @code{elmo-nmz-index-alias-alist}.
1400 When list is specified, all index contained in the list is used as the
1406 (setq elmo-nmz-index-alias-alist
1407 '(("all" . ("~/.elmo/cache" "~/documents"))
1408 ("cache" . "~/.elmo/cache")))
1411 Using above alias setting, you can specify
1417 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1418 directory @file{~/.elmo/cache} and @file{~/documents}.
1420 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1421 @section Multi Folder
1423 @cindex Multi Folder
1424 @cindex Folder, Multiple
1425 @cindex Folder, Marge
1427 A folder to access virtual folder which collects messages from
1434 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1438 After @samp{*} character, specify multiple folders you want to collect
1439 separated by @samp{,} like
1440 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1446 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1447 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1448 treated as one folder.
1450 *+inbox,-fj.rec.tv,%inbox
1451 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1456 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1457 @section Filter Folder
1459 @cindex Filter Folder
1460 @cindex Folder, Filtering
1461 @cindex Folder, Virtual
1462 @cindex Folder, Conditional
1464 A folder to access virtual folder which collects all messages that
1465 satisfy a condition.
1470 @samp{/} @var{condition} @samp{/} @var{target-folder}
1473 In the @var{condition} part, you can specify following.
1477 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1479 first: @var{number} messages are picked from top of folder.
1480 last: @var{number} messages are picked from bottom of folder.
1486 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1487 /first:20/%inbox -> First 20 messages from %inbox are picked.
1492 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1494 since: only messages arrived since @var{date} are picked.
1495 before: only messages arrived before @var{date} are picked.
1497 You can specify following as @var{date}.
1501 yesterday -> a day before today.
1502 lastweek -> same day of last week.
1503 lastmonth -> same day of last month.
1504 lastyear -> same day of last year.
1505 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1506 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1514 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1516 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1522 Field filter: @samp{@var{field}:@var{value}}
1524 All messages that have @var{field} and its value is @var{value} are picked.
1525 @var{field} and @var{value} are case insensitive.
1531 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1532 and its value includes "teranisi" string are picked.
1533 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1541 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1542 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1544 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1545 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1551 /from:teranisi&!to:teranisi/+inbox
1552 -> In +inbox, messages are picked if the message's
1553 From: field includes "teranisi" and
1554 To: field doesn't include "teranisi".
1556 /tocc:"Yuuichi Teranishi"/+inbox
1557 -> In +inbox, messages are picked if the
1558 message's To: field or Cc: field includes
1559 "Yuuichi Teranishi".
1561 /(from:yt|from:teranisi)&subject:report/+inbox
1562 -> In +inbox, messages are picked if the message's
1563 From: field includes "yt" or "teranisi", and
1564 Subject includes "report".
1570 Tip for string description:
1572 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1573 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1574 should be escaped with @samp{\} in it). You can enclose the string with
1575 @samp{"} even it does not contain these characters.
1581 *%inbox,/from:teranisi/%inbox@@server
1582 -> Messages in %inbox or
1583 message is in the %inbox@@server folder and it's From field
1584 includes "teranisi" are collected.
1586 /last:100//to:teranisi/*+inbox,%inbox
1587 -> Latest 100 messages which is in the +inbox or %inbox folder
1588 and To: field matches "teranisi".
1590 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1591 -> Pick messages which have From: field and it includes "hogehoge"
1592 from latest 20 messages in the %#mh/inbox@@localhost
1593 and To: or Cc: field includes "teranisi".
1596 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1597 @section Pipe Folder
1601 @cindex Download Message
1602 @cindex Incorporate Message
1604 In the pipe folder, messages are automatically transferred from the source
1605 folder to destination folder.
1610 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1613 When you access the pipe folder, messages are automatically transferred
1614 from @var{source-folder} to @var{destination-folder}.
1615 It is convenient if you want to download messages to local disk via POP.
1616 For example, if you specify following
1619 |&username@@popserver|+inbox
1623 and access it, messages are downloaded automatically from
1624 @samp{&username@@popserver} to @samp{+inbox}.
1626 On the other hand, if you put @samp{|:} instead of second @samp{|},
1627 then messages are copied to the destination folder (not deleted from
1628 source-folder). At the next time you access that folder, only new
1629 messages will be copied.
1632 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1635 If you want to copy messages from POP server and view them, specify the
1639 |&username@@popserver|:+inbox
1642 where messages will be kept on the server.
1648 |%inbox|%myinbox -> Download %inbox to %myinbox.
1649 |*&user@@popserver1,&user@@popserver2|+inbox
1650 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1651 |-gnu.emacs.sources|:+sources
1652 -> Copy messages from -gnu.emacs.sources to +sources.
1656 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1658 @node Internal Folder, , Pipe Folder, Folders
1659 @section Internal folder
1661 @cindex Internal Folder
1662 @cindex Folder, @samp{$} mark
1664 @c @cindex Folder, Null
1666 A folder to access internal messages of Wanderlust.
1678 A folder named @samp{'mark} is a special virtual folder which collects
1679 messages which have important mark @samp{$}.
1681 You can review important messages at once after you put important marks
1682 on the messages in the different folders.
1684 In this folder, if you delete message, important mark @samp{$} put on
1685 the message is removed. If you append messages to this folder, the
1686 message will have @samp{$} mark.
1688 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1689 folder. If you want IMAP folder's message remove from @samp{'mark}
1690 folder, remove important mark at IMAP Folder.)
1693 A folder named @samp{'sendlog} is a virtual folder which collects
1694 cached messages which are recoded on @file{~/.elmo/sendlog}.
1695 It might be useful when you forgot to add cc for yourself.
1696 To use this, you should set @code{wl-draft-use-cache} to non-nil
1697 so that sent messages are cached.
1700 You can access cached messages fetched via network by accessing
1701 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1702 the name of the subdirectories of the cache directory
1703 (@file{~/.elmo/cache}).
1706 @node Folder, Summary, Folders, Top
1707 @chapter Folder mode
1710 After you start Wanderlust, folder mode is appeared firstly.
1711 It contains folder list you subscribed.
1712 You can select and edit folders in this mode.
1715 * Selecting Folder:: Select folder you want to read
1716 * Folder Manager:: Editing folders
1720 @node Selecting Folder, Folder Manager, Folder, Folder
1721 @section Selecting Folder
1722 @cindex Selecting Folder
1724 @subsection Usage (TIPS)
1726 @subsubsection Check new, unread number
1728 Folder mode looks like this.
1729 (In XEmacs, it looks much nicer @t{;-)})
1733 [-]Desktop:14186/35580/67263
1738 [-]Emacsen:0/34/4837
1739 Wanderlust ML:0/0/558
1742 XEmacs Beta:0/29/255
1753 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1757 @kbd{s} key on the folder line updates these numbers.
1758 It changes its color if it has many new messages.
1760 The whole folder mode is a folder group named @samp{Desktop}.
1761 Folder group open/close by return key.
1762 A operation to a folder group is treated as operations on the
1764 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1765 six children folders update its unread number status.
1767 @subsubsection Select Folder
1769 To enter summary mode of the folder, type return (or space) key on
1771 If the variable @code{wl-stay-folder-window} has non-nil value,
1772 summary window appears on the right of the folder mode window.
1774 @subsection Key bindings
1776 Folder mode's key binding (related to selecting folders) is following.
1781 @kindex @key{SPC} (Folder)
1782 @kindex @key{RET} (Folder)
1783 @findex wl-folder-jump-to-current-entity
1784 Enter to the summary mode of the folder at the current cursor point.
1785 If the cursor is on the top of folder group line,
1786 the folder group is opened or closed.
1787 When the cursor is on the access group and this command is called
1788 with prefix argument, folder children list is updated to the newest one.
1789 (Children list is updated recursively if the access folder has hierarchical
1791 (@code{wl-folder-jump-to-current-entity})
1794 @kindex M-@key{RET} (Folder)
1795 @findex wl-folder-update-recursive-current-entity
1796 Folder children list of the access group at the current cursor point
1797 is updated to the newest one.
1798 (Children list is updated recursively if the access folder has hierarchical
1800 (@code{wl-folder-update-recursive-current-entity})
1805 Create a new draft message.
1810 @findex wl-folder-write-current-folder
1811 If the current cursor point is on the NNTP folder, create a new draft
1812 message which already has @samp{Newsgroups:} field. If the current
1813 cursor point is on the folder for mailing list (refile destination),
1814 create a new draft message which already has @samp{To:} field with
1815 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1817 (@code{wl-folder-write-current-folder})
1820 @kindex C-c C-o (Folder)
1821 @findex wl-jump-to-draft-buffer
1822 Move to the draft buffer if available. If multiple draft buffer exists,
1823 moved to one after another. If prefix argument is specified, load draft
1824 folder's message to the draft buffer and jump to it.
1825 (@code{wl-jump-to-draft-buffer})
1829 @findex wl-folder-check-current-entity
1830 Update new and unread number information of the folder at the current
1832 (@code{wl-folder-check-current-entity})
1836 @findex wl-folder-sync-current-entity
1837 Update summary information of the folder at the current cursor point.
1838 (@code{wl-folder-sync-current-entity})
1841 @kindex r s (Folder)
1842 @findex wl-folder-check-region
1843 Update new and unread number information of the folders in the currently
1845 (@code{wl-folder-check-region})
1848 @kindex r S (Folder)
1849 @findex wl-folder-sync-region
1850 Update summary information of the folders in the currently selected region.
1851 (@code{wl-folder-sync-region})
1855 @findex wl-status-update
1856 Sync up address book status with @file{~/.addresses}'s content.
1857 (@code{wl-status-update})
1861 @findex wl-folder-prev-unread
1862 Jump cursor to the folder which have unread messages on the upward from
1863 current cursor point.
1864 (@code{wl-folder-prev-unread})
1868 Jump cursor to the folder which have unread messages on the downward
1869 from current cursor point.
1870 (@code{wl-folder-next-unread})
1874 Move cursor to the folder on the previous line.
1875 (@code{wl-folder-prev-entity})
1879 Move cursor to the folder on the next line.
1880 (@code{wl-folder-next-entity})
1884 Jump to the folder specified by the user input.
1885 (@code{wl-folder-jump-folder})
1889 @findex wl-folder-prefetch-current-entity
1890 Prefetch new messages of the folder at the current cursor point by
1891 @code{wl-summary-incorporate}.
1892 If the cursor is on the folder group, it is executed recursively.
1893 (@code{wl-folder-prefetch-current-entity})
1897 @findex wl-folder-mark-as-read-all-current-entity
1898 Mark all unread messages of the folder at the current cursor point as read.
1899 If the cursor is on the folder group, it is executed recursively.
1900 (@code{wl-folder-mark-as-read-all-current-entity})
1904 @findex wl-folder-goto-first-unread-folder
1905 Enter summary mode of the first unread folder.
1906 (@code{wl-folder-goto-first-unread-folder})
1910 @findex wl-folder-empty-trash
1912 (@code{wl-folder-empty-trash})
1916 @findex wl-folder-open-all-unread-folder
1917 All unread folder is opened.
1918 (@code{wl-folder-open-all-unread-folder})
1922 @findex wl-folder-open-close
1923 Folder group is opened/closed.
1924 (@code{wl-thread-open-close})
1928 All folder group is opened.
1929 (@code{wl-folder-open-all})
1933 All folder group is closed.
1934 (@code{wl-folder-close-all})
1944 (@code{wl-folder-suspend})
1947 @kindex M-s (Folder)
1948 Save current folder status.
1952 @kindex M-t (Folder)
1953 Toggle Wanderlust's offline/online status.
1954 (@code{wl-toggle-plugged})
1957 @kindex C-t (Folder)
1958 Start Wanderlust's plug-status manager.
1959 (@code{wl-plugged-change})
1962 @subsection Customize variables
1965 @item wl-folders-file
1966 @vindex wl-folders-file
1967 The initial setting is @file{~/.folders}.
1968 Subscribed folders are described (saved) in this file.
1970 @item wl-folder-info-save
1971 @vindex wl-folder-info-save
1972 The initial setting is @code{t}. If non-nil, unread information is
1973 saved and used in the next Wanderlust session.
1975 @item wl-stay-folder-window
1976 @vindex wl-stay-folder-window
1977 The initial setting is @code{nil}.
1978 If non-nil, summary window is appeared on the right side of the folder buffer.
1980 @item wl-folder-window-width
1981 @vindex wl-folder-window-width
1982 The initial setting is 20.
1983 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1985 @item wl-folder-use-frame
1986 @vindex wl-folder-use-frame
1987 The initial setting is @code{nil}.
1988 If non-nil, use new frame for the folder window.
1990 @item wl-folder-many-unsync-threshold
1991 @vindex wl-folder-many-unsync-threshold
1992 The initial setting is 70.
1993 If the number of unread messages is more than this value,
1994 folder color is changed.
1996 @item wl-highlight-folder-by-numbers
1997 @vindex wl-highlight-folder-by-numbers
1998 This option controls how to highlight each line in the folder buffer.
1999 The default value is @code{t}, highlighting with various colors based on
2000 the message numbers. If it is @code{nil}, highlighting with various
2001 colors based on the folder status. In addition, if it is a number
2002 (e.g. 1), highlighting will be done based on both the message numbers
2003 and the folder status.
2005 @item wl-folder-desktop-name
2006 @vindex wl-folder-desktop-name
2007 The initial setting is @samp{Desktop}.
2008 The name of top folder group.
2010 @item wl-folder-petname-alist
2011 @vindex wl-folder-petname-alist
2012 The initial setting is @code{nil}.
2013 An alist of folder's realname and its nickname.
2015 @item wl-folder-access-subscribe-alist
2016 @vindex wl-folder-access-subscribe-alist
2017 The initial setting is @code{nil}.
2019 Control automatic subscribing and unsubscribing of the children list
2025 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2029 If @var{subscribe-flag} is non-nil, folders which have name matched to
2030 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2031 already unsubscribed folder is not displayed even when the
2032 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2039 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2040 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2041 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2042 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2046 @item wl-folder-hierarchy-access-folders
2047 @vindex wl-folder-hierarchy-access-folders
2048 The initial setting is the list shown below:
2057 A list of access groups which creates children folder list hierarchically.
2059 For example, if you specify
2060 @code{wl-folder-hierarchy-access-folders} like following,
2064 (setq wl-folder-hierarchy-access-folders
2065 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
2070 such access group hierarchy is obtained.
2076 -fj.comp.announce:0/0/2
2077 -fj.comp.dev.cdrom:0/0/0
2079 [+]-japan:238/238/1688
2082 -comp.unix.admin:0/0/0
2083 -comp.unix.dos-under-unix:0/0/0
2084 -comp.unix.programmer:0/0/0
2085 [-]-comp.unix.bsd:0/0/23
2086 -comp.unix.bsd.freebsd.announce:0/0/0
2091 If you opened @samp{-} in this example, only the direct children is created
2092 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2093 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2094 is not created until the children access group is opened.
2098 @node Folder Manager, , Selecting Folder, Folder
2099 @section Editing Folders
2100 @cindex Folder Manager
2101 @cindex Folder, Edit
2102 @cindex Folder, Subscribe
2103 @cindex Folder, Unsubscribe
2105 As described before, subscribed folder list is saved in @file{~/.folders} file.
2106 But you don't have to edit @file{~/.folders} directly.
2107 You can append, delete, edit folders from folder mode.
2109 @subsection Usage (Tips)
2111 @subsubsection Append Folder
2113 @kbd{m a} appends new folder to the folder mode.
2114 @kbd{m g} appends new folder group.
2115 To append new folder to this group, firstly open it,
2116 then execute append command in the next line.
2118 @subsubsection Edit Folder
2120 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2121 Thus, you can change folder position as if you were editing a normal file.
2123 @subsubsection Create Multi Folder.
2127 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2129 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2131 Type @kbd{m m}, then you can create multi folder.
2134 @subsubsection Delete Nickname, Filter
2136 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2137 minibuffer while appending.
2139 @subsubsection Append Folder to Empty Group
2141 To append new folder to the empty folder group
2142 (after you create folder group by typing @kbd{m g}),
2143 firstly open it, then execute append command in the next line.
2144 If it is closed, folder is appended on the same level with
2145 the above folder group. It is difficult to explain by words so try it.
2146 In other words, appended position depends on the
2147 above folder group's open/close status.
2149 @subsubsection Charset of the Folders File.
2151 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2153 @subsubsection Create Filter
2155 @kbd{m f} adds filter to the folder at the current cursor point. To
2156 create new filter folder and leave the current folder unchanged, copy it
2157 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2158 filter can be specified while appending filter. If you put
2159 ``''(@var{NULL}), filter is deleted.
2161 @subsubsection Sort Folders
2163 Sorting of the folders is executed by the function specified by
2164 @code{wl-fldmgr-sort-function}.
2165 The initial setting is @code{wl-fldmgr-sort-standard},
2166 which sorts alphabetically.
2167 Sorting affects only on the current folder group. It does not
2168 affect on the child groups.
2170 @subsubsection Hiding Folders in the Access Group
2172 Usually, access group displays all children folders, but you can set
2173 some folders hidden. Following operations are only available on access
2176 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2177 (subscribe/unsubscribe) of the folder at current cursor point. Against
2178 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2181 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2182 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2183 argument and if the argument has positive number, the unsubscribe it.
2184 If the prefix argument has negative value, folder becomes visible and if
2185 zero, folder visibility is toggled.
2187 The other commands, @code{wl-fldmgr-subscribe} and
2188 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2191 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2192 executed in the access group, they have a same effect with
2193 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2194 The difference is that cut commands deletes folders from the current
2197 @subsubsection Operations in the Access Group
2199 You can insert and delete folders in the access group like usual folder
2200 group. But insert and delete commands can be only available for the
2201 children folders of the access group and they only sets the subscribe
2202 status. In other words, insertion of the folder means subscribing,
2203 deletion means unsubscribing.
2204 @footnote{In the current implementation,
2205 it is faster to delete region than to unsubscribe region.}
2207 To update the access group when children folders are inserted or deleted
2208 by other way (other than Wanderlust),
2209 open the access group by typing @kbd{C-u @key{RET}}.
2210 @xref{Selecting Folder}.
2212 The order of children folders of access group is saved after
2213 insertion/deletion/sorting.
2214 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2215 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2216 newly created folders are inserted on the top of the access group.
2218 @subsection Key bindings
2219 @cindex Keybind, Folder Mode
2220 @cindex Keybind, Folder Buffer
2222 Key bindings on the folder mode related to folder editing are shown below.
2223 All bindings starts with @kbd{m}, and primary commands are binded to
2224 one stroke key binding.
2228 @kindex m a (Folder)
2229 @findex wl-fldmgr-add
2231 (@code{wl-fldmgr-add})
2236 @kindex m g (Folder)
2237 @findex wl-fldmgr-make-group
2238 Create a folder group.
2239 (@code{wl-fldmgr-make-group})
2242 @kindex m A (Folder)
2243 @findex wl-fldmgr-make-access-group
2244 Create an access group.
2245 (@code{wl-fldmgr-make-access-group})
2248 @kindex m d (Folder)
2249 @findex wl-fldmgr-delete
2250 Delete folder itself and msgdb.
2251 If the folder itself cannot be deleted like NNTP folder,
2252 only msgdb is deleted.
2253 (@code{wl-fldmgr-delete})
2258 @kindex m R (Folder)
2259 @findex wl-fldmgr-rename
2260 Change the name of folder or folder group.
2261 msgdb's path is also changed.
2262 (@code{wl-fldmgr-rename})
2268 @findex wl-fldmgr-make-multi
2269 Create a multi folders in the cutlist (cut, copied folders).
2270 (@code{wl-fldmgr-make-multi})
2275 @kindex m f (Folder)
2276 @findex wl-fldmgr-make-filter
2277 Create a filter folder. (Put a filter on the folder).
2278 (@code{wl-fldmgr-make-filter})
2282 @kindex M-c (Folder)
2283 @kindex m c (Folder)
2284 @findex wl-fldmgr-copy
2285 Copy folder (it is not available on folder group).
2286 (@code{wl-fldmgr-copy})
2290 @kindex M-w (Folder)
2291 @kindex m W (Folder)
2292 @findex wl-fldmgr-copy-region
2293 Copy folders in the specified region.
2294 (@code{wl-fldmgr-copy-region})
2298 @kindex C-k (Folder)
2299 @kindex m k (Folder)
2300 @findex wl-fldmgr-cut
2301 Cut folder. Folder itself is not deleted.
2302 (@code{wl-fldmgr-cut})
2306 @kindex C-w (Folder)
2307 @kindex m C-w (Folder)
2308 @findex wl-fldmgr-cut-region
2309 Cut folders in the specified region.
2310 (@code{wl-fldmgr-cut-region})
2314 @kindex C-y (Folder)
2315 @kindex m y (Folder)
2316 @findex wl-fldmgr-yank
2317 Paste folders that are copied or cut (folders in the cut-list).
2318 (@code{wl-fldmgr-yank})
2321 @kindex m p (Folder)
2322 @findex wl-fldmgr-set-petname
2323 Put nickname on the folder.
2324 (@code{wl-fldmgr-set-petname})
2327 @kindex m q (Folder)
2328 @findex wl-fldmgr-clear-cut-entity-list
2329 Clear the cut-list. (cut, copied folder information is cleared,
2330 you cannot paste after this)
2331 (@code{wl-fldmgr-clear-cut-entity-list})
2334 @kindex m s (Folder)
2335 @findex wl-fldmgr-sort
2336 Sort folders in the current folder group.
2337 (@code{wl-fldmgr-sort})
2340 @kindex m C-s (Folder)
2341 @findex wl-fldmgr-save
2342 Save current folder view to the @file{wl-folders-file}.
2343 (@code{wl-fldmgr-save})
2346 [Following commands are only available on the access groups]
2352 @kindex m u (Folder)
2353 @findex wl-fldmgr-unsubscribe
2354 Set the visibility of folder (subscribe/unsubscribe).
2355 (@code{wl-fldmgr-unsubscribe})
2360 @kindex r u (Folder)
2361 @findex wl-fldmgr-unsubscribe-region
2362 Set the visibility of the folders (subscribe/unsubscribe) in the
2364 (@code{wl-fldmgr-unsubscribe-region})
2369 @kindex m l (Folder)
2370 @findex wl-fldmgr-access-display-normal
2371 List folders that are currently available.
2372 (@code{wl-fldmgr-access-display-normal})
2377 @kindex m L (Folder)
2378 @findex wl-fldmgr-access-display-all
2379 List all folders regardless of the subscription status.
2380 (@code{wl-fldmgr-access-display-all})
2384 @subsection Customize variables
2387 @item wl-interactive-save-folders
2388 @vindex wl-interactive-save-folders
2389 The initial setting is @code{t}. If non-nil and folder view is
2390 modified, confirm saving it before Wanderlust or Emacs exits. If
2391 @code{nil}, save without confirmation.
2393 @item wl-fldmgr-make-backup
2394 @vindex wl-fldmgr-make-backup
2395 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2396 created before saving the folder status.
2398 @item wl-fldmgr-sort-function
2399 @vindex wl-fldmgr-sort-function
2400 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2401 sort folders. By default function, folders are sorted alphabetically
2402 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2405 @item wl-fldmgr-sort-group-first
2406 @vindex wl-fldmgr-sort-group-first
2407 The initial setting is @code{t}. If non-nil,
2408 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2409 does not care whether it is folder group or not.
2411 @item wl-folder-check-async
2412 @vindex wl-folder-check-async
2413 The initial setting is @code{t}. If non-nil, check folder's unread
2414 status asynchronously. It boosts newsgroup checking.
2416 @item wl-folder-check-fast
2417 @vindex wl-folder-check-fast
2418 The initial setting is @code{nil}.
2419 If non-nil, it does not update folder status while checking.
2421 @item wl-folder-notify-deleted
2422 @vindex wl-folder-notify-deleted
2423 The initial setting is @code{nil}.
2425 If non-nil, negative value is displayed when the message is deleted. If
2426 @code{sync}, folder is synchronized when the message is deleted. If
2427 @code{nil}, message deletion is ignored.
2429 @item wl-fldmgr-add-complete-with-current-folder-list
2430 @vindex wl-fldmgr-add-complete-with-current-folder-list
2431 The initial setting is @code{nil}.
2432 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2433 candidate for @code{wl-fldmgr-add}.
2436 @subsection Miscellanea
2438 Following is a note for folder editing.
2442 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2443 paste(yank) command pastes the folders on one cut or copy command
2444 (If copy command is executed by region, folders in the region are pasted
2445 by one paste command)
2448 You cannot cut @samp{Desktop} group.
2449 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2452 You cannot copy folder group.
2455 Operations on the access group are only available for the folders
2456 in the same access group.
2459 You cannot create a folder which has same name with the folders already exist.
2462 You cannot insert folders which have same name in one group.
2463 You can insert them in the different groups.
2464 You cannot put same nickname to the different folders.
2468 @node Summary, Message, Folder, Top
2469 @chapter Summary Mode
2471 After you select the folder via folder mode, you enter to the summary
2475 * Usage of Summary Mode:: TIPS
2476 * Thread Operations:: Thread operations
2477 * Cache:: File cache, Buffer cache, and Prefetch
2478 * Auto Refile:: Auto refile settings
2479 * Sticky Summary:: Summary make sticky
2480 * Key Bindings of Summary:: Key bindings
2481 * Variables of Summary:: Customize Summary Mode
2485 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2486 @section Usage (Tips)
2488 @subsection Summary Content
2490 In the summary mode, messages are displayed like following.
2494 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2495 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2496 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2497 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2504 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2508 You cannot change this in the current version.
2510 @var{Message number} is the message's unique number in the folder. In
2511 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2512 in the MH folder, it is the filename of the message.
2514 @var{Temporal mark} and @var{Persistent mark} are described later.
2516 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2517 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2518 Japanese, but if you want to display it in English, set the value of
2519 @code{wl-summary-weekday-name-lang} as @samp{en}.
2521 @var{Sender}'s indentation corresponds to the depth of the thread.
2522 Sender name is displayed as nickname if it is defined in the address
2523 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2524 displaying with nickname.
2526 If number is printed at the head of @var{Sender} part like @samp{+2},
2527 that means the message have 2 follow messages.
2529 @var{Subject} is the @samp{Subject:} header field of the message. If
2530 the message have same @samp{Subject:} with the parent message, it is not
2531 displayed. Some mailing list puts its sequence number in the
2532 @samp{Subject:} field, but it is
2533 ignored. @code{wl-summary-no-subject-message} is displayed when the
2534 message has empty subject field.
2536 @subsection Temporary Marks
2537 @cindex Mark, Temporary
2539 There are four temporary marks,
2540 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2541 Temporary marks indicates message operations.
2546 You can execute a command on the all messages that have @samp{*} mark,
2547 with the key bindings which begins with @kbd{m}.
2550 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2554 After you type @kbd{o} key, prompt appears to input refile destination.
2555 Your answer is printed in the summary line.
2559 You can put this mark by typing @kbd{O} key.
2560 The difference between this mark and refile mark is,
2561 this mark does not delete the message while latter does.
2564 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2566 @subsection Persistent Marks
2568 There are five persistent marks,
2569 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2571 The persistent mark indicates the message's status and it is saved.
2572 Each persistent mark indicates:
2578 It is unread message.
2580 It is unread but cached message.
2582 It is read but it is not cached.
2584 It is important message. You can put @samp{$} mark by typing @kbd{$}
2585 key (if already exists, the mark is deleted). It is convenient to put
2586 this mark on the messages to remember (If you want to remember to write
2587 a reply for the message, for example) because this mark remains after
2588 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2589 @samp{'mark} folder even the message itself is deleted in the actual folder.
2592 If the message is read and cached (or local message),there are no
2596 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2597 cache. Messages with the marks other than these, you can read them in
2598 the offline status even they are in the IMAP folder or netnews folder.
2600 Among messages with persistent marks, ones with marks specified by
2601 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2602 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2604 @subsection How To Read
2606 Basically, you can read messages only typing space key again and again.
2608 To update summary status to the newest status (synchronize),
2611 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2612 moves cursor to the next message.
2613 Enter message buffer by typing @kbd{j} key.
2614 To operate multipart, you have to enter to the message buffer.
2617 @subsection Pack the Message Numbers
2618 You can pack the message numbers in Summary by
2619 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2620 News Spool Folder and Maildir Folder are supported folder types.
2623 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2624 @section Thread Operations
2626 For example, the following line indicates one thread (a context of a topic).
2629 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2633 If you type @kbd{/} on this line, the thread is opened and it changes
2634 the appearance like following.
2638 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2639 388 09/17(Thu)22:34 +-[ Murata san ]
2643 (Message 388 is the replied message to the message 384.)
2644 If you type @kbd{/} key once again, the thread is closed.
2645 With prefix argument, @kbd{/} opens all children threads.
2647 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2650 Commands with the key binding that begins with @kbd{t} executes commands
2651 on the messages in the thread.
2652 @xref{Key Bindings of Summary}.
2654 @subsection reconstruct thread by hand
2656 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2657 (@code{wl-summary-save-current-message}) at the corresponding message,
2658 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2659 message then you have the reconstructed thread.
2662 @node Cache, Auto Refile, Thread Operations, Summary
2665 @subsection Cache File
2667 The messages which have to access via network (e.x. IMAP, NNTP folder)
2668 are cached as a local file. The cache file is saved under the directory
2669 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2670 elmo-cache-expire-by-size}. The command deletes cache files to the
2671 specified size by the order of last accessed time.
2673 @subsection Buffer Cache and Prefetching
2675 The messages that are read are kept in the cache buffer. It is called
2676 `buffer cache'. The number of cache buffer is specified by
2677 @code{wl-message-buffer-cache-size}.
2679 There are message prefetching mechanism in the Wanderlust that
2680 prefetches next message while you are reading.
2682 You can control the message prefetching mechanism by these two
2686 @item wl-message-buffer-prefetch-folder-type-list
2687 @vindex wl-message-buffer-prefetch-folder-type-list
2688 The initial setting is @code{t}. In this case, prefetch messages in all
2690 If it is a list of folder types, it specifies the folder types in which
2691 message prefetching is enabled.
2692 Following is an example (prefetch messages in nntp and imap4 folders)
2696 (setq wl-message-buffer-prefetch-folder-type-list
2701 In this case, multi folder that contains localdir and imap4 prefetches
2702 only imap4 messages. This variable precedes the value of
2703 @code{wl-message-buffer-prefetch-folder-list}.
2705 @item wl-message-buffer-prefetch-folder-list
2706 @vindex wl-message-buffer-prefetch-folder-list
2707 The initial setting is @code{nil}.
2708 A list of regexp of folders to enable message prefetching.
2710 @item wl-message-buffer-prefetch-depth
2711 @vindex wl-message-buffer-prefetch-depth
2712 The initial setting is 3. The number of messages for automatical prefetch.
2714 @item wl-message-buffer-prefetch-idle-time
2715 @vindex wl-message-buffer-prefetch-idle-time
2716 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2718 @item wl-message-buffer-prefetch-threshold
2719 @vindex wl-message-buffer-prefetch-threshold
2720 The initial setting is 30000 (bytes). If prefetching message has larger
2721 size than this value, Wanderlust does not prefetch automatically.
2722 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2723 the message is not checked for the size.
2727 @node Auto Refile, Sticky Summary, Cache, Summary
2728 @section Auto Refile
2729 @vindex elmo-msgdb-extra-fields
2730 @vindex wl-refile-rule-alist
2731 @findex wl-summary-auto-refile
2733 You can refile messages automatically, by typing @kbd{C-o}
2734 (@code{wl-summary-auto-refile}). It decides destination of refile by
2735 the content of the message header information (information in the msgdb).
2737 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2738 available. If you want to decide destination by other header fields,
2739 set the variable @code{elmo-msgdb-extra-fields} like following.
2743 (setq elmo-msgdb-extra-fields
2753 By this setting, Wanderlust saves extra fields in the msgdb. You have
2754 to type @kbd{s all} to get extra fields for the messages that are
2755 already exists in the summary.
2757 Then, specify the refile rule. The refile target folder of auto
2758 refiling is decided by the value of @code{wl-refile-rule-alist}.
2759 @code{wl-refile-rule-alist} is a list of a rule:
2763 (@var{field} (@var{regexp} . @var{target})
2764 (@var{regexp} . @var{target})
2769 Each rule means `if @var{field} value matches @var{regexp},
2770 then refile to @var{target} folder'.
2771 The rule matched first is applied.
2773 @var{field} is a string of field name. You can specify a list of field name
2774 string, too. In this case, if one of these fields is matched, then the
2775 rule is fired (i.e. OR condition).
2777 @var{regexp} is a regular expression for field value. @var{target} is a target
2778 folder string. You can specify a rule at @var{target} part, too. In this
2779 case, If the field value of the rule and the current rule is matched,
2780 then the current rule is fired (i.e. AND condition).
2782 In @var{target} part, you can refer matched substring of @var{regexp}.
2783 To refer substring, specify following in @var{target}:
2787 means substitute original matched text.
2790 means substitute what matched the @var{N}th `\(@dots{}\)'.
2791 (@var{N} is a number.)
2794 Following is an example of @code{wl-refile-rule-alist}.
2798 (setq wl-refile-rule-alist
2800 ("^Wanderlust" . "+wl")
2801 ("^Elisp" . "+elisp"))
2803 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2805 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2806 "+from-me-to-you"))))))
2810 After these settings, refile marks are automatically put on the condition
2811 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2813 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2815 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2816 with these persistent marks are not automatically refiled.
2817 It means Wanderlust does not execute auto refile on unread messages by
2818 the default setting.
2819 To execute auto refile on all messages, set following.
2822 (setq wl-summary-auto-refile-skip-marks nil)
2826 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2827 @section Sticky Summary
2828 @cindex Summary, Sticky
2829 @cindex Sticky Summary
2831 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2833 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2834 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2836 The buffer name of the sticky summary becomes like
2837 @samp{Summary:@var{folder-name}}.
2839 You can visit the sticky summary at any time by @kbd{C-x b}
2840 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2841 q}. Other operations in the sticky summary are same as normal summary.
2843 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2844 are automatically stuck.
2847 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2848 @section Key bindings
2849 @cindex Keybind, Summary Mode
2850 @cindex Keybind, Summary Buffer
2852 Key bindings of the summary mode are shown below.
2856 @kindex @key{SPC} (Summary)
2857 @findex wl-summary-read
2858 Proceed reading a message at the current cursor point.
2859 (@code{wl-summary-read})
2863 @findex wl-summary-redisplay
2864 Redisplay a message at the current cursor point.
2865 If this command is called with prefix argument,
2866 Redisplay message regardless of the message cache (message is re-loaded
2868 (@code{wl-summary-redisplay})
2872 @findex wl-summary-display-top
2873 Display the top message in the folder.
2874 (@code{wl-summary-display-top})
2878 @findex wl-summary-display-bottom
2879 Display the bottom message in the folder.
2880 (@code{wl-summary-display-bottom})
2884 @kindex @key{BS} (Summary)
2885 @kindex @key{DEL} (Summary)
2886 Display the previous page of the message at the current cursor point.
2887 @findex wl-summary-prev-page
2888 (@code{wl-summary-prev-page})
2891 @kindex @key{RET} (Summary)
2892 @findex wl-summary-next-line-content
2893 Display the next line of the message at the current cursor point.
2894 Display the message at the current cursor point if it is not displayed yet.
2895 (@code{wl-summary-next-line-content})
2900 @kindex M-@key{RET} (Summary)
2901 @findex wl-summary-prev-line-content
2902 Display the previous line of the message at the current cursor point.
2903 Display the message at the current cursor point if it is not displayed yet.
2904 (@code{wl-summary-prev-line-content})
2908 @findex wl-thread-open-close
2909 Toggle open or close the thread at the current cursor point.
2910 (@code{wl-thread-open-close})
2915 @findex wl-thread-open-all
2916 (@code{wl-thread-open-all})
2921 @findex wl-thread-close-all
2922 (@code{wl-thread-close-all})
2926 @findex wl-summary-goto-folder
2928 (@code{wl-summary-goto-folder})
2932 Mark all messages in the folder as read.
2933 @findex wl-summary-mark-as-read-all
2934 (@code{wl-summary-mark-as-read-all})
2938 @findex wl-summary-reply
2939 Prepare a draft for reply the message at the current cursor point.
2940 (@code{wl-summary-reply})
2944 @findex wl-summary-reply-with-citation
2945 Prepare a draft for reply the message at the current cursor point.
2946 (@code{wl-summary-reply-with-citation})
2950 @findex wl-summary-cancel-message
2951 If the message at current cursor point is your own netnews article,
2953 (@code{wl-summary-cancel-message})
2957 @findex wl-summary-reedit
2958 Prepare a draft for re-editing the message at current cursor point.
2959 If the message at current cursor point is your own netnews article,
2960 a draft for `supersedes message' for the message is prepared.
2961 (@code{wl-summary-reedit})
2964 @kindex M-e (Summary)
2965 @findex wl-summary-resend-bounced-mail
2966 If the message at current cursor point is a bounced message,
2967 a draft for re-sending original message is prepared.
2968 (@code{wl-summary-resend-bounced-mail})
2972 @findex wl-summary-forward
2973 A draft for forwarding the message at current cursor point is prepared.
2974 (@code{wl-summary-forward})
2978 @findex wl-summary-mark-as-important
2979 Put @samp{$} mark on the message at current cursor point.
2980 If already marked as @samp{$}, delete it.
2981 (@code{wl-summary-mark-as-important})
2987 Save the message at current cursor point.
2988 @findex wl-summary-save
2989 (@code{wl-summary-save})
2993 @findex wl-summary-next
2994 Move cursor to the next message.
2995 If message is marked with a temporal mark in
2996 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2997 In the offline mode, cursor is not moved to the messages which are not cached
2999 (@code{wl-summary-next})
3003 @findex wl-summary-prev
3004 Move cursor to the previous message.
3005 If message is marked with a temporal mark in
3006 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3007 In the offline mode, cursor is not moved to the messages which are not cached
3009 (@code{wl-summary-prev})
3013 @findex wl-summary-down
3014 Move cursor to the downward message which is unread or marked
3016 In the offline mode, cursor is not moved to the messages which are not cached
3018 If there are messages which have target mark @samp{*} in the summary,
3019 cursor is moved to the downward message which have a target mark.
3020 This behavior is changed according to the value of @code{wl-summary-move-order}.
3021 (@code{wl-summary-down})
3025 @findex wl-summary-up
3026 Move cursor to the upward message which is unread or marked
3028 In the offline mode, cursor is not moved to the messages which are not cached
3030 If there are messages which have target mark @samp{*} in the summary,
3031 cursor is moved to the downward message which have a target mark.
3032 This behavior is changed according to the value of @code{wl-summary-move-order}.
3033 (@code{wl-summary-up})
3037 @findex wl-summary-write
3038 Prepare a new draft.
3039 (@code{wl-summary-write})
3043 @findex wl-summary-write-current-folder
3044 Prepare a new draft. If the current folder is NNTP folder,
3045 @samp{Newsgroups:} field is completed. If the current folder is mailing
3046 list folder (refile destination), guess @samp{To:} field and completed
3047 (If @code{wl-subscribed-mailing-list} is valid list)
3048 (@code{wl-summary-write-current-folder})
3052 @findex wl-summary-redisplay-all-header
3053 Redisplay the message at current cursor point with all header fields.
3054 (@code{wl-summary-redisplay-all-header})
3058 @findex wl-summary-redisplay-no-mime
3059 Redisplay the message at current cursor point without MIME analysis.
3060 (@code{wl-summary-redisplay-no-mime})
3064 @findex wl-summary-burst
3065 If the message at current cursor point has
3066 encapsulates multiple messages using MIME,
3067 de-capsulate and extract them on the current folder.
3068 (@code{wl-summary-burst})
3071 @kindex @@ (Summary)
3072 @findex wl-summary-edit-addresses
3073 Append/change/delete the message's sender information to the address
3074 book @file{~/.addresses} interactively. If this command is called with
3075 prefix argument, arbitrary address can be edited.
3076 (@code{wl-summary-edit-petname})
3080 @findex wl-status-update
3081 Sync up address book status with @file{~/.addresses}'s content.
3082 (@code{wl-status-update})
3086 @findex wl-summary-pipe-message
3087 Pipe current message's content to the external process.
3088 (@code{wl-summary-pipe-message})
3092 @findex wl-summary-print-message
3093 Print out current message's content.
3094 It uses @code{ps-print} module in Emacs 20.x.
3095 If you don't use color printer, you might want to set
3096 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3099 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3102 (@code{wl-summary-print-message})
3106 @findex wl-summary-exit
3107 Exit current folder.
3108 (@code{wl-summary-exit})
3112 @findex wl-summary-jump-to-current-message
3113 Jump cursor to the currently displayed message's window.
3114 (@code{wl-summary-jump-to-current-message})
3118 Jump cursor to the other message.
3119 @findex wl-summary-jump-to-msg
3120 (@code{wl-summary-jump-to-msg})
3124 Update summary status and
3125 prefetch all messages which have marks included in the
3126 @code{wl-summary-incorporate-marks}.
3127 @findex wl-summary-incorporate
3128 (@code{wl-summary-incorporate})
3131 @kindex M-j (Summary)
3132 @findex wl-summary-jump-to-msg-by-message-id
3133 Jump cursor to the message which have specified @samp{Message-Id:}. If
3134 @code{elmo-use-database} is non-nil, other folder is also searched.
3135 (@code{wl-summary-jump-to-msg-by-message-id})
3139 Jump to parent message.
3140 @findex wl-summary-jump-to-parent-message
3141 (@code{wl-summary-jump-to-parent-message})
3145 @findex wl-summary-mark-as-unread
3146 Mark as unread the message at current cursor point.
3147 (@code{wl-summary-mark-as-unread})
3151 @findex wl-summary-sync
3152 Synchronize summary view after prompting the update range
3153 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3157 all ...Discard current summary and update all message.
3158 all-visible ...Discard current summary and update all visible message.
3159 update ...Update the difference between summary and the folder itself.
3160 rescan ...Rescan the msgdb and display again.
3161 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3162 cache-status ...Sync the all marks with the real status of cache.
3163 first, last ...Move to the filter folder(partial filter).
3168 (@code{wl-summary-sync})
3172 @findex wl-summary-sort
3174 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3175 (@code{wl-summary-sort})
3179 @findex wl-summary-toggle-thread
3180 Toggle the threading.
3181 Threading status is displayed on the modeline.
3182 @samp{@{S@}} means threading is off (Sequence) and
3183 @samp{@{T@}} means threading is on (Thread).
3184 (@code{wl-summary-toggle-thread})
3188 @findex wl-summary-toggle-disp-folder
3189 Toggle displaying of folder window.
3190 (@code{wl-summary-toggle-disp-folder})
3194 Toggle displaying of message window.
3195 @findex wl-summary-toggle-disp-msg
3196 (@code{wl-summary-toggle-disp-msg})
3200 Move to the virtual folder with the condition specified.
3201 If called with prefix argument and current folder is virtual, exit it.
3202 @findex wl-summary-virtual
3203 (@code{wl-summary-virtual})
3206 @kindex @key{TAB} (Summary)
3207 @findex wl-summary-goto-last-displayed-msg
3208 Jump to the message which is displayed last.
3209 (@code{wl-summary-goto-last-displayed-msg})
3213 Put @samp{*} mark on the messages that satisfies the specified condition.
3214 @findex wl-summary-pick
3215 (@code{wl-summary-pick})
3219 @findex wl-summary-mark-as-read
3220 Mark as read the message at the current cursor point.
3221 (@code{wl-summary-mark-as-read})
3225 Prefetch the message at the current cursor point.
3226 With prefix argument, prefetch the message even if it is cached.
3227 @findex wl-summary-prefetch
3228 (@code{wl-summary-prefetch})
3232 Execute @samp{D}, @samp{o} and @samp{O} marks.
3233 @findex wl-summary-exec
3234 (@code{wl-summary-exec})
3238 @findex wl-summary-target-mark-line
3239 Put target mark on the message at the current cursor point.
3240 (@code{wl-summary-target-mark-line})
3244 Put refile mark on the message at the current cursor point.
3245 @findex wl-summary-refile
3246 (@code{wl-summary-refile})
3249 @kindex C-o (Summary)
3250 Execute auto refile.
3251 @findex wl-summary-auto-refile
3252 (@code{wl-summary-auto-refile})
3256 Put copy mark on the message at the current cursor point.
3257 @findex wl-summary-copy
3258 (@code{wl-summary-copy})
3261 @kindex M-o (Summary)
3262 Put refile mark on the message at the current cursor point with the destination
3263 previously specified.
3264 @findex wl-summary-refile-prev-destination
3265 (@code{wl-summary-refile-prev-destination})
3269 @findex wl-summary-delete
3270 Put delete mark on the message at the current cursor point.
3271 (@code{wl-summary-delete})
3275 @findex wl-summary-unmark
3276 Unmark the temporal mark on the message at the current cursor point.
3277 (@code{wl-summary-unmark})
3281 Unmark all the temporal marks.
3282 @findex wl-summary-unmark-all
3283 (@code{wl-summary-unmark-all})
3286 @kindex r R (Summary)
3287 @findex wl-summary-mark-as-read-region
3288 Mark as read messages in the specified region.
3289 (@code{wl-summary-mark-as-read-region})
3292 @kindex r $ (Summary)
3293 @findex wl-summary-mark-as-important-region
3294 Mark as important @samp{$} messages in the specified region.
3295 If @samp{$} already exists, it is deleted.
3296 (@code{wl-summary-mark-as-important-region})
3299 @kindex r ! (Summary)
3300 @findex wl-summary-mark-as-unread-region
3301 Mark as unread messages in the specified region.
3302 (@code{wl-summary-mark-as-unread-region})
3305 @kindex r i (Summary)
3306 @findex wl-summary-prefetch-region
3307 Prefetch messages in the specified region.
3308 (@code{wl-summary-prefetch-region})
3311 @kindex r x (Summary)
3312 @findex wl-summary-exec-region
3313 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3315 (@code{wl-summary-exec-region})
3318 @kindex r * (Summary)
3319 @findex wl-summary-target-mark-region
3320 Put target mark on the messages in the specified region.
3321 (@code{wl-summary-target-mark-region})
3324 @kindex r o (Summary)
3325 @findex wl-summary-refile-region
3326 Put refile mark on the messages in the specified region.
3327 (@code{wl-summary-refile-region})
3330 @kindex r O (Summary)
3331 @findex wl-summary-copy-region
3332 Put copy mark on the messages in the specified region.
3333 (@code{wl-summary-copy-region})
3336 @kindex r d (Summary)
3337 @findex wl-summary-delete-region
3338 Put delete mark on the messages in the specified region.
3339 (@code{wl-summary-delete-region})
3342 @kindex r u (Summary)
3343 @findex wl-summary-unmark-region
3344 Delete temporal mark on the messages in the specified region.
3345 (@code{wl-summary-unmark-region})
3348 @kindex r y (Summary)
3349 Save messages in the specified region.
3350 @findex wl-summary-save-region
3351 (@code{wl-summary-save-region})
3354 @kindex t R (Summary)
3355 @findex wl-thread-mark-as-read
3356 Mark as read messages which are the descendant of the current thread.
3357 With prefix argument, it affects on the all messages in the thread tree.
3358 (@code{wl-thread-mark-as-read})
3361 @kindex t $ (Summary)
3362 @findex wl-thread-mark-as-important
3363 Put important mark @samp{$} on the messages which are the
3364 descendant of the current thread.
3365 If @samp{$} mark exists, it is deleted.
3366 With prefix argument, it affects on the all messages in the thread tree.
3367 (@code{wl-thread-mark-as-important})
3370 @kindex t ! (Summary)
3371 @findex wl-thread-mark-as-unread
3372 Mark as unread messages which are the descendant of the current thread.
3373 With prefix argument, it affects on the all messages in the thread tree.
3374 (@code{wl-thread-mark-as-unread})
3377 @kindex t i (Summary)
3378 @findex wl-thread-prefetch
3379 Prefetch messages which are the descendant of the current thread.
3380 With prefix argument, it affects on the all messages in the thread tree.
3381 (@code{wl-thread-prefetch})
3384 @kindex t x (Summary)
3385 @findex wl-thread-exec
3386 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3387 the descendant of the current thread. With prefix argument, it affects
3388 on the all messages in the thread tree.
3389 (@code{wl-thread-exec})
3392 @kindex t * (Summary)
3393 @findex wl-thread-target-mark
3394 Put target mark @samp{*} on the messages which are the descendant of the
3395 current thread. With prefix argument, it affects on the all messages in
3397 (@code{wl-thread-target-mark})
3400 @kindex t o (Summary)
3401 @findex wl-thread-refile
3402 Put refile mark on the messages which are the descendant of the current thread.
3403 With prefix argument, it affects on the all messages in the thread tree.
3404 (@code{wl-thread-refile})
3407 @kindex t O (Summary)
3408 @findex wl-thread-copy
3409 Put copy mark on the messages which are the descendant of the current thread.
3410 With prefix argument, it affects on the all messages in the thread tree.
3411 (@code{wl-thread-copy})
3414 @kindex t d (Summary)
3415 @findex wl-thread-delete
3416 Put delete mar on the messages which are the descendant of the current thread.
3417 With prefix argument, it affects on the all messages in the thread tree.
3418 (@code{wl-thread-delete})
3421 @kindex t u (Summary)
3422 @findex wl-thread-unmark
3423 Unmark temporal mark on the messages which are the descendant of the
3424 current thread. With prefix argument, it affects on the all messages in
3426 (@code{wl-thread-unmark})
3429 @kindex t y (Summary)
3430 @findex wl-thread-save
3431 Save messages which are the descendant of the current thread.
3432 With prefix argument, it affects on the all messages in the thread tree.
3433 (@code{wl-thread-save})
3436 @kindex m i (Summary)
3437 @findex wl-summary-target-mark-prefetch
3438 Prefetch all messages which have target mark @samp{*}.
3439 With prefix argument, prefetch all targets even if some of them are cached.
3440 (@code{wl-summary-target-mark-prefetch})
3443 @kindex m R (Summary)
3444 @findex wl-summary-target-mark-mark-as-read
3445 Mark as read all messages which have target mark @samp{*}.
3446 (@code{wl-summary-target-mark-mark-as-read})
3449 @kindex m $ (Summary)
3450 @findex wl-summary-target-mark-mark-as-important
3451 Mark as important all messages which have target mark @samp{*}.
3452 If already marked as @samp{$}, it is deleted.
3453 (@code{wl-summary-target-mark-mark-as-important})
3456 @kindex m ! (Summary)
3457 @findex wl-summary-target-mark-mark-as-unread
3458 Mark as unread all messages which have target mark @samp{*}.
3459 (@code{wl-summary-target-mark-mark-as-unread})
3462 @kindex m o (Summary)
3463 @findex wl-summary-target-mark-refile
3464 Put refile mark on the messages which have target mark @samp{*}.
3465 (@code{wl-summary-target-mark-refile})
3468 @kindex m O (Summary)
3469 @findex wl-summary-target-mark-copy
3470 Put copy mark on the messages which have target mark @samp{*}.
3471 (@code{wl-summary-target-mark-copy})
3474 @kindex m d (Summary)
3475 @findex wl-summary-target-mark-delete
3476 Put delete mark on the messages which have target mark @samp{*}.
3477 (@code{wl-summary-target-mark-delete})
3480 @kindex m y (Summary)
3481 @findex wl-summary-target-mark-save
3482 Save messages which have target mark @samp{*}.
3483 (@code{wl-summary-target-mark-save})
3486 @kindex m u (Summary)
3487 Unmark all temporal marks.
3488 (@code{wl-summary-delete-all-temp-marks})
3489 @findex wl-summary-delete-all-temp-marks
3492 @kindex m a (Summary)
3493 Put target mark @samp{*} on the all messages.
3494 (@code{wl-summary-target-mark-all})
3495 @findex wl-summary-target-mark-all
3498 @kindex m t (Summary)
3499 Put target mark @samp{*} on the messages in the current thread.
3500 @findex wl-summary-target-mark-thread
3501 (@code{wl-summary-target-mark-thread})
3504 @kindex m r (Summary)
3505 @findex wl-summary-target-mark-region
3506 Put target mark @samp{*} on the messages in the specified region.
3507 (@code{wl-summary-target-mark-region})
3510 @kindex m A (Summary)
3511 @findex wl-summary-target-mark-reply-with-citation
3512 Prepare a draft which cites all messages which have target mark @samp{*}.
3513 (@code{wl-summary-target-mark-reply-with-citation})
3516 @kindex m f (Summary)
3517 @findex wl-summary-target-mark-forward
3518 Prepare a draft which forwards all messages which have target mark @samp{*}.
3519 (@code{wl-summary-target-mark-forward})
3522 @kindex m U (Summary)
3523 @findex wl-summary-target-mark-uudecode
3524 Uudecode the messages which have target mark @samp{*}.
3525 (@code{wl-summary-target-mark-uudecode})
3528 @kindex m ? (Summary)
3529 @findex wl-summary-target-mark-pick
3530 Pick messages from the @samp{*} marked messages.
3531 That is, @samp{*} marks on the messages are remained
3532 if the specified condition is satisfied.
3533 (@code{wl-summary-target-mark-pick})
3536 @kindex M-t (Summary)
3537 @findex wl-toggle-plugged
3538 Toggle offline/online status of Wanderlust.
3539 (@code{wl-toggle-plugged})
3542 @kindex C-t (Summary)
3543 Start Wanderlust's plug-status manager.
3544 (@code{wl-plugged-change})
3547 @kindex C-c C-o (Summary)
3548 @findex wl-jump-to-draft-buffer
3549 Move to the draft buffer if available. If multiple draft buffer exists,
3550 moved to one after another. If prefix argument is specified, load draft
3551 folder's message to the draft buffer and jump to it.
3552 (@code{wl-jump-to-draft-buffer})
3555 @kindex M-w (Summary)
3556 @findex wl-summary-save-current-message
3557 Save the message at the current cursor point.
3558 (@code{wl-summary-save-current-message})
3561 @kindex C-y (Summary)
3562 @findex wl-summary-yank-saved-message
3563 Regard the message at the current cursor point as
3564 parent, connect the message saved by
3565 @code{wl-summary-save-current-message}
3567 (@code{wl-summary-yank-saved-message})
3571 @node Variables of Summary, , Key Bindings of Summary, Summary
3572 @section Customiziable variables
3575 @item wl-summary-move-order
3576 @vindex wl-summary-move-order
3577 The initial setting is @code{unread}. Specify cursor moving policy. If
3578 you want to precede new messages, set @code{new}. If you want to
3579 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3582 @item wl-auto-select-first
3583 @vindex wl-auto-select-first
3584 The initial setting is @code{nil}.
3585 If non-nil, first message is automatically displayed.
3587 @item wl-auto-select-next
3588 @vindex wl-auto-select-next
3589 The initial setting is @code{nil}. This controls behavior when there is
3590 no unread message in current summary.
3593 nil: asks whether you want to go back to folder mode
3594 'unread: asks whether you want to go to next unread folder
3595 If the next one comes to be possessing no unread message
3596 by treatment of cross-posted messages or Scoring, then
3597 asks whether you want to go to next to next folder.
3598 'skip-no-unread: similar as unread
3599 But does not ask before going to next to next folder.
3600 otherwise: asks whether you want to go to next unread folder
3603 It might be useful to set @code{'skip-no-unread} for people who
3604 want to continue reading by just pressing and pressing space key.
3606 @item wl-thread-insert-opened
3607 @vindex wl-thread-insert-opened
3608 The initial setting is @code{nil}.
3609 If non-nil, thread is inserted as opened.
3611 @item wl-thread-open-reading-thread
3612 @vindex wl-thread-open-reading-thread
3613 The initial setting is @code{t}. If non-nil, reading thread is
3614 automatically opened though it is closed thread.
3616 @item wl-summary-exit-next-move
3617 @vindex wl-summary-exit-next-move
3618 The initial setting is @code{t}. If non-nil, move to next folder at
3621 @item wl-folder-move-cur-folder
3622 @vindex wl-folder-move-cur-folder
3623 The initial setting is @code{nil}. If non-nil, cursor position on the
3626 @item wl-summary-weekday-name-lang
3627 @vindex wl-summary-weekday-name-lang
3628 The initial setting is @samp{ja}. Specify language of the weekday.
3629 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3630 displays Deutsch. You should rescan summary view after changing this value.
3632 @item wl-summary-fix-timezone
3633 @vindex wl-summary-fix-timezone
3634 The initial setting is @code{nil}.
3635 Time zone of the date string in summary mode is adjusted using this value.
3636 If @code{nil}, it is adjust to the default time zone information
3637 (system's default time zone or environment variable @samp{TZ}).
3639 @item wl-use-petname
3640 @vindex wl-use-petname
3641 The initial setting is @code{t}.
3642 If non-nil, sender part displays nickname.
3644 @item wl-break-pages
3645 @vindex wl-break-pages
3646 The initial setting is @code{t}.
3647 If non-nil, message is split as pages by @samp{^L}.
3649 @item wl-message-window-size
3650 @vindex wl-message-window-size
3651 The initial setting is '(1 . 4).
3652 A cons cell to specify the rate of summary and message window.
3653 car:cdr corresponds summary:message.
3655 @item wl-summary-no-from-message
3656 @vindex wl-summary-no-from-message
3657 The initial setting is @samp{nobody@@nowhere?}. A string which is
3658 displayed when there's no @samp{From:} field in the message.
3660 @item wl-summary-no-subject-message
3661 @vindex wl-summary-no-subject-message
3662 The initial setting is @samp{(WL:No Subject in original.)}. A string
3663 which is displayed when there's no @samp{Subject:} field in the message.
3665 @item wl-summary-use-frame
3666 @vindex wl-summary-use-frame
3667 The initial setting is @code{nil}.
3668 If non-nil, use new frame for the summary.
3670 @item wl-use-folder-petname
3671 @vindex wl-use-folder-petname
3672 The initial setting is the list shown below:
3681 A list of display policy (symbol) of folder nickname. Available symbols
3686 Display folder petname on modeline.
3688 Destination folder is notified as nickname if
3689 @code{wl-auto-select-next} is non-nil.
3691 You can input folder name by nickname in the function
3692 @code{wl-summary-read-folder}.
3695 @item wl-summary-move-direction-toggle
3696 @vindex wl-summary-move-direction-toggle
3697 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3698 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3699 want to aware of reading direction, set this to @code{t}.
3701 @item wl-summary-width
3702 @vindex wl-summary-width
3703 The initial setting is 80.
3704 Width of summary line. If @code{nil}, summary line's width is as is.
3706 @item wl-summary-from-width
3707 @vindex wl-summary-from-width
3708 The initial setting is 17.
3709 Width of sender part of summary line.
3711 @item wl-summary-subject-length-limit
3712 @vindex wl-summary-subject-length-limit
3713 The initial setting is @code{nil}. Specify the limit for the length of
3714 subject parts in summary. @code{nil} means unlimited.
3716 @item wl-summary-indent-length-limit
3717 @vindex wl-summary-indent-length-limit
3718 The initial setting is 46.
3719 Specify the limit of thread indent level. @code{nil} means unlimited
3721 If you set this to @code{nil} you should set @code{wl-summary-width}
3724 @item wl-summary-recenter
3725 @vindex wl-summary-recenter
3726 The initial setting is t.
3727 If non-nil, cursor point is moved to the center of the summary window.
3729 @item wl-summary-divide-thread-when-subject-changed
3730 @vindex wl-summary-divide-thread-when-subject-changed
3731 The initial setting is @code{nil}. If non-nil, thread is split if
3732 the subject is changed.
3734 @item wl-summary-search-via-nntp
3735 @vindex wl-summary-search-via-nntp
3736 The initial setting is @code{confirm}.
3738 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3739 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3740 from the NNTP server @code{elmo-nntp-default-server}. The value of
3741 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3742 @code{elmo-nntp-default-stream-type} are used.
3744 If @code{confirm}, server name can be specified. You can specify NNTP
3745 folder format like @samp{-:username@@servername:119!}.
3747 @item wl-summary-keep-cursor-command
3748 @vindex wl-summary-keep-cursor-command
3749 The initial setting is the list shown below:
3753 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3758 When you entered to summary by these commands and the target summary
3759 buffer already exists, summary status is not automatically updated and
3760 cursor position is saved.
3762 @item elmo-folder-update-threshold
3763 @vindex elmo-folder-update-threshold
3764 The initial setting is 500. If updated message number is larger than
3765 this value, confirm whether drop them or not (in the case where the value
3766 of @code{elmo-folder-update-confirm} is non-nil).
3768 @item elmo-folder-update-confirm
3769 @vindex elmo-folder-update-confirm
3770 The initial setting is @code{t}. If the value is non-nil, do check with
3771 @code{elmo-folder-update-threshold}.
3773 @item wl-summary-always-sticky-folder-list
3774 @vindex wl-summary-always-sticky-folder-list
3775 The initial setting is @code{nil}.
3776 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3777 are automatically stuck. Each element is regexp of folder name.
3779 @item wl-summary-reserve-mark-list
3780 @vindex wl-summary-reserve-mark-list
3781 The initial setting is the list shown below:
3790 If a message is already marked as temporal marks in this list, the
3791 message is not marked by any mark command.
3793 @item wl-summary-skip-mark-list
3794 @vindex wl-summary-skip-mark-list
3795 The initial setting is the list shown below:
3804 If a message is already marked as temporal marks in this list, the
3805 message is skipped at cursor move.
3807 @item elmo-message-fetch-threshold
3808 @vindex elmo-message-fetch-threshold
3809 The initial setting is 30000 (bytes). If displaying message has larger
3810 size than this value, Wanderlust confirms whether fetch the message or
3811 not (in the case where the value of @code{elmo-message-fetch-confirm}
3814 @item elmo-message-fetch-confirm
3815 @vindex elmo-message-fetch-confirm
3816 The initial setting is @code{t}. If the value is non-nil, do check with
3817 @code{elmo-message-fetch-threshold}.
3819 @item wl-prefetch-threshold
3820 @vindex wl-prefetch-threshold
3821 The initial setting is 30000 (bytes). If prefetching message has larger
3822 size than this value and @code{wl-prefetch-confirm} is non-nil,
3823 Wanderlust confirms whether prefetch the message or not. If
3824 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3825 without confirmation.
3827 @item wl-prefetch-confirm
3828 @vindex wl-prefetch-confirm
3829 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3830 prefetch the message or not if the message has larger size than
3831 @code{wl-prefetch-threshold}.
3833 @item elmo-imap4-use-cache
3834 @vindex elmo-imap4-use-cache
3835 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3838 @item elmo-nntp-use-cache
3839 @vindex elmo-nntp-use-cache
3840 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3843 @item elmo-pop3-use-cache
3844 @vindex elmo-pop3-use-cache
3845 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3848 @item elmo-shimbun-use-cache
3849 @vindex elmo-shimbun-use-cache
3850 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3853 @item wl-folder-process-duplicates-alist
3854 @vindex wl-folder-process-duplicates-alist
3855 The initial setting is @code{nil}.
3856 This list determines how to deal with duplicated messages in the same folder.
3857 Each item in the list is regexp of folder name and action; you can specify any
3858 one of the following in the place of action:
3861 @code{nil} : do nothing for duplicated messages.
3862 @code{hide} : hide duplicated messages from the summary.
3863 @code{read} : set duplicated messages as read.
3867 Following is an example (hide duplicated messages in multi folders)
3871 (setq wl-folder-process-duplicates-alist
3872 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3873 ("^\\*.*" . hide) (".*" . read)))
3879 @node Message, Draft, Summary, Top
3880 @chapter Message Buffer
3882 Message Buffers utilize MIME-View mode of SEMI. For operational
3883 procedures and key bindings, refer to respective documents.
3884 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3885 You can also see help by @kbd{?} in message buffer.
3887 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3888 brings you back to Summary mode. @kbd{l} toggles display of Summary
3891 @section Key Bindings
3897 @findex wl-message-toggle-disp-summary
3898 Toggles display of Summary mode buffer.
3899 (@code{wl-message-toggle-disp-summary})
3902 @findex wl-message-refer-article-or-url
3903 @kindex Button-2 (Message)
3904 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3905 corresponding message if found.
3906 (@code{wl-message-refer-article-or-url})
3908 @item Button-4 (upward movement of a wheel)
3909 @kindex Button-4 (Message)
3910 @findex wl-message-wheel-down
3911 Scrolls the message backwards. When the top of the message is hit,
3912 moves to the previous message.
3913 (@code{wl-message-wheel-down})
3915 @item Button-5 (downward movement of a wheel)
3916 @kindex Button-5 (Message)
3917 @findex wl-message-wheel-up
3918 Scrolls the message forward. When the bottom of the message is hit,
3919 moves to the next message.
3920 (@code{wl-message-wheel-up})
3923 @section Customizable Variables
3926 @item wl-message-window-size
3927 @vindex wl-message-window-size
3928 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3929 its car and cdr value corresponds to the ratio of Summary and Message
3932 @item wl-message-ignored-field-list
3933 @vindex wl-message-ignored-field-list
3934 (SEMI only) Initial setting is @code{nil}.
3935 All fields that match this list will be hidden in message buffer.
3936 Each elements are regexp of field-name.
3937 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3939 @item wl-message-visible-field-list
3940 @vindex wl-message-visible-field-list
3941 (SEMI only) Initial setting is @code{nil}.
3942 All fields that match this list will be display in message buffer.
3943 Each elements are regexp of field-name. This value precedes
3944 @code{wl-message-ignored-field-list}.
3945 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3947 @item wl-message-sort-field-list
3948 @vindex wl-message-sort-field-list
3949 (SEMI only) Initial setting is
3950 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3951 Header fields in message buffer are ordered by this value.
3952 Each elements are regexp of field-name.
3954 @item wl-message-truncate-lines
3955 @vindex wl-message-truncate-lines
3956 The initial value is the value of @code{default-truncate-lines}.
3957 If it is non-nil, truncate long lines in message buffer.
3960 @node Draft, Disconnected Operations, Message, Top
3961 @chapter Draft Buffer
3963 At Summary mode, pressing @kbd{w} and the like creates a new draft
3964 buffer. You can edit and send mail and news articles in this buffer.
3968 Basically it is Emacs-standard mail mode.
3970 @subsection Address Completion
3972 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3973 addresses. @kbd{@key{TAB}} completes them.
3975 If you want to submit a news article, add @samp{Newsgroups:} field by
3976 yourself. Field names can be completed by @kbd{@key{TAB}}.
3978 If you save the draft buffer you are editing, it is appended to the
3979 folder specified by @code{wl-draft-folder}.
3981 Using @samp{FCC:} field, you can specify the folder to which a copy of
3982 the message is saved when it is sent.
3984 @subsection Editing Messages
3986 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
3987 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
3988 a MIME user interface for GNU Emacs}.
3989 You can also see help by @kbd{C-c C-x ?} in draft buffer.
3991 @subsection Dynamic Modification of Messages
3992 @vindex wl-draft-config-alist
3993 @c @cindex Change Message
3994 @c @cindex Message, Change Dynamic
3996 You can set @code{wl-draft-config-alist} so that header and body of the
3997 message will automatically modified depending on information of header
4000 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4002 In the example below, the header is modified when
4003 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4004 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4005 before sending the message.
4009 (setq wl-draft-config-alist
4010 '(((string-match "aaa\\.example\\.com$" (system-name))
4011 ;; @r{applied if the expression is non-nil}
4012 (wl-smtp-posting-server . "mailserver-B")
4013 (wl-nntp-posting-server . "newsserver-B")
4014 ;; @r{settings of temporary variables}
4016 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4017 ;; @r{applied if it matches the header of the draft buffer}
4018 ("Organization" . (format "Go %s" my-webpage)))
4019 ;; @r{you can write elisp expressions here (eval only)}
4020 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4021 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4026 The format of @code{wl-draft-config-alist} is:
4030 '(("@var{regexp of the header}" or @var{elisp expression}
4031 ("@var{Field}" . value(@var{elisp expression}))
4032 (@var{variable} . value(@var{elisp expression}))
4033 (@var{sub-function} . value(@var{elisp expression}))
4036 ("@var{regexp of the header}" or @var{elisp expression}
4037 ("@var{Field}" . value(@var{elisp expression}))
4042 Per default, there are 10 following sub-functions.
4045 'header: Inserts the specified string at the bottom of the header.
4046 'header-top: Inserts the specified string at the top of the header.
4047 'header-file: Inserts the specified file at the bottom of the header.
4048 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4049 'top: Inserts the specified string at the top of the body.
4050 'top-file: Inserts the specified file at the top of the body.
4051 'body: Replaces the body with the specified string.
4052 Specifying @code{nil} deletes the entire body string.
4053 'body-file: Replaces the body with the content of the specified file.
4054 'bottom: Inserts the specified string at the bottom of the body.
4055 'bottom-file: Inserts the specified file at the top of the body.
4056 'part-top: Inserts the specified string at the top of the current part.
4057 'part-bottom: Inserts the specified string at the bottom of the current part.
4058 'template: Applies the specified template.
4059 (refer to the next subsection)
4062 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4063 change them or add your own functions. If you read the code, you can
4064 easily find how to write the functions.
4066 At the first of each item, @var{a regular expression of the header} or
4067 an @var{elisp expression} should be specified. In the case of an elisp
4068 expression, the item is applied when the expression is evaluated
4071 Per default, when multiple items match or are evaluated non-nil, all
4072 such items are applied, but if you set a variable
4073 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4076 At the second of the item, a cons or a list of functions should be
4077 specified. The car part of the cons should be a header field, a
4078 variable, or a sub-function. When a header field is specified, the
4079 field will be modified. If a variable is specified, the value of the
4080 variable will be modified temporarily.
4082 In the cdr part of a cons, not only a variable but also an elisp
4083 expression can be specified as is. If the car part is a header field
4084 and the cdr part is @code{nil}, the field will be deleted.
4086 If you want to use name of parent folder, you can refer the buffer local
4087 variable @code{wl-draft-parent-folder}.
4089 See the next example as well:
4093 (setq wl-draft-config-alist
4095 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4096 ;; @r{applied if it matches the header of the buffer being replied}
4097 (body . " Hello.\n")
4098 (template . "default")
4103 As in the (1) above, if a header regexp is prepended with @code{reply},
4104 it is applied when the draft is prepared by @code{wl-summary-reply} for
4105 example, and when it matches the header being replied. It is ignored
4106 when there is no buffer being replied, like after @code{wl-draft} was
4109 Note that @code{wl-draft-config-alist} is applied only once when
4110 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4111 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4112 aborting transmission, execute @kbd{C-c C-e}
4113 (@code{wl-draft-config-exec}) explicitly.
4115 If you don't want to apply @code{wl-draft-config-alist} when
4116 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4120 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4123 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4124 prepared, do the following:
4127 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4130 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4131 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4135 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4138 @subsection Inserting Templates
4140 @cindex Apply Template
4142 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4143 @kbd{M-x wl-template-select} in the draft buffer.
4145 The format of @code{wl-template-alist} is almost the same as
4146 @code{wl-draft-config-alist}.
4150 (setq wl-template-alist
4153 ("Organization" . "Example Co.Ltd.")
4154 (body . "Hello.\n"))
4156 (template . "default") ;; @r{(a)}
4157 ("To" . "boss@@example.com")
4158 ("Subject" . "Report")
4159 (body-file . "~/work/report.txt")
4165 As you can see, the only difference is item (template) names such as
4166 @samp{default} and @samp{report}, instead of a regexp of header.
4167 Because definition of each item is the same as
4168 @code{wl-draft-config-alist}, you can call another template, like (a).
4170 Executing the command @code{wl-template-select} results in template
4171 selection, but the result differs depending on variable
4172 @code{wl-template-visible-select}.
4174 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4175 window is shown below the draft buffer. You can select a template by
4176 @kbd{n} and @kbd{p} seeing the buffer window.
4178 Press the @key{RET} key and the template is actually applied to the draft
4179 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4180 adjust the window size by @code{wl-template-buffer-lines}.
4182 If @code{wl-template-visible-select} is @code{nil}, you should type the
4183 name of the template in the mini buffer.
4185 As shown in the example in @code{wl-draft-config-alist}, you can select
4186 @samp{default} template by writing:
4189 (template . "default")
4192 @subsection Sending mail by POP-before-SMTP
4193 @cindex POP-before-SMTP
4195 You can send mail by POP-before-SMTP with this single line:
4198 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4202 Configure the following variables if you need.
4205 @item wl-pop-before-smtp-user
4206 The POP user name for POP-before-SMTP authentication.
4207 If unset, @code{elmo-pop3-default-user} is used.
4209 @item wl-pop-before-smtp-server
4210 The POP server name for POP-before-SMTP authentication.
4211 If unset, @code{elmo-pop3-default-server} is used.
4213 @item wl-pop-before-smtp-authenticate-type
4214 The POP authentication method for POP-before-SMTP authentication.
4215 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4217 @item wl-pop-before-smtp-port
4218 The POP port number for POP-before-SMTP authentication.
4219 If unset, @code{elmo-pop3-default-port} is used.
4221 @item wl-pop-before-smtp-stream-type
4222 If non-nil, POP connection is established using SSL. If
4223 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4224 unset, @code{elmo-pop3-default-stream-type} is used.
4227 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4228 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4230 Therefore, if SMTP server and POP server are actually the same, and if
4231 POP folder per default (such as @samp{&}) is available, no settings are
4234 Refer to the following URL about POP-before-SMTP.
4238 http://spam.ayamura.org/tools/smPbS.html
4239 http://www.iecc.com/pop-before-smtp.html
4243 @section Key Bindings
4244 @cindex Keybind, Draft Mode
4245 @cindex Keybind, Draft Buffer
4250 @kindex C-c C-y (Draft)
4251 @findex wl-draft-yank-original
4252 Cites the content of the current message buffer.
4253 (@code{wl-draft-yank-original})
4256 @kindex C-c C-p (Draft)
4257 @findex wl-draft-preview-message
4258 Previews the content of the current draft.
4259 This is useful for previewing MIME multi-part messages.
4260 (@code{wl-draft-preview-message})
4263 @kindex C-c C-s (Draft)
4264 @findex wl-draft-send
4265 Sends the content of the current draft. Does not erase the draft buffer.
4266 This is useful for sending multiple messages, which are a little different
4268 (@code{wl-draft-send})
4271 @kindex C-c C-c (Draft)
4272 @findex wl-draft-send-and-exit
4273 Sends the content of the current draft and erases the draft buffer.
4274 (@code{wl-draft-send-and-exit})
4277 @kindex C-x C-s (Draft)
4278 @findex wl-draft-save
4279 Save the current draft.
4280 (@code{wl-draft-save})
4283 @kindex C-c C-k (Draft)
4284 @findex wl-draft-kill
4285 Kills the current draft.
4286 (@code{wl-draft-kill})
4289 @kindex C-x k (Draft)
4290 @findex wl-draft-mimic-kill-buffer
4291 Kills the current draft.
4292 (@code{wl-draft-mimic-kill-buffer})
4295 @kindex C-c C-z (Draft)
4296 @findex wl-draft-save-and-exit
4297 Saves the current draft, and erases the draft buffer.
4298 This is useful if you want to suspend editing of the draft.
4299 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4300 the @samp{+draft} folder.
4301 (@code{wl-draft-save-and-exit})
4304 @kindex C-c C-r (Draft)
4305 @findex wl-caesar-region
4306 Encodes or decodes the specified region in Caesar cipher.
4307 (@code{wl-caesar-region})
4311 @findex wl-draft-highlight-and-recenter
4312 Recenter and rehighlight current draft.
4313 (@code{wl-draft-highlight-and-recenter})
4317 @findex wl-toggle-plugged
4318 Toggles off-line/on-line states of Wanderlust.
4319 (@code{wl-toggle-plugged})
4322 @kindex C-c C-o (Draft)
4323 @findex wl-jump-to-draft-buffer
4324 Jumps to the other draft buffer, if exists.
4325 With prefix argument, reads a file (if any) from the draft folder when
4326 there is no such buffer.
4327 (@code{wl-jump-to-draft-buffer})
4330 @kindex C-c C-e (Draft)
4331 @findex wl-draft-config-exec
4332 Applies @code{wl-draft-config-alist}.
4333 (@code{wl-draft-config-exec})
4336 @kindex C-c C-j (Draft)
4337 @findex wl-template-select
4339 (@code{wl-template-select})
4342 @kindex C-c C-a (Draft)
4344 Enter Address Manager.
4345 @xref{Address Manager}.
4349 @kindex C-c C-d (Draft)
4350 @findex wl-draft-elide-region
4351 Elide the text between point and mark (@code{wl-draft-elide-region}).
4352 The text is killed and replaced with the contents of the variable
4353 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4357 @section Customizable Variables
4360 @item wl-subscribed-mailing-list
4361 @vindex wl-subscribed-mailing-list
4362 The initial setting is @code{nil}. Mailing lists to which you
4363 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4364 field of a reply draft, removes your own address from
4365 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4366 contained in @samp{To:} or @samp{Cc:} field of a message to be
4367 automatically re-filed, the destination folder will be leaned in
4368 connection with the address.
4374 (setq wl-subscribed-mailing-list
4375 '("wl@@lists.airs.net"
4377 "emacs-mime-ja@@m17n.org"))
4381 @item wl-insert-mail-followup-to
4382 @vindex wl-insert-mail-followup-to
4383 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4384 field is automatically inserted in the draft buffer.
4386 @item wl-insert-mail-reply-to
4387 @vindex wl-insert-mail-reply-to
4388 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4389 field is automatically inserted in the draft buffer.
4391 @item wl-auto-insert-x-face
4392 @vindex wl-auto-insert-x-face
4393 The initial setting is @code{t}. If non-nil and there is an encoded
4394 X-Face string in a file @file{~/.xface} (the value of the variable
4395 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4396 draft buffer. If @code{nil}, it is not automatically inserted.
4398 @item wl-insert-message-id
4399 @vindex wl-insert-message-id
4400 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4401 is automatically inserted on the transmission.
4403 @item wl-message-id-use-wl-from
4404 @vindex wl-message-id-use-wl-from
4405 The initial setting is @code{nil}. If non-nil, the value of
4406 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4408 @item wl-local-domain
4409 @vindex wl-local-domain
4410 The initial setting is @code{nil}. If @code{nil}, the return value of
4411 the function @code{system-name} will be used as the domain part of
4414 If @code{system-name} does not return FQDN (i.e. the full name of the
4415 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4416 to the string of the local domain name without hostname (like
4417 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4418 @samp{.} @code{wl-local-domain} is used as domain part of the
4421 If your terminal does not have global IP, set the value of
4422 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4423 you use invalid @samp{Message-ID:}.)
4425 Moreover, concatenation of @code{system-name} @samp{.}
4426 @code{wl-local-domain} will be used as an argument to the HELO command
4429 @item wl-message-id-domain
4430 @vindex wl-message-id-domain
4431 The initial setting is @code{nil}. If non-nil, this value is used as a
4432 domain part of the @samp{Message-ID:}. If your terminal does not have
4433 global IP address, set unique string to this value (e.x. your e-mail
4436 @item wl-unique-id-suffix
4437 @vindex wl-unique-id-suffix
4438 The initial setting is @samp{.wl}. You can specify the string in generated
4439 Message-ID which appear just before @samp{@@}.
4441 @item wl-draft-config-alist
4442 @vindex wl-draft-config-alist
4443 The initial setting is @code{nil}. Modifies the draft message just
4444 before the transmission. The content of @code{wl-draft-config-alist}
4445 will be automatically applied only once on the transmission. If you
4446 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4449 @item wl-template-alist
4450 @vindex wl-template-alist
4451 The initial setting is @code{nil}.
4452 This variable specifies the template to be applied in the draft buffer.
4454 @item wl-draft-config-matchone
4455 @vindex wl-draft-config-matchone
4456 The initial setting is @code{nil}. If non-nil, only the first matching
4457 item is used when @code{wl-draft-config-alist} is applied. If
4458 @code{nil}, all matching items are used.
4460 @item wl-template-visible-select
4461 @vindex wl-template-visible-select
4462 The initial setting is @code{t}.
4463 If non-nil, you can preview the result of the template selection in
4466 @item wl-template-confirm
4467 @vindex wl-template-confirm
4468 The initial setting is @code{nil}.
4469 If non-nil, asks for confirmation when you press the enter key to select
4470 template while previewing.
4472 @item wl-template-buffer-lines
4473 @vindex wl-template-buffer-lines
4474 The initial setting is 7.
4475 If @code{wl-template-visible-select} is non-nil, this variable specifies
4476 the size of the preview window.
4478 @item wl-draft-reply-buffer-style
4479 @vindex wl-draft-reply-buffer-style
4480 The initial setting is @code{split}. @code{split} or @code{full} can be
4481 specified. In the case of @code{full}, the whole frame will be used for
4482 a reply draft buffer when it is prepared.
4484 @item wl-draft-use-frame
4485 @vindex wl-draft-use-frame
4486 The initial setting is @code{nil}.
4487 If non-nil, use new frame for the draft.
4489 @item wl-draft-truncate-lines
4490 @vindex wl-draft-truncate-lines
4491 The initial value is the value of @code{default-truncate-lines}.
4492 If it is non-nil, truncate long lines in draft buffer.
4496 The initial setting is the value of the variable
4497 @code{user-mail-address}. The value of this variable is inserted as a
4498 @samp{From:} field of the draft when it is prepared.
4500 @item wl-envelope-from
4501 @vindex wl-envelope-from
4502 The initial setting is @code{nil}.
4503 The value of this variable is used for envelope from (MAIL FROM).
4504 If @code{nil}, the address part of @code{wl-from} is used.
4506 @item wl-user-mail-address-list
4507 @vindex wl-user-mail-address-list
4508 The initial setting is @code{nil}.
4509 This is the User's address list. If you have multiple addresses,
4514 The initial setting is @code{nil}.
4515 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4516 the draft when it is prepared. If function is specified, its return
4521 The initial setting is @code{nil}.
4522 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4523 the draft when it is prepared.
4525 @item wl-reply-subject-prefix
4526 @vindex wl-reply-subject-prefix
4527 The initial setting is @samp{Re: }.
4528 In the @samp{Subject:} of the reply draft, this string is prepended to
4529 the @samp{Subject:} of being replied.
4531 @item wl-draft-reply-use-address-with-full-name
4532 @vindex wl-draft-reply-use-address-with-full-name
4533 The initial setting is @code{t}.
4534 If non-nil, insert her full name with address when prepare a draft for
4535 reply a message. If it is @code{nil}, insert her address only.
4537 @item wl-draft-enable-queuing
4538 @vindex wl-draft-enable-queuing
4539 The initial setting is @code{t}.
4540 This flag controls off-line transmission. If non-nil, the draft is
4543 @item wl-draft-use-cache
4544 @vindex wl-draft-use-cache
4545 The initial setting is @code{nil}. If the value is non-nil and
4546 @code{wl-insert-message-id} is nil, cache the message which is sent.
4548 @item wl-fcc-force-as-read
4549 @vindex wl-fcc-force-as-read
4550 The initial setting is @code{nil}. If the value is non-nil,
4551 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4553 @item wl-auto-flush-queue
4554 @vindex wl-auto-flush-queue
4555 The initial setting is t.
4556 This flag controls automatic transmission of the queue when Wanderlust
4557 becomes on-line. If non-nil, the queue is automatically transmitted
4558 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4559 manually, press @kbd{F} in the folder mode.
4561 @item wl-ignored-forwarded-headers
4562 @vindex wl-ignored-forwarded-headers
4563 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4564 All headers that match this regexp will be deleted when forwarding a message.
4566 @item wl-ignored-resent-headers
4567 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4568 All headers that match this regexp will be deleted when resending a message.
4570 @item wl-draft-always-delete-myself
4571 @vindex wl-draft-always-delete-myself
4572 If non-nil, always removes your own address from @samp{To:} and
4573 @samp{Cc:} when you are replying to the mail addressed to you.
4575 @item wl-draft-delete-myself-from-bcc-fcc
4576 @vindex wl-draft-delete-myself-from-bcc-fcc
4577 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4578 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4580 @item wl-smtp-posting-server
4581 @vindex wl-smtp-posting-server
4582 The initial setting is @code{nil}.
4583 This is the SMTP server name for mail transmission.
4585 @item wl-smtp-posting-user
4586 @vindex wl-smtp-posting-user
4587 The initial setting is @code{nil}.
4588 This is the user name for SMTP AUTH authentication. If @code{nil},
4589 @code{smtp-authenticate-user} is used.
4591 @item wl-smtp-authenticate-type
4592 @vindex wl-smtp-authenticate-type
4593 The initial setting is @code{nil}.
4594 This is the authentication method for SMTP AUTH authentication. If
4595 @code{nil}, @code{smtp-authenticate-type} is used. If
4596 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4599 @item wl-smtp-connection-type
4600 @vindex wl-smtp-connection-type
4601 The initial setting is @code{nil}.
4602 This variable specifies how to establish SMTP connections.
4603 If @code{nil}, @code{smtp-connection-type} is used.
4604 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4606 @item wl-nntp-posting-server
4607 @vindex wl-nntp-posting-server
4608 The initial setting is @code{nil}.
4609 This is the NNTP server name used for news submission.
4610 If @code{nil}, @code{elmo-nntp-default-server} is used.
4612 @item wl-nntp-posting-user
4613 @vindex wl-nntp-posting-user
4614 The initial setting is @code{nil}.
4615 This is the user name for AUTHINFO authentication on news submission.
4616 If @code{nil}, @code{elmo-nntp-default-user} is used.
4617 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4619 @item wl-nntp-posting-port
4620 @vindex wl-nntp-posting-port
4621 The initial setting is @code{nil}.
4622 This is the port number of the NNTP server used for news submission.
4623 If @code{nil}, @code{elmo-nntp-default-server} is used.
4625 @item wl-nntp-posting-stream-type
4626 @vindex wl-nntp-posting-stream-type
4627 The initial setting is @code{nil}.
4628 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4629 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4630 connection will be established.
4632 @item wl-pop-before-smtp-user
4633 @vindex wl-pop-before-smtp-user
4634 The initial setting is @code{nil}.
4635 This is the POP user name for POP-before-SMTP.
4636 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4638 @item wl-pop-before-smtp-server
4639 @vindex wl-pop-before-smtp-server
4640 The initial setting is @code{nil}.
4641 This is the POP server name for POP-before-SMTP.
4642 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4644 @item wl-pop-before-smtp-authenticate-type
4645 @vindex wl-pop-before-smtp-authenticate-type
4646 The initial setting is @code{nil}.
4647 This is the authentication method for POP-before-SMTP authentication.
4648 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4650 @item wl-pop-before-smtp-port
4651 @vindex wl-pop-before-smtp-port
4652 The initial setting is @code{nil}.
4653 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4654 @code{elmo-pop3-default-port} is used.
4656 @item wl-pop-before-smtp-stream-type
4657 @vindex wl-pop-before-smtp-stream-type
4658 The initial setting is @code{nil}.
4659 This flag controls the use of SSL for POP-before-SMTP. If it is
4660 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4661 STARTTLS (RFC2595) connection will be established.
4663 @item wl-draft-queue-save-variables
4664 @vindex wl-draft-queue-save-variables
4665 Specifies a list of variable to which queued messages are saved on the
4666 off-line transmission.
4668 @item wl-draft-sendlog
4669 @vindex wl-draft-sendlog
4670 The initial setting is @code{t}.
4671 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4675 @item drafts are sent by smtp or qmail
4676 @item saved into folders by fcc
4677 @item saved into folders by queuing
4680 (it is written even if the transmission fails).
4681 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4682 and left to the logging function of @command{imput}.
4685 @item wl-draft-sendlog-max-size
4686 @vindex wl-draft-sendlog-max-size
4687 The initial setting is 20000 (in bytes).
4688 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4689 beyond the size specified by this variable.
4693 The initial setting is @code{nil}.
4694 If non-nil, address completion uses LDAP.
4696 @item wl-ldap-server
4697 @vindex wl-ldap-server
4698 The initial setting is @samp{localhost}.
4699 LDAP server name for address completion.
4702 @vindex wl-ldap-port
4703 The initial setting is @code{nil}.
4704 If non-nil, the value is used as port number.
4707 @vindex wl-ldap-base
4708 The initial setting is @samp{c=US}.
4709 LDAP search starting point (base) for address completion.
4711 @item wl-draft-remove-group-list-contents
4712 @vindex wl-draft-remove-group-list-contents
4713 The initial setting is @code{t}.
4714 If non-nil, remove the group-lists' members in the recipients when
4715 sending the message (group-list means the description such as
4716 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4719 @node Disconnected Operations, Expire and Archive, Draft, Top
4720 @chapter Off-line Management
4721 @cindex Disconnected Operations
4723 Wanderlust has on-line and off-line states.
4726 * Off-line State:: Wanderlust has on-line and off-line states
4727 * Enable Operations:: Enable Disconnected Operations
4728 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4729 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4730 * Variables of Plugged Mode:: Customize Plugged Mode
4734 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4735 @section Off-line State
4737 Wanderlust has on-line and off-line states. In the off-line state, you
4738 cannot access messages via network, unless they are cached.
4740 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4741 in the mode line indicates the off-line state. In folder or summary
4742 modes, press @kbd{M-t} to switch between off- and on-line.
4744 You can invoke Wanderlust in the off-line state by setting
4745 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4747 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4748 ignores uncached messages.
4751 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4752 @section Enable Disconeected Operations
4754 Even in the off-line state, provided that relevant messages are cached,
4755 and the variable @code{elmo-enable-disconnected-operation} (described
4756 later) is non-nil, you can following operations:
4757 @xref{Plugged Mode}, @xref{Off-line State settings}.
4760 * Send Messages off-line:: Transmit Messages
4761 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4762 * Creation of Folders:: Create Folders off-line (IMAP4)
4763 * Marking:: Mark (IMAP4)
4764 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4767 As soon as Wanderlust becomes on-line, such operations invoked off-line
4768 are reflected in the servers via network.
4771 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4772 @subsection Transmission of Messages
4774 You can send mail/news messages off-line (if you are using
4775 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4776 accumulated in the queue folder, @samp{+queue}. These messages are
4777 transmitted at once when Wanderlust becomes on-line.
4779 You can visit @samp{+queue} in the off-line state and confirm content of
4780 messages in the queue. You can also remove messages. Removed messages
4781 are not transmitted even in the on-line state.
4784 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4785 @subsection Re-file and Copy (IMAP4)
4787 Re-file and copy operations to IMAP folders invoked during the off-line
4788 state are accumulated in the queue, and reflected in the server side
4789 when Wanderlust becomes on-line. If you visit destination folders after
4790 off-line re-file or copy, it looks as if messages were appended even in
4793 For the safety reasons, messages re-filed off-line are removed from
4794 source folders only if their @samp{Message-ID:} match messages on the
4795 servers. While the queue is processed, messages that failed to be
4796 re-filed or copied to the specified folders are appended to the folder
4800 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4801 @subsection Creation of Folders (IMAP4)
4803 You can create IMAP folders off-line. The creation of folders are
4804 reflected in the servers when Wanderlust becomes on-line. At that time,
4805 if folders failed to be created on the servers for any reasons, messages
4806 re-filed to such folders are appended to the folder @samp{+lost+found}.
4809 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4810 @subsection Marking (IMAP4)
4812 Off-line changes in unread/read and importance mark @samp{$} information
4813 are also reflected in the servers when Wanderlust becomes on-line.
4816 @node Pre-fetching Reservations, , Marking, Enable Operations
4817 @subsection Pre-fetching (IMAP4, NNTP)
4819 You can make reservations for pre-fetching messages in IMAP or NNTP
4820 folders. Reserved messages are marked with @samp{!} but not cached
4821 yet. When Wanderlust becomes on-line, they are pre-fetched from
4824 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4825 these off-line operations for IMAP4 and NNTP do not take place, and
4826 off-line re-file, copy or suchlike simply results in error.
4828 Because off-line operations use cache files, it is a bad idea to erase
4829 them by hand; it may cause Wanderlust to malfunction.
4831 If you want to remove caches, be sure to execute @kbd{M-x
4832 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4833 remove caches for messages relevant to off-line operations.
4836 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4837 @section Switching On-line/Off-line per Server/Port
4839 @kbd{M-t} described above switches networking states as a whole, but you
4840 can switch on-line/off-line per server/port.
4842 Pressing @kbd{C-t} in the folder or summary modes brings you in
4843 wl-plugged-mode shown below, in which you can change the plugged state
4848 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4851 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4852 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4854 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4855 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4861 The first line indicates status of the following three variables, and
4862 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4863 column modifies the values of these variables.
4867 "Queuing" @code{wl-draft-enable-queuing}
4868 "AutoFlushQueue" @code{wl-auto-flush-queue}
4869 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4873 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4876 The second and after lines indicate on-line/off-line states of servers
4877 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4878 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4879 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4881 @dfn{sending queue} means messages accumulated in the folder
4882 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4883 off-line operations when @code{elmo-enable-disconnected-operation} is
4885 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4886 @c off-line operations are enabled.
4888 They are displayed if there are any of them. In the example above, in
4889 the sending queue there are two messages (the first and the second in
4890 the queue folder) for smtp to hosta and one (the third) for nntp to
4891 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4894 If you change @samp{(wl-plugged)} in the second line, the variable
4895 @code{wl-plugged} is changed, so that the mode line indicator and
4896 plugged states of all ports are affected. If you change plugged states
4897 of any servers or ports, @samp{(wl-plugged)} in the second line is
4898 affected depending on @code{elmo-plugged-condition} settings and the
4899 plugged state of each port.
4902 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4903 @section Invoking Wanderlust in the Off-line State
4905 As described before, if you set @code{wl-plugged} to @code{nil} in
4906 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4907 off-line state. You can specify off-line state on a per server or port
4908 basis. Refer to @code{wl-reset-plugged-alist} also.
4910 Usually, when Wanderlust starts up, the plugged state of each port is
4911 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4912 @code{wl-nntp-posting-server} and so on. If you want to change the
4913 plugged state of these ports or to add other ports, configure
4914 @code{wl-make-plugged-hook} with a function.
4918 (add-hook 'wl-make-plugged-hook
4920 (elmo-set-plugged plugged-value(t/nil) server port)
4921 ;; @r{add or change plugged states of the port of the server}
4922 (elmo-set-plugged plugged-value(t/nil) server)
4923 ;; @r{if the port is omitted, all ports are affected}
4924 ;; @r{(you cannot omit the port if you newly add the server)}
4930 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4931 @section Customizable Variables
4936 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4937 mode from the beginning.
4939 @item wl-queue-folder
4940 @vindex wl-queue-folder
4941 The initial setting is @samp{+queue}.
4942 This is the folder in which messages in the transmission queue are
4945 @item wl-auto-flush-queue
4946 @vindex wl-auto-flush-queue
4947 The initial setting is @code{t}.
4948 This flag controls automatic transmission of the queue when Wanderlust
4949 becomes on-line. If non-nil, the queue is automatically transmitted
4950 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4951 manually, press @kbd{F} in the folder mode.
4953 @item elmo-enable-disconnected-operation
4954 @vindex elmo-enable-disconnected-operation
4955 The initial setting is @code{nil}. Controls off-line operations
4956 regarding IMAP4. If non-nil, off-line operations are carried out.
4958 @item elmo-lost+found-folder
4959 @vindex elmo-lost+found-folder
4960 The initial setting is @samp{+lost+found}.
4961 This is the folder to which messages are saved when they fails to be
4962 appended while the off-line re-file/copy queue is processed.
4964 @item elmo-plugged-condition
4965 @vindex elmo-plugged-condition
4966 The initial setting is @code{one}.
4967 The value of @code{wl-plugged} reflects the return value of the function
4968 @code{elmo-plugged-p} (without arguments).
4969 This variable @code{elmo-plugged-condition} specifies the condition on
4970 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4971 plugged state of each port.
4974 'one : plugged if one or more ports are plugged.
4975 'all : plugged if all ports are plugged.
4976 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4977 states of the ports.
4978 @var{function} : reflects the return value of the @var{function}
4979 functions available per default
4980 'elmo-plug-on-by-servers
4981 : reflects the plugged state of the servers specified by the
4982 variable elmo-plug-on-servers.
4983 'elmo-plug-on-by-exclude-servers
4984 : reflects the plugged state of the servers that are not
4985 in elmo-plug-on-exclude-servers.
4986 elmo-plug-on-exclude-servers defaults to
4989 (system-name)without the domain part)
4995 (setq elmo-plugged-condition 'all)
4997 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4998 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5000 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5001 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5005 @item wl-reset-plugged-alist
5006 @vindex wl-reset-plugged-alist
5007 The initial setting is @code{t}. If non-nil, plugged states are
5008 initialized on a per server or port basis when Wanderlust starts up.
5010 If @code{nil}, plugged states are retained while Emacs is running. In
5011 other words, they are initialized when Emacs is restarted even if the
5012 value is @code{nil}.
5016 @node Expire and Archive, Scoring, Disconnected Operations, Top
5017 @chapter Automatic Expiration and Archiving of Messages
5018 @cindex Expire and Archive
5021 * Expire:: Expiration and Archiving
5022 * Archive:: Archiving All Messages
5026 @node Expire, Archive, Expire and Archive, Expire and Archive
5028 @cindex Expire Message
5030 Expiration means deletion of old messages which have outlasted a
5031 certain period of time.
5033 @code{wl-expire} supports not only simple deletion, but also moving to
5034 specified archiving folders.
5038 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5039 or @kbd{M-e} in the summary mode.
5041 @subsection Configuring @code{wl-expire-alist}
5043 An example configuration of @code{wl-expire-alist} is shown below.
5044 Everything in this @code{wl-expire-alist} makes a great difference in
5045 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5046 to @code{t}, especially in the initial stage.
5050 (setq wl-expire-alist
5051 '(("^\\+trash$" (date 14) remove)
5053 ("^\\+tmp$" (date 7) trash)
5054 ;; @r{re-file to @code{wl-trash-folder}}
5055 ("^\\+outbox$" (number 300) "$outbox;lha")
5056 ;; @r{re-file to the specific folder}
5058 ;; @r{do not expire}
5059 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5060 ;; @r{archive by message number (retaining numbers)}
5061 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5062 ;; @r{archive by a fixed number (retaining numbers)}
5063 ("^\\+diary$" (date 30) wl-expire-archive-date)
5064 ;; @r{archive by year and month (numbers discarded)}
5069 Items in the list has the format of:
5072 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5076 The folder is examined if it matches @var{regexp-for-folders} from the
5077 beginning of the list. If you invoke expiration on the folder that does
5078 not match any of them, nothing will happen. And if either the second or
5079 the third element of the item is @code{nil}, expiration will not take
5082 You can use any one of the following for
5083 @var{specification-of-message-to-be-deleted}:
5086 @item (number @var{n1} [@var{n2}])
5087 deletes messages depending on the number of messages in the folder.
5089 @var{n1} is the number of messages which should survive deletion, for example
5090 if its value is 500, the newest 500 messages survive and the rests are
5093 @var{n2} is the number of messages in the folder on which expiration should
5094 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5095 folders with 510 or more messages are expired.
5096 If you configured automatic expiration, frequently used folders may
5097 expire every time it receive messages, and you may be annoyed with the
5098 long delay in reading mail.
5099 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5100 expiration would not take place until a certain number of messages
5103 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5104 with important/new/unread) are not deleted.
5105 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5106 will expire so as to have 500 messages including such ones.
5107 Otherwise, it will have 500 messages except such ones.
5109 @item (date @var{d1})
5110 deletes messages depending on the dates.
5112 Messages dated @var{d1} or more days ago are deleted, for example if its
5113 value is seven, messages seven days old or more are deleted. Note that
5114 the date is the one in the @samp{Date:} field of the message, not when
5115 the message entered the folder.
5117 Messages with no or invalid @samp{Date:} field does not expire; you
5118 might have to delete them by hand.
5121 You can use any one of the following in the place of @var{destination}:
5125 deletes the messages instantly.
5128 hide the messages from summary (messages are not deleted).
5131 moves the messages to @code{wl-trash-folder}.
5133 @item @var{string}(folder)
5134 moves the messages to the folder specified with @var{string}.
5136 It would be useful for specifying an archiving folder, but because this
5137 does not move important messages, it might be better to use the
5138 standard functions described below.
5140 @item @var{function}
5141 invokes the specified @var{function}.
5143 To the @var{function}, three arguments are passed: a folder name, a list
5144 of messages to be deleted, and msgdb information of the summary. You
5145 can specify function-specific arguments after the name of the
5146 @var{function}. Note that the list contains messages with marks in
5147 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5150 These are four standard functions; three of them move messages to an archive
5151 folder in the specified way. This means old messages can be compressed
5152 and saved in a file, being deleted from the original folder.
5153 The last one divides messages to some MH folders.
5156 @item wl-expire-archive-number1
5157 re-files to archiving folders corresponding to the message numbers of
5158 the messages being deleted. For example, a message numbered 102 will be
5159 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5160 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5161 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5163 The archiving folders to which messages are re-filed are determined by
5164 the name of the folder as follows (in this case, archiving folders are
5165 handled as if @code{elmo-archive-treat-file} were non-nil).
5168 @item If the folder type is localdir:
5169 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5171 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5172 (@file{~/Mail/ml/wl-00100.zip}).
5174 @item The folder type is other than localdir:
5175 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5177 For example, @samp{%#mh/ml/wl} corresponds to
5178 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5181 As you can see, in the case of localdir, the folder type is not included
5182 in the path name, but otherwise it is included.
5183 And you can control the prefix to the archiving folder name by
5184 @code{wl-expire-archive-folder-prefix}.
5185 Refer to @code{wl-expire-archive-folder-prefix} for details.
5187 @item wl-expire-archive-number2
5188 re-files every certain number of messages to archiving folders.
5190 This differs from @samp{wl-expire-archive-number1} in that this re-files
5191 to the folder up to the specified number regardless of message numbers.
5192 The archiving folders to which messages are re-filed are determined in the
5193 same way as @code{wl-expire-archive-number1}.
5195 @item wl-expire-archive-date
5196 re-files messages depending on its date (year and month) to archive
5199 For example, a message dated December 1998 is re-filed to
5200 @code{$folder-199812;zip}. The name of the archiving folders except the
5201 date part are determined in the same way as
5202 @code{wl-expire-archive-number1}.
5205 You can set the first argument to these three standard functions to non-nil
5206 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5207 For example, it can be specified just after the name of the function:
5210 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5213 If you omit the argument, consecutive numbers from 1 are assigned for
5214 each archiving folder.
5216 @item wl-expire-localdir-date
5217 divedes messages depending on its date (year and month) to MH folders
5218 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5222 @subsection Treatment for Important or Unread Messages
5224 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5225 standard function, messages with marks in
5226 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5227 messages} thereafter) are retained.
5229 Per default, this variable include the important, new, and unread marks,
5230 so that messages with these marks are not removed.
5231 Note that you cannot include the temporary mark (i.e. temporary marks
5232 are removed anyway), and be sure to process temporary marks before you
5235 @subsection Auto Expiration
5237 The following setup invokes expiration when you move into the summary
5238 mode. There will be no confirmation, so make sure you made no mistake
5239 in regexp and other settings before you set up this.
5243 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5247 In the folder mode, you can invoke expiration per group as well as per
5248 folder. Therefore, if you specify @samp{Desktop} group, all folders
5249 matching @code{wl-expire-alist} expire.
5253 @subsection Treating archive folders.
5254 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5255 you must set non-nil value to @code{elmo-archive-treat-file}.
5257 @subsection Confirming
5259 If you are to use @code{remove}, try @code{trash} at first and see
5260 messages move to @code{wl-trash-folder} as expected, then replace it
5261 with @code{remove}. It would be dangerous to use @code{remove} from the
5264 If you are to use @code{wl-expire-archive-number1} and the like, try to
5265 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5266 you can append messages to it. Even if settings in
5267 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5268 would not be saved anywhere and disappeared in case the archiver program
5271 After you make sure you can archive to the folder correctly, you can
5272 invoke expiration and utilize the log.
5274 If you set @code{wl-expire-use-log} to @code{t},
5275 @file{~/.elmo/expired-log} should contain the log, for example:
5279 delete +ml/wl (593 594 595 596 597 598 599)
5280 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5284 The first column indicates the operation, i.e. @samp{delete},
5285 @samp{copy}, or @samp{move}. The next is the name of the folder that
5286 expired. In the case of @samp{copy} and @samp{move}, the destination
5287 folder is recorded after @samp{->}. The last is the list of message
5288 numbers that are actually deleted or moved (in the case of @samp{copy}
5289 and @samp{move}, the number is the one in the source folder, rather than
5290 the destination folder).
5292 @subsection Re-filing Reserved Messages
5294 The three standard functions copy reserved messages to the archive
5295 folder, but do not delete them from the source folder. Because
5296 reserved messages and the like always remain, they are recorded in
5297 @file{~/.elmo/expired-alist} so that they are not copied over and over
5298 again. They are not recorded if copied by @code{wl-summary-archive}.
5300 If you enabled logging, usually @samp{move} is recorded for re-filing,
5301 but instead @samp{copy} and @samp{delete} are recorded separately if
5302 reserved messages are involved. This is because it actually copies
5303 messages including reserved, then deletes ones except reserved in that
5306 @section Customizable Variables
5309 @item wl-expire-alist
5310 @vindex wl-expire-alist
5311 The initial setting is @code{nil}.
5312 This variable specifies folders and methods to expire. For details,
5313 refer to @code{wl-expire-alist} settings above.
5315 @item wl-summary-expire-reserve-marks
5316 @vindex wl-summary-expire-reserve-marks
5317 The initial setting is the list below.
5321 (list wl-summary-important-mark
5323 wl-summary-unread-mark
5324 wl-summary-unread-uncached-mark
5325 wl-summary-unread-cached-mark)
5329 Messages with these marks are retained in the folder, even after
5331 Only permanent marks can be listed, not temporary marks.
5333 You can list marks one by one as in the default; you can use the
5334 following settings as well:
5338 All messages with permanent marks are retained,
5339 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5343 All messages are handled as usual ones that are already read, no matter
5344 what marks they have; even important messages are deleted.
5347 @item wl-expire-archive-files
5348 @vindex wl-expire-archive-files
5349 The initial setting is 100.
5350 This variable specifies the number of messages to be retained in one
5353 @item wl-expire-number-with-reserve-marks
5354 @vindex wl-expire-number-with-reserve-marks
5355 The initial setting is @code{nil}.
5356 If non-nil, if expiring messages are specified by @code{number},
5357 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5359 @item wl-expire-archive-get-folder-function
5360 @vindex wl-expire-archive-get-folder-function
5361 The initial setting is @code{wl-expire-archive-get-folder}.
5363 This variable specifies a function that returns the name of an archiving
5364 folder for standard functions in the place of @var{destination}.
5365 You can use the following three variables for simple modification of
5366 folder names; if you want more complex settings, define your own
5367 function in this variable.
5369 @code{wl-expire-archive-get-folder} can be customized by these
5372 @item @code{wl-expire-archive-folder-name-fmt}
5373 @item @code{wl-expire-archive-folder-type}
5374 @item @code{wl-expire-archive-folder-prefix}
5377 @item wl-expire-archive-folder-name-fmt
5378 @vindex wl-expire-archive-folder-name-fmt
5379 The initial setting is @samp{%s-%%05d;%s}.
5380 This is a @code{format} string for archiving folders used in
5381 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5382 Note that you must specify the message number by @samp{%%d}, because it
5383 is parsed twice by @code{format}.
5385 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5388 @item wl-expire-archive-date-folder-name-fmt
5389 @vindex wl-expire-archive-date-folder-name-fmt
5390 The initial setting is @samp{%s-%%04d%%02d;%s}.
5391 This is a @code{format} string for archiving folders used in
5392 @code{wl-expire-archive-date}. Note that you must specify the message
5393 number by @samp{%%d}, because it is parsed twice by @code{format}.
5394 There should be @samp{%%d} twice, one for the year and the other for the
5397 If you modify this, adjust
5398 @code{wl-expire-archive-date-folder-num-regexp} as well.
5400 @item wl-expire-archive-folder-type
5401 @vindex wl-expire-archive-folder-type
5402 The initial setting is @code{zip}.
5403 This variable specifies an archiver type of the archiving folders.
5405 @item wl-expire-archive-folder-prefix
5406 @vindex wl-expire-archive-folder-prefix
5407 The initial setting is @code{nil}.
5408 This variable specifies the prefix (directory structure) to archiving
5410 Exercise extreme caution in using this feature, as it has not been
5412 In the worst case, there is a fear of destructing archiving folders.
5416 There will be no prefix.
5419 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5420 @samp{$ml/wl-00000;zip;wl}.
5423 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5426 @samp{$ml/wl-00000;zip;ml/wl}.
5429 @item wl-expire-archive-folder-num-regexp
5430 @vindex wl-expire-archive-folder-num-regexp
5431 The initial setting is @samp{-\\([-0-9]+\\);}.
5432 This variable specifies the regular expression to be used for getting
5433 message numbers from multiple archiving folders specified by
5434 @code{elmo-list-folders}.
5435 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5437 @item wl-expire-archive-date-folder-num-regexp
5438 @vindex wl-expire-archive-date-folder-num-regexp
5439 The initial setting is @samp{-\\([-0-9]+\\);}.
5440 This is the regular expression to be used for getting message numbers
5441 from multiple archiving folders specified by @code{elmo-list-folders}.
5442 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5444 @item wl-expire-delete-oldmsg-confirm
5445 @vindex wl-expire-delete-oldmsg-confirm
5446 The initial setting is @code{t}.
5447 If non-nil, messages older than the one with the largest number will be
5448 deleted with confirmation.
5449 If @code{nil}, they are deleted without confirmation.
5451 This feature is valid only if non-nil is specified as a argument to the
5452 standard functions so as to retain numbers.
5454 @item wl-expire-use-log
5455 @vindex wl-expire-use-log
5456 The initial setting is @code{nil}.
5457 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5458 They are appended but not truncated or rotated automatically; you might
5459 need to remove it manually.
5461 @item wl-expire-add-seen-list
5462 @vindex wl-expire-add-seen-list
5463 The initial setting is @code{t}.
5465 If non-nil, when messages are re-filed by expiration, read/unread
5466 information is passed to the destination folder.
5468 However if you do not read the destination folder from Wanderlust,
5469 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5470 want to set this to @code{nil} if you are simply saving to some
5471 archiving folders. Even if its value is @code{nil}, messages in the
5472 archiving folders are simply treated as unread; it does not affect
5475 @item wl-expire-folder-update-msgdb
5476 @vindex wl-expire-folder-update-msgdb
5477 The initial setting is @code{t}.
5478 If @code{t}, in the folder mode, expiration is carried out after
5479 updating summary information. If you specified a list of regular
5480 expressions of folder names, summary information is updated for matching
5485 @node Archive, , Expire, Expire and Archive
5486 @section Archiving Messages
5488 @subsection Archiving Messages
5489 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5490 folders. If there are the archiving folders already, only new messages
5493 You can use @code{wl-archive-alist} in order to specify how messages are
5494 archived according to their folder names, as in @code{wl-expire-alist}.
5499 (setq wl-archive-alist
5500 '(("^\\+tmp$" wl-archive-date)
5501 ("^\\+outbox$" wl-archive-number2)
5502 (".*" wl-archive-number1)))
5506 Each item in the list has the following format:
5509 (@var{folders-regexp} @var{deleting-function})
5512 As you can see, you can only use a function after @var{folders-regexp}.
5513 Per default, there are three functions:
5516 @item @code{wl-archive-number1}
5517 @item @code{wl-archive-number2}
5518 @item @code{wl-archive-date}
5521 As inferred from their names, they work similarly to "expire" versions,
5522 other than the following points:
5525 @item No messages are deleted
5526 @item Message numbers are retained even if invoked without arguments
5529 These functions are good to archive all messages in a folder by their
5530 numbers or by their dates.
5531 These are also useful for backup or confirmation purposes before
5533 If you try to re-file them after they are archived, they are deleted but
5536 Per default, the archiving folders to which messages are copied are
5537 determined automatically by @code{wl-expire-archive-get-folder-function}.
5538 You can copy to a specific folder by invoking with a prefix argument,
5539 i.e. @kbd{C-u M-x wl-summary-archive}.
5541 Note that this feature has not been seriously tested, because you can
5542 simply copy to an archiving folder, for example by
5543 @code{wl-summary-copy-region}.
5545 The archiving folders are determined by the same logic as in
5546 @code{wl-summary-expire}; the following customizable variables are
5550 @item @code{wl-expire-archive-files}
5551 @item @code{wl-expire-archive-get-folder-function}
5552 @item @code{wl-expire-archive-folder-name-fmt}
5553 @item @code{wl-expire-archive-folder-type}
5554 @item @code{wl-expire-archive-folder-prefix}
5555 @item @code{wl-expire-archive-folder-num-regexp}
5558 @subsection Customizable Variables
5561 @item wl-archive-alist
5562 @vindex wl-archive-alist
5563 The initial setting is the list shown below:
5567 ((".*" wl-archive-number1))
5572 This variable specifies a function that copies to archiving folders.
5573 To the function, three arguments are passed: a folder name, a list of
5574 messages in the folder, and msgdb information of the summary.
5575 Needless to say, you can use your own function.
5579 @node Scoring, Address Book, Expire and Archive, Top
5580 @chapter Score of the Messages
5582 @c @cindex Kill File
5584 Scoring is the function that associates a score (value) with each
5585 message, and marks as read or deletes from the summary according to it.
5587 You can put target or important marks on essential messages, or read marks
5588 on the ones you do not want to read, for example spam articles.
5590 This scoring function has a capability and a format similar to the one
5591 that Gnus has, although there are some unsupported features and
5592 Wanderlust specifics.
5593 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5596 * Score Commands:: Score Commands
5597 * Score File Format:: Score File Format
5601 @node Score Commands, Score File Format, Scoring, Scoring
5602 @section Score Commands
5603 @cindex Score Commands
5605 @subsection Score File Specification
5607 @code{wl-score-folder-alist} specifies score files or variables in which
5608 scores are defined, corresponding to folder names.
5612 (setq wl-score-folder-alist
5621 If paths to the score files are omitted, the directory specified in the
5622 variable @code{wl-score-files-directory} is assumed.
5624 No matter what you write in @code{wl-score-folder-alist}, the default
5625 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5626 read (it does not have to exist).
5627 Therefore, in the example above, the three score files,
5628 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5629 the folders that matches @samp{^-.*}.
5631 @subsection Scored Messages
5633 Scores are attached to the messages that are specified by
5634 @code{wl-summary-score-marks} temporarily when the summary is updated;
5635 when you exit from the summary, the scores are removed and reverts to
5638 @subsection Creation of Score Files
5640 In the summary buffer, move to an appropriate message and type @kbd{L}.
5641 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5642 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5644 This makes @minus{}1000 are scored for messages with the same
5645 @samp{Subject:} as the string you entered. That is, such a score file
5646 is created automatically.
5648 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5649 The score file you just made appears.
5650 This buffer is called @dfn{score editing buffer} thereafter.
5651 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5652 as you are previously; type @kbd{a}. Then a score entry for "From"
5654 In this way, you can create a score file easily either in the summary
5655 buffer or in the score editing buffer.
5657 By the way, you might be aware the numbers of key strokes are different
5658 between @kbd{s s p} and @kbd{a}.
5659 This is determined by @code{wl-score-header-default-entry}.
5660 This variable specifies the default score entries corresponding to
5662 For example, for "subject" field, a type and a time limit are prompted,
5663 but for "from" field, they are fixed upon automatically as substring and
5664 permanent respectively.
5665 However, score values can be modified by the prefix argument.
5666 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5669 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5670 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5671 erasing contents of the buffer deletes the score file being edited.
5675 @subsubsection Selecting Score Files
5677 You can change score files to which scores are appended by
5678 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5679 @code{wl-score-change-score-file}.
5681 @subsubsection Summing Up the Score
5683 If you add the same entries by @code{wl-summary-increase-score},
5684 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5685 scores for the entry is summed up.
5687 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5688 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5689 @minus{}1200 will be created as a result.
5691 @subsubsection Creating Thread Key
5693 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5694 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5696 @subsubsection Creating Followup Key
5698 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5699 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5700 at the cursor to @samp{References} key.
5701 If @code{wl-score-auto-make-followup-entry} is non-nil,
5702 @samp{Message-ID} of all messages to be followed up within dates
5703 specified by @code{wl-score-expiry-days}.
5705 @subsection Key Bindings
5710 @findex wl-summary-increase-score
5711 Increases the score for the current message.
5712 And the score entry is appended to the score file at the same moment.
5713 You can specify the score value by a prefix argument.
5717 @findex wl-summary-lower-score
5718 Decreases the score for the current message.
5719 And the score entry is appended to the score file at the same moment.
5720 You can specify the score value by a prefix argument.
5723 @kindex h R (Summary)
5724 @findex wl-summary-rescore
5725 Re-applies the scoring.
5726 However, already scored messages are not scored anew.
5729 @kindex h c (Summary)
5730 @findex wl-score-change-score-file
5731 Changes the score file currently selected.
5734 @kindex h e (Summary)
5735 @findex wl-score-edit-current-scores
5736 Edits the score file currently selected.
5737 If there are multiple score files, the previously specified one is
5741 @kindex h f (Summary)
5742 @findex wl-score-edit-file
5743 Edits an arbitrary score file and selects it.
5746 @kindex h F (Summary)
5747 @findex wl-score-flush-cache
5748 Erases caches associated to the score files that are read.
5749 If you modified score files directly (from other than Wanderlust), you
5750 need to re-read them after erasing the cache.
5753 @kindex h m (Summary)
5754 @findex wl-score-set-mark-below
5755 Specifies the criterion for scores to be marked as read.
5756 Messages with scores less than this value are marked as read.
5759 @kindex h x (Summary)
5760 @findex wl-score-set-expunge-below
5761 Specifies the criterion for scores to be deleted from the summary.
5762 Messages with scores less than this value are deleted.
5763 "Deleted" means it is not shown; they are not removed from the summary
5764 information or the folder.
5765 The deleted messages can be shown by rescan-noscore again.
5768 @subsection Key Bindings in the Score Editing Buffer
5772 @kindex C-c C-k (Score Mode)
5773 @findex wl-score-edit-kill
5774 Abandons the file being edited.
5777 @kindex C-c C-c (Score Mode)
5778 @findex wl-score-edit-exit
5779 Saves the file being edited, and quits from the edit mode.
5782 @kindex C-c C-p (Score Mode)
5783 @findex wl-score-pretty-print
5787 @kindex C-c C-d (Score Mode)
5788 @findex wl-score-edit-insert-date
5789 Inserts the number of dates from Dec. 31, 1 B.C.
5790 It is used for creating the third factor of time-limited scores.
5793 @kindex C-c C-s (Score Mode)
5794 @findex wl-score-edit-insert-header
5795 Inserts the header of the message selected in the summary buffer.
5798 @kindex C-c C-e (Score Mode)
5799 @findex wl-score-edit-insert-entry
5800 Inserts the score entry of the message selected in the summary buffer.
5803 @subsection Customizable Variables
5806 @item wl-summary-default-score
5807 @vindex wl-summary-default-score
5808 The initial setting is 0 (zero).
5809 This variable specifies the default value of the score.
5810 The score is increased or decreased based upon this value.
5812 @item wl-summary-important-above
5813 @vindex wl-summary-important-above
5814 The initial setting is @code{nil}.
5815 Messages with scores larger than this value are attached with the
5816 important mark (@samp{$}).
5817 If @code{nil}, no important marks are attached.
5819 @item wl-summary-target-above
5820 @vindex wl-summary-target-above
5821 The initial setting is @code{nil}.
5822 Messages with scores larger than this value are attached with the target
5824 If @code{nil}, no target marks are attached.
5826 @item wl-summary-mark-below
5827 @vindex wl-summary-mark-below
5828 The initial setting is 0 (zero).
5829 Messages with scores smaller than this value are marked as read.
5831 @item wl-summary-expunge-below
5832 @vindex wl-summary-expunge-below
5833 The initial setting is @code{nil}.
5834 Messages with scores smaller than this value are deleted from the
5836 If @code{nil}, they are not deleted.
5838 @item wl-summary-score-marks
5839 @vindex wl-summary-score-marks
5840 The initial setting is the list shown below:
5844 (list wl-summary-new-mark)
5849 Messages with these marks are scored.
5851 @item wl-use-scoring
5852 @vindex wl-use-scoring
5853 The initial setting is t.
5854 If non-nil, scoring is enabled.
5856 @item wl-score-files-directory
5857 @vindex wl-score-files-directory
5858 The initial setting is @file{~/.elmo/}.
5859 The default directory for score files.
5861 @item wl-score-interactive-default-score
5862 @vindex wl-score-interactive-default-score
5863 The initial setting is 1000.
5864 This value is used as a score when a score factor is @code{nil} in the
5865 score file. It is also used in @code{wl-summary-increase-score} and
5866 @code{wl-summary-lower-score}, on condition that the value of
5867 @code{wl-score-header-default-entry} is @code{nil}.
5869 @item wl-score-expiry-days
5870 @vindex wl-score-expiry-days
5871 The initial setting is 7.
5872 This is the number of days before time-limited scores are deleted.
5874 @item wl-score-update-entry-dates
5875 @vindex wl-score-update-entry-dates
5876 The initial setting is @code{t}.
5877 If non-nil, it enables deletion of time-limited scores.
5879 @item wl-score-header-default-entry
5880 @vindex wl-score-header-default-entry
5881 Specifies the default value for each header field for score entries
5882 created by @code{wl-summary-increase-score},
5883 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5885 @item wl-score-simplify-fuzzy-regexp
5886 @vindex wl-score-simplify-fuzzy-regexp
5887 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5888 regular expression to be deleted from the string.
5889 Because this is usually used for Subject, the default is prefixes that
5890 are attached by mailing list programs.
5892 @item wl-summary-rescore-partial-threshold
5893 @vindex wl-summary-rescore-partial-threshold
5894 The initial setting is 200.
5895 When sync-all or rescan is executed, if there are messages more than
5896 this value, only the last same number of messages as this value are
5899 @item wl-summary-auto-sync-marks
5900 @vindex wl-summary-auto-sync-marks
5901 If non-nil, unread/important marks are synchronized when the summary
5903 Unread marks reflect information on the IMAP4 server.
5904 Important marks reflect information on the IMAP4 server (flagged or
5905 not), and contents of @samp{'mark} folder.
5906 The initial setting is @code{t}.
5910 @node Score File Format, , Score Commands, Scoring
5911 @section Score File Format
5912 @cindex Score File Format
5914 The format of score files are the same as Gnus, and basically you can
5915 use Gnus score files as they are. But they are not fully compatible
5916 because some keys are not supported and there are Wanderlust specifics.
5917 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5922 ("for sale" -1000 nil s)
5923 ("profit" -1000 nil s))
5925 ("spam@@spamspamspam" -10000 nil s))
5927 ("my@@address" 3001 nil s))
5929 (1000000 -10 nil >))
5939 If the key is a string, it is the name of the header to be matched.
5940 The following keys are available:
5941 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5942 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5943 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5944 @code{Chars} and @code{Lines} mean the size and the number of lines of
5945 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5946 are described later.
5947 The rest corresponds the field of the same name.
5949 Arbitrary numbers of core entries are specified after the key.
5950 Each score entry consists of these five factors:
5954 A factor that matches header. This should be a number in the cases of
5955 @code{lines} and @code{chars}, otherwise a string.
5958 A score factor. When the first item matches, the score of the message
5959 is increased or decreased by this value.
5962 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5963 of a number, the score is deleted if it does not match for days
5964 (@code{wl-score-expiry-days}) from the date specified by this.
5965 The date is since Dec. 31, 1 B.C.
5968 A type factor. This specifies the way the first factor matches.
5969 Available types depend on keys.
5972 @item From, Subject, References, Message-ID
5973 For these keys in string, @code{r} and @code{R} (regexp),
5974 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5975 as well as @code{f} and @code{F} (fuzzy) can be used.
5976 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5979 For these keys, the following five numerical relative operators can be
5980 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5983 This key matches @code{From} header, and scores all follow-ups to the
5985 For example, it would be useful for increasing scores for follow-ups to
5988 You can use the same types as @code{From} except for @code{f}.
5989 And a @samp{Followup} entry is automatically appended to the score file.
5992 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5993 A @samp{Thread} entry is automatically appended for each article that
5994 has @var{x} in the @code{References} header.
5995 You can make sure the whole thread including messages that does not have
5996 all ancestors @code{Message-ID} in @code{References} is scored.
5998 You can use the same types as @code{References} except for @code{f}.
5999 And a @samp{Thread} entry is automatically appended to the score file.
6003 A factor for extension header. This is meaningful only if the key is
6005 This specifies headers to be matched other than standard headers like
6006 @code{Subject} and @code{From}.
6007 Note that you should specify the header in
6008 @code{elmo-msgdb-extra-fields} also.
6009 Therefore it does not work in folders where extension headers cannot be
6014 The sum of these scores @emph{after all factors are applied} becomes the
6015 score of the message.
6017 @cindex Score File Atoms
6019 Messages with a score less than this value is marked as read.
6020 The default is @code{wl-summary-mark-below}.
6023 Messages with a score less than this value is deleted from the summary.
6024 The default is @code{wl-summary-expunge-below}.
6026 @item mark-and-expunge
6027 Both @code{mark} and @code{expunge} are applied,
6028 i.e. messages with a score less than this value is marked as read and
6029 deleted from the summary.
6032 Messages with a score greater than this value is attached with temp
6034 The default is @code{wl-summary-target-above}.
6037 Messages with a score greater than this value is attached with important
6039 The default is @code{wl-summary-important-above}.
6044 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6045 are used, you need to set @code{elmo-msgdb-extra-fields}.
6048 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6051 There are other restrictions as shown below:
6054 @item Because @samp{References} field in the summary information
6055 contains only the last @samp{Message-ID}, @code{references} key matches
6059 Keys that can be seen by folder of types:
6063 chars lines xref extra
6064 localdir,localnews Y E E E
6065 nntp (supporting xover) Y E E N
6071 N: cannot be seen (ignored)
6072 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6077 @node Address Book, Customization, Scoring, Top
6078 @chapter Address Book
6079 @cindex Address Book
6081 With address book, you can utilize address completion, and you have
6082 summary displayed with nicknames.
6085 * Mail Addresses:: Definition of Address Book
6086 * Address Manager:: Address Manager
6089 @node Mail Addresses, Address Manager, Address Book, Address Book
6090 @section Address book
6091 @cindex Address book Definition
6093 @cindex Alias, Address
6095 The file @file{~/.addresses} is a simple address book for Wanderlust.
6096 Make address file @file{~/.addresses}, and edit to suit your requirement.
6098 The data written in @file{~/.addresses} are used for address completion
6099 under draft editing mode. Furthermore, they are used when showing names
6100 in summary display mode. You can safely skip this section, if you don't
6101 want to customize address completion and summary display.
6102 It is possible to add/change/remove addresses from @file{~/.addresses} in
6103 summary buffer after Wanderlust is invoked. @refill
6105 The format is very simple. Like this. @refill
6110 # @r{Lines begin with @samp{#} are comment.}
6111 # @r{Empty lines are ignored}
6113 # @r{Format of each line:}
6114 # @var{email-address} "@var{nickname} "@var{realname}"
6116 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6117 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6118 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6123 One line defines one persons description.
6125 Actually, in default setup, @var{nickname} is used in summary-mode and
6126 @var{realname} is used in draft preparation mode. This behavior is
6127 better understood if you try it and confirmed the function first. You
6128 can write and try a small definition, so you will know the idea of the
6129 address book before writing a big one.
6131 And, if MH alias file is specified in variable @code{wl-alias-file},
6132 it is used as an address information in the draft preparation mode.
6134 If variable @code{wl-use-ldap} is non-nil (initial setting is
6135 @code{nil}), address completion in draft mode uses LDAP information.
6137 If you use LDAP, you have to set @code{wl-ldap-server},
6138 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6139 not have LDAP feature as built-in feature (Currently only XEmacs can
6140 have built-in LDAP feature), you have to set command exec @env{PATH} to
6141 the program @command{ldapsearch}.
6144 @node Address Manager, , Mail Addresses, Address Book
6145 @section Address Manager
6146 @cindex Address Manager
6148 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6149 the address book and insert address to draft buffer.
6151 @subsection Key Bindings
6155 @kindex t (Address Manager)
6156 @findex wl-addrmgr-set-to
6157 Add @samp{To:} mark.
6160 @kindex c (Address Manager)
6161 @findex wl-addrmgr-set-cc
6162 Add @samp{Cc:} mark.
6165 @kindex b (Address Manager)
6166 @findex wl-addrmgr-set-bcc
6167 Add @samp{Bcc:} mark.
6170 @kindex u (Address Manager)
6171 @findex wl-addrmgr-unmark
6175 @kindex x (Address Manager)
6176 @findex wl-addrmgr-apply
6178 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6179 buffer and quit address manager. When no draft buffer, make new draft
6180 with insert marked addresses.
6182 If no mark, quit address manager.
6186 @kindex q (Address Manager)
6187 @findex wl-addrmgr-quit
6188 Quit address manager.
6191 @kindex a (Address Manager)
6192 @findex wl-addrmgr-add
6196 @kindex d (Address Manager)
6197 @findex wl-addrmgr-delete
6201 @kindex e (Address Manager)
6202 @findex wl-addrmgr-edit
6207 @node Customization, Mailing List, Address Book, Top
6208 @chapter Customizing Wanderlust
6209 @cindex Customization
6212 * Living with other packages:: Cooperating with other packages
6213 * Highlights:: Highlights
6214 * Biff:: Notify Mail arrival
6215 * Advanced Settings:: Advanced Settings
6216 * Customizable Variables:: Customizable Variables
6221 @node Living with other packages, Highlights, Customization, Customization
6222 @section Living with other packages
6224 Examples with other packages.
6227 * imput:: imput (im-wl.el)
6229 * supercite:: supercite.el
6230 * mu-cite:: mu-cite.el
6231 * X-Face:: x-face,bitmap-mule
6232 * dired-dd:: dired-dd.el
6234 * Addrbook:: Addrbook
6235 * mime-w3m:: mime-w3m.el
6239 @node imput, BBDB, Living with other packages, Living with other packages
6244 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6247 If @command{imput} is on the @code{exec-path} at the installation,
6248 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6252 (autoload 'wl-draft-send-with-imput-async "im-wl")
6253 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6258 @node BBDB, supercite, imput, Living with other packages
6262 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6265 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6266 byte-compiled and installed.
6274 ;; @r{enable pop-ups}
6275 (setq bbdb-use-pop-up t)
6276 ;; @r{auto collection}
6277 (setq bbdb/mail-auto-create-p t)
6278 ;; @r{exceptional folders against auto collection}
6279 (setq bbdb-wl-ignore-folder-regexp "^@@")
6280 (setq signature-use-bbdb t)
6281 (setq bbdb-north-american-phone-numbers-p nil)
6282 ;; @r{shows the name of bbdb in the summary} :-)
6283 (setq wl-summary-from-function 'bbdb-wl-from-func)
6284 ;; @r{automatically add mailing list fields}
6285 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6286 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6290 You can complete address with BBDB by @kbd{M-@key{TAB}}
6294 @node supercite, mu-cite, BBDB, Living with other packages
6295 @subsection sc.el(supercite), sc-register.el
6299 The same setting as usual mailers should be OK. The following is an
6300 example of settings:
6304 (autoload 'sc-cite-original "supercite" nil t)
6305 (add-hook 'mail-citation-hook 'sc-cite-original)
6310 @node mu-cite, X-Face, supercite, Living with other packages
6311 @subsection mu-cite.el
6314 The same setting as usual mailers should be OK. The following is an
6315 example of settings.
6317 If you use mu-cite version 8.0 or earlier:
6321 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6322 (setq mail-citation-hook 'mu-cite/cite-original)
6326 If you use mu-cite version 8.1 or later:
6330 (autoload 'mu-cite-original "mu-cite" nil t)
6331 (add-hook 'mail-citation-hook (function mu-cite-original))
6335 @node X-Face, dired-dd, mu-cite, Living with other packages
6339 If you have installed one of the following, you can decode
6340 @samp{X-Face:} field in message buffer and you will see face image.
6343 * x-face-xmas:: XEmacs case
6344 * x-face-mule:: Emacs case
6347 If there is an encoded X-Face string in a file @file{~/.xface} (the
6348 value of the variable @code{wl-x-face-file}), it is inserted as a
6349 @samp{X-Face:} field in the draft buffer (if
6350 @code{wl-auto-insert-x-face} is non-nil).
6352 @node x-face-xmas, x-face-mule, X-Face, X-Face
6353 @subsubsection x-face-xmas (for XEmacs)
6356 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6357 1.3.6.13 or later, do the following:
6361 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6362 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6366 @node x-face-mule, , x-face-xmas, X-Face
6367 @subsubsection x-face-mule (for Emacs)
6371 If you use @file{x-face-mule.el} in bitmap-mule
6372 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6376 (autoload 'x-face-decode-message-header "x-face-mule")
6377 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6381 @subsubsection x-face-e21 (for Emacs 21.x)
6384 With Emacs 21.x, you can use @file{x-face-e21.el}
6385 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6386 to display X-Face. In this case, bitmap-mule is not required.
6391 (autoload 'x-face-decode-message-header "x-face-e21")
6392 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6397 @node dired-dd, MHC, X-Face, Living with other packages
6398 @subsection dired-dd(Dired-DragDrop)
6399 @pindex Dired-DragDrop
6401 @cindex Drag and Drop
6403 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6404 compose multi-part by simple Drag-and-Drop from dired to the draft
6405 buffer being edited in GNU Emacs (this feature is not Wanderlust
6406 specific, but general-purpose for SEMI).
6410 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6416 ;; @r{Set dired-x variables here.}
6417 ;; @r{To and flo@dots{}}
6419 (progn (require 'dired-dd)
6420 (require 'dired-dd-mime))))))
6424 @node MHC, Addrbook, dired-dd, Living with other packages
6428 Message Harmonized Calendaring system
6429 (@uref{http://www.quickhack.net/mhc/})
6431 By using MHC, you can make a calendar from the messages.
6437 (setq mhc-mailer-package 'wl)
6438 (autoload 'mhc-mode "mhc" nil t)
6439 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6440 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6448 (autoload 'mhc-wl-setup "mhc-wl")
6449 (add-hook 'wl-init-hook 'mhc-wl-setup)
6453 @node Addrbook, mime-w3m, MHC, Living with other packages
6454 @subsection wl-addrbook.el
6458 (@uref{http://www.mew.org/})
6460 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6461 @code{load-path} and do the following settings.
6465 (require 'wl-addrbook)
6470 @node mime-w3m, , Addrbook, Living with other packages
6471 @subsection mime-w3m.el
6474 You can display html part by using @file{mime-w3m.el}
6475 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6476 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6479 @node Highlights, Biff, Living with other packages, Customization
6482 @subsection Customizable Variables
6485 @item wl-summary-highlight
6486 @vindex wl-summary-highlight
6487 The initial setting is @code{t}.
6488 If non-nil, the summary is highlighted.
6490 @item wl-highlight-max-summary-lines
6491 @vindex wl-highlight-max-summary-lines
6492 The initial setting is 10000.
6493 The summary is not highlighted if it has more lines than this value.
6495 @item wl-summary-highlight-partial-threshold
6496 @vindex wl-summary-highlight-partial-threshold
6497 The initial setting is 1000.
6498 This is a threshold whether the whole summary is highlighted.
6499 If there are more lines of messages in the summary, it is partially
6502 @item wl-summary-partial-highlight-above-lines
6503 @vindex wl-summary-partial-highlight-above-lines
6504 The initial setting is 30. If there are more lines of messages than
6505 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6506 after the point that is the same number of lines as this value above the
6507 cursor line are highlighted partially. (If this value is @code{nil},
6508 the last same number of lines as the value of
6509 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6511 @item wl-highlight-body-too
6512 @vindex wl-highlight-body-too
6513 The initial setting is @code{t}.
6514 If non-nil, bodies of drafts and messages are also highlighted.
6516 @item wl-highlight-message-header-alist
6517 @vindex wl-highlight-message-header-alist
6518 When highlighting headers of drafts and messages, this variable
6519 specifies which faces are allocated to important
6520 (@code{wl-highlight-message-important-header-contents}), secondly
6521 important (@code{wl-highlight-message-important-header-contents2}), and
6522 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6524 Similarly, it can be used for allocating arbitrary faces to arbitrary
6525 regular expressions.
6527 @item wl-highlight-citation-prefix-regexp
6528 @vindex wl-highlight-citation-prefix-regexp
6529 Specifies a regular expression to which quoted lines in bodies of
6530 drafts and messages match.
6531 Bodies matching to this regular expression are highlighted by the faces
6532 specified by (@code{wl-highlight-message-cited-text-*}).
6534 @item wl-highlight-highlight-citation-too
6535 @vindex wl-highlight-highlight-citation-too
6536 The initial setting is @code{nil}.
6537 If non-nil, the quoting regular expression itself given by
6538 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6540 @item wl-highlight-citation-header-regexp
6541 @vindex wl-highlight-citation-header-regexp
6542 Specifies a regular expression that denotes beginning of quotation.
6543 Bodies matching to this regular expression are highlighted by the face
6544 specified by @code{wl-highlight-message-headers}.
6546 @item wl-highlight-max-header-size
6547 @vindex wl-highlight-max-header-size
6548 The initial setting is @code{nil}. If a header size is larger than this
6549 value, it will not be highlighted. If @code{nil}, always highlighted
6550 (ignore header size).
6552 @item wl-highlight-max-message-size
6553 @vindex wl-highlight-max-message-size
6554 The initial setting is 10000.
6555 If a message is larger than this value, it will not be highlighted.
6556 With this variable, highlight is suppressed for uuencode or huge digest
6559 @item wl-highlight-signature-separator
6560 @vindex wl-highlight-signature-separator
6561 Specifies regular expressions that denotes the boundary of a signature.
6562 It can be a regular expression, or a list of ones.
6563 Messages after the place that matches this regular expression are
6564 highlighted by the face specified by
6565 @code{wl-highlight-message-signature}.
6567 @item wl-max-signature-size
6568 @vindex wl-max-signature-size
6569 The initial setting is 400.
6570 This is the largest size for a signature to be highlighted.
6572 @item wl-use-highlight-mouse-line
6573 @vindex wl-use-highlight-mouse-line
6574 The initial setting is @code{t}.
6575 If non-nil, the line pointed by the mouse is highlighted in the folder
6576 mode, summary mode, and the like.
6579 @subsection Setting Colors and Fonts of the Characters
6581 If you want to change colors or fonts of the characters, you need to
6582 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6583 want to change fonts, and @code{set-face-foreground} for colors, and so
6584 on. You cannot write face settings in @file{.emacs}; write in
6587 For example, if you want to change the color for signatures to yellow,
6591 (set-face-foreground 'wl-highlight-message-signature "yellow")
6597 Faces defined in Wanderlust:
6600 @item wl-highlight-message-headers
6601 The face for field names of message headers.
6603 @item wl-highlight-message-header-contents
6604 The face for field bodies of message headers.
6606 @item wl-highlight-message-important-header-contents
6607 The face for important parts of message headers.
6608 Per default, this face is used for a body of @samp{Subject:} field.
6609 You can change its value by editing
6610 @code{wl-highlight-message-header-alist}.
6612 @item wl-highlight-message-important-header-contents2
6613 The face for secondly important parts of message headers.
6614 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6615 fields. You can change its value by editing
6616 @code{wl-highlight-message-header-alist}.
6618 @item wl-highlight-message-unimportant-header-contents
6619 The face for unimportant parts of message headers.
6620 Per default, this face is used for bodies of @samp{X-} fields
6621 @samp{User-Agent:} fields. You can change its value by editing
6622 @code{wl-highlight-message-header-alist}.
6624 @item wl-highlight-message-citation-header
6625 The face for headers of quoted messages.
6627 @item wl-highlight-message-cited-text-*
6628 The face for texts of quoted messages. The last @samp{*} is a
6629 @var{single figure} so that 10 different colors can be used according to
6632 @item wl-highlight-message-signature
6633 The face for signatures of messages. The initial settings are
6634 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6635 dark background colors.
6637 @item wl-highlight-header-separator-face
6638 The face for header separators of draft messages.
6640 @item wl-highlight-summary-important-face
6641 The face for message lines with important marks in the summary.
6643 @item wl-highlight-summary-new-face
6644 The face for message lines with new marks in the summary.
6646 @item wl-highlight-summary-displaying-face
6647 The face for the message line that is currently displayed.
6648 This face is overlaid.
6650 @item wl-highlight-thread-indent-face
6651 The face for the threads that is currently displayed.
6653 @item wl-highlight-summary-unread-face
6654 The face for message lines with unread marks in the summary.
6656 @item wl-highlight-summary-deleted-face
6657 The face for message lines with delete marks in the summary.
6659 @item wl-highlight-summary-refiled-face
6660 The face for message lines with re-file marks in the summary.
6662 @item wl-highlight-refile-destination-face
6663 The face for re-file information part of message lines with re-file
6664 marks in the summary.
6666 @item wl-highlight-summary-copied-face
6667 The face for message lines with copy marks in the summary.
6669 @item wl-highlight-summary-target-face
6670 The face for message lines with target marks @samp{*} in the summary.
6672 @item wl-highlight-summary-thread-top-face
6673 The face for message lines that are on the top of the thread in the
6676 @item wl-highlight-summary-normal-face
6677 The face for message lines that are not on top of the thread in the
6680 @item wl-highlight-folder-unknown-face
6681 The face for folders that are not known to have how many unsync messages
6684 @item wl-highlight-folder-zero-face
6685 The face for folders that have no unsync messages in the folder mode.
6687 @item wl-highlight-folder-few-face
6688 The face for folders that have some unsync messages in the folder mode.
6690 @item wl-highlight-folder-many-face
6691 The face for folders that have many unsync messages in the folder mode.
6692 The boundary between `some' and `many' is specified by the variable
6693 @code{wl-folder-many-unsync-threshold}.
6695 @item wl-highlight-folder-unread-face
6696 The face for folders that have no unsync but unread messages in the
6699 @item wl-highlight-folder-killed-face
6700 The face for folders that are deleted from the access group in the
6703 @item wl-highlight-folder-opened-face
6704 The face for open groups in the folder mode.
6705 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6706 @code{nil} or a @var{number}.
6708 @item wl-highlight-folder-closed-face
6709 The face for close groups in the folder mode.
6710 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6711 @code{nil} or a @var{number}.
6713 @item wl-highlight-folder-path-face
6714 The face for the path to the currently selected folder in the folder
6717 @item wl-highlight-logo-face
6718 The face for logo in the demo.
6720 @item wl-highlight-demo-face
6721 The face for strings (for example, a version number) in the demo.
6725 @node Biff, Advanced Settings, Highlights, Customization
6726 @section Notify Mail arrival
6729 Following setting is to notify mail arrival of @samp{%inbox}
6730 by the indicator on the modeline
6733 (setq wl-biff-check-folder-list '("%inbox"))
6736 @subsection Customizable Variables
6738 @item wl-biff-check-folder-list
6739 @vindex wl-biff-check-folder-list
6740 The initial setting is @code{nil}.
6741 This is the list of folders to check mail arrival.
6742 If @code{nil}, wl doesn't check mail arrival.
6744 @item wl-biff-check-interval
6745 @vindex wl-biff-check-interval
6746 The initial setting is 40 (in seconds).
6747 Check mail arrival in this period.
6749 @item wl-biff-notify-hook
6750 @vindex wl-biff-notify-hook
6751 This hook is run at the arrival of new mail.
6752 To beep with mail arrival(initial setting), set as follows.
6754 (setq wl-biff-notify-hook '(ding))
6756 For silence, set to @code{nil}.
6760 @node Advanced Settings, Customizable Variables, Biff, Customization
6761 @section Advanced Settings
6764 * Draft for Reply:: Draft for Reply
6765 * Thread Format:: Appearance of Thread
6766 * User-Agent Field:: @samp{User-Agent:} Header Field
6770 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6771 @subsection Draft for Replay
6772 @vindex wl-draft-reply-with-argument-list
6773 @vindex wl-draft-reply-without-argument-list
6774 @vindex wl-draft-reply-myself-with-argument-list
6775 @vindex wl-draft-reply-myself-without-argument-list
6777 If you want, when you replying to articles in mailing lists, the address
6778 in Reply-To field of the original message to be prepared to To field of
6779 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6784 (setq wl-draft-reply-without-argument-list
6785 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6786 ("Followup-To" . (nil nil ("Followup-To")))
6787 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6788 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6793 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6794 in the original message, @samp{Reply-To:} field in the original is
6795 copied to @samp{To:} field.)
6797 Moreover, the behavior of @kbd{a} with prefix argument can
6798 be directed by @code{wl-draft-reply-with-argument-list} as well.
6800 Note: To set the behavior when you reply to the message written by yourself, use
6801 @code{wl-draft-reply-myself-without-argument-list} and
6802 @code{wl-draft-reply-myself-with-argument-list}
6805 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6806 @subsection Appearance of Threads
6810 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6811 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6812 391 09/18(Fri)19:24 +-[ Murata-san ]
6813 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6814 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6815 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6816 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6817 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6818 412 09/22(Tue)09:28 | +-[ Teranishi ]
6819 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6820 416 09/22(Tue)12:38 | +-[ Teranishi ]
6821 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6822 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6826 Settings to make appearance of threads like shown above:
6830 (setq wl-thread-indent-level 2)
6831 (setq wl-thread-have-younger-brother-str "+")
6832 (setq wl-thread-youngest-child-str "+")
6833 (setq wl-thread-vertical-str "|")
6834 (setq wl-thread-horizontal-str "-")
6835 (setq wl-thread-space-str " ")
6839 If you do not want to see branches, do the following:
6843 (setq wl-thread-indent-level 2)
6844 (setq wl-thread-have-younger-brother-str " ")
6845 (setq wl-thread-youngest-child-str " ")
6846 (setq wl-thread-vertical-str " ")
6847 (setq wl-thread-horizontal-str " ")
6848 (setq wl-thread-space-str " ")
6853 @node User-Agent Field, , Thread Format, Advanced Settings
6854 @subsection User-Agent Field
6858 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6859 @samp{User-Agent:} fields, define a function that generate appropriate
6860 strings as you like, and set it to variable
6861 @code{wl-generate-mailer-string-function}.
6863 If you do not want verbose @samp{User-Agent:} field, do the following:
6867 (setq wl-generate-mailer-string-function
6870 (concat "User-Agent: "
6871 (wl-generate-user-agent-string-1 nil)))))
6875 The following is a example:
6879 (setq mime-edit-insert-user-agent-field nil)
6880 (setq wl-generate-mailer-string-function
6883 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6888 @node Customizable Variables, Hooks, Advanced Settings, Customization
6889 @section Customizable Variables
6891 Customizable variables that have not been described yet:
6894 @item wl-default-folder
6895 @vindex wl-default-folder
6896 The initial setting is @samp{%inbox}. This is the default value for moving to
6897 a folder and the like.
6899 @item wl-draft-folder
6900 @vindex wl-draft-folder
6901 The initial setting is @samp{+draft}. It is the folder to which drafts are
6902 saved. It must be a localdir folder.
6904 @item wl-trash-folder
6905 @vindex wl-trash-folder
6906 The initial setting is @samp{+trash}. It is the wastebasket folder.
6907 If you changed this variable, you had better restart Wanderlust.
6909 @item wl-interactive-exit
6910 @vindex wl-interactive-exit
6911 The initial setting is @code{t}.
6912 If non-nil, you are asked for confirmation when Wanderlust terminates.
6914 @item wl-interactive-send
6915 @vindex wl-interactive-send
6916 The initial setting is @code{t}.
6917 If non-nil, you are asked for confirmation when mail is sent.
6919 @item wl-folder-sync-range-alist
6920 @vindex wl-folder-sync-range-alist
6921 The initial setting is the alist shown below:
6926 ("^\\+draft$\\|^\\+queue$" . "all"))
6931 This is an associative list of regular expressions of folder names and
6932 update range of the summary. Update range is one of the @samp{all},
6933 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6934 @samp{last}. If a folder do not match, @samp{update} is used.
6937 @vindex wl-ask-range
6938 The initial setting is @code{t}.
6939 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6940 for updating the summary when you changed folders.
6942 @item wl-mime-charset
6943 @vindex wl-mime-charset
6944 The initial setting is @code{x-ctext}.
6945 This is the MIME charset for messages that are not MIME (e.g. without
6946 @samp{Content-Type:}). This value also used as default charset for
6947 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6948 this value as @code{iso-2022-jp}.)
6950 @item wl-highlight-folder-with-icon
6951 @vindex wl-highlight-folder-with-icon
6952 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6953 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6955 @item wl-strict-diff-folders
6956 @vindex wl-strict-diff-folders
6957 This is a list of regular expressions of folders.
6958 Unread messages are checked, for example when you press @kbd{s} in
6959 the folder mode, usually in a brief way (rapidly processed but not
6961 The folders matching this variable are seriously checked.
6962 You may want to set this variable so as to match conditional filter
6963 folders for IMAP4 folders.
6964 The initial setting is @code{nil}.
6966 @item wl-folder-use-server-diff
6967 @vindex wl-folder-use-server-diff
6968 When unread messages are checked, for example when you press @kbd{s} in
6969 the folder mode, usually (the number of messages on the server) @minus{}
6970 (the number of local messages) will be the number of unread messages.
6971 However, if this variable is non-nil, the number of unread messages on
6972 the server is checked. This affects IMAP4 folders only, but IMAP4
6973 folders in mail boxes matching
6974 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6975 the number of unread messages on the server, even if they matches this
6976 variable. The initial setting is @code{t}.
6978 @item wl-auto-check-folder-name
6979 @vindex wl-auto-check-folder-name
6980 The initial setting is @code{nil}.
6981 You can specify a folder or a group which is checked for unread message
6982 at the start. You can also specify a list of folders (groups) to be checked.
6983 If the value is @code{nil}, whole Desktop is checked at the start.
6984 If it is @code{none}, no folders are checked.
6986 @item wl-auto-uncheck-folder-list
6987 @vindex wl-auto-uncheck-folder-list
6988 The initial setting is the list shown below:
6997 You can set a list of regular expressions to specify folders
6998 which are not automatically checked even if they are included
6999 in some groups assigned by @code{wl-auto-check-folder-name}.
7001 @item wl-auto-check-folder-list
7002 @vindex wl-auto-check-folder-list
7003 The initial setting is @code{nil}.
7004 You can set a list of regular expressions to specify exceptions
7005 for @code{wl-auto-uncheck-folder-list}.
7007 @item wl-no-save-folder-list
7008 @vindex wl-no-save-folder-list
7009 The initial setting is the list shown below:
7018 This is a list of regular expressions of folders not to be saved.
7020 @item wl-save-folder-list
7021 @vindex wl-save-folder-list
7022 The initial setting is @code{nil}.
7023 This is a list of regular expressions of folders to be saved.
7024 This takes precedence over @code{wl-no-save-folder-list}.
7026 @item wl-folder-mime-charset-alist
7027 @vindex wl-folder-mime-charset-alist
7028 The initial setting is the alist shown below:
7032 (("^-alt\\.chinese" . big5)
7033 ("^-relcom\\." . koi8-r)
7035 ("^-han\\." . euc-kr))
7040 This is an associative list of regular expressions of folder names and
7042 If a folder do not match, @code{wl-mime-charset} is used.
7044 @item wl-folder-init-load-access-folders
7045 @vindex wl-folder-init-load-access-folders
7046 The initial setting is @code{nil}.
7047 This is a list of access groups to be loaded specifically at the start.
7048 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7050 @item wl-folder-init-no-load-access-folders
7051 @vindex wl-folder-init-no-load-access-folders
7052 The initial setting is @code{nil}.
7053 This is a list of access groups not to be loaded specifically at the
7055 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7057 @item wl-delete-folder-alist
7058 @vindex wl-delete-folder-alist
7059 The initial setting is the alist shown below:
7068 This list determines disposition of messages with delete marks.
7069 Each item in the list is a folder and destination; you can specify any
7070 one of the following in the place of destination:
7073 @code{remove} or @code{null} : deletes the messages instantly.
7074 string : moves the messages to the specific folder.
7075 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7078 @item wl-refile-policy-alist
7079 @vindex wl-refile-policy-alist
7080 The initial setting is the list shown below:
7090 This list determines whether messages with re-file marks are moved or
7091 copied. Each item in the list is a cons cell of a folder and
7092 @code{copy} or @code{move}.
7094 @item wl-x-face-file
7095 @vindex wl-x-face-file
7096 The initial setting is @file{~/.xface}.
7097 The name of the file that contains encoded X-Face strings.
7100 @item wl-demo-display-logo
7101 @vindex wl-demo-display-logo
7102 If non-nil, bitmap image is shown on the opening demo. If you set
7103 @code{xpm} or @code{xbm}, (if possible) display selected image type
7106 @item elmo-use-database
7107 @vindex elmo-use-database
7108 This is meaningful for XEmacs only. The initial setting depends on
7109 XEmacs (@code{t} for XEmacs with dbm).
7110 If non-nil, Message-ID is controlled by dbm.
7112 @item elmo-passwd-alist-file-name
7113 @vindex elmo-passwd-alist-file-name
7114 The initial setting is @file{passwd}.
7115 This is the name of the file in which passwords are saved.
7116 @code{elmo-passwd-alist-save} saves current passwords to the file.
7118 @item elmo-nntp-list-folders-use-cache
7119 @vindex elmo-nntp-list-folders-use-cache
7120 The initial setting is 600 (in seconds).
7121 This is period in seconds during which results of @samp{list} and
7122 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7125 @item elmo-nntp-max-number-precedes-list-active
7126 @vindex elmo-nntp-max-number-precedes-list-active
7127 The initial setting is @code{nil}.
7128 If non-nil, the number of article obtained by @samp{list active} in NNTP
7129 are used as the maximum article number of the folder.
7130 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7131 and if the number of read messages is not correct.
7133 @item elmo-nntp-default-use-listgroup
7134 @vindex elmo-nntp-default-use-listgroup
7135 The initial setting is @code{t}.
7136 If non-nil, @samp{listgroup} is used for checking the total number of
7137 articles. If it is @code{nil}, @samp{group} is used. In the latter
7138 case, the processing will be a little faster at the sacrifice of
7141 @item elmo-pop3-send-command-synchronously
7142 @vindex elmo-pop3-send-command-synchronously
7143 The initial setting is @code{nil}.
7144 If non-nil, POP3 commands are issued synchronously. Some implementation
7145 of POP3 server fails to get summary information without this setting.
7146 You may have to set this variable to @code{t}, if the process hangs
7147 while looking up POP3.
7149 @item elmo-dop-flush-confirm
7150 @vindex elmo-dop-flush-confirm
7151 The initial setting is @code{t}.
7152 If non-nil, you are asked for confirmation if accumulated off-line
7153 operations are executed.
7155 @item elmo-display-progress-threshold
7156 @vindex elmo-display-progress-threshold
7157 The initial setting is 20.
7158 Threshold for display of progress gauge. If number of renewal is more than
7159 this value, display progress gauge.
7163 @node Hooks, , Customizable Variables, Customization
7169 @node Mailing List, Addition, Customization, Top
7170 @chapter Wanderlust Mailing List
7175 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7178 Topics related to Wanderlust are discussed in the mailing list.
7179 The latest version is also announced there (in Japanese, sorry).
7181 A guide can be obtained automatically by sending mail to
7182 @t{wl-ctl@@lists.airs.net} with the body
7187 Please send bug reports or patches to the mailing list. You can post to
7188 the mailing list even though you are not a member of it.
7190 If you send a bug report, please attach Backtrace with it.
7191 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7194 I would like to express my thanks to the members of the mailing list for
7195 valuable advice and many pieces of code they contributed.
7198 @node Addition, Index, Mailing List, Top
7199 @chapter Additional Information
7201 @section Brief History
7204 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7205 3/10 Made a msgdb mechanism by elisp.
7206 3/26 IMAP and NNTP can be displayed in threads.
7207 4/13 Began to assemble thread display modules as elmo.
7208 5/01 Finished 0.1.0, initial version with many defects.
7209 6/12 I made a slip of the tongue and said I was writing elisp
7210 mailer supporting IMAP
7211 6/16 0.1.3 was announced at tm-ja, elisp ML.
7212 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7213 7/01 Support for mm-backend (0.3.0).
7214 8/25 multi folder added (0.5.0).
7215 8/28 filter folder added (0.5.1).
7216 9/10 You can open/close threads (0.6.0).
7217 9/11 fldmgr by Murata-san made editing folders easy.
7218 9/18 lha folders added by Okunishi-san (0.6.3).
7219 9/24 Display of branches of threads (0.6.5).
7220 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7221 10/28 Off-line operations (0.7.4).
7222 12/09 Becomes beta version.
7223 12/21 wl-expire by Murata-san.
7224 1999 2/03 auto-refile by Tsumura-san.
7225 4/28 wl-template by Murata-san.
7226 5/18 Released 1.0.0 stable.
7227 7/05 Scoring by Murata-san (2.1.0).
7228 9/26 New plugged system by Murata-san (2.2.2).
7229 12/20 Support Modified UTF7.
7230 2000 3/24 Released 1.1.0 stable.
7231 4/03 CVS development started.
7232 5/07 Thread restoration & Its speed up with Murata-san.
7233 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7234 7/11 killed message feature.
7235 7/18 Use UIDL in POP3.
7236 9/12 biff feature with Satata-san & Yamaoka-san.
7237 10/17 expire-hide by Okada-san.
7238 11/08 Released 2.4.0 stable.
7239 2001 7/04 Released 2.6.0 stable.
7240 8/21 wl-addrmgr by Kitamoto-san.
7241 12/27 Released 2.8.1 stable.
7244 See @file{ChangeLog} for details.
7248 According to a dictionary, Wanderlust has the meaning:
7252 n eager longing for or impulse towards travelling in distant lands
7253 [Ger, fr wandern to wander + lust desire, pleasure]
7257 but I had no profound intention. (if farfetched, IMAP @result{} you can
7258 read mail anywhere @result{} desire to wander ?)
7260 Elmo is the abbreviation of @samp{Elisp Library for Message
7261 Orchestration}. At first I meant the red puppet in the Sesame Street,
7262 but you may associate it with Wandering @result{} Drifting @result{}
7263 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7267 Each versions has code names (they are almost jokes).
7268 Currently they are picked up alphabetically from the top 40 hits of
7269 U.S. Billboard magazines in 1980s.
7271 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7274 @node Index, , Addition, Top
7278 * Concept Index:: Concept Index
7279 * Key Index:: Key Index
7280 * Variable Index:: Variable Index
7281 * Function Index:: Function Index
7284 @node Concept Index, Key Index, Index, Index
7285 @unnumberedsec Concept Index
7288 @node Key Index, Variable Index, Concept Index, Index
7289 @unnumberedsec Key Index
7292 @node Variable Index, Function Index, Key Index, Index
7293 @unnumberedsec Variable Index
7296 @node Function Index, , Variable Index, Index
7297 @unnumberedsec Function Index