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 * Terminology:: Terminologies
125 * Mailing List:: Wanderlust mailing list
126 * Addition:: Additional Information
131 @node Introduction, Start Me Up, Top, Top
132 @chapter Introduction of Wanderlust
135 Wanderlust is an mail/news management system on Emacsen.
136 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
138 The main features of Wanderlust:
141 @item Pure elisp implementation.
142 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
143 @item Unified access method to messages based on Mew-like Folder Specification.
144 @item Mew-like Key-bind and mark handling.
145 @item Manages unread messages.
146 @item Interactive thread display.
147 @item Folder Mode shows the list of subscribed folders.
148 @item Message Cache, Disconnected Operation (Read Only).
149 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
150 @item MIME compliant (by SEMI).
151 @item Transmission of news and mail are unified by Message transmitting draft.
152 @item Graphical list of folders (XEmacs and Emacs 21).
153 @item View a part of message without retrieving the whole message (IMAP4).
154 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
155 @item Virtual Folders.
156 @item Supports compressed folder using common archiving utilities.
157 @item Old articles in folders are automatically removed/archived (Expiration).
158 @item Automatic re-file.
159 @item Template function makes it convenient to send fixed form messages.
165 Wanderlust is supposed to run on following Emacsen:
168 @item Mule 2.3 based on Emacs 19.34
169 @item Emacs 20.2 or later
170 @item XEmacs 20.4 or later
171 @item Meadow 1.00 or later
172 @item NTEmacs 20.4 or later
176 IMAP4 connectivity with following imapd are confirmed to work with
180 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
181 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
182 @item Courier-IMAP 1.3.2 or later
183 @item AIR MAIL (AIRC imapd release 2.00)
185 @item Microsoft Exchange Server 5.5
186 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
189 LDAP connectivity with following LDAPd are confirmed to work with
193 @item OpenLDAP 2.0.6 or later
197 @node Start Me Up, Folders, Introduction, Top
198 @chapter Start up Wanderlust
201 The necessary procedure for starting Wanderlust is explained in steps
204 (Of course, you need a mail/news readable environment in advance)
207 * MIME Modules:: Installing the MIME modules
208 * Download:: Download and extract the packages
209 * Install:: Byte-compile and install
210 * Minimal Settings:: @file{.emacs} setup
211 * Folder Definition:: Folder definition
212 * Start Wanderlust:: Starting Wanderlust
216 @node MIME Modules, Download, Start Me Up, Start Me Up
217 @section Installing MIME modules
223 SEMI must be installed to make Wanderlust work correctly.
225 SEMI can be downloaded from these sites:
229 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
233 You need packages named APEL and FLIM to use SEMI.
234 You can download APEL and FLIM from following URLs:
238 APEL: ftp://ftp.m17n.org/pub/mule/apel/
239 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
243 You have to install APEL, FLIM and SEMI in this order. Generally,
244 @samp{make install} will do the job. (In XEmacs 21, @samp{make
247 Refer to the documents of each package for detailed installation
248 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
249 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
253 Recommended combination of APEL, FLIM and SEMI are following:
256 @item APEL 10.3, FLIM 1.14.3 and SEMI 1.14.3
259 You can also use many other FLIM/SEMI variants. Combination of the
260 latest versions should work. For example, the following combination are
264 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
265 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
268 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
271 @node Download, Install, MIME Modules, Start Me Up
272 @section Download and Extract the Package
275 You can download Wanderlust package from following sites:
279 ftp://ftp.gohome.org/wl/
282 Mirrored ftp/http sites:
286 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
287 http://www.jpl.org/elips/wl/
288 http://www.ring.gr.jp/archives/text/elisp/wl/
289 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
290 ftp://opaopa.org/pub/mirror/elisp/wl/
291 @c ftp://roguelife.org/pub/tsumura/wl/
295 Extract the obtained package to your working directory:
300 % tar zxvf wl-@var{version}.tar.gz
301 % cd wl-@var{version}
305 @subsection To use SSL (Secure Socket Layer)
310 SSL (Secure Socket Layer) can be used for
311 SMTP, IMAP, NNTP and POP connections in Wanderlust.
313 There are two ways to use SSL. One is to start SSL negotiation just
314 after the connection establishment (generic way). The other one is to
315 start SSL negotiation by invoking STARTTLS command in the each session.
317 To use the formal SSL (generic SSL), you must set @env{PATH} to the
318 directory that OpenSSL commands are installed.
320 To use the latter SSL(STARTTLS), you must install starttls package in
322 You can download starttls package from the following site.
325 ftp://opaopa.org/pub/elisp/
328 @node Install, Minimal Settings, Download, Start Me Up
329 @section Byte-compile and install
336 @subsection Installation
338 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
339 Set the Emacs's command name to @code{EMACS}.
340 Set package installation directory to @code{LISPDIR}.
341 Then, please execute following commands.
350 Destination directory is auto-probed if you leave @code{LISPDIR}
351 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
353 If you are using an Emacs variant which does not merge specified directory
354 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
355 then you will see the error message:
358 Cannot open load file: mime-setup
362 In this case, either add destination directories of custom, APEL, FLIM
363 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
364 @code{load-path} in @file{WL-CFG} in extracted directory.
366 If you want to use BBDB, then the necessary modules are byte-compiled
367 and installed when BBDB directory is added to @code{load-path}.
370 @subsection @file{WL-CFG}
372 Contents of the file @file{WL-CFG} is loaded under installation if a file
373 with that name exists in extracted directory. You can use @file{WL-CFG} to
374 configure @code{load-path} to extra packages such as SEMI if needed.
376 If you want to specify the install directory of Wanderlust related
377 files, then set following variables in @file{WL-CFG}
381 A directory to install WL modules.
382 This directory is relative directory from @code{LISPDIR}.
383 WL modules include @file{wl*.el}, @file{wl*.elc} files.
384 @c Modules under the directory @file{util/} are also installed if
385 @c it detected as necessary.
388 A directory to install ELMO modules.
389 This directory is relative directory from @code{LISPDIR}.
390 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
391 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
395 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
397 If you want to install ELMO related files under a sub-directory
398 such as "elmo" then add following to @file{WL-CFG}:
401 (setq ELMO_PREFIX "elmo")
404 @subsection Install as a XEmacs package
405 @cindex XEmacs package
406 @cindex XEmacs package install
407 @cindex Package, XEmacs
408 @cindex Package install, XEmacs
409 @c @cindex install-package
411 It is possible to install Wanderlust as one of packages of XEmacs (21.0
412 or later). Configuration for autoload and icon-path in local
413 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
416 Follow the next example to install Wanderlust as an XEmacs package.
422 % make install-package
426 package directory is auto-probed, if SEMI is installed.
427 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
429 @subsection Run in place
431 If wl and elmo directories are defined in @code{load-path}, then
432 byte-compilation and installation are not necessary to start Wanderlust.
433 For example, if package is extracted in @file{~/work}, Wanderlust can be
434 invoked with following setting in @file{~/.emacs}.
438 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
439 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
445 Manual is described in Info format. Please do following.
454 If you install Wanderlust as a XEmacs package, Info file is already
455 installed too, so there are no need of these commands.
457 Manual directory is automatically detected. Of course, it can be
458 configured by @code{INFODIR} in @file{Makefile}.
460 You can read manual at the following URL:
463 http://www.gohome.org/wl/doc/wl_toc.html
466 @node Minimal Settings, Folder Definition, Install, Start Me Up
467 @section Set up .emacs
468 @cindex Minimal Settings
470 @cindex Configuration
474 The Wanderlust package contains two module groups.
477 @item ELMO (elmo-*.el)
478 These modules show everything as folders. This is the back-end for WL.
480 These modules controls the behavior of main body of Wanderlust.
481 They are also the front-end for ELMO.
484 You can customize the behavior of Wanderlust by changing the value
485 of environmental variables which begins with @code{elmo-} and @code{wl-}.
487 The minimal requirement for settings is as the following.
491 ;; @r{The setting to use SEMI}
492 (require 'mime-setup)
494 ;; @r{autoload configuration}
495 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
496 (autoload 'wl "wl" "Wanderlust" t)
497 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
498 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
500 ;; @r{Directory where icons are placed.}
501 ;; @r{Default: the peculiar value to the running version of Emacs.}
502 ;; @r{(This is not required if the default value has been set properly)}
503 (setq wl-icon-directory "~/work/wl/etc")
505 ;; @r{SMTP server for mail posting. Default: @code{nil}}
506 (setq wl-smtp-posting-server "your.smtp.example.com")
507 ;; @r{NNTP server for news posting. Default: @code{nil}}
508 (setq wl-nntp-posting-server "your.nntp.example.com")
512 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
513 file exists). So it is convenient to gather Wanderlust specific settings
514 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
515 because you can't write them in @file{.emacs}
516 (if you write it to @file{.emacs}, you'll get an error).
519 All above described settings except @samp{(require 'mime-setup)} and autoload
520 configuration can be written in
523 @subsection @code{mail-user-agent}
524 @cindex Default Mailer
525 @cindex Mailer, Default
526 @vindex mail-user-agent
529 If you write following setting in you @file{.emacs}, you can
530 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
531 This means it enables you to run Wanderlust as a default mail composer
534 It is effective only when your Emacs can define @code{mail-user-agent}.
535 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
539 (autoload 'wl-user-agent-compose "wl-draft" nil t)
540 (if (boundp 'mail-user-agent)
541 (setq mail-user-agent 'wl-user-agent))
542 (if (fboundp 'define-mail-user-agent)
543 (define-mail-user-agent
545 'wl-user-agent-compose
554 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
555 @section Folder Definition
556 @cindex Folder Definition
559 You can skip this section because it is possible to add/edit the
560 subscribe folders from the buffer for list of folders.
561 @xref{Folder Manager}.
563 Define the folders you want to subscribe in file @file{~/.folders}. The
564 contents written in @file{~/.folders} become the folders which you
565 subscribe to as it is.
567 Format for @file{~/.folders} is very simple. Here is an example:
572 # @r{Lines begin with @samp{#} are comment.}
573 # @r{Empty lines are ignored}
575 # @var{folder name} "@var{folder nickname}"
576 # @r{(nicknames are not necessary)}
581 %#mh/Backup@@my.imap.example.com "Sent"
584 %#mh/spool/wl "Wanderlust ML"
585 %#mh/spool/elips "ELIPS ML"
586 %#mh/spool/apel-ja "APEL Japanese ML"
587 %#mh/spool/xemacs-beta "XEmacs beta"
588 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
589 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
592 # @r{If folder name ends with @samp{/}, that means an `access group',}
593 # @r{all subfolders automatically included in one folder group.}
595 %#mh/expire@@localhost /
596 # @r{All MH folders are included in one folder group.}
601 Each line contains one folder you want to read. The definition of
602 folders will be explained in detail in the next section.
604 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
605 become one folder group. One folder group is treated as a directory
606 which can be opened and closed in folder mode. It is convenient for
607 collecting some folders and putting them in order.
609 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
610 line and you have to write it that way (It is because the parser sucks).
612 There are two types of groups. One is like @samp{Emacsen} from above
613 example which the user chooses his favorite folders as a group.
615 The other one is @dfn{access group} like @samp{+ /} from above example.
616 It makes all the sub-folders in a folder to a group. (It differs from
617 the type of the folder. For example, @samp{+} followed by @samp{/}
618 makes entire MH sub-directories to one group)
620 This behavior is better understood if you try it and confirmed the
621 function first. You can write and try a small folder definition, so you
622 will know the idea of the folder function before writing the real one.
624 @node Start Wanderlust, , Folder Definition, Start Me Up
625 @section Start Wanderlust
626 @cindex Start Wanderlust
628 If installation and configuration worked well, you can invoke Wanderlust by
629 typing following command in Emacs.
636 After initialization, Folder Mode which shows the list of folders will appear.
637 That means the folders you defined in the @file{~/.folders} are listed
638 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
639 can skip folder checking.
641 Basically, you will handle messages in wanderlust while you come and go
642 from/to each of the following buffers.
646 You can see the list of folders. You can select some folder and go into the summary
647 of it. You can subscribe new folder or edit subscription list.
649 You can see the list of messages in the folder. You can select message and view its
650 contents, and reply to some message. You can delete ones or move ones to another
653 You can see the contents of the message. You can save part to disk or open in external
656 You can edit message.
659 Details of each ones are explained later.
662 @node Folders, Folder, Start Me Up, Top
663 @chapter Wanderlust's folders
666 This chapter describes the folder types which Wanderlust is able to handle.
668 Wanderlust uses ELMO as it's interface, so every folder types supported
669 by ELMO is usable in Wanderlust.
671 As of version @value{VERSION}, 11 types of folders are predefined. These are
672 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
673 Pipe and Internal folder types.
676 * IMAP Folder:: @samp{%} -- IMAP folder
677 * NNTP Folder:: @samp{-} -- NNTP folder
678 * MH Folder:: @samp{+} -- MH folder
679 * Maildir Folder:: @samp{.} -- Maildir folder
680 * News Spool Folder:: @samp{=} -- News spool folder
681 * Archive Folder:: @samp{$} -- Archive folder
682 * POP Folder:: @samp{&} -- POP folder
683 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
684 * Namazu Folder:: @samp{[} -- Namazu Folder
685 * Multi Folder:: @samp{*} -- Multi folder
686 * Filter Folder:: @samp{/} -- Filter folder
687 * Pipe Folder:: @samp{|} -- Pipe folder
688 * Internal Folder:: @samp{'} -- Internal folder
692 @node IMAP Folder, NNTP Folder, Folders, Folders
700 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
706 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
710 You can specify @code{login} (encoded password transmission),
711 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
712 authentication) or @code{clear} (or @code{nil}, plain password
713 transmission) as @var{authenticate-type}.
718 @var{username} -> The value of @code{elmo-imap4-default-user}.
719 Initial setting is @env{USER} environment variable or
720 @env{LOGNAME} environment variable or return value of
721 @code{(user-login-name)}.
722 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
723 Initial setting is "auth".
724 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
725 Initial setting is "localhost".
726 @var{port} -> The value of @code{elmo-imap4-default-port}.
727 Initial setting is 143.
730 You can omit the @var{hostname} from folder names if you set
731 @code{elmo-imap4-default-server} as your main IMAP server.
732 For example, you can specify a folder as @samp{foo%imap@@gateway} even
733 if you have to go through a firewall.
737 ;; @r{Example: imap4.exaple.org as main IMAP server}
738 (setq elmo-imap4-default-server "imap4.example.org")
742 SSL (Secure Socket Layer) connection will be used if a folder name ends
743 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
744 is @code{ssl}, SSL will be the default connection. If a folder name
745 ends with @samp{!!}, STARTTLS connection will be established. If the
746 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
747 STARTTLS will be the default connection.
751 ;; @r{Example: Use SSL connection}
752 (setq elmo-imap4-default-stream-type 'ssl)
756 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
757 authentication method, the password is sent in encoded form. But, if
758 your server is unable to receive an encoded password, authentication
759 will fall back to @code{clear} (that is, sending password in raw format)
760 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
761 authentication will fall back to @code{clear} without confirmation
762 (default value is @code{nil}).
766 ;; @r{Example: password in raw format}
767 (setq elmo-imap4-default-authenticate-type 'clear)
775 %inbox -> IMAP mailbox "inbox"
776 %#mh/inbox -> IMAP mailbox "#mh/inbox"
778 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
779 %inbox:hoge/clear@@server1
780 -> server1's IMAP mailbox "inbox"
781 of user "hoge", with plain password authentication
786 @subsection International mailbox names (Modified UTF7)
787 @cindex Modified UTF7
794 You can use international mailbox names in @var{mailbox} part, if you
795 are using Emacs which can treat unicode and
796 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
797 value is @code{nil}).
799 Currently, following Emacsen can treat unicode.
802 @item Emacs 20.3 or later + Mule-UCS
804 If you installed Mule-UCS package, Emacs can treat unicode.
805 You can obtain Mule-UCS package from following URL.
808 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
811 @item XEmacs 21.2.13 or later + ucs-conv package
813 By default, XEmacs 21 cannot treat unicodes, but if you installed
814 ucs-conv package, it can.
815 You can obtain ucs-conv package from following anonymous CVS.
819 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
820 Password: @var{NULL} (Just enter return key)
821 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
825 You also need utf7 conversion programs, @command{u7tou8} and
826 @command{u8tou7} to use international mailbox name in the current
827 XEmacs. These programs are included in the UTF7 package which can be
828 obtained from following URL.
831 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
836 @node NNTP Folder, MH Folder, IMAP Folder, Folders
847 A folder to access USENET news via NNTP protocol (RFC 977).
848 One newsgroup is treated as a folder.
854 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
860 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
861 Initial setting is @samp{localhost}.
862 @var{username} -> The value of @code{elmo-nntp-default-user}.
863 Initial setting is @code{nil}.
864 @var{port} -> The value of @code{elmo-nntp-default-port}.
865 Initial setting is 119.
868 AUTHINFO is used as authentication method if the @var{username} is
869 non-nil. SSL will be default method if
870 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
871 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
872 STARTTLS connection will be established. if the value of
873 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
874 be the default connection.
880 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
881 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
886 @node MH Folder, Maildir Folder, NNTP Folder, Folders
893 A folder to access MH format mail (1 file is 1 mail).
898 @samp{+} @var{directory-name}
901 Normally, @var{directory-name} is an relative path to the variable
902 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
903 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
904 (this is also true for drive-letters).
906 Message number is used for the name of the message file.
912 +inbox -> @file{~/Mail/inbox}
913 +from/teranisi -> @file{~/Mail/from/teranisi}
914 +~/test -> @file{~/test}
919 @node Maildir Folder, News Spool Folder, MH Folder, Folders
920 @section Maildir Folder
922 @cindex Maildir Folder
926 A folder to access Maildir format (1 file is 1 mail).
931 @samp{.} [@var{directory-name}]
934 Normally, @var{directory-name} is a relative path to the variable
935 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
936 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
937 (this is also true for drive-letters).
939 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
940 Messages are contained in the @file{cur} directory. All message files
941 in the @file{new} directory are moved to @file{cur} directory when you
942 access the folder. All message files contained in the @file{tmp}
943 directory and not accessed for 36 hours are deleted.
945 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
951 . -> @file{~/Maildir}
952 .inbox -> @file{~/Maildir/inbox}
953 .from/teranisi -> @file{~/Maildir/from/teranisi}
954 .~/test -> @file{~/test}
959 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
960 @section News Spool Folder
962 @cindex News spool Folder
965 This folder handles locally saved news articles which are proposed by
966 Mew/IM. You can also read articles directly from a spool-file which is
967 retrieved by an utility like @command{gnspool}.
972 @samp{=} @var{directory-name}
975 @var{directory-name} is a sub-directory to the directory defined by
976 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
977 You can use @samp{.} as directory delimiter as well as @samp{/}.
983 =fj/os/os2 -> @file{~/News/fj/os/os2}
984 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
989 @node Archive Folder, POP Folder, News Spool Folder, Folders
990 @section Archive Folder
992 @cindex Archive Folder
995 This method can handle archive files, which are compressed by utilities
996 such as Info-ZIP or LHA, as one folder.
1002 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1006 @var{path-name} is the relative path from
1007 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1008 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1009 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1010 also permitted under the environment of ange-ftp, efs.
1012 The actual file name of the archive folder is
1013 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1014 under the @var{path-name}. If a file named @var{path-name} exists, it is
1015 treated as folder. The suffix is automatically decided for
1016 @var{archiver-type}.
1018 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1019 (Initial setting is @code{zip}) is referred.
1021 @var{prefix} specifies the internal directory structure of the archive.
1022 For example, if the ML server is fml, @file{msend.tar.gz} has a
1023 structure like @file{spool/1}, so you have to specify @samp{spool} as
1030 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1031 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1032 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1033 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1034 $ml;zip/ -> Access group consists of archive folders
1035 under @file{~/Mail/ml}
1040 * Archiver:: Supported Archivers
1041 * Archive Tips:: TIPS
1042 * Archive Vars:: Customization
1046 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1047 @subsection Supported Archives
1057 By default, following archives are supported.
1061 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1062 GNU TAR('tgz, 'tar) ;; read-only
1066 If your archiver can include multiple files in one archive, you have a
1067 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1068 of the candidate. TAR is supported read-only because it cannot delete
1069 file in the archive (@code{mv})).
1071 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1072 archiver of Wanderlust because they cannot include multiple
1073 files. Archivers that cannot extract files to standard output are also
1076 @subsection OS specific information about archiver.
1078 Behaviors of the following archivers are confirmed by further experiences.
1079 (@samp{*} mark means recommended archiver).
1082 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1083 LHA OS/2 version Rel.2.06b Feb 18, 1998
1084 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1085 *Zip 2.2 (November 3rd 1997).
1086 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1087 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1088 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1090 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1091 LHa for UNIX V 1.14c
1092 UnZip 5.32 of 3 November 1997
1093 Zip 2.2 (November 3rd 1997)
1094 GNU tar 1.12 (1.11.x is no good)
1095 gzip 1.2.4 (18 Aug 93)
1097 [Win32] Win.98/Meadow
1101 GNU tar 1.11.8 + 1.5(WIN32)
1108 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1109 Hiramatsu version of LHA is only supported.
1110 In Win32, LHa32 is only supported (DOS version is no good).
1112 * Caution about GNU tar
1114 You have to take care about GNU tar's version because many version has
1115 problem on deleting file from archive.
1117 Please test @option{--delete} @option{-f} options work. Otherwise, your
1118 archive will be destroyed. No problem is reported on above versions of
1122 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1124 @cindex Archive Tips
1126 For comfortable migration, usage of @code{wl-summary-archive}
1127 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1128 archive folders created by expiration, you must set non-nil value to
1129 @code{elmo-archive-treat-file}.
1131 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1132 in processing speed. For comfortable use, Emacs20 is recommended.
1133 (If re-search's performance is the problem, 19.3x or later may be okay.)
1135 If many files are included in one archive,
1136 it takes long time to access the archive folder because
1137 archiver starting overhead is increased (especially LHA).
1138 150-200 messages in one archive is recommended.
1140 Of course, following is possible @t{:-)}
1141 (meanings of these variables are described later.)
1145 (setq wl-fcc "$backup")
1146 (setq wl-trash-folder "$trash;lha")
1150 @node Archive Vars, , Archive Tips, Archive Folder
1151 @subsection Variables About Archive Folder
1152 @cindex Archive variables
1155 @item elmo-archive-default-type
1156 @vindex elmo-archive-default-type
1157 The initial setting is @code{zip}.
1158 Set archiver type by symbol.
1160 @item elmo-archive-@var{type}-method-alist
1161 @vindex elmo-archive-TYPE-method-alist
1162 Define archiver @var{type}'s methods.
1163 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1164 Each element of the alist is following.
1168 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1169 (@var{action} . @var{function}) ;; function
1173 Currently available actions are following.
1177 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1178 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1185 actions enclosed with braces are optional (They are used for better
1188 @item elmo-archive-suffix-alist
1189 @vindex elmo-archive-suffix-alist
1190 An alist of archiver-type (symbol) and suffix.
1192 @item elmo-archive-file-regexp-alist
1193 @vindex elmo-archive-file-regexp-alist
1194 An alist of a regexp to get file number from list output of archiver
1195 and archiver-type (symbol).
1197 @item elmo-archive-method-list
1198 @vindex elmo-archive-method-list
1199 A list of elmo-archive-@var{type}-method-alist
1200 (@var{type} is a symbol of archiver-type).
1202 @item elmo-archive-lha-dos-compatible
1203 @vindex elmo-archive-lha-dos-compatible
1204 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1205 DOS (Mr. Yoshizaki original) compatible.
1207 @item elmo-archive-cmdstr-max-length
1208 @vindex elmo-archive-cmdstr-max-length
1209 The initial setting is 8000.
1211 Max length of command line argument for external archiver program.
1212 Emacs does not have a limit of command line byte length, but some OS
1213 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1214 this limit because it calls external archiver program directly (not
1215 called via shell). For example, you cannot delete messages if archiver
1216 program must receive larger bytes of arguments to delete. OS/2 have a
1217 command line argument limit of 8190 bytes, so we defined default as 8000
1220 However, you don't have an influence of command line argument limit
1221 if the archiver has `actions' to receive target file information from
1222 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1226 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1234 A folder to access e-mails via POP3 protocol (RFC 1939).
1240 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1245 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1246 as @var{authenticate-type}.
1248 You can specify @samp{uidl} (use UIDL command for message numbering) or
1249 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1253 @var{username} -> The value of @code{elmo-pop3-default-user}.
1254 Initial setting is @env{USER} environment variable or
1255 @env{LOGNAME} environment variable or return value of
1256 @code{(user-login-name)}.
1257 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1258 Initial setting is @samp{user}.
1259 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1260 If t, use UIDL for numbering. Initial setting is t.
1261 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1262 Initial setting is @samp{localhost}.
1263 @var{port} -> The value of @code{elmo-pop3-default-port}.
1264 Initial setting is 110.
1271 &hoge@@localhost -> access localhost as user @samp{hoge}.
1272 &hoge@@popserver:109 -> access the server "popserver" on port 109
1273 as user @samp{hoge}.
1277 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1278 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1279 @file{utils/sasl/lisp/} or Emacs/W3 package
1280 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1283 If the last character of the folder name is @samp{!}, Wanderlust
1284 connects to the POP server via SSL (Secure Socket Layer). If you set
1285 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1286 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1287 with @samp{!!}, STARTTLS connection will be established. if the value
1288 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1292 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1293 @section Shimbun Folder
1295 @cindex Shimbun Folder
1296 @cindex Folder, Shimbun
1301 A folder for watching "shimbun" (means "newspaper" in Japanese),
1302 news site and mailing list archives on WWW by using emacs-w3m
1303 (@uref{http://emacs-w3m.namazu.org/}).
1305 You should possess w3m and emacs-w3m to use this.
1311 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1315 Admissible values of @var{module-name} and @var{folder-name} are
1316 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1322 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1323 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1327 @subsection Variables About Shimbun Folder
1330 @item elmo-shimbun-update-overview-folder-list
1331 @vindex elmo-shimbun-update-overview-folder-list
1332 The initial setting is @code{nil}. You can specify a list of regular
1333 expressions of shimbun folder names. The overview of matched shimbun
1334 folder is updated when messages are fetched.
1335 You should @kbd{s rescan} after fetching to update summary.
1339 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1340 @section Namazu Folder
1342 @cindex Namazu Folder
1343 @cindex Folder, Namazu
1344 @cindex Folder, Text Search
1347 A folder to access messages found in namazu-index with some condition.
1348 It uses namazu (@uref{http://www.namazu.org/}) for search.
1354 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1358 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1364 [wanderlust] -> search messages matched with
1365 "wanderlust" from the default index
1366 [semi flim]~/Mail/semi -> search "semi flim" from the index
1367 in the directory "~/Mail/semi"
1373 @subsubsection Enter space to separate keywords
1375 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1377 @subsubsection Alias name for index
1379 You can define an alias name for index.
1384 (setq elmo-nmz-index-alias-alist
1385 '(("cache" . "~/.elmo/cache")
1386 ("docs" . "~/documents")))
1389 Above definition defines two index aliases.
1396 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1397 directory @file{~/.elmo/cache}.
1399 @subsubsection Multiple indices
1401 You can specify a list for @code{elmo-nmz-default-index-path} and
1402 @code{elmo-nmz-index-alias-alist}.
1403 When list is specified, all index contained in the list is used as the
1409 (setq elmo-nmz-index-alias-alist
1410 '(("all" . ("~/.elmo/cache" "~/documents"))
1411 ("cache" . "~/.elmo/cache")))
1414 Using above alias setting, you can specify
1420 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1421 directory @file{~/.elmo/cache} and @file{~/documents}.
1423 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1424 @section Multi Folder
1426 @cindex Multi Folder
1427 @cindex Folder, Multiple
1428 @cindex Folder, Marge
1430 A folder to access virtual folder which collects messages from
1437 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1441 After @samp{*} character, specify multiple folders you want to collect
1442 separated by @samp{,} like
1443 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1449 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1450 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1451 treated as one folder.
1453 *+inbox,-fj.rec.tv,%inbox
1454 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1459 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1460 @section Filter Folder
1462 @cindex Filter Folder
1463 @cindex Folder, Filtering
1464 @cindex Folder, Virtual
1465 @cindex Folder, Conditional
1467 A folder to access virtual folder which collects all messages that
1468 satisfy a condition.
1473 @samp{/} @var{condition} @samp{/} @var{target-folder}
1476 In the @var{condition} part, you can specify following.
1480 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1482 first: @var{number} messages are picked from top of folder.
1483 last: @var{number} messages are picked from bottom of folder.
1489 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1490 /first:20/%inbox -> First 20 messages from %inbox are picked.
1495 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1497 since: only messages arrived since @var{date} are picked.
1498 before: only messages arrived before @var{date} are picked.
1500 You can specify following as @var{date}.
1504 yesterday -> a day before today.
1505 lastweek -> same day of last week.
1506 lastmonth -> same day of last month.
1507 lastyear -> same day of last year.
1508 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1509 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1517 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1519 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1525 Field filter: @samp{@var{field}:@var{value}}
1527 All messages that have @var{field} and its value is @var{value} are picked.
1528 @var{field} and @var{value} are case insensitive.
1534 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1535 and its value includes "teranisi" string are picked.
1536 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1544 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1545 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1547 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1548 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1554 /from:teranisi&!to:teranisi/+inbox
1555 -> In +inbox, messages are picked if the message's
1556 From: field includes "teranisi" and
1557 To: field doesn't include "teranisi".
1559 /tocc:"Yuuichi Teranishi"/+inbox
1560 -> In +inbox, messages are picked if the
1561 message's To: field or Cc: field includes
1562 "Yuuichi Teranishi".
1564 /(from:yt|from:teranisi)&subject:report/+inbox
1565 -> In +inbox, messages are picked if the message's
1566 From: field includes "yt" or "teranisi", and
1567 Subject includes "report".
1573 Tip for string description:
1575 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1576 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1577 should be escaped with @samp{\} in it). You can enclose the string with
1578 @samp{"} even it does not contain these characters.
1584 *%inbox,/from:teranisi/%inbox@@server
1585 -> Messages in %inbox or
1586 message is in the %inbox@@server folder and it's From field
1587 includes "teranisi" are collected.
1589 /last:100//to:teranisi/*+inbox,%inbox
1590 -> Latest 100 messages which is in the +inbox or %inbox folder
1591 and To: field matches "teranisi".
1593 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1594 -> Pick messages which have From: field and it includes "hogehoge"
1595 from latest 20 messages in the %#mh/inbox@@localhost
1596 and To: or Cc: field includes "teranisi".
1599 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1600 @section Pipe Folder
1604 @cindex Download Message
1605 @cindex Incorporate Message
1607 In the pipe folder, messages are automatically transferred from the source
1608 folder to destination folder.
1613 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1616 When you access the pipe folder, messages are automatically transferred
1617 from @var{source-folder} to @var{destination-folder}.
1618 It is convenient if you want to download messages to local disk via POP.
1619 For example, if you specify following
1622 |&username@@popserver|+inbox
1626 and access it, messages are downloaded automatically from
1627 @samp{&username@@popserver} to @samp{+inbox}.
1629 On the other hand, if you put @samp{|:} instead of second @samp{|},
1630 then messages are copied to the destination folder (not deleted from
1631 source-folder). At the next time you access that folder, only new
1632 messages will be copied.
1635 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1638 If you want to copy messages from POP server and view them, specify the
1642 |&username@@popserver|:+inbox
1645 where messages will be kept on the server.
1651 |%inbox|%myinbox -> Download %inbox to %myinbox.
1652 |*&user@@popserver1,&user@@popserver2|+inbox
1653 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1654 |-gnu.emacs.sources|:+sources
1655 -> Copy messages from -gnu.emacs.sources to +sources.
1659 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1661 @node Internal Folder, , Pipe Folder, Folders
1662 @section Internal folder
1664 @cindex Internal Folder
1665 @cindex Folder, @samp{$} mark
1667 @c @cindex Folder, Null
1669 A folder to access internal messages of Wanderlust.
1681 A folder named @samp{'mark} is a special virtual folder which collects
1682 messages which have important mark @samp{$}.
1684 You can review important messages at once after you put important marks
1685 on the messages in the different folders.
1687 In this folder, if you delete message, important mark @samp{$} put on
1688 the message is removed. If you append messages to this folder, the
1689 message will have @samp{$} mark.
1691 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1692 folder. If you want IMAP folder's message remove from @samp{'mark}
1693 folder, remove important mark at IMAP Folder.)
1696 A folder named @samp{'sendlog} is a virtual folder which collects
1697 cached messages which are recoded on @file{~/.elmo/sendlog}.
1698 It might be useful when you forgot to add cc for yourself.
1699 To use this, you should set @code{wl-draft-use-cache} to non-nil
1700 so that sent messages are cached.
1703 You can access cached messages fetched via network by accessing
1704 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1705 the name of the subdirectories of the cache directory
1706 (@file{~/.elmo/cache}).
1709 @node Folder, Summary, Folders, Top
1710 @chapter Folder mode
1713 After you start Wanderlust, folder mode is appeared firstly.
1714 It contains folder list you subscribed.
1715 You can select and edit folders in this mode.
1718 * Selecting Folder:: Select folder you want to read
1719 * Folder Manager:: Editing folders
1723 @node Selecting Folder, Folder Manager, Folder, Folder
1724 @section Selecting Folder
1725 @cindex Selecting Folder
1727 @subsection Usage (TIPS)
1729 @subsubsection Check new, unread number
1731 Folder mode looks like this.
1732 (In XEmacs, it looks much nicer @t{;-)})
1736 [-]Desktop:14186/35580/67263
1741 [-]Emacsen:0/34/4837
1742 Wanderlust ML:0/0/558
1745 XEmacs Beta:0/29/255
1756 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1760 @kbd{s} key on the folder line updates these numbers.
1761 It changes its color if it has many new messages.
1763 The whole folder mode is a folder group named @samp{Desktop}.
1764 Folder group open/close by return key.
1765 A operation to a folder group is treated as operations on the
1767 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1768 six children folders update its unread number status.
1770 @subsubsection Select Folder
1772 To enter summary mode of the folder, type return (or space) key on
1774 If the variable @code{wl-stay-folder-window} has non-nil value,
1775 summary window appears on the right of the folder mode window.
1777 @subsection Key bindings
1779 Folder mode's key binding (related to selecting folders) is following.
1784 @kindex @key{SPC} (Folder)
1785 @kindex @key{RET} (Folder)
1786 @findex wl-folder-jump-to-current-entity
1787 Enter to the summary mode of the folder at the current cursor point.
1788 With prefix argument, enter the sticky summary.
1789 If the cursor is on the top of folder group line,
1790 the folder group is opened or closed.
1791 When the cursor is on the access group and this command is called
1792 with prefix argument, folder children list is updated to the newest one.
1793 (Children list is updated recursively if the access folder has hierarchical
1795 (@code{wl-folder-jump-to-current-entity})
1798 @kindex M-@key{RET} (Folder)
1799 @findex wl-folder-update-recursive-current-entity
1800 Folder children list of the access group at the current cursor point
1801 is updated to the newest one.
1802 (Children list is updated recursively if the access folder has hierarchical
1804 (@code{wl-folder-update-recursive-current-entity})
1809 Create a new draft message.
1814 @findex wl-folder-write-current-folder
1815 If the current cursor point is on the NNTP folder, create a new draft
1816 message which already has @samp{Newsgroups:} field. If the current
1817 cursor point is on the folder for mailing list (refile destination),
1818 create a new draft message which already has @samp{To:} field with
1819 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1821 (@code{wl-folder-write-current-folder})
1824 @kindex C-c C-o (Folder)
1825 @findex wl-jump-to-draft-buffer
1826 Move to the draft buffer if available. If multiple draft buffer exists,
1827 moved to one after another. If prefix argument is specified, load draft
1828 folder's message to the draft buffer and jump to it.
1829 (@code{wl-jump-to-draft-buffer})
1833 @findex wl-folder-check-current-entity
1834 Update new and unread number information of the folder at the current
1836 (@code{wl-folder-check-current-entity})
1840 @findex wl-folder-sync-current-entity
1841 Update summary information of the folder at the current cursor point.
1842 (@code{wl-folder-sync-current-entity})
1845 @kindex r s (Folder)
1846 @findex wl-folder-check-region
1847 Update new and unread number information of the folders in the currently
1849 (@code{wl-folder-check-region})
1852 @kindex r S (Folder)
1853 @findex wl-folder-sync-region
1854 Update summary information of the folders in the currently selected region.
1855 (@code{wl-folder-sync-region})
1859 @findex wl-status-update
1860 Sync up address book status with @file{~/.addresses}'s content.
1861 (@code{wl-status-update})
1865 @findex wl-folder-prev-unread
1866 Jump cursor to the folder which have unread messages on the upward from
1867 current cursor point.
1868 (@code{wl-folder-prev-unread})
1872 Jump cursor to the folder which have unread messages on the downward
1873 from current cursor point.
1874 (@code{wl-folder-next-unread})
1878 Move cursor to the folder on the previous line.
1879 (@code{wl-folder-prev-entity})
1883 Move cursor to the folder on the next line.
1884 (@code{wl-folder-next-entity})
1888 Jump to the folder specified by the user input.
1889 (@code{wl-folder-jump-folder})
1893 @findex wl-folder-prefetch-current-entity
1894 Prefetch new messages of the folder at the current cursor point by
1895 @code{wl-summary-incorporate}.
1896 If the cursor is on the folder group, it is executed recursively.
1897 (@code{wl-folder-prefetch-current-entity})
1901 @findex wl-folder-mark-as-read-all-current-entity
1902 Mark all unread messages of the folder at the current cursor point as read.
1903 If the cursor is on the folder group, it is executed recursively.
1904 (@code{wl-folder-mark-as-read-all-current-entity})
1908 @findex wl-folder-goto-first-unread-folder
1909 Enter summary mode of the first unread folder.
1910 (@code{wl-folder-goto-first-unread-folder})
1914 @findex wl-folder-empty-trash
1916 (@code{wl-folder-empty-trash})
1920 @findex wl-folder-flush-queue
1922 (@code{wl-folder-flush-queue})
1926 @findex wl-folder-virtual
1927 Move to the virtual folder with the condition specified.
1928 (@code{wl-folder-virtual})
1932 @findex wl-folder-pick
1933 Search the folders with the condition specified.
1934 (@code{wl-folder-pick})
1938 @findex wl-folder-open-all-unread-folder
1939 All unread folder is opened.
1940 (@code{wl-folder-open-all-unread-folder})
1944 @findex wl-folder-open-close
1945 Folder group is opened/closed.
1946 (@code{wl-thread-open-close})
1950 All folder group is opened.
1951 (@code{wl-folder-open-all})
1955 All folder group is closed.
1956 (@code{wl-folder-close-all})
1966 (@code{wl-folder-suspend})
1969 @kindex M-s (Folder)
1970 Save current folder status.
1974 @kindex M-t (Folder)
1975 Toggle Wanderlust's offline/online status.
1976 (@code{wl-toggle-plugged})
1979 @kindex C-t (Folder)
1980 Start Wanderlust's plug-status manager.
1981 (@code{wl-plugged-change})
1984 @subsection Customize variables
1987 @item wl-folders-file
1988 @vindex wl-folders-file
1989 The initial setting is @file{~/.folders}.
1990 Subscribed folders are described (saved) in this file.
1992 @item wl-folder-info-save
1993 @vindex wl-folder-info-save
1994 The initial setting is @code{t}. If non-nil, unread information is
1995 saved and used in the next Wanderlust session.
1997 @item wl-stay-folder-window
1998 @vindex wl-stay-folder-window
1999 The initial setting is @code{nil}.
2000 If non-nil, summary window is appeared on the right side of the folder buffer.
2002 @item wl-folder-window-width
2003 @vindex wl-folder-window-width
2004 The initial setting is 20.
2005 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2007 @item wl-folder-use-frame
2008 @vindex wl-folder-use-frame
2009 The initial setting is @code{nil}.
2010 If non-nil, use new frame for the folder window.
2012 @item wl-folder-many-unsync-threshold
2013 @vindex wl-folder-many-unsync-threshold
2014 The initial setting is 70.
2015 If the number of unread messages is more than this value,
2016 folder color is changed.
2018 @item wl-highlight-folder-by-numbers
2019 @vindex wl-highlight-folder-by-numbers
2020 This option controls how to highlight each line in the folder buffer.
2021 The default value is @code{t}, highlighting with various colors based on
2022 the message numbers. If it is @code{nil}, highlighting with various
2023 colors based on the folder status. In addition, if it is a number
2024 (e.g. 1), highlighting will be done based on both the message numbers
2025 and the folder status.
2027 @item wl-folder-desktop-name
2028 @vindex wl-folder-desktop-name
2029 The initial setting is @samp{Desktop}.
2030 The name of top folder group.
2032 @item wl-folder-petname-alist
2033 @vindex wl-folder-petname-alist
2034 The initial setting is @code{nil}.
2035 An alist of folder's realname and its nickname.
2037 @item wl-folder-access-subscribe-alist
2038 @vindex wl-folder-access-subscribe-alist
2039 The initial setting is @code{nil}.
2041 Control automatic subscribing and unsubscribing of the children list
2047 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2051 If @var{subscribe-flag} is non-nil, folders which have name matched to
2052 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2053 already unsubscribed folder is not displayed even when the
2054 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2061 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2062 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2063 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2064 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2068 @item wl-folder-hierarchy-access-folders
2069 @vindex wl-folder-hierarchy-access-folders
2070 The initial setting is the list shown below:
2079 A list of regular expressions for access groups which creates children
2080 folder list hierarchically.
2082 For example, if you specify
2083 @code{wl-folder-hierarchy-access-folders} like following,
2087 (setq wl-folder-hierarchy-access-folders
2088 '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
2093 such access group hierarchy is obtained.
2099 -fj.comp.announce:0/0/2
2100 -fj.comp.dev.cdrom:0/0/0
2102 [+]-japan:238/238/1688
2105 -comp.unix.admin:0/0/0
2106 -comp.unix.dos-under-unix:0/0/0
2107 -comp.unix.programmer:0/0/0
2108 [-]-comp.unix.bsd:0/0/23
2109 -comp.unix.bsd.freebsd.announce:0/0/0
2114 If you opened @samp{-} in this example, only the direct children is created
2115 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2116 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2117 is not created until the children access group is opened.
2121 @node Folder Manager, , Selecting Folder, Folder
2122 @section Editing Folders
2123 @cindex Folder Manager
2124 @cindex Folder, Edit
2125 @cindex Folder, Subscribe
2126 @cindex Folder, Unsubscribe
2128 As described before, subscribed folder list is saved in @file{~/.folders} file.
2129 But you don't have to edit @file{~/.folders} directly.
2130 You can append, delete, edit folders from folder mode.
2132 @subsection Usage (Tips)
2134 @subsubsection Append Folder
2136 @kbd{m a} appends new folder to the folder mode.
2137 @kbd{m g} appends new folder group.
2138 To append new folder to this group, firstly open it,
2139 then execute append command in the next line.
2141 @subsubsection Edit Folder
2143 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2144 Thus, you can change folder position as if you were editing a normal file.
2146 @subsubsection Create Multi Folder.
2150 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2152 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2154 Type @kbd{m m}, then you can create multi folder.
2157 @subsubsection Delete Nickname, Filter
2159 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2160 minibuffer while appending.
2162 @subsubsection Append Folder to Empty Group
2164 To append new folder to the empty folder group
2165 (after you create folder group by typing @kbd{m g}),
2166 firstly open it, then execute append command in the next line.
2167 If it is closed, folder is appended on the same level with
2168 the above folder group. It is difficult to explain by words so try it.
2169 In other words, appended position depends on the
2170 above folder group's open/close status.
2172 @subsubsection Charset of the Folders File.
2174 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2176 @subsubsection Create Filter
2178 @kbd{m f} adds filter to the folder at the current cursor point. To
2179 create new filter folder and leave the current folder unchanged, copy it
2180 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2181 filter can be specified while appending filter. If you put
2182 ``''(@var{NULL}), filter is deleted.
2184 @subsubsection Sort Folders
2186 Sorting of the folders is executed by the function specified by
2187 @code{wl-fldmgr-sort-function}.
2188 The initial setting is @code{wl-fldmgr-sort-standard},
2189 which sorts alphabetically.
2190 Sorting affects only on the current folder group. It does not
2191 affect on the child groups.
2193 @subsubsection Hiding Folders in the Access Group
2195 Usually, access group displays all children folders, but you can set
2196 some folders hidden. Following operations are only available on access
2199 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2200 (subscribe/unsubscribe) of the folder at current cursor point. Against
2201 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2204 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2205 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2206 argument and if the argument has positive number, the unsubscribe it.
2207 If the prefix argument has negative value, folder becomes visible and if
2208 zero, folder visibility is toggled.
2210 The other commands, @code{wl-fldmgr-subscribe} and
2211 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2214 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2215 executed in the access group, they have a same effect with
2216 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2217 The difference is that cut commands deletes folders from the current
2220 @subsubsection Operations in the Access Group
2222 You can insert and delete folders in the access group like usual folder
2223 group. But insert and delete commands can be only available for the
2224 children folders of the access group and they only sets the subscribe
2225 status. In other words, insertion of the folder means subscribing,
2226 deletion means unsubscribing.
2227 @footnote{In the current implementation,
2228 it is faster to delete region than to unsubscribe region.}
2230 To update the access group when children folders are inserted or deleted
2231 by other way (other than Wanderlust),
2232 open the access group by typing @kbd{C-u @key{RET}}.
2233 @xref{Selecting Folder}.
2235 The order of children folders of access group is saved after
2236 insertion/deletion/sorting.
2237 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2238 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2239 newly created folders are inserted on the top of the access group.
2241 @subsection Key bindings
2242 @cindex Keybind, Folder Mode
2243 @cindex Keybind, Folder Buffer
2245 Key bindings on the folder mode related to folder editing are shown below.
2246 All bindings starts with @kbd{m}, and primary commands are binded to
2247 one stroke key binding.
2251 @kindex m a (Folder)
2252 @findex wl-fldmgr-add
2254 (@code{wl-fldmgr-add})
2259 @kindex m g (Folder)
2260 @findex wl-fldmgr-make-group
2261 Create a folder group.
2262 (@code{wl-fldmgr-make-group})
2265 @kindex m A (Folder)
2266 @findex wl-fldmgr-make-access-group
2267 Create an access group.
2268 (@code{wl-fldmgr-make-access-group})
2271 @kindex m d (Folder)
2272 @findex wl-fldmgr-delete
2273 Delete folder itself and msgdb.
2274 If the folder itself cannot be deleted like NNTP folder,
2275 only msgdb is deleted.
2276 (@code{wl-fldmgr-delete})
2281 @kindex m R (Folder)
2282 @findex wl-fldmgr-rename
2283 Change the name of folder or folder group.
2284 msgdb's path is also changed.
2285 (@code{wl-fldmgr-rename})
2291 @findex wl-fldmgr-make-multi
2292 Create a multi folders in the cutlist (cut, copied folders).
2293 (@code{wl-fldmgr-make-multi})
2298 @kindex m f (Folder)
2299 @findex wl-fldmgr-make-filter
2300 Create a filter folder. (Put a filter on the folder).
2301 (@code{wl-fldmgr-make-filter})
2305 @kindex M-c (Folder)
2306 @kindex m c (Folder)
2307 @findex wl-fldmgr-copy
2308 Copy folder (it is not available on folder group).
2309 (@code{wl-fldmgr-copy})
2313 @kindex M-w (Folder)
2314 @kindex m W (Folder)
2315 @findex wl-fldmgr-copy-region
2316 Copy folders in the specified region.
2317 (@code{wl-fldmgr-copy-region})
2321 @kindex C-k (Folder)
2322 @kindex m k (Folder)
2323 @findex wl-fldmgr-cut
2324 Cut folder. Folder itself is not deleted.
2325 (@code{wl-fldmgr-cut})
2329 @kindex C-w (Folder)
2330 @kindex m C-w (Folder)
2331 @findex wl-fldmgr-cut-region
2332 Cut folders in the specified region.
2333 (@code{wl-fldmgr-cut-region})
2337 @kindex C-y (Folder)
2338 @kindex m y (Folder)
2339 @findex wl-fldmgr-yank
2340 Paste folders that are copied or cut (folders in the cut-list).
2341 (@code{wl-fldmgr-yank})
2344 @kindex m p (Folder)
2345 @findex wl-fldmgr-set-petname
2346 Put nickname on the folder.
2347 (@code{wl-fldmgr-set-petname})
2350 @kindex m q (Folder)
2351 @findex wl-fldmgr-clear-cut-entity-list
2352 Clear the cut-list. (cut, copied folder information is cleared,
2353 you cannot paste after this)
2354 (@code{wl-fldmgr-clear-cut-entity-list})
2357 @kindex m s (Folder)
2358 @findex wl-fldmgr-sort
2359 Sort folders in the current folder group.
2360 (@code{wl-fldmgr-sort})
2363 @kindex m C-s (Folder)
2364 @findex wl-fldmgr-save
2365 Save current folder view to the @file{wl-folders-file}.
2366 (@code{wl-fldmgr-save})
2369 [Following commands are only available on the access groups]
2375 @kindex m u (Folder)
2376 @findex wl-fldmgr-unsubscribe
2377 Set the visibility of folder (subscribe/unsubscribe).
2378 (@code{wl-fldmgr-unsubscribe})
2383 @kindex r u (Folder)
2384 @findex wl-fldmgr-unsubscribe-region
2385 Set the visibility of the folders (subscribe/unsubscribe) in the
2387 (@code{wl-fldmgr-unsubscribe-region})
2392 @kindex m l (Folder)
2393 @findex wl-fldmgr-access-display-normal
2394 List folders that are currently available.
2395 (@code{wl-fldmgr-access-display-normal})
2400 @kindex m L (Folder)
2401 @findex wl-fldmgr-access-display-all
2402 List all folders regardless of the subscription status.
2403 (@code{wl-fldmgr-access-display-all})
2407 @subsection Customize variables
2410 @item wl-interactive-save-folders
2411 @vindex wl-interactive-save-folders
2412 The initial setting is @code{t}. If non-nil and folder view is
2413 modified, confirm saving it before Wanderlust or Emacs exits. If
2414 @code{nil}, save without confirmation.
2416 @item wl-fldmgr-make-backup
2417 @vindex wl-fldmgr-make-backup
2418 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2419 created before saving the folder status.
2421 @item wl-fldmgr-sort-function
2422 @vindex wl-fldmgr-sort-function
2423 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2424 sort folders. By default function, folders are sorted alphabetically
2425 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2428 @item wl-fldmgr-sort-group-first
2429 @vindex wl-fldmgr-sort-group-first
2430 The initial setting is @code{t}. If non-nil,
2431 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2432 does not care whether it is folder group or not.
2434 @item wl-folder-check-async
2435 @vindex wl-folder-check-async
2436 The initial setting is @code{t}. If non-nil, check folder's unread
2437 status asynchronously. It boosts newsgroup checking.
2439 @item wl-folder-check-fast
2440 @vindex wl-folder-check-fast
2441 The initial setting is @code{nil}.
2442 If non-nil, it does not update folder status while checking.
2444 @item wl-folder-notify-deleted
2445 @vindex wl-folder-notify-deleted
2446 The initial setting is @code{nil}.
2448 If non-nil, negative value is displayed when the message is deleted. If
2449 @code{sync}, folder is synchronized when the message is deleted. If
2450 @code{nil}, message deletion is ignored.
2452 @item wl-fldmgr-add-complete-with-current-folder-list
2453 @vindex wl-fldmgr-add-complete-with-current-folder-list
2454 The initial setting is @code{nil}.
2455 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2456 candidate for @code{wl-fldmgr-add}.
2459 @subsection Miscellanea
2461 Following is a note for folder editing.
2465 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2466 paste(yank) command pastes the folders on one cut or copy command
2467 (If copy command is executed by region, folders in the region are pasted
2468 by one paste command)
2471 You cannot cut @samp{Desktop} group.
2472 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2475 You cannot copy folder group.
2478 Operations on the access group are only available for the folders
2479 in the same access group.
2482 You cannot create a folder which has same name with the folders already exist.
2485 You cannot insert folders which have same name in one group.
2486 You can insert them in the different groups.
2487 You cannot put same nickname to the different folders.
2491 @node Summary, Message, Folder, Top
2492 @chapter Summary Mode
2494 After you select the folder via folder mode, you enter to the summary
2498 * Usage of Summary Mode:: TIPS
2499 * Thread Operations:: Thread operations
2500 * Cache:: File cache, Buffer cache, and Prefetch
2501 * Auto Refile:: Auto refile settings
2502 * Sticky Summary:: Summary make sticky
2503 * Key Bindings of Summary:: Key bindings
2504 * Variables of Summary:: Customize Summary Mode
2508 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2509 @section Usage (Tips)
2511 @subsection Summary Content
2513 In the summary mode, messages are displayed like following.
2517 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2518 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2519 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2520 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2527 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2531 You cannot change this in the current version.
2533 @var{Message number} is the message's unique number in the folder. In
2534 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2535 in the MH folder, it is the filename of the message.
2537 @var{Temporal mark} and @var{Persistent mark} are described later.
2539 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2540 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2541 Japanese, but if you want to display it in English, set the value of
2542 @code{wl-summary-weekday-name-lang} as @samp{en}.
2544 @var{Sender}'s indentation corresponds to the depth of the thread.
2545 Sender name is displayed as nickname if it is defined in the address
2546 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2547 displaying with nickname.
2549 If number is printed at the head of @var{Sender} part like @samp{+2},
2550 that means the message have 2 follow messages.
2552 @var{Subject} is the @samp{Subject:} header field of the message. If
2553 the message have same @samp{Subject:} with the parent message, it is not
2554 displayed. Some mailing list puts its sequence number in the
2555 @samp{Subject:} field, but it is
2556 ignored. @code{wl-summary-no-subject-message} is displayed when the
2557 message has empty subject field.
2559 @subsection Temporary Marks
2560 @cindex Mark, Temporary
2562 There are four temporary marks,
2563 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2564 Temporary marks indicates message operations.
2569 You can execute a command on the all messages that have @samp{*} mark,
2570 with the key bindings which begins with @kbd{m}.
2573 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2577 After you type @kbd{o} key, prompt appears to input refile destination.
2578 Your answer is printed in the summary line.
2582 You can put this mark by typing @kbd{O} key.
2583 The difference between this mark and refile mark is,
2584 this mark does not delete the message while latter does.
2587 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2589 @subsection Persistent Marks
2591 There are five persistent marks,
2592 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2594 The persistent mark indicates the message's status and it is saved.
2595 Each persistent mark indicates:
2601 It is unread message.
2603 It is unread but cached message.
2605 It is read but it is not cached.
2607 It is important message. You can put @samp{$} mark by typing @kbd{$}
2608 key (if already exists, the mark is deleted). It is convenient to put
2609 this mark on the messages to remember (If you want to remember to write
2610 a reply for the message, for example) because this mark remains after
2611 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2612 @samp{'mark} folder even the message itself is deleted in the actual folder.
2615 If the message is read and cached (or local message),there are no
2619 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2620 cache. Messages with the marks other than these, you can read them in
2621 the offline status even they are in the IMAP folder or netnews folder.
2623 Among messages with persistent marks, ones with marks specified by
2624 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2625 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2627 @subsection How To Read
2629 Basically, you can read messages only typing space key again and again.
2631 To update summary status to the newest status (synchronize),
2634 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2635 moves cursor to the next message.
2636 Enter message buffer by typing @kbd{j} key.
2637 To operate multipart, you have to enter to the message buffer.
2640 @subsection Pack the Message Numbers
2641 You can pack the message numbers in Summary by
2642 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2643 News Spool Folder and Maildir Folder are supported folder types.
2646 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2647 @section Thread Operations
2649 For example, the following line indicates one thread (a context of a topic).
2652 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2656 If you type @kbd{/} on this line, the thread is opened and it changes
2657 the appearance like following.
2661 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2662 388 09/17(Thu)22:34 +-[ Murata san ]
2666 (Message 388 is the replied message to the message 384.)
2667 If you type @kbd{/} key once again, the thread is closed.
2668 With prefix argument, @kbd{/} opens all children threads.
2670 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2673 Commands with the key binding that begins with @kbd{t} executes commands
2674 on the messages in the thread.
2675 @xref{Key Bindings of Summary}.
2677 @subsection reconstruct thread by hand
2679 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2680 (@code{wl-summary-save-current-message}) at the corresponding message,
2681 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2682 message then you have the reconstructed thread.
2685 @node Cache, Auto Refile, Thread Operations, Summary
2688 @subsection Cache File
2690 The messages which have to access via network (e.x. IMAP, NNTP folder)
2691 are cached as a local file. The cache file is saved under the directory
2692 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2693 elmo-cache-expire-by-size}. The command deletes cache files to the
2694 specified size by the order of last accessed time.
2696 @subsection Buffer Cache and Prefetching
2698 The messages that are read are kept in the cache buffer. It is called
2699 `buffer cache'. The number of cache buffer is specified by
2700 @code{wl-message-buffer-cache-size}.
2702 There are message prefetching mechanism in the Wanderlust that
2703 prefetches next message while you are reading.
2705 You can control the message prefetching mechanism by these two
2709 @item wl-message-buffer-prefetch-folder-type-list
2710 @vindex wl-message-buffer-prefetch-folder-type-list
2711 The initial setting is @code{t}. In this case, prefetch messages in all
2713 If it is a list of folder types, it specifies the folder types in which
2714 message prefetching is enabled.
2715 Following is an example (prefetch messages in nntp and imap4 folders)
2719 (setq wl-message-buffer-prefetch-folder-type-list
2724 In this case, multi folder that contains localdir and imap4 prefetches
2725 only imap4 messages. This variable precedes the value of
2726 @code{wl-message-buffer-prefetch-folder-list}.
2728 @item wl-message-buffer-prefetch-folder-list
2729 @vindex wl-message-buffer-prefetch-folder-list
2730 The initial setting is @code{nil}.
2731 A list of regexp of folders to enable message prefetching.
2733 @item wl-message-buffer-prefetch-depth
2734 @vindex wl-message-buffer-prefetch-depth
2735 The initial setting is 3. The number of messages for automatical prefetch.
2737 @item wl-message-buffer-prefetch-idle-time
2738 @vindex wl-message-buffer-prefetch-idle-time
2739 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2741 @item wl-message-buffer-prefetch-threshold
2742 @vindex wl-message-buffer-prefetch-threshold
2743 The initial setting is 30000 (bytes). If prefetching message has larger
2744 size than this value, Wanderlust does not prefetch automatically.
2745 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2746 the message is not checked for the size.
2748 @item wl-auto-prefetch-first
2749 @vindex wl-auto-prefetch-first
2750 The initial setting is @code{nil}.
2751 If non-nil, first message is automatically prefetched to the buffer
2752 when you enter the folder.
2756 @node Auto Refile, Sticky Summary, Cache, Summary
2757 @section Auto Refile
2758 @vindex elmo-msgdb-extra-fields
2759 @vindex wl-refile-rule-alist
2760 @findex wl-summary-auto-refile
2762 You can refile messages automatically, by typing @kbd{C-o}
2763 (@code{wl-summary-auto-refile}). It decides destination of refile by
2764 the content of the message header information (information in the msgdb).
2766 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2767 available. If you want to decide destination by other header fields,
2768 set the variable @code{elmo-msgdb-extra-fields} like following.
2772 (setq elmo-msgdb-extra-fields
2782 By this setting, Wanderlust saves extra fields in the msgdb. You have
2783 to type @kbd{s all} to get extra fields for the messages that are
2784 already exists in the summary.
2786 Then, specify the refile rule. The refile target folder of auto
2787 refiling is decided by the value of @code{wl-refile-rule-alist}.
2788 @code{wl-refile-rule-alist} is a list of a rule:
2792 (@var{field} (@var{regexp} . @var{target})
2793 (@var{regexp} . @var{target})
2798 Each rule means `if @var{field} value matches @var{regexp},
2799 then refile to @var{target} folder'.
2800 The rule matched first is applied.
2802 @var{field} is a string of field name. You can specify a list of field name
2803 string, too. In this case, if one of these fields is matched, then the
2804 rule is fired (i.e. OR condition).
2806 @var{regexp} is a regular expression for field value. @var{target} is a target
2807 folder string. You can specify a rule at @var{target} part, too. In this
2808 case, If the field value of the rule and the current rule is matched,
2809 then the current rule is fired (i.e. AND condition).
2811 In @var{target} part, you can refer matched substring of @var{regexp}.
2812 To refer substring, specify following in @var{target}:
2816 means substitute original matched text.
2819 means substitute what matched the @var{N}th `\(@dots{}\)'.
2820 (@var{N} is a number.)
2823 Following is an example of @code{wl-refile-rule-alist}.
2827 (setq wl-refile-rule-alist
2829 ("^Wanderlust" . "+wl")
2830 ("^Elisp" . "+elisp"))
2832 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2834 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2835 "+from-me-to-you"))))))
2839 After these settings, refile marks are automatically put on the condition
2840 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2842 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2844 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2845 with these persistent marks are not automatically refiled.
2846 It means Wanderlust does not execute auto refile on unread messages by
2847 the default setting.
2848 To execute auto refile on all messages, set following.
2851 (setq wl-summary-auto-refile-skip-marks nil)
2855 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2856 @section Sticky Summary
2857 @cindex Summary, Sticky
2858 @cindex Sticky Summary
2860 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2862 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2863 @kbd{G} in some suummary sticky summary buffer is created.
2864 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2865 makes current one sticky.
2867 The buffer name of the sticky summary becomes like
2868 @samp{Summary:@var{folder-name}}.
2869 You can visit the sticky summary at any time by @kbd{C-x b}
2870 (@code{switch-to-buffer}), or you can go round summary buffers by
2871 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2872 (@code{wl-summary-next-buffer}) in summary mode.
2874 In sticky summary, the summary buffer is preserved after @kbd{g} or
2875 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2876 another summary by @kbd{C-u g}. Other operations in the sticky summary
2877 are same as normal summary.
2879 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2880 are automatically stuck.
2883 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2884 @section Key bindings
2885 @cindex Keybind, Summary Mode
2886 @cindex Keybind, Summary Buffer
2888 Key bindings of the summary mode are shown below.
2892 @kindex @key{SPC} (Summary)
2893 @findex wl-summary-read
2894 Proceed reading a message at the current cursor point.
2895 (@code{wl-summary-read})
2899 @findex wl-summary-redisplay
2900 Redisplay a message at the current cursor point.
2901 If this command is called with prefix argument,
2902 Redisplay message regardless of the message cache (message is re-loaded
2904 (@code{wl-summary-redisplay})
2908 @findex wl-summary-display-top
2909 Display the top message in the folder.
2910 (@code{wl-summary-display-top})
2914 @findex wl-summary-display-bottom
2915 Display the bottom message in the folder.
2916 (@code{wl-summary-display-bottom})
2920 @kindex @key{BS} (Summary)
2921 @kindex @key{DEL} (Summary)
2922 Display the previous page of the message at the current cursor point.
2923 @findex wl-summary-prev-page
2924 (@code{wl-summary-prev-page})
2927 @kindex @key{RET} (Summary)
2928 @findex wl-summary-next-line-content
2929 Display the next line of the message at the current cursor point.
2930 Display the message at the current cursor point if it is not displayed yet.
2931 (@code{wl-summary-next-line-content})
2936 @kindex M-@key{RET} (Summary)
2937 @findex wl-summary-prev-line-content
2938 Display the previous line of the message at the current cursor point.
2939 Display the message at the current cursor point if it is not displayed yet.
2940 (@code{wl-summary-prev-line-content})
2944 @findex wl-thread-open-close
2945 Toggle open or close the thread at the current cursor point.
2946 (@code{wl-thread-open-close})
2951 @findex wl-thread-open-all
2952 (@code{wl-thread-open-all})
2957 @findex wl-thread-close-all
2958 (@code{wl-thread-close-all})
2962 @findex wl-summary-goto-folder
2964 (@code{wl-summary-goto-folder})
2968 Mark all messages in the folder as read.
2969 @findex wl-summary-mark-as-read-all
2970 (@code{wl-summary-mark-as-read-all})
2974 @findex wl-summary-reply
2975 Prepare a draft for reply the message at the current cursor point.
2976 (@code{wl-summary-reply})
2980 @findex wl-summary-reply-with-citation
2981 Prepare a draft for reply the message at the current cursor point.
2982 (@code{wl-summary-reply-with-citation})
2986 @findex wl-summary-cancel-message
2987 If the message at current cursor point is your own netnews article,
2989 (@code{wl-summary-cancel-message})
2993 @findex wl-summary-reedit
2994 Prepare a draft for re-editing the message at current cursor point.
2995 If the message at current cursor point is your own netnews article,
2996 a draft for `supersedes message' for the message is prepared.
2997 (@code{wl-summary-reedit})
3000 @kindex M-e (Summary)
3001 @findex wl-summary-resend-bounced-mail
3002 If the message at current cursor point is a bounced message,
3003 a draft for re-sending original message is prepared.
3004 (@code{wl-summary-resend-bounced-mail})
3008 @findex wl-summary-forward
3009 A draft for forwarding the message at current cursor point is prepared.
3010 (@code{wl-summary-forward})
3014 @findex wl-summary-mark-as-important
3015 Put @samp{$} mark on the message at current cursor point.
3016 If already marked as @samp{$}, delete it.
3017 (@code{wl-summary-mark-as-important})
3023 Save the message at current cursor point.
3024 @findex wl-summary-save
3025 (@code{wl-summary-save})
3029 @findex wl-summary-next
3030 Move cursor to the next message.
3031 If message is marked with a temporal mark in
3032 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3033 In the offline mode, cursor is not moved to the messages which are not cached
3035 (@code{wl-summary-next})
3039 @findex wl-summary-prev
3040 Move cursor to the previous message.
3041 If message is marked with a temporal mark in
3042 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3043 In the offline mode, cursor is not moved to the messages which are not cached
3045 (@code{wl-summary-prev})
3049 @findex wl-summary-down
3050 Move cursor to the downward message which is unread or marked
3052 In the offline mode, cursor is not moved to the messages which are not cached
3054 If there are messages which have target mark @samp{*} in the summary,
3055 cursor is moved to the downward message which have a target mark.
3056 This behavior is changed according to the value of @code{wl-summary-move-order}.
3057 (@code{wl-summary-down})
3061 @findex wl-summary-up
3062 Move cursor to the upward message which is unread or marked
3064 In the offline mode, cursor is not moved to the messages which are not cached
3066 If there are messages which have target mark @samp{*} in the summary,
3067 cursor is moved to the downward message which have a target mark.
3068 This behavior is changed according to the value of @code{wl-summary-move-order}.
3069 (@code{wl-summary-up})
3073 @findex wl-summary-write
3074 Prepare a new draft.
3075 (@code{wl-summary-write})
3079 @findex wl-summary-write-current-folder
3080 Prepare a new draft. If the current folder is NNTP folder,
3081 @samp{Newsgroups:} field is completed. If the current folder is mailing
3082 list folder (refile destination), guess @samp{To:} field and completed
3083 (If @code{wl-subscribed-mailing-list} is valid list)
3084 (@code{wl-summary-write-current-folder})
3088 @findex wl-summary-redisplay-all-header
3089 Redisplay the message at current cursor point with all header fields.
3090 (@code{wl-summary-redisplay-all-header})
3094 @findex wl-summary-redisplay-no-mime
3095 Redisplay the message at current cursor point without MIME analysis.
3096 (@code{wl-summary-redisplay-no-mime})
3100 @findex wl-summary-burst
3101 If the message at current cursor point has
3102 encapsulates multiple messages using MIME,
3103 de-capsulate and extract them on the current folder.
3104 (@code{wl-summary-burst})
3107 @kindex @@ (Summary)
3108 @findex wl-summary-edit-addresses
3109 Append/change/delete the message's sender information to the address
3110 book @file{~/.addresses} interactively. If this command is called with
3111 prefix argument, arbitrary address can be edited.
3112 (@code{wl-summary-edit-petname})
3116 @findex wl-status-update
3117 Sync up address book status with @file{~/.addresses}'s content.
3118 (@code{wl-status-update})
3122 @findex wl-summary-pipe-message
3123 Pipe current message's content to the external process.
3124 (@code{wl-summary-pipe-message})
3128 @findex wl-summary-print-message
3129 Print out current message's content.
3130 It uses @code{ps-print} module in Emacs 20.x.
3131 If you don't use color printer, you might want to set
3132 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3135 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3138 (@code{wl-summary-print-message})
3142 @findex wl-summary-exit
3143 Exit current folder.
3144 (@code{wl-summary-exit})
3148 @findex wl-summary-jump-to-current-message
3149 Jump cursor to the currently displayed message's window.
3150 (@code{wl-summary-jump-to-current-message})
3154 Jump cursor to the other message.
3155 @findex wl-summary-jump-to-msg
3156 (@code{wl-summary-jump-to-msg})
3160 Update summary status and
3161 prefetch all messages which have marks included in the
3162 @code{wl-summary-incorporate-marks}.
3163 @findex wl-summary-incorporate
3164 (@code{wl-summary-incorporate})
3167 @kindex M-j (Summary)
3168 @findex wl-summary-jump-to-msg-by-message-id
3169 Jump cursor to the message which have specified @samp{Message-Id:}. If
3170 @code{elmo-use-database} is non-nil, other folder is also searched.
3171 (@code{wl-summary-jump-to-msg-by-message-id})
3175 Jump to parent message.
3176 @findex wl-summary-jump-to-parent-message
3177 (@code{wl-summary-jump-to-parent-message})
3181 @findex wl-summary-mark-as-unread
3182 Mark as unread the message at current cursor point.
3183 (@code{wl-summary-mark-as-unread})
3187 @findex wl-summary-sync
3188 Synchronize summary view after prompting the update range
3189 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3193 all ...Discard current summary and update all message.
3194 all-visible ...Discard current summary and update all visible message.
3195 update ...Update the difference between summary and the folder itself.
3196 rescan ...Rescan the msgdb and display again.
3197 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3198 cache-status ...Sync the all marks with the real status of cache.
3199 first, last ...Move to the filter folder(partial filter).
3204 (@code{wl-summary-sync})
3208 @findex wl-summary-sort
3210 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3211 (@code{wl-summary-sort})
3215 @findex wl-summary-toggle-thread
3216 Toggle the threading.
3217 Threading status is displayed on the modeline.
3218 @samp{@{S@}} means threading is off (Sequence) and
3219 @samp{@{T@}} means threading is on (Thread).
3220 (@code{wl-summary-toggle-thread})
3224 @findex wl-summary-toggle-disp-folder
3225 Toggle displaying of folder window.
3226 (@code{wl-summary-toggle-disp-folder})
3230 Toggle displaying of message window.
3231 @findex wl-summary-toggle-disp-msg
3232 (@code{wl-summary-toggle-disp-msg})
3236 Move to the virtual folder with the condition specified.
3237 If called with prefix argument and current folder is virtual, exit it.
3238 @findex wl-summary-virtual
3239 (@code{wl-summary-virtual})
3242 @kindex @key{TAB} (Summary)
3243 @findex wl-summary-goto-last-displayed-msg
3244 Jump to the message which is displayed last.
3245 (@code{wl-summary-goto-last-displayed-msg})
3249 Put @samp{*} mark on the messages that satisfies the specified condition.
3250 @findex wl-summary-pick
3251 (@code{wl-summary-pick})
3255 @findex wl-summary-mark-as-read
3256 Mark as read the message at the current cursor point.
3257 (@code{wl-summary-mark-as-read})
3261 Prefetch the message at the current cursor point.
3262 With prefix argument, prefetch the message even if it is cached.
3263 @findex wl-summary-prefetch
3264 (@code{wl-summary-prefetch})
3268 Execute @samp{D}, @samp{o} and @samp{O} marks.
3269 @findex wl-summary-exec
3270 (@code{wl-summary-exec})
3274 @findex wl-summary-target-mark-line
3275 Put target mark on the message at the current cursor point.
3276 (@code{wl-summary-target-mark-line})
3280 Put refile mark on the message at the current cursor point.
3281 @findex wl-summary-refile
3282 (@code{wl-summary-refile})
3285 @kindex C-o (Summary)
3286 Execute auto refile.
3287 @findex wl-summary-auto-refile
3288 (@code{wl-summary-auto-refile})
3292 Put copy mark on the message at the current cursor point.
3293 @findex wl-summary-copy
3294 (@code{wl-summary-copy})
3297 @kindex M-o (Summary)
3298 Put refile mark on the message at the current cursor point with the destination
3299 previously specified.
3300 @findex wl-summary-refile-prev-destination
3301 (@code{wl-summary-refile-prev-destination})
3305 @findex wl-summary-delete
3306 Put delete mark on the message at the current cursor point.
3307 (@code{wl-summary-delete})
3311 @findex wl-summary-unmark
3312 Unmark the temporal mark on the message at the current cursor point.
3313 (@code{wl-summary-unmark})
3317 Unmark all the temporal marks.
3318 @findex wl-summary-unmark-all
3319 (@code{wl-summary-unmark-all})
3322 @kindex r R (Summary)
3323 @findex wl-summary-mark-as-read-region
3324 Mark as read messages in the specified region.
3325 (@code{wl-summary-mark-as-read-region})
3328 @kindex r $ (Summary)
3329 @findex wl-summary-mark-as-important-region
3330 Mark as important @samp{$} messages in the specified region.
3331 If @samp{$} already exists, it is deleted.
3332 (@code{wl-summary-mark-as-important-region})
3335 @kindex r ! (Summary)
3336 @findex wl-summary-mark-as-unread-region
3337 Mark as unread messages in the specified region.
3338 (@code{wl-summary-mark-as-unread-region})
3341 @kindex r i (Summary)
3342 @findex wl-summary-prefetch-region
3343 Prefetch messages in the specified region.
3344 (@code{wl-summary-prefetch-region})
3347 @kindex r x (Summary)
3348 @findex wl-summary-exec-region
3349 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3351 (@code{wl-summary-exec-region})
3354 @kindex r * (Summary)
3355 @findex wl-summary-target-mark-region
3356 Put target mark on the messages in the specified region.
3357 (@code{wl-summary-target-mark-region})
3360 @kindex r o (Summary)
3361 @findex wl-summary-refile-region
3362 Put refile mark on the messages in the specified region.
3363 (@code{wl-summary-refile-region})
3366 @kindex r O (Summary)
3367 @findex wl-summary-copy-region
3368 Put copy mark on the messages in the specified region.
3369 (@code{wl-summary-copy-region})
3372 @kindex r d (Summary)
3373 @findex wl-summary-delete-region
3374 Put delete mark on the messages in the specified region.
3375 (@code{wl-summary-delete-region})
3378 @kindex r u (Summary)
3379 @findex wl-summary-unmark-region
3380 Delete temporal mark on the messages in the specified region.
3381 (@code{wl-summary-unmark-region})
3384 @kindex r y (Summary)
3385 Save messages in the specified region.
3386 @findex wl-summary-save-region
3387 (@code{wl-summary-save-region})
3390 @kindex t R (Summary)
3391 @findex wl-thread-mark-as-read
3392 Mark as read messages which are the descendant of the current thread.
3393 With prefix argument, it affects on the all messages in the thread tree.
3394 (@code{wl-thread-mark-as-read})
3397 @kindex t $ (Summary)
3398 @findex wl-thread-mark-as-important
3399 Put important mark @samp{$} on the messages which are the
3400 descendant of the current thread.
3401 If @samp{$} mark exists, it is deleted.
3402 With prefix argument, it affects on the all messages in the thread tree.
3403 (@code{wl-thread-mark-as-important})
3406 @kindex t ! (Summary)
3407 @findex wl-thread-mark-as-unread
3408 Mark as unread messages which are the descendant of the current thread.
3409 With prefix argument, it affects on the all messages in the thread tree.
3410 (@code{wl-thread-mark-as-unread})
3413 @kindex t i (Summary)
3414 @findex wl-thread-prefetch
3415 Prefetch messages which are the descendant of the current thread.
3416 With prefix argument, it affects on the all messages in the thread tree.
3417 (@code{wl-thread-prefetch})
3420 @kindex t x (Summary)
3421 @findex wl-thread-exec
3422 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3423 the descendant of the current thread. With prefix argument, it affects
3424 on the all messages in the thread tree.
3425 (@code{wl-thread-exec})
3428 @kindex t * (Summary)
3429 @findex wl-thread-target-mark
3430 Put target mark @samp{*} on the messages which are the descendant of the
3431 current thread. With prefix argument, it affects on the all messages in
3433 (@code{wl-thread-target-mark})
3436 @kindex t o (Summary)
3437 @findex wl-thread-refile
3438 Put refile mark on the messages which are the descendant of the current thread.
3439 With prefix argument, it affects on the all messages in the thread tree.
3440 (@code{wl-thread-refile})
3443 @kindex t O (Summary)
3444 @findex wl-thread-copy
3445 Put copy mark on the messages which are the descendant of the current thread.
3446 With prefix argument, it affects on the all messages in the thread tree.
3447 (@code{wl-thread-copy})
3450 @kindex t d (Summary)
3451 @findex wl-thread-delete
3452 Put delete mar on the messages which are the descendant of the current thread.
3453 With prefix argument, it affects on the all messages in the thread tree.
3454 (@code{wl-thread-delete})
3457 @kindex t u (Summary)
3458 @findex wl-thread-unmark
3459 Unmark temporal mark on the messages which are the descendant of the
3460 current thread. With prefix argument, it affects on the all messages in
3462 (@code{wl-thread-unmark})
3465 @kindex t y (Summary)
3466 @findex wl-thread-save
3467 Save messages which are the descendant of the current thread.
3468 With prefix argument, it affects on the all messages in the thread tree.
3469 (@code{wl-thread-save})
3472 @kindex m i (Summary)
3473 @findex wl-summary-target-mark-prefetch
3474 Prefetch all messages which have target mark @samp{*}.
3475 With prefix argument, prefetch all targets even if some of them are cached.
3476 (@code{wl-summary-target-mark-prefetch})
3479 @kindex m R (Summary)
3480 @findex wl-summary-target-mark-mark-as-read
3481 Mark as read all messages which have target mark @samp{*}.
3482 (@code{wl-summary-target-mark-mark-as-read})
3485 @kindex m $ (Summary)
3486 @findex wl-summary-target-mark-mark-as-important
3487 Mark as important all messages which have target mark @samp{*}.
3488 If already marked as @samp{$}, it is deleted.
3489 (@code{wl-summary-target-mark-mark-as-important})
3492 @kindex m ! (Summary)
3493 @findex wl-summary-target-mark-mark-as-unread
3494 Mark as unread all messages which have target mark @samp{*}.
3495 (@code{wl-summary-target-mark-mark-as-unread})
3498 @kindex m o (Summary)
3499 @findex wl-summary-target-mark-refile
3500 Put refile mark on the messages which have target mark @samp{*}.
3501 (@code{wl-summary-target-mark-refile})
3504 @kindex m O (Summary)
3505 @findex wl-summary-target-mark-copy
3506 Put copy mark on the messages which have target mark @samp{*}.
3507 (@code{wl-summary-target-mark-copy})
3510 @kindex m d (Summary)
3511 @findex wl-summary-target-mark-delete
3512 Put delete mark on the messages which have target mark @samp{*}.
3513 (@code{wl-summary-target-mark-delete})
3516 @kindex m y (Summary)
3517 @findex wl-summary-target-mark-save
3518 Save messages which have target mark @samp{*}.
3519 (@code{wl-summary-target-mark-save})
3522 @kindex m u (Summary)
3523 Unmark all temporal marks.
3524 (@code{wl-summary-delete-all-temp-marks})
3525 @findex wl-summary-delete-all-temp-marks
3528 @kindex m a (Summary)
3529 Put target mark @samp{*} on the all messages.
3530 (@code{wl-summary-target-mark-all})
3531 @findex wl-summary-target-mark-all
3534 @kindex m t (Summary)
3535 Put target mark @samp{*} on the messages in the current thread.
3536 @findex wl-summary-target-mark-thread
3537 (@code{wl-summary-target-mark-thread})
3540 @kindex m r (Summary)
3541 @findex wl-summary-target-mark-region
3542 Put target mark @samp{*} on the messages in the specified region.
3543 (@code{wl-summary-target-mark-region})
3546 @kindex m A (Summary)
3547 @findex wl-summary-target-mark-reply-with-citation
3548 Prepare a draft which cites all messages which have target mark @samp{*}.
3549 (@code{wl-summary-target-mark-reply-with-citation})
3552 @kindex m f (Summary)
3553 @findex wl-summary-target-mark-forward
3554 Prepare a draft which forwards all messages which have target mark @samp{*}.
3555 (@code{wl-summary-target-mark-forward})
3558 @kindex m U (Summary)
3559 @findex wl-summary-target-mark-uudecode
3560 Uudecode the messages which have target mark @samp{*}.
3561 (@code{wl-summary-target-mark-uudecode})
3564 @kindex m ? (Summary)
3565 @findex wl-summary-target-mark-pick
3566 Pick messages from the @samp{*} marked messages.
3567 That is, @samp{*} marks on the messages are remained
3568 if the specified condition is satisfied.
3569 (@code{wl-summary-target-mark-pick})
3572 @kindex m # (Summary)
3573 @findex wl-summary-target-mark-print
3574 Print out all messages which have target mark @samp{*}.
3575 (@code{wl-summary-target-mark-print})
3578 @kindex m | (Summary)
3579 @findex wl-summary-target-mark-pipe
3580 Pipe content of each message with target mark @samp{*} to some specified
3582 (@code{wl-summary-target-mark-pipe})
3585 @kindex M-t (Summary)
3586 @findex wl-toggle-plugged
3587 Toggle offline/online status of Wanderlust.
3588 (@code{wl-toggle-plugged})
3591 @kindex C-t (Summary)
3592 Start Wanderlust's plug-status manager.
3593 (@code{wl-plugged-change})
3596 @kindex C-c C-o (Summary)
3597 @findex wl-jump-to-draft-buffer
3598 Move to the draft buffer if available. If multiple draft buffer exists,
3599 moved to one after another. If prefix argument is specified, load draft
3600 folder's message to the draft buffer and jump to it.
3601 (@code{wl-jump-to-draft-buffer})
3604 @kindex M-w (Summary)
3605 @findex wl-summary-save-current-message
3606 Save the message at the current cursor point.
3607 (@code{wl-summary-save-current-message})
3610 @kindex C-y (Summary)
3611 @findex wl-summary-yank-saved-message
3612 Regard the message at the current cursor point as
3613 parent, connect the message saved by
3614 @code{wl-summary-save-current-message}
3616 (@code{wl-summary-yank-saved-message})
3619 @kindex C-x C-s (Summary)
3620 @findex wl-summary-save-status
3621 Save the current summary.
3622 (@code{wl-summary-save-status})
3626 @node Variables of Summary, , Key Bindings of Summary, Summary
3627 @section Customiziable variables
3630 @item wl-summary-move-order
3631 @vindex wl-summary-move-order
3632 The initial setting is @code{unread}. Specify cursor moving policy. If
3633 you want to precede new messages, set @code{new}. If you want to
3634 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3637 @item wl-auto-select-first
3638 @vindex wl-auto-select-first
3639 The initial setting is @code{nil}.
3640 If non-nil, first message is automatically displayed when you enter
3643 @item wl-auto-select-next
3644 @vindex wl-auto-select-next
3645 The initial setting is @code{nil}. This controls behavior when there is
3646 no unread message in current summary.
3649 nil: asks whether you want to go back to folder mode
3650 'unread: asks whether you want to go to next unread folder
3651 If the next one comes to be possessing no unread message
3652 by treatment of cross-posted messages or Scoring, then
3653 asks whether you want to go to next to next folder.
3654 'skip-no-unread: similar as unread
3655 But does not ask before going to next to next folder.
3656 otherwise: asks whether you want to go to next unread folder
3659 It might be useful to set @code{'skip-no-unread} for people who
3660 want to continue reading by just pressing and pressing space key.
3662 @item wl-thread-insert-opened
3663 @vindex wl-thread-insert-opened
3664 The initial setting is @code{nil}.
3665 If non-nil, thread is inserted as opened.
3667 @item wl-thread-open-reading-thread
3668 @vindex wl-thread-open-reading-thread
3669 The initial setting is @code{t}. If non-nil, reading thread is
3670 automatically opened though it is closed thread.
3672 @item wl-summary-exit-next-move
3673 @vindex wl-summary-exit-next-move
3674 The initial setting is @code{t}. If non-nil, move to next folder at
3677 @item wl-folder-move-cur-folder
3678 @vindex wl-folder-move-cur-folder
3679 The initial setting is @code{nil}. If non-nil, cursor position on the
3682 @item wl-summary-weekday-name-lang
3683 @vindex wl-summary-weekday-name-lang
3684 The initial setting is @samp{ja}. Specify language of the weekday.
3685 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3686 displays Deutsch. You should rescan summary view after changing this value.
3688 @item wl-summary-fix-timezone
3689 @vindex wl-summary-fix-timezone
3690 The initial setting is @code{nil}.
3691 Time zone of the date string in summary mode is adjusted using this value.
3692 If @code{nil}, it is adjust to the default time zone information
3693 (system's default time zone or environment variable @samp{TZ}).
3695 @item wl-use-petname
3696 @vindex wl-use-petname
3697 The initial setting is @code{t}.
3698 If non-nil, sender part displays nickname.
3700 @item wl-break-pages
3701 @vindex wl-break-pages
3702 The initial setting is @code{t}.
3703 If non-nil, message is split as pages by @samp{^L}.
3705 @item wl-message-window-size
3706 @vindex wl-message-window-size
3707 The initial setting is '(1 . 4).
3708 A cons cell to specify the rate of summary and message window.
3709 car:cdr corresponds summary:message.
3711 @item wl-summary-no-from-message
3712 @vindex wl-summary-no-from-message
3713 The initial setting is @samp{nobody@@nowhere?}. A string which is
3714 displayed when there's no @samp{From:} field in the message.
3716 @item wl-summary-no-subject-message
3717 @vindex wl-summary-no-subject-message
3718 The initial setting is @samp{(WL:No Subject in original.)}. A string
3719 which is displayed when there's no @samp{Subject:} field in the message.
3721 @item wl-summary-use-frame
3722 @vindex wl-summary-use-frame
3723 The initial setting is @code{nil}.
3724 If non-nil, use new frame for the summary.
3726 @item wl-use-folder-petname
3727 @vindex wl-use-folder-petname
3728 The initial setting is the list shown below:
3737 A list of display policy (symbol) of folder nickname. Available symbols
3742 Display folder petname on modeline.
3744 Destination folder is notified as nickname if
3745 @code{wl-auto-select-next} is non-nil.
3747 You can input folder name by nickname in the function
3748 @code{wl-summary-read-folder}.
3751 @item wl-summary-move-direction-toggle
3752 @vindex wl-summary-move-direction-toggle
3753 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3754 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3755 want to aware of reading direction, set this to @code{t}.
3757 @item wl-summary-width
3758 @vindex wl-summary-width
3759 The initial setting is 80.
3760 Width of summary line. If @code{nil}, summary line's width is as is.
3762 @item wl-summary-from-width
3763 @vindex wl-summary-from-width
3764 The initial setting is 17.
3765 Width of sender part of summary line.
3767 @item wl-summary-subject-length-limit
3768 @vindex wl-summary-subject-length-limit
3769 The initial setting is @code{nil}. Specify the limit for the length of
3770 subject parts in summary. @code{nil} means unlimited.
3772 @item wl-summary-indent-length-limit
3773 @vindex wl-summary-indent-length-limit
3774 The initial setting is 46.
3775 Specify the limit of thread indent level. @code{nil} means unlimited
3777 If you set this to @code{nil} you should set @code{wl-summary-width}
3780 @item wl-summary-recenter
3781 @vindex wl-summary-recenter
3782 The initial setting is t.
3783 If non-nil, cursor point is moved to the center of the summary window.
3785 @item wl-summary-divide-thread-when-subject-changed
3786 @vindex wl-summary-divide-thread-when-subject-changed
3787 The initial setting is @code{nil}. If non-nil, thread is split if
3788 the subject is changed.
3790 @item wl-summary-search-via-nntp
3791 @vindex wl-summary-search-via-nntp
3792 The initial setting is @code{confirm}.
3794 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3795 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3796 from the NNTP server @code{elmo-nntp-default-server}. The value of
3797 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3798 @code{elmo-nntp-default-stream-type} are used.
3800 If @code{confirm}, server name can be specified. You can specify NNTP
3801 folder format like @samp{-:username@@servername:119!}.
3803 @item wl-summary-keep-cursor-command
3804 @vindex wl-summary-keep-cursor-command
3805 The initial setting is the list shown below:
3809 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3814 When you entered to summary by these commands and the target summary
3815 buffer already exists, summary status is not automatically updated and
3816 cursor position is saved.
3818 @item elmo-folder-update-threshold
3819 @vindex elmo-folder-update-threshold
3820 The initial setting is 500. If updated message number is larger than
3821 this value, confirm whether drop them or not (in the case where the value
3822 of @code{elmo-folder-update-confirm} is non-nil).
3824 @item elmo-folder-update-confirm
3825 @vindex elmo-folder-update-confirm
3826 The initial setting is @code{t}. If the value is non-nil, do check with
3827 @code{elmo-folder-update-threshold}.
3829 @item wl-summary-always-sticky-folder-list
3830 @vindex wl-summary-always-sticky-folder-list
3831 The initial setting is @code{nil}.
3832 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3833 are automatically stuck. Each element is regexp of folder name.
3835 @item wl-summary-reserve-mark-list
3836 @vindex wl-summary-reserve-mark-list
3837 The initial setting is the list shown below:
3846 If a message is already marked as temporal marks in this list, the
3847 message is not marked by any mark command.
3849 @item wl-summary-skip-mark-list
3850 @vindex wl-summary-skip-mark-list
3851 The initial setting is the list shown below:
3860 If a message is already marked as temporal marks in this list, the
3861 message is skipped at cursor move.
3863 @item elmo-message-fetch-threshold
3864 @vindex elmo-message-fetch-threshold
3865 The initial setting is 30000 (bytes). If displaying message has larger
3866 size than this value, Wanderlust confirms whether fetch the message or
3867 not (in the case where the value of @code{elmo-message-fetch-confirm}
3870 @item elmo-message-fetch-confirm
3871 @vindex elmo-message-fetch-confirm
3872 The initial setting is @code{t}. If the value is non-nil, do check with
3873 @code{elmo-message-fetch-threshold}.
3875 @item wl-prefetch-threshold
3876 @vindex wl-prefetch-threshold
3877 The initial setting is 30000 (bytes). If prefetching message has larger
3878 size than this value and @code{wl-prefetch-confirm} is non-nil,
3879 Wanderlust confirms whether prefetch the message or not. If
3880 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3881 without confirmation.
3883 @item wl-prefetch-confirm
3884 @vindex wl-prefetch-confirm
3885 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3886 prefetch the message or not if the message has larger size than
3887 @code{wl-prefetch-threshold}.
3889 @item elmo-imap4-use-cache
3890 @vindex elmo-imap4-use-cache
3891 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3894 @item elmo-nntp-use-cache
3895 @vindex elmo-nntp-use-cache
3896 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3899 @item elmo-pop3-use-cache
3900 @vindex elmo-pop3-use-cache
3901 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3904 @item elmo-shimbun-use-cache
3905 @vindex elmo-shimbun-use-cache
3906 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3909 @item wl-folder-process-duplicates-alist
3910 @vindex wl-folder-process-duplicates-alist
3911 The initial setting is @code{nil}.
3912 This list determines how to deal with duplicated messages in the same folder.
3913 Each item in the list is regexp of folder name and action; you can specify any
3914 one of the following in the place of action:
3917 @code{nil} : do nothing for duplicated messages.
3918 @code{hide} : hide duplicated messages from the summary.
3919 @code{read} : set duplicated messages as read.
3923 Following is an example (hide duplicated messages in multi folders)
3927 (setq wl-folder-process-duplicates-alist
3928 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3929 ("^\\*.*" . hide) (".*" . read)))
3935 @node Message, Draft, Summary, Top
3936 @chapter Message Buffer
3938 Message Buffers utilize MIME-View mode of SEMI. For operational
3939 procedures and key bindings, refer to respective documents.
3940 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3941 You can also see help by @kbd{?} in message buffer.
3943 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3944 brings you back to Summary mode. @kbd{l} toggles display of Summary
3947 @section Key Bindings
3953 @findex wl-message-toggle-disp-summary
3954 Toggles display of Summary mode buffer.
3955 (@code{wl-message-toggle-disp-summary})
3958 @findex wl-message-refer-article-or-url
3959 @kindex Button-2 (Message)
3960 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3961 corresponding message if found.
3962 (@code{wl-message-refer-article-or-url})
3964 @item Button-4 (upward movement of a wheel)
3965 @kindex Button-4 (Message)
3966 @findex wl-message-wheel-down
3967 Scrolls the message backwards. When the top of the message is hit,
3968 moves to the previous message.
3969 (@code{wl-message-wheel-down})
3971 @item Button-5 (downward movement of a wheel)
3972 @kindex Button-5 (Message)
3973 @findex wl-message-wheel-up
3974 Scrolls the message forward. When the bottom of the message is hit,
3975 moves to the next message.
3976 (@code{wl-message-wheel-up})
3979 @section Customizable Variables
3982 @item wl-message-window-size
3983 @vindex wl-message-window-size
3984 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3985 its car and cdr value corresponds to the ratio of Summary and Message
3988 @item wl-message-ignored-field-list
3989 @vindex wl-message-ignored-field-list
3990 (SEMI only) Initial setting is @code{nil}.
3991 All fields that match this list will be hidden in message buffer.
3992 Each elements are regexp of field-name.
3993 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3995 @item wl-message-visible-field-list
3996 @vindex wl-message-visible-field-list
3997 (SEMI only) Initial setting is @code{nil}.
3998 All fields that match this list will be display in message buffer.
3999 Each elements are regexp of field-name. This value precedes
4000 @code{wl-message-ignored-field-list}.
4001 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4003 @item wl-message-sort-field-list
4004 @vindex wl-message-sort-field-list
4005 (SEMI only) Initial setting is
4006 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4007 Header fields in message buffer are ordered by this value.
4008 Each elements are regexp of field-name.
4010 @item wl-message-truncate-lines
4011 @vindex wl-message-truncate-lines
4012 The initial value is the value of @code{default-truncate-lines}.
4013 If it is non-nil, truncate long lines in message buffer.
4016 @node Draft, Disconnected Operations, Message, Top
4017 @chapter Draft Buffer
4019 At Summary mode, pressing @kbd{w} and the like creates a new draft
4020 buffer. You can edit and send mail and news articles in this buffer.
4022 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4023 with those if possible.
4027 Basically it is Emacs-standard mail mode.
4029 @subsection Address Completion
4031 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4032 addresses. @kbd{@key{TAB}} completes them.
4034 If you want to submit a news article, add @samp{Newsgroups:} field by
4035 yourself. Field names can be completed by @kbd{@key{TAB}}.
4037 If you save the draft buffer you are editing, it is appended to the
4038 folder specified by @code{wl-draft-folder}.
4040 Using @samp{FCC:} field, you can specify the folder to which a copy of
4041 the message is saved when it is sent.
4043 @subsection Editing Messages
4045 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4046 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4047 a MIME user interface for GNU Emacs}.
4048 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4050 @subsection Dynamic Modification of Messages
4051 @vindex wl-draft-config-alist
4052 @c @cindex Change Message
4053 @c @cindex Message, Change Dynamic
4055 You can set @code{wl-draft-config-alist} so that header and body of the
4056 message will automatically modified depending on information of header
4059 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4061 In the example below, the header is modified when
4062 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4063 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4064 before sending the message.
4068 (setq wl-draft-config-alist
4069 '(((string-match "aaa\\.example\\.com$" (system-name))
4070 ;; @r{applied if the expression is non-nil}
4071 (wl-smtp-posting-server . "mailserver-B")
4072 (wl-nntp-posting-server . "newsserver-B")
4073 ;; @r{settings of temporary variables}
4075 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4076 ;; @r{applied if it matches the header of the draft buffer}
4077 ("Organization" . (format "Go %s" my-webpage)))
4078 ;; @r{you can write elisp expressions here (eval only)}
4079 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4080 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4085 The format of @code{wl-draft-config-alist} is:
4089 '(("@var{regexp of the header}" or @var{elisp expression}
4090 ("@var{Field}" . value(@var{elisp expression}))
4091 (@var{variable} . value(@var{elisp expression}))
4092 (@var{sub-function} . value(@var{elisp expression}))
4095 ("@var{regexp of the header}" or @var{elisp expression}
4096 ("@var{Field}" . value(@var{elisp expression}))
4101 Per default, there are 10 following sub-functions.
4104 'header: Inserts the specified string at the bottom of the header.
4105 'header-top: Inserts the specified string at the top of the header.
4106 'header-file: Inserts the specified file at the bottom of the header.
4107 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4108 'top: Inserts the specified string at the top of the body.
4109 'top-file: Inserts the specified file at the top of the body.
4110 'body: Replaces the body with the specified string.
4111 Specifying @code{nil} deletes the entire body string.
4112 'body-file: Replaces the body with the content of the specified file.
4113 'bottom: Inserts the specified string at the bottom of the body.
4114 'bottom-file: Inserts the specified file at the top of the body.
4115 'part-top: Inserts the specified string at the top of the current part.
4116 'part-bottom: Inserts the specified string at the bottom of the current part.
4117 'template: Applies the specified template.
4118 (refer to the next subsection)
4121 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4122 change them or add your own functions. If you read the code, you can
4123 easily find how to write the functions.
4125 At the first of each item, @var{a regular expression of the header} or
4126 an @var{elisp expression} should be specified. In the case of an elisp
4127 expression, the item is applied when the expression is evaluated
4130 Per default, when multiple items match or are evaluated non-nil, all
4131 such items are applied, but if you set a variable
4132 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4135 At the second of the item, a cons or a list of functions should be
4136 specified. The car part of the cons should be a header field, a
4137 variable, or a sub-function. When a header field is specified, the
4138 field will be modified. If a variable is specified, the value of the
4139 variable will be modified temporarily.
4141 In the cdr part of a cons, not only a variable but also an elisp
4142 expression can be specified as is. If the car part is a header field
4143 and the cdr part is @code{nil}, the field will be deleted.
4145 If you want to use name of parent folder, you can refer the buffer local
4146 variable @code{wl-draft-parent-folder}.
4148 See the next example as well:
4152 (setq wl-draft-config-alist
4154 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4155 ;; @r{applied if it matches the header of the buffer being replied}
4156 (body . " Hello.\n")
4157 (template . "default")
4162 As in the (1) above, if a header regexp is prepended with @code{reply},
4163 it is applied when the draft is prepared by @code{wl-summary-reply} for
4164 example, and when it matches the header being replied. It is ignored
4165 when there is no buffer being replied, like after @code{wl-draft} was
4168 Note that @code{wl-draft-config-alist} is applied only once when
4169 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4170 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4171 aborting transmission, execute @kbd{C-c C-e}
4172 (@code{wl-draft-config-exec}) explicitly.
4174 If you don't want to apply @code{wl-draft-config-alist} when
4175 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4179 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4182 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4183 prepared, do the following:
4186 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4189 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4190 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4194 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4197 @subsection Inserting Templates
4199 @cindex Apply Template
4201 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4202 @kbd{M-x wl-template-select} in the draft buffer.
4204 The format of @code{wl-template-alist} is almost the same as
4205 @code{wl-draft-config-alist}.
4209 (setq wl-template-alist
4212 ("Organization" . "Example Co.Ltd.")
4213 (body . "Hello.\n"))
4215 (template . "default") ;; @r{(a)}
4216 ("To" . "boss@@example.com")
4217 ("Subject" . "Report")
4218 (body-file . "~/work/report.txt")
4224 As you can see, the only difference is item (template) names such as
4225 @samp{default} and @samp{report}, instead of a regexp of header.
4226 Because definition of each item is the same as
4227 @code{wl-draft-config-alist}, you can call another template, like (a).
4229 Executing the command @code{wl-template-select} results in template
4230 selection, but the result differs depending on variable
4231 @code{wl-template-visible-select}.
4233 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4234 window is shown below the draft buffer. You can select a template by
4235 @kbd{n} and @kbd{p} seeing the buffer window.
4237 Press the @key{RET} key and the template is actually applied to the draft
4238 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4239 adjust the window size by @code{wl-template-buffer-lines}.
4241 If @code{wl-template-visible-select} is @code{nil}, you should type the
4242 name of the template in the mini buffer.
4244 As shown in the example in @code{wl-draft-config-alist}, you can select
4245 @samp{default} template by writing:
4248 (template . "default")
4251 @subsection Sending mail by POP-before-SMTP
4252 @cindex POP-before-SMTP
4254 You can send mail by POP-before-SMTP with this single line:
4257 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4261 Configure the following variables if you need.
4264 @item wl-pop-before-smtp-user
4265 The POP user name for POP-before-SMTP authentication.
4266 If unset, @code{elmo-pop3-default-user} is used.
4268 @item wl-pop-before-smtp-server
4269 The POP server name for POP-before-SMTP authentication.
4270 If unset, @code{elmo-pop3-default-server} is used.
4272 @item wl-pop-before-smtp-authenticate-type
4273 The POP authentication method for POP-before-SMTP authentication.
4274 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4276 @item wl-pop-before-smtp-port
4277 The POP port number for POP-before-SMTP authentication.
4278 If unset, @code{elmo-pop3-default-port} is used.
4280 @item wl-pop-before-smtp-stream-type
4281 If non-nil, POP connection is established using SSL. If
4282 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4283 unset, @code{elmo-pop3-default-stream-type} is used.
4286 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4287 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4289 Therefore, if SMTP server and POP server are actually the same, and if
4290 POP folder per default (such as @samp{&}) is available, no settings are
4293 Refer to the following URL about POP-before-SMTP.
4297 http://spam.ayamura.org/tools/smPbS.html
4298 http://www.iecc.com/pop-before-smtp.html
4302 @section Key Bindings
4303 @cindex Keybind, Draft Mode
4304 @cindex Keybind, Draft Buffer
4309 @kindex C-c C-y (Draft)
4310 @findex wl-draft-yank-original
4311 Cites the content of the current message buffer.
4312 (@code{wl-draft-yank-original})
4315 @kindex C-c C-p (Draft)
4316 @findex wl-draft-preview-message
4317 Previews the content of the current draft.
4318 This is useful for previewing MIME multi-part messages.
4319 (@code{wl-draft-preview-message})
4322 @kindex C-c C-s (Draft)
4323 @findex wl-draft-send
4324 Sends the content of the current draft. Does not erase the draft buffer.
4325 This is useful for sending multiple messages, which are a little different
4327 (@code{wl-draft-send})
4330 @kindex C-c C-c (Draft)
4331 @findex wl-draft-send-and-exit
4332 Sends the content of the current draft and erases the draft buffer.
4333 (@code{wl-draft-send-and-exit})
4336 @kindex C-x C-s (Draft)
4337 @findex wl-draft-save
4338 Save the current draft.
4339 (@code{wl-draft-save})
4342 @kindex C-c C-k (Draft)
4343 @findex wl-draft-kill
4344 Kills the current draft.
4345 (@code{wl-draft-kill})
4348 @kindex C-x k (Draft)
4349 @findex wl-draft-mimic-kill-buffer
4350 Kills the current draft.
4351 (@code{wl-draft-mimic-kill-buffer})
4354 @kindex C-c C-z (Draft)
4355 @findex wl-draft-save-and-exit
4356 Saves the current draft, and erases the draft buffer.
4357 This is useful if you want to suspend editing of the draft.
4358 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4359 the @samp{+draft} folder.
4360 (@code{wl-draft-save-and-exit})
4363 @kindex C-c C-r (Draft)
4364 @findex wl-caesar-region
4365 Encodes or decodes the specified region in Caesar cipher.
4366 (@code{wl-caesar-region})
4370 @findex wl-draft-highlight-and-recenter
4371 Recenter and rehighlight current draft.
4372 (@code{wl-draft-highlight-and-recenter})
4376 @findex wl-toggle-plugged
4377 Toggles off-line/on-line states of Wanderlust.
4378 (@code{wl-toggle-plugged})
4381 @kindex C-c C-o (Draft)
4382 @findex wl-jump-to-draft-buffer
4383 Jumps to the other draft buffer, if exists.
4384 With prefix argument, reads a file (if any) from the draft folder when
4385 there is no such buffer.
4386 (@code{wl-jump-to-draft-buffer})
4389 @kindex C-c C-e (Draft)
4390 @findex wl-draft-config-exec
4391 Applies @code{wl-draft-config-alist}.
4392 (@code{wl-draft-config-exec})
4395 @kindex C-c C-j (Draft)
4396 @findex wl-template-select
4398 (@code{wl-template-select})
4401 @kindex C-c C-a (Draft)
4403 Enter Address Manager.
4404 @xref{Address Manager}.
4408 @kindex C-c C-d (Draft)
4409 @findex wl-draft-elide-region
4410 Elide the text between point and mark (@code{wl-draft-elide-region}).
4411 The text is killed and replaced with the contents of the variable
4412 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4416 @section Customizable Variables
4419 @item wl-subscribed-mailing-list
4420 @vindex wl-subscribed-mailing-list
4421 The initial setting is @code{nil}. Mailing lists to which you
4422 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4423 field of a reply draft, removes your own address from
4424 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4425 contained in @samp{To:} or @samp{Cc:} field of a message to be
4426 automatically re-filed, the destination folder will be leaned in
4427 connection with the address.
4433 (setq wl-subscribed-mailing-list
4434 '("wl@@lists.airs.net"
4436 "emacs-mime-ja@@m17n.org"))
4440 @item wl-insert-mail-followup-to
4441 @vindex wl-insert-mail-followup-to
4442 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4443 field is automatically inserted in the draft buffer.
4445 @item wl-insert-mail-reply-to
4446 @vindex wl-insert-mail-reply-to
4447 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4448 field is automatically inserted in the draft buffer.
4450 @item wl-auto-insert-x-face
4451 @vindex wl-auto-insert-x-face
4452 The initial setting is @code{t}. If non-nil and there is an encoded
4453 X-Face string in a file @file{~/.xface} (the value of the variable
4454 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4455 draft buffer. If @code{nil}, it is not automatically inserted.
4457 @item wl-insert-message-id
4458 @vindex wl-insert-message-id
4459 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4460 is automatically inserted on the transmission.
4462 @item wl-message-id-use-wl-from
4463 @vindex wl-message-id-use-wl-from
4464 The initial setting is @code{nil}. If non-nil, the value of
4465 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4467 @item wl-local-domain
4468 @vindex wl-local-domain
4469 The initial setting is @code{nil}. If @code{nil}, the return value of
4470 the function @code{system-name} will be used as the domain part of
4473 If @code{system-name} does not return FQDN (i.e. the full name of the
4474 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4475 to the string of the local domain name without hostname (like
4476 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4477 @samp{.} @code{wl-local-domain} is used as domain part of the
4480 If your terminal does not have global IP, set the value of
4481 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4482 you use invalid @samp{Message-ID:}.)
4484 Moreover, concatenation of @code{system-name} @samp{.}
4485 @code{wl-local-domain} will be used as an argument to the HELO command
4488 @item wl-message-id-domain
4489 @vindex wl-message-id-domain
4490 The initial setting is @code{nil}. If non-nil, this value is used as a
4491 domain part of the @samp{Message-ID:}. If your terminal does not have
4492 global IP address, set unique string to this value (e.x. your e-mail
4495 @item wl-unique-id-suffix
4496 @vindex wl-unique-id-suffix
4497 The initial setting is @samp{.wl}. You can specify the string in generated
4498 Message-ID which appear just before @samp{@@}.
4500 @item wl-draft-config-alist
4501 @vindex wl-draft-config-alist
4502 The initial setting is @code{nil}. Modifies the draft message just
4503 before the transmission. The content of @code{wl-draft-config-alist}
4504 will be automatically applied only once on the transmission. If you
4505 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4508 @item wl-template-alist
4509 @vindex wl-template-alist
4510 The initial setting is @code{nil}.
4511 This variable specifies the template to be applied in the draft buffer.
4513 @item wl-draft-config-matchone
4514 @vindex wl-draft-config-matchone
4515 The initial setting is @code{nil}. If non-nil, only the first matching
4516 item is used when @code{wl-draft-config-alist} is applied. If
4517 @code{nil}, all matching items are used.
4519 @item wl-template-visible-select
4520 @vindex wl-template-visible-select
4521 The initial setting is @code{t}.
4522 If non-nil, you can preview the result of the template selection in
4525 @item wl-template-confirm
4526 @vindex wl-template-confirm
4527 The initial setting is @code{nil}.
4528 If non-nil, asks for confirmation when you press the enter key to select
4529 template while previewing.
4531 @item wl-template-buffer-lines
4532 @vindex wl-template-buffer-lines
4533 The initial setting is 7.
4534 If @code{wl-template-visible-select} is non-nil, this variable specifies
4535 the size of the preview window.
4537 @item wl-draft-reply-buffer-style
4538 @vindex wl-draft-reply-buffer-style
4539 The initial setting is @code{split}. @code{split} or @code{full} can be
4540 specified. In the case of @code{full}, the whole frame will be used for
4541 a reply draft buffer when it is prepared.
4543 @item wl-draft-use-frame
4544 @vindex wl-draft-use-frame
4545 The initial setting is @code{nil}.
4546 If non-nil, use new frame for the draft.
4548 @item wl-draft-truncate-lines
4549 @vindex wl-draft-truncate-lines
4550 The initial value is the value of @code{default-truncate-lines}.
4551 If it is non-nil, truncate long lines in draft buffer.
4555 The initial setting is the value of the variable
4556 @code{user-mail-address}. The value of this variable is inserted as a
4557 @samp{From:} field of the draft when it is prepared.
4559 @item wl-envelope-from
4560 @vindex wl-envelope-from
4561 The initial setting is @code{nil}.
4562 The value of this variable is used for envelope from (MAIL FROM).
4563 If @code{nil}, the address part of @code{wl-from} is used.
4565 @item wl-user-mail-address-list
4566 @vindex wl-user-mail-address-list
4567 The initial setting is @code{nil}.
4568 This is the User's address list. If you have multiple addresses,
4573 The initial setting is @code{nil}.
4574 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4575 the draft when it is prepared. If function is specified, its return
4580 The initial setting is @code{nil}.
4581 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4582 the draft when it is prepared.
4584 @item wl-reply-subject-prefix
4585 @vindex wl-reply-subject-prefix
4586 The initial setting is @samp{Re: }.
4587 In the @samp{Subject:} of the reply draft, this string is prepended to
4588 the @samp{Subject:} of being replied.
4590 @item wl-draft-reply-use-address-with-full-name
4591 @vindex wl-draft-reply-use-address-with-full-name
4592 The initial setting is @code{t}.
4593 If non-nil, insert her full name with address when prepare a draft for
4594 reply a message. If it is @code{nil}, insert her address only.
4596 @item wl-draft-enable-queuing
4597 @vindex wl-draft-enable-queuing
4598 The initial setting is @code{t}.
4599 This flag controls off-line transmission. If non-nil, the draft is
4602 @item wl-draft-use-cache
4603 @vindex wl-draft-use-cache
4604 The initial setting is @code{nil}. If the value is non-nil and
4605 @code{wl-insert-message-id} is nil, cache the message which is sent.
4607 @item wl-fcc-force-as-read
4608 @vindex wl-fcc-force-as-read
4609 The initial setting is @code{nil}. If the value is non-nil,
4610 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4612 @item wl-auto-flush-queue
4613 @vindex wl-auto-flush-queue
4614 The initial setting is t.
4615 This flag controls automatic transmission of the queue when Wanderlust
4616 becomes on-line. If non-nil, the queue is automatically transmitted
4617 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4618 manually, press @kbd{F} in the folder mode.
4620 @item wl-ignored-forwarded-headers
4621 @vindex wl-ignored-forwarded-headers
4622 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4623 All headers that match this regexp will be deleted when forwarding a message.
4625 @item wl-ignored-resent-headers
4626 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4627 All headers that match this regexp will be deleted when resending a message.
4629 @item wl-draft-always-delete-myself
4630 @vindex wl-draft-always-delete-myself
4631 If non-nil, always removes your own address from @samp{To:} and
4632 @samp{Cc:} when you are replying to the mail addressed to you.
4634 @item wl-draft-delete-myself-from-bcc-fcc
4635 @vindex wl-draft-delete-myself-from-bcc-fcc
4636 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4637 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4639 @item wl-smtp-posting-server
4640 @vindex wl-smtp-posting-server
4641 The initial setting is @code{nil}.
4642 This is the SMTP server name for mail transmission.
4644 @item wl-smtp-posting-user
4645 @vindex wl-smtp-posting-user
4646 The initial setting is @code{nil}.
4647 This is the user name for SMTP AUTH authentication. If @code{nil},
4648 @code{smtp-authenticate-user} is used.
4650 @item wl-smtp-authenticate-type
4651 @vindex wl-smtp-authenticate-type
4652 The initial setting is @code{nil}.
4653 This is the authentication method for SMTP AUTH authentication. If
4654 @code{nil}, @code{smtp-authenticate-type} is used. If
4655 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4658 @item wl-smtp-connection-type
4659 @vindex wl-smtp-connection-type
4660 The initial setting is @code{nil}.
4661 This variable specifies how to establish SMTP connections.
4662 If @code{nil}, @code{smtp-connection-type} is used.
4663 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4665 @item wl-nntp-posting-server
4666 @vindex wl-nntp-posting-server
4667 The initial setting is @code{nil}.
4668 This is the NNTP server name used for news submission.
4669 If @code{nil}, @code{elmo-nntp-default-server} is used.
4671 @item wl-nntp-posting-user
4672 @vindex wl-nntp-posting-user
4673 The initial setting is @code{nil}.
4674 This is the user name for AUTHINFO authentication on news submission.
4675 If @code{nil}, @code{elmo-nntp-default-user} is used.
4676 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4678 @item wl-nntp-posting-port
4679 @vindex wl-nntp-posting-port
4680 The initial setting is @code{nil}.
4681 This is the port number of the NNTP server used for news submission.
4682 If @code{nil}, @code{elmo-nntp-default-server} is used.
4684 @item wl-nntp-posting-stream-type
4685 @vindex wl-nntp-posting-stream-type
4686 The initial setting is @code{nil}.
4687 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4688 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4689 connection will be established.
4691 @item wl-pop-before-smtp-user
4692 @vindex wl-pop-before-smtp-user
4693 The initial setting is @code{nil}.
4694 This is the POP user name for POP-before-SMTP.
4695 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4697 @item wl-pop-before-smtp-server
4698 @vindex wl-pop-before-smtp-server
4699 The initial setting is @code{nil}.
4700 This is the POP server name for POP-before-SMTP.
4701 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4703 @item wl-pop-before-smtp-authenticate-type
4704 @vindex wl-pop-before-smtp-authenticate-type
4705 The initial setting is @code{nil}.
4706 This is the authentication method for POP-before-SMTP authentication.
4707 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4709 @item wl-pop-before-smtp-port
4710 @vindex wl-pop-before-smtp-port
4711 The initial setting is @code{nil}.
4712 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4713 @code{elmo-pop3-default-port} is used.
4715 @item wl-pop-before-smtp-stream-type
4716 @vindex wl-pop-before-smtp-stream-type
4717 The initial setting is @code{nil}.
4718 This flag controls the use of SSL for POP-before-SMTP. If it is
4719 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4720 STARTTLS (RFC2595) connection will be established.
4722 @item wl-draft-queue-save-variables
4723 @vindex wl-draft-queue-save-variables
4724 Specifies a list of variable to which queued messages are saved on the
4725 off-line transmission.
4727 @item wl-draft-sendlog
4728 @vindex wl-draft-sendlog
4729 The initial setting is @code{t}.
4730 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4734 @item drafts are sent by smtp or qmail
4735 @item saved into folders by fcc
4736 @item saved into folders by queuing
4739 (it is written even if the transmission fails).
4740 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4741 and left to the logging function of @command{imput}.
4744 @item wl-draft-sendlog-max-size
4745 @vindex wl-draft-sendlog-max-size
4746 The initial setting is 20000 (in bytes).
4747 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4748 beyond the size specified by this variable.
4752 The initial setting is @code{nil}.
4753 If non-nil, address completion uses LDAP.
4755 @item wl-ldap-server
4756 @vindex wl-ldap-server
4757 The initial setting is @samp{localhost}.
4758 LDAP server name for address completion.
4761 @vindex wl-ldap-port
4762 The initial setting is @code{nil}.
4763 If non-nil, the value is used as port number.
4766 @vindex wl-ldap-base
4767 The initial setting is @samp{c=US}.
4768 LDAP search starting point (base) for address completion.
4770 @item wl-draft-remove-group-list-contents
4771 @vindex wl-draft-remove-group-list-contents
4772 The initial setting is @code{t}.
4773 If non-nil, remove the group-lists' members in the recipients when
4774 sending the message (group-list means the description such as
4775 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4778 @node Disconnected Operations, Expire and Archive, Draft, Top
4779 @chapter Off-line Management
4780 @cindex Disconnected Operations
4782 Wanderlust has on-line and off-line states.
4785 * Off-line State:: Wanderlust has on-line and off-line states
4786 * Enable Operations:: Enable Disconnected Operations
4787 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4788 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4789 * Variables of Plugged Mode:: Customize Plugged Mode
4793 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4794 @section Off-line State
4796 Wanderlust has on-line and off-line states. In the off-line state, you
4797 cannot access messages via network, unless they are cached.
4799 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4800 in the mode line indicates the off-line state. In folder or summary
4801 modes, press @kbd{M-t} to switch between off- and on-line.
4803 You can invoke Wanderlust in the off-line state by setting
4804 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4806 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4807 ignores uncached messages.
4810 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4811 @section Enable Disconeected Operations
4813 Even in the off-line state, provided that relevant messages are cached,
4814 and the variable @code{elmo-enable-disconnected-operation} (described
4815 later) is non-nil, you can following operations:
4816 @xref{Plugged Mode}, @xref{Off-line State settings}.
4819 * Send Messages off-line:: Transmit Messages
4820 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4821 * Creation of Folders:: Create Folders off-line (IMAP4)
4822 * Marking:: Mark (IMAP4)
4823 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4826 As soon as Wanderlust becomes on-line, such operations invoked off-line
4827 are reflected in the servers via network.
4830 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4831 @subsection Transmission of Messages
4833 You can send mail/news messages off-line (if you are using
4834 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4835 accumulated in the queue folder, @samp{+queue}. These messages are
4836 transmitted at once when Wanderlust becomes on-line.
4838 You can visit @samp{+queue} in the off-line state and confirm content of
4839 messages in the queue. You can also remove messages. Removed messages
4840 are not transmitted even in the on-line state.
4843 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4844 @subsection Re-file and Copy (IMAP4)
4846 Re-file and copy operations to IMAP folders invoked during the off-line
4847 state are accumulated in the queue, and reflected in the server side
4848 when Wanderlust becomes on-line. If you visit destination folders after
4849 off-line re-file or copy, it looks as if messages were appended even in
4852 For the safety reasons, messages re-filed off-line are removed from
4853 source folders only if their @samp{Message-ID:} match messages on the
4854 servers. While the queue is processed, messages that failed to be
4855 re-filed or copied to the specified folders are appended to the folder
4859 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4860 @subsection Creation of Folders (IMAP4)
4862 You can create IMAP folders off-line. The creation of folders are
4863 reflected in the servers when Wanderlust becomes on-line. If the creation
4864 of those folders fails at that time for some reasons, messages
4865 to be re-filed into those are appended to the folder @samp{+lost+found}
4869 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4870 @subsection Marking (IMAP4)
4872 Off-line changes in unread/read and importance mark @samp{$} information
4873 are also reflected in the servers when Wanderlust becomes on-line.
4876 @node Pre-fetching Reservations, , Marking, Enable Operations
4877 @subsection Pre-fetching (IMAP4, NNTP)
4879 You can make reservations for pre-fetching messages in IMAP or NNTP
4880 folders. Reserved messages are marked with @samp{!} but not cached
4881 yet. When Wanderlust becomes on-line, they are pre-fetched from
4884 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4885 these off-line operations for IMAP4 and NNTP do not take place, and
4886 off-line re-file, copy or suchlike simply results in error.
4888 Because off-line operations use cache files, it is a bad idea to erase
4889 them by hand; it may cause Wanderlust to malfunction.
4891 If you want to remove caches, be sure to execute @kbd{M-x
4892 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4893 remove caches for messages relevant to off-line operations.
4896 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4897 @section Switching On-line/Off-line per Server/Port
4899 @kbd{M-t} described above switches networking states as a whole, but you
4900 can switch on-line/off-line per server/port.
4902 Pressing @kbd{C-t} in the folder or summary modes brings you in
4903 wl-plugged-mode shown below, in which you can change the plugged state
4908 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4911 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4912 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4914 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4915 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4921 The first line indicates status of the following three variables, and
4922 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4923 column modifies the values of these variables.
4927 "Queuing" @code{wl-draft-enable-queuing}
4928 "AutoFlushQueue" @code{wl-auto-flush-queue}
4929 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4933 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4936 The second and after lines indicate on-line/off-line states of servers
4937 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4938 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4939 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4941 @dfn{sending queue} means messages accumulated in the folder
4942 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4943 off-line operations when @code{elmo-enable-disconnected-operation} is
4945 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4946 @c off-line operations are enabled.
4948 They are displayed if there are any of them. In the example above, in
4949 the sending queue there are two messages (the first and the second in
4950 the queue folder) for smtp to hosta and one (the third) for nntp to
4951 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4954 If you change @samp{(wl-plugged)} in the second line, the variable
4955 @code{wl-plugged} is changed, so that the mode line indicator and
4956 plugged states of all ports are affected. If you change plugged states
4957 of any servers or ports, @samp{(wl-plugged)} in the second line is
4958 affected depending on @code{elmo-plugged-condition} settings and the
4959 plugged state of each port.
4962 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4963 @section Invoking Wanderlust in the Off-line State
4965 As described before, if you set @code{wl-plugged} to @code{nil} in
4966 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4967 off-line state. You can specify off-line state on a per server or port
4968 basis. Refer to @code{wl-reset-plugged-alist} also.
4970 Usually, when Wanderlust starts up, the plugged state of each port is
4971 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4972 @code{wl-nntp-posting-server} and so on. If you want to change the
4973 plugged state of these ports or to add other ports, configure
4974 @code{wl-make-plugged-hook} with a function.
4978 (add-hook 'wl-make-plugged-hook
4980 (elmo-set-plugged plugged-value(t/nil) server port)
4981 ;; @r{add or change plugged states of the port of the server}
4982 (elmo-set-plugged plugged-value(t/nil) server)
4983 ;; @r{if the port is omitted, all ports are affected}
4984 ;; @r{(you cannot omit the port if you newly add the server)}
4990 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4991 @section Customizable Variables
4996 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4997 mode from the beginning.
4999 @item wl-queue-folder
5000 @vindex wl-queue-folder
5001 The initial setting is @samp{+queue}.
5002 This is the folder in which messages in the transmission queue are
5005 @item wl-auto-flush-queue
5006 @vindex wl-auto-flush-queue
5007 The initial setting is @code{t}.
5008 This flag controls automatic transmission of the queue when Wanderlust
5009 becomes on-line. If non-nil, the queue is automatically transmitted
5010 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5011 manually, press @kbd{F} in the folder mode.
5013 @item elmo-enable-disconnected-operation
5014 @vindex elmo-enable-disconnected-operation
5015 The initial setting is @code{nil}. Controls off-line operations
5016 regarding IMAP4. If non-nil, off-line operations are carried out.
5018 @item elmo-lost+found-folder
5019 @vindex elmo-lost+found-folder
5020 The initial setting is @samp{+lost+found}.
5021 This is the folder to which messages are saved when they fails to be
5022 appended while the off-line re-file/copy queue is processed.
5024 @item elmo-plugged-condition
5025 @vindex elmo-plugged-condition
5026 The initial setting is @code{one}.
5027 The value of @code{wl-plugged} reflects the return value of the function
5028 @code{elmo-plugged-p} (without arguments).
5029 This variable @code{elmo-plugged-condition} specifies the condition on
5030 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5031 plugged state of each port.
5034 'one : plugged if one or more ports are plugged.
5035 'all : plugged if all ports are plugged.
5036 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5037 states of the ports.
5038 @var{function} : reflects the return value of the @var{function}
5039 functions available per default
5040 'elmo-plug-on-by-servers
5041 : reflects the plugged state of the servers specified by the
5042 variable elmo-plug-on-servers.
5043 'elmo-plug-on-by-exclude-servers
5044 : reflects the plugged state of the servers that are not
5045 in elmo-plug-on-exclude-servers.
5046 elmo-plug-on-exclude-servers defaults to
5049 (system-name)without the domain part)
5055 (setq elmo-plugged-condition 'all)
5057 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5058 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5060 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5061 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5065 @item wl-reset-plugged-alist
5066 @vindex wl-reset-plugged-alist
5067 The initial setting is @code{t}. If non-nil, plugged states are
5068 initialized on a per server or port basis when Wanderlust starts up.
5070 If @code{nil}, plugged states are retained while Emacs is running. In
5071 other words, they are initialized when Emacs is restarted even if the
5072 value is @code{nil}.
5076 @node Expire and Archive, Scoring, Disconnected Operations, Top
5077 @chapter Automatic Expiration and Archiving of Messages
5078 @cindex Expire and Archive
5081 * Expire:: Expiration and Archiving
5082 * Archive:: Archiving All Messages
5086 @node Expire, Archive, Expire and Archive, Expire and Archive
5088 @cindex Expire Message
5090 Expiration means deletion of old messages which have outlasted a
5091 certain period of time.
5093 @code{wl-expire} supports not only simple deletion, but also moving to
5094 specified archiving folders.
5098 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5099 or @kbd{M-e} in the summary mode.
5101 @subsection Configuring @code{wl-expire-alist}
5103 An example configuration of @code{wl-expire-alist} is shown below.
5104 Everything in this @code{wl-expire-alist} makes a great difference in
5105 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5106 to @code{t}, especially in the initial stage.
5110 (setq wl-expire-alist
5111 '(("^\\+trash$" (date 14) remove)
5113 ("^\\+tmp$" (date 7) trash)
5114 ;; @r{re-file to @code{wl-trash-folder}}
5115 ("^\\+outbox$" (number 300) "$outbox;lha")
5116 ;; @r{re-file to the specific folder}
5118 ;; @r{do not expire}
5119 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5120 ;; @r{archive by message number (retaining numbers)}
5121 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5122 ;; @r{archive by a fixed number (retaining numbers)}
5123 ("^\\+diary$" (date 30) wl-expire-archive-date)
5124 ;; @r{archive by year and month (numbers discarded)}
5129 Items in the list has the format of:
5132 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5136 The folder is examined if it matches @var{regexp-for-folders} from the
5137 beginning of the list. If you invoke expiration on the folder that does
5138 not match any of them, nothing will happen. And if either the second or
5139 the third element of the item is @code{nil}, expiration will not take
5142 You can use any one of the following for
5143 @var{specification-of-message-to-be-deleted}:
5146 @item (number @var{n1} [@var{n2}])
5147 deletes messages depending on the number of messages in the folder.
5149 @var{n1} is the number of messages which should survive deletion, for example
5150 if its value is 500, the newest 500 messages survive and the rests are
5153 @var{n2} is the number of messages in the folder on which expiration should
5154 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5155 folders with 510 or more messages are expired.
5156 If you configured automatic expiration, frequently used folders may
5157 expire every time it receive messages, and you may be annoyed with the
5158 long delay in reading mail.
5159 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5160 expiration would not take place until a certain number of messages
5163 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5164 with important/new/unread) are not deleted.
5165 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5166 will expire so as to have 500 messages including such ones.
5167 Otherwise, it will have 500 messages except such ones.
5169 @item (date @var{d1})
5170 deletes messages depending on the dates.
5172 Messages dated @var{d1} or more days ago are deleted, for example if its
5173 value is seven, messages seven days old or more are deleted. Note that
5174 the date is the one in the @samp{Date:} field of the message, not when
5175 the message entered the folder.
5177 Messages with no or invalid @samp{Date:} field does not expire; you
5178 might have to delete them by hand.
5181 You can use any one of the following in the place of @var{destination}:
5185 deletes the messages instantly.
5188 hide the messages from summary (messages are not deleted).
5191 moves the messages to @code{wl-trash-folder}.
5193 @item @var{string}(folder)
5194 moves the messages to the folder specified with @var{string}.
5196 It would be useful for specifying an archiving folder, but because this
5197 does not move important messages, it might be better to use the
5198 standard functions described below.
5200 @item @var{function}
5201 invokes the specified @var{function}.
5203 To the @var{function}, three arguments are passed: a folder name, a list
5204 of messages to be deleted, and msgdb information of the summary. You
5205 can specify function-specific arguments after the name of the
5206 @var{function}. Note that the list contains messages with marks in
5207 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5210 These are four standard functions; three of them move messages to an archive
5211 folder in the specified way. This means old messages can be compressed
5212 and saved in a file, being deleted from the original folder.
5213 The last one divides messages to some MH folders.
5216 @item wl-expire-archive-number1
5217 re-files to archiving folders corresponding to the message numbers of
5218 the messages being deleted. For example, a message numbered 102 will be
5219 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5220 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5221 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5223 The archiving folders to which messages are re-filed are determined by
5224 the name of the folder as follows (in this case, archiving folders are
5225 handled as if @code{elmo-archive-treat-file} were non-nil).
5228 @item If the folder type is localdir:
5229 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5231 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5232 (@file{~/Mail/ml/wl-00100.zip}).
5234 @item The folder type is other than localdir:
5235 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5237 For example, @samp{%#mh/ml/wl} corresponds to
5238 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5241 As you can see, in the case of localdir, the folder type is not included
5242 in the path name, but otherwise it is included.
5243 And you can control the prefix to the archiving folder name by
5244 @code{wl-expire-archive-folder-prefix}.
5245 Refer to @code{wl-expire-archive-folder-prefix} for details.
5247 @item wl-expire-archive-number2
5248 re-files every certain number of messages to archiving folders.
5250 This differs from @samp{wl-expire-archive-number1} in that this re-files
5251 to the folder up to the specified number regardless of message numbers.
5252 The archiving folders to which messages are re-filed are determined in the
5253 same way as @code{wl-expire-archive-number1}.
5255 @item wl-expire-archive-date
5256 re-files messages depending on its date (year and month) to archive
5259 For example, a message dated December 1998 is re-filed to
5260 @code{$folder-199812;zip}. The name of the archiving folders except the
5261 date part are determined in the same way as
5262 @code{wl-expire-archive-number1}.
5265 You can set the first argument to these three standard functions to non-nil
5266 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5267 For example, it can be specified just after the name of the function:
5270 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5273 If you omit the argument, consecutive numbers from 1 are assigned for
5274 each archiving folder.
5276 @item wl-expire-localdir-date
5277 divedes messages depending on its date (year and month) to MH folders
5278 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5282 @subsection Treatment for Important or Unread Messages
5284 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5285 standard function, messages with marks in
5286 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5287 messages} thereafter) are retained.
5289 Per default, this variable include the important, new, and unread marks,
5290 so that messages with these marks are not removed.
5291 Note that you cannot include the temporary mark (i.e. temporary marks
5292 are removed anyway), and be sure to process temporary marks before you
5295 @subsection Auto Expiration
5297 The following setup invokes expiration when you move into the summary
5298 mode. There will be no confirmation, so make sure you made no mistake
5299 in regexp and other settings before you set up this.
5303 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5307 In the folder mode, you can invoke expiration per group as well as per
5308 folder. Therefore, if you specify @samp{Desktop} group, all folders
5309 matching @code{wl-expire-alist} expire.
5313 @subsection Treating archive folders.
5314 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5315 you must set non-nil value to @code{elmo-archive-treat-file}.
5317 @subsection Confirming
5319 If you are to use @code{remove}, try @code{trash} at first and see
5320 messages move to @code{wl-trash-folder} as expected, then replace it
5321 with @code{remove}. It would be dangerous to use @code{remove} from the
5324 If you are to use @code{wl-expire-archive-number1} and the like, try to
5325 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5326 you can append messages to it. Even if settings in
5327 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5328 would not be saved anywhere and disappeared in case the archiver program
5331 After you make sure you can archive to the folder correctly, you can
5332 invoke expiration and utilize the log.
5334 If you set @code{wl-expire-use-log} to @code{t},
5335 @file{~/.elmo/expired-log} should contain the log, for example:
5339 delete +ml/wl (593 594 595 596 597 598 599)
5340 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5344 The first column indicates the operation, i.e. @samp{delete},
5345 @samp{copy}, or @samp{move}. The next is the name of the folder that
5346 expired. In the case of @samp{copy} and @samp{move}, the destination
5347 folder is recorded after @samp{->}. The last is the list of message
5348 numbers that are actually deleted or moved (in the case of @samp{copy}
5349 and @samp{move}, the number is the one in the source folder, rather than
5350 the destination folder).
5352 @subsection Re-filing Reserved Messages
5354 The three standard functions copy reserved messages to the archive
5355 folder, but do not delete them from the source folder. Because
5356 reserved messages and the like always remain, they are recorded in
5357 @file{~/.elmo/expired-alist} so that they are not copied over and over
5358 again. They are not recorded if copied by @code{wl-summary-archive}.
5360 If you enabled logging, usually @samp{move} is recorded for re-filing,
5361 but instead @samp{copy} and @samp{delete} are recorded separately if
5362 reserved messages are involved. This is because it actually copies
5363 messages including reserved, then deletes ones except reserved in that
5366 @section Customizable Variables
5369 @item wl-expire-alist
5370 @vindex wl-expire-alist
5371 The initial setting is @code{nil}.
5372 This variable specifies folders and methods to expire. For details,
5373 refer to @code{wl-expire-alist} settings above.
5375 @item wl-summary-expire-reserve-marks
5376 @vindex wl-summary-expire-reserve-marks
5377 The initial setting is the list below.
5381 (list wl-summary-important-mark
5383 wl-summary-unread-mark
5384 wl-summary-unread-uncached-mark
5385 wl-summary-unread-cached-mark)
5389 Messages with these marks are retained in the folder, even after
5391 Only permanent marks can be listed, not temporary marks.
5393 You can list marks one by one as in the default; you can use the
5394 following settings as well:
5398 All messages with permanent marks are retained,
5399 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5403 All messages are handled as usual ones that are already read, no matter
5404 what marks they have; even important messages are deleted.
5407 @item wl-expire-archive-files
5408 @vindex wl-expire-archive-files
5409 The initial setting is 100.
5410 This variable specifies the number of messages to be retained in one
5413 @item wl-expire-number-with-reserve-marks
5414 @vindex wl-expire-number-with-reserve-marks
5415 The initial setting is @code{nil}.
5416 If non-nil, if expiring messages are specified by @code{number},
5417 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5419 @item wl-expire-archive-get-folder-function
5420 @vindex wl-expire-archive-get-folder-function
5421 The initial setting is @code{wl-expire-archive-get-folder}.
5423 This variable specifies a function that returns the name of an archiving
5424 folder for standard functions in the place of @var{destination}.
5425 You can use the following three variables for simple modification of
5426 folder names; if you want more complex settings, define your own
5427 function in this variable.
5429 @code{wl-expire-archive-get-folder} can be customized by these
5432 @item @code{wl-expire-archive-folder-name-fmt}
5433 @item @code{wl-expire-archive-folder-type}
5434 @item @code{wl-expire-archive-folder-prefix}
5437 @item wl-expire-archive-folder-name-fmt
5438 @vindex wl-expire-archive-folder-name-fmt
5439 The initial setting is @samp{%s-%%05d;%s}.
5440 This is a @code{format} string for archiving folders used in
5441 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5442 Note that you must specify the message number by @samp{%%d}, because it
5443 is parsed twice by @code{format}.
5445 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5448 @item wl-expire-archive-date-folder-name-fmt
5449 @vindex wl-expire-archive-date-folder-name-fmt
5450 The initial setting is @samp{%s-%%04d%%02d;%s}.
5451 This is a @code{format} string for archiving folders used in
5452 @code{wl-expire-archive-date}. Note that you must specify the message
5453 number by @samp{%%d}, because it is parsed twice by @code{format}.
5454 There should be @samp{%%d} twice, one for the year and the other for the
5457 If you modify this, adjust
5458 @code{wl-expire-archive-date-folder-num-regexp} as well.
5460 @item wl-expire-archive-folder-type
5461 @vindex wl-expire-archive-folder-type
5462 The initial setting is @code{zip}.
5463 This variable specifies an archiver type of the archiving folders.
5465 @item wl-expire-archive-folder-prefix
5466 @vindex wl-expire-archive-folder-prefix
5467 The initial setting is @code{nil}.
5468 This variable specifies the prefix (directory structure) to archiving
5470 Exercise extreme caution in using this feature, as it has not been
5472 In the worst case, there is a fear of destructing archiving folders.
5476 There will be no prefix.
5479 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5480 @samp{$ml/wl-00000;zip;wl}.
5483 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5486 @samp{$ml/wl-00000;zip;ml/wl}.
5489 @item wl-expire-archive-folder-num-regexp
5490 @vindex wl-expire-archive-folder-num-regexp
5491 The initial setting is @samp{-\\([-0-9]+\\);}.
5492 This variable specifies the regular expression to be used for getting
5493 message numbers from multiple archiving folders specified by
5494 @code{elmo-list-folders}.
5495 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5497 @item wl-expire-archive-date-folder-num-regexp
5498 @vindex wl-expire-archive-date-folder-num-regexp
5499 The initial setting is @samp{-\\([-0-9]+\\);}.
5500 This is the regular expression to be used for getting message numbers
5501 from multiple archiving folders specified by @code{elmo-list-folders}.
5502 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5504 @item wl-expire-delete-oldmsg-confirm
5505 @vindex wl-expire-delete-oldmsg-confirm
5506 The initial setting is @code{t}.
5507 If non-nil, messages older than the one with the largest number will be
5508 deleted with confirmation.
5509 If @code{nil}, they are deleted without confirmation.
5511 This feature is valid only if non-nil is specified as a argument to the
5512 standard functions so as to retain numbers.
5514 @item wl-expire-use-log
5515 @vindex wl-expire-use-log
5516 The initial setting is @code{nil}.
5517 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5518 They are appended but not truncated or rotated automatically; you might
5519 need to remove it manually.
5521 @item wl-expire-add-seen-list
5522 @vindex wl-expire-add-seen-list
5523 The initial setting is @code{t}.
5525 If non-nil, when messages are re-filed by expiration, read/unread
5526 information is passed to the destination folder.
5528 However if you do not read the destination folder from Wanderlust,
5529 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5530 want to set this to @code{nil} if you are simply saving to some
5531 archiving folders. Even if its value is @code{nil}, messages in the
5532 archiving folders are simply treated as unread; it does not affect
5535 @item wl-expire-folder-update-msgdb
5536 @vindex wl-expire-folder-update-msgdb
5537 The initial setting is @code{t}.
5538 If @code{t}, in the folder mode, expiration is carried out after
5539 updating summary information. If you specified a list of regular
5540 expressions of folder names, summary information is updated for matching
5545 @node Archive, , Expire, Expire and Archive
5546 @section Archiving Messages
5548 @subsection Archiving Messages
5549 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5550 folders. If there are the archiving folders already, only new messages
5553 You can use @code{wl-archive-alist} in order to specify how messages are
5554 archived according to their folder names, as in @code{wl-expire-alist}.
5559 (setq wl-archive-alist
5560 '(("^\\+tmp$" wl-archive-date)
5561 ("^\\+outbox$" wl-archive-number2)
5562 (".*" wl-archive-number1)))
5566 Each item in the list has the following format:
5569 (@var{folders-regexp} @var{deleting-function})
5572 As you can see, you can only use a function after @var{folders-regexp}.
5573 Per default, there are three functions:
5576 @item @code{wl-archive-number1}
5577 @item @code{wl-archive-number2}
5578 @item @code{wl-archive-date}
5581 As inferred from their names, they work similarly to "expire" versions,
5582 other than the following points:
5585 @item No messages are deleted
5586 @item Message numbers are retained even if invoked without arguments
5589 These functions are good to archive all messages in a folder by their
5590 numbers or by their dates.
5591 These are also useful for backup or confirmation purposes before
5593 If you try to re-file them after they are archived, they are deleted but
5596 Per default, the archiving folders to which messages are copied are
5597 determined automatically by @code{wl-expire-archive-get-folder-function}.
5598 You can copy to a specific folder by invoking with a prefix argument,
5599 i.e. @kbd{C-u M-x wl-summary-archive}.
5601 Note that this feature has not been seriously tested, because you can
5602 simply copy to an archiving folder, for example by
5603 @code{wl-summary-copy-region}.
5605 The archiving folders are determined by the same logic as in
5606 @code{wl-summary-expire}; the following customizable variables are
5610 @item @code{wl-expire-archive-files}
5611 @item @code{wl-expire-archive-get-folder-function}
5612 @item @code{wl-expire-archive-folder-name-fmt}
5613 @item @code{wl-expire-archive-folder-type}
5614 @item @code{wl-expire-archive-folder-prefix}
5615 @item @code{wl-expire-archive-folder-num-regexp}
5618 @subsection Customizable Variables
5621 @item wl-archive-alist
5622 @vindex wl-archive-alist
5623 The initial setting is the list shown below:
5627 ((".*" wl-archive-number1))
5632 This variable specifies a function that copies to archiving folders.
5633 To the function, three arguments are passed: a folder name, a list of
5634 messages in the folder, and msgdb information of the summary.
5635 Needless to say, you can use your own function.
5639 @node Scoring, Address Book, Expire and Archive, Top
5640 @chapter Score of the Messages
5642 @c @cindex Kill File
5644 Scoring is the function that associates a score (value) with each
5645 message, and marks as read or deletes from the summary according to it.
5647 You can put target or important marks on essential messages, or read marks
5648 on the ones you do not want to read, for example spam articles.
5650 This scoring function has a capability and a format similar to the one
5651 that Gnus has, although there are some unsupported features and
5652 Wanderlust specifics.
5653 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5656 * Score Commands:: Score Commands
5657 * Score File Format:: Score File Format
5661 @node Score Commands, Score File Format, Scoring, Scoring
5662 @section Score Commands
5663 @cindex Score Commands
5665 @subsection Score File Specification
5667 @code{wl-score-folder-alist} specifies score files or variables in which
5668 scores are defined, corresponding to folder names.
5672 (setq wl-score-folder-alist
5681 If paths to the score files are omitted, the directory specified in the
5682 variable @code{wl-score-files-directory} is assumed.
5684 No matter what you write in @code{wl-score-folder-alist}, the default
5685 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5686 read (it does not have to exist).
5687 Therefore, in the example above, the three score files,
5688 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5689 the folders that matches @samp{^-.*}.
5691 @subsection Scored Messages
5693 Scores are attached to the messages that are specified by
5694 @code{wl-summary-score-marks} temporarily when the summary is updated;
5695 when you exit from the summary, the scores are removed and reverts to
5698 @subsection Creation of Score Files
5700 In the summary buffer, move to an appropriate message and type @kbd{L}.
5701 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5702 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5704 This makes @minus{}1000 are scored for messages with the same
5705 @samp{Subject:} as the string you entered. That is, such a score file
5706 is created automatically.
5708 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5709 The score file you just made appears.
5710 This buffer is called @dfn{score editing buffer} thereafter.
5711 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5712 as you are previously; type @kbd{a}. Then a score entry for "From"
5714 In this way, you can create a score file easily either in the summary
5715 buffer or in the score editing buffer.
5717 By the way, you might be aware the numbers of key strokes are different
5718 between @kbd{s s p} and @kbd{a}.
5719 This is determined by @code{wl-score-header-default-entry}.
5720 This variable specifies the default score entries corresponding to
5722 For example, for "subject" field, a type and a time limit are prompted,
5723 but for "from" field, they are fixed upon automatically as substring and
5724 permanent respectively.
5725 However, score values can be modified by the prefix argument.
5726 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5729 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5730 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5731 erasing contents of the buffer deletes the score file being edited.
5735 @subsubsection Selecting Score Files
5737 You can change score files to which scores are appended by
5738 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5739 @code{wl-score-change-score-file}.
5741 @subsubsection Summing Up the Score
5743 If you add the same entries by @code{wl-summary-increase-score},
5744 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5745 scores for the entry is summed up.
5747 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5748 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5749 @minus{}1200 will be created as a result.
5751 @subsubsection Creating Thread Key
5753 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5754 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5756 @subsubsection Creating Followup Key
5758 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5759 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5760 at the cursor to @samp{References} key.
5761 If @code{wl-score-auto-make-followup-entry} is non-nil,
5762 @samp{Message-ID} of all messages to be followed up within dates
5763 specified by @code{wl-score-expiry-days}.
5765 @subsection Key Bindings
5770 @findex wl-summary-increase-score
5771 Increases the score for the current message.
5772 And the score entry is appended to the score file at the same moment.
5773 You can specify the score value by a prefix argument.
5777 @findex wl-summary-lower-score
5778 Decreases the score for the current message.
5779 And the score entry is appended to the score file at the same moment.
5780 You can specify the score value by a prefix argument.
5783 @kindex h R (Summary)
5784 @findex wl-summary-rescore
5785 Re-applies the scoring.
5786 However, already scored messages are not scored anew.
5789 @kindex h c (Summary)
5790 @findex wl-score-change-score-file
5791 Changes the score file currently selected.
5794 @kindex h e (Summary)
5795 @findex wl-score-edit-current-scores
5796 Edits the score file currently selected.
5797 If there are multiple score files, the previously specified one is
5801 @kindex h f (Summary)
5802 @findex wl-score-edit-file
5803 Edits an arbitrary score file and selects it.
5806 @kindex h F (Summary)
5807 @findex wl-score-flush-cache
5808 Erases caches associated to the score files that are read.
5809 If you modified score files directly (from other than Wanderlust), you
5810 need to re-read them after erasing the cache.
5813 @kindex h m (Summary)
5814 @findex wl-score-set-mark-below
5815 Specifies the criterion for scores to be marked as read.
5816 Messages with scores less than this value are marked as read.
5819 @kindex h x (Summary)
5820 @findex wl-score-set-expunge-below
5821 Specifies the criterion for scores to be deleted from the summary.
5822 Messages with scores less than this value are deleted.
5823 "Deleted" means it is not shown; they are not removed from the summary
5824 information or the folder.
5825 The deleted messages can be shown by rescan-noscore again.
5828 @subsection Key Bindings in the Score Editing Buffer
5832 @kindex C-c C-k (Score Mode)
5833 @findex wl-score-edit-kill
5834 Abandons the file being edited.
5837 @kindex C-c C-c (Score Mode)
5838 @findex wl-score-edit-exit
5839 Saves the file being edited, and quits from the edit mode.
5842 @kindex C-c C-p (Score Mode)
5843 @findex wl-score-pretty-print
5847 @kindex C-c C-d (Score Mode)
5848 @findex wl-score-edit-insert-date
5849 Inserts the number of dates from Dec. 31, 1 B.C.
5850 It is used for creating the third factor of time-limited scores.
5853 @kindex C-c C-s (Score Mode)
5854 @findex wl-score-edit-insert-header
5855 Inserts the header of the message selected in the summary buffer.
5858 @kindex C-c C-e (Score Mode)
5859 @findex wl-score-edit-insert-entry
5860 Inserts the score entry of the message selected in the summary buffer.
5863 @subsection Customizable Variables
5866 @item wl-summary-default-score
5867 @vindex wl-summary-default-score
5868 The initial setting is 0 (zero).
5869 This variable specifies the default value of the score.
5870 The score is increased or decreased based upon this value.
5872 @item wl-summary-important-above
5873 @vindex wl-summary-important-above
5874 The initial setting is @code{nil}.
5875 Messages with scores larger than this value are attached with the
5876 important mark (@samp{$}).
5877 If @code{nil}, no important marks are attached.
5879 @item wl-summary-target-above
5880 @vindex wl-summary-target-above
5881 The initial setting is @code{nil}.
5882 Messages with scores larger than this value are attached with the target
5884 If @code{nil}, no target marks are attached.
5886 @item wl-summary-mark-below
5887 @vindex wl-summary-mark-below
5888 The initial setting is 0 (zero).
5889 Messages with scores smaller than this value are marked as read.
5891 @item wl-summary-expunge-below
5892 @vindex wl-summary-expunge-below
5893 The initial setting is @code{nil}.
5894 Messages with scores smaller than this value are deleted from the
5896 If @code{nil}, they are not deleted.
5898 @item wl-summary-score-marks
5899 @vindex wl-summary-score-marks
5900 The initial setting is the list shown below:
5904 (list wl-summary-new-mark)
5909 Messages with these marks are scored.
5911 @item wl-use-scoring
5912 @vindex wl-use-scoring
5913 The initial setting is t.
5914 If non-nil, scoring is enabled.
5916 @item wl-score-files-directory
5917 @vindex wl-score-files-directory
5918 The initial setting is @file{~/.elmo/}.
5919 The default directory for score files.
5921 @item wl-score-interactive-default-score
5922 @vindex wl-score-interactive-default-score
5923 The initial setting is 1000.
5924 This value is used as a score when a score factor is @code{nil} in the
5925 score file. It is also used in @code{wl-summary-increase-score} and
5926 @code{wl-summary-lower-score}, on condition that the value of
5927 @code{wl-score-header-default-entry} is @code{nil}.
5929 @item wl-score-expiry-days
5930 @vindex wl-score-expiry-days
5931 The initial setting is 7.
5932 This is the number of days before time-limited scores are deleted.
5934 @item wl-score-update-entry-dates
5935 @vindex wl-score-update-entry-dates
5936 The initial setting is @code{t}.
5937 If non-nil, it enables deletion of time-limited scores.
5939 @item wl-score-header-default-entry
5940 @vindex wl-score-header-default-entry
5941 Specifies the default value for each header field for score entries
5942 created by @code{wl-summary-increase-score},
5943 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5945 @item wl-score-simplify-fuzzy-regexp
5946 @vindex wl-score-simplify-fuzzy-regexp
5947 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5948 regular expression to be deleted from the string.
5949 Because this is usually used for Subject, the default is prefixes that
5950 are attached by mailing list programs.
5952 @item wl-summary-rescore-partial-threshold
5953 @vindex wl-summary-rescore-partial-threshold
5954 The initial setting is 200.
5955 When sync-all or rescan is executed, if there are messages more than
5956 this value, only the last same number of messages as this value are
5959 @item wl-summary-auto-sync-marks
5960 @vindex wl-summary-auto-sync-marks
5961 If non-nil, unread/important marks are synchronized when the summary
5963 Unread marks reflect information on the IMAP4 server.
5964 Important marks reflect information on the IMAP4 server (flagged or
5965 not), and contents of @samp{'mark} folder.
5966 The initial setting is @code{t}.
5970 @node Score File Format, , Score Commands, Scoring
5971 @section Score File Format
5972 @cindex Score File Format
5974 The format of score files are the same as Gnus, and basically you can
5975 use Gnus score files as they are. But they are not fully compatible
5976 because some keys are not supported and there are Wanderlust specifics.
5977 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5982 ("for sale" -1000 nil s)
5983 ("profit" -1000 nil s))
5985 ("spam@@spamspamspam" -10000 nil s))
5987 ("my@@address" 3001 nil s))
5989 (1000000 -10 nil >))
5999 If the key is a string, it is the name of the header to be matched.
6000 The following keys are available:
6001 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6002 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6003 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6004 @code{Chars} and @code{Lines} mean the size and the number of lines of
6005 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6006 are described later.
6007 The rest corresponds the field of the same name.
6009 Arbitrary numbers of core entries are specified after the key.
6010 Each score entry consists of these five factors:
6014 A factor that matches header. This should be a number in the cases of
6015 @code{lines} and @code{chars}, otherwise a string.
6018 A score factor. When the first item matches, the score of the message
6019 is increased or decreased by this value.
6022 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6023 of a number, the score is deleted if it does not match for days
6024 (@code{wl-score-expiry-days}) from the date specified by this.
6025 The date is since Dec. 31, 1 B.C.
6028 A type factor. This specifies the way the first factor matches.
6029 Available types depend on keys.
6032 @item From, Subject, References, Message-ID
6033 For these keys in string, @code{r} and @code{R} (regexp),
6034 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6035 as well as @code{f} and @code{F} (fuzzy) can be used.
6036 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6039 For these keys, the following five numerical relative operators can be
6040 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6043 This key matches @code{From} header, and scores all follow-ups to the
6045 For example, it would be useful for increasing scores for follow-ups to
6048 You can use the same types as @code{From} except for @code{f}.
6049 And a @samp{Followup} entry is automatically appended to the score file.
6052 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6053 A @samp{Thread} entry is automatically appended for each article that
6054 has @var{x} in the @code{References} header.
6055 You can make sure the whole thread including messages that does not have
6056 all ancestors @code{Message-ID} in @code{References} is scored.
6058 You can use the same types as @code{References} except for @code{f}.
6059 And a @samp{Thread} entry is automatically appended to the score file.
6063 A factor for extension header. This is meaningful only if the key is
6065 This specifies headers to be matched other than standard headers like
6066 @code{Subject} and @code{From}.
6067 Note that you should specify the header in
6068 @code{elmo-msgdb-extra-fields} also.
6069 Therefore it does not work in folders where extension headers cannot be
6074 The sum of these scores @emph{after all factors are applied} becomes the
6075 score of the message.
6077 @cindex Score File Atoms
6079 Messages with a score less than this value is marked as read.
6080 The default is @code{wl-summary-mark-below}.
6083 Messages with a score less than this value is deleted from the summary.
6084 The default is @code{wl-summary-expunge-below}.
6086 @item mark-and-expunge
6087 Both @code{mark} and @code{expunge} are applied,
6088 i.e. messages with a score less than this value is marked as read and
6089 deleted from the summary.
6092 Messages with a score greater than this value is attached with temp
6094 The default is @code{wl-summary-target-above}.
6097 Messages with a score greater than this value is attached with important
6099 The default is @code{wl-summary-important-above}.
6104 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6105 are used, you need to set @code{elmo-msgdb-extra-fields}.
6108 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6111 There are other restrictions as shown below:
6114 @item Because @samp{References} field in the summary information
6115 contains only the last @samp{Message-ID}, @code{references} key matches
6119 Keys that can be seen by folder of types:
6123 chars lines xref extra
6124 localdir,localnews Y E E E
6125 nntp (supporting xover) Y E E N
6131 N: cannot be seen (ignored)
6132 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6137 @node Address Book, Customization, Scoring, Top
6138 @chapter Address Book
6139 @cindex Address Book
6141 With address book, you can utilize address completion, and you have
6142 summary displayed with nicknames.
6145 * Mail Addresses:: Definition of Address Book
6146 * Address Manager:: Address Manager
6149 @node Mail Addresses, Address Manager, Address Book, Address Book
6150 @section Address book
6151 @cindex Address book Definition
6153 @cindex Alias, Address
6155 The file @file{~/.addresses} is a simple address book for Wanderlust.
6156 Make address file @file{~/.addresses}, and edit to suit your requirement.
6158 The data written in @file{~/.addresses} are used for address completion
6159 under draft editing mode. Furthermore, they are used when showing names
6160 in summary display mode. You can safely skip this section, if you don't
6161 want to customize address completion and summary display.
6162 It is possible to add/change/remove addresses from @file{~/.addresses} in
6163 summary buffer after Wanderlust is invoked. @refill
6165 The format is very simple. Like this. @refill
6170 # @r{Lines begin with @samp{#} are comment.}
6171 # @r{Empty lines are ignored}
6173 # @r{Format of each line:}
6174 # @var{email-address} "@var{nickname} "@var{realname}"
6176 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6177 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6178 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6183 One line defines one persons description.
6185 Actually, in default setup, @var{nickname} is used in summary-mode and
6186 @var{realname} is used in draft preparation mode. This behavior is
6187 better understood if you try it and confirmed the function first. You
6188 can write and try a small definition, so you will know the idea of the
6189 address book before writing a big one.
6191 And, if MH alias file is specified in variable @code{wl-alias-file},
6192 it is used as an address information in the draft preparation mode.
6194 If variable @code{wl-use-ldap} is non-nil (initial setting is
6195 @code{nil}), address completion in draft mode uses LDAP information.
6197 If you use LDAP, you have to set @code{wl-ldap-server},
6198 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6199 not have LDAP feature as built-in feature (Currently only XEmacs can
6200 have built-in LDAP feature), you have to set command exec @env{PATH} to
6201 the program @command{ldapsearch}.
6204 @node Address Manager, , Mail Addresses, Address Book
6205 @section Address Manager
6206 @cindex Address Manager
6208 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6209 the address book and insert address to draft buffer.
6211 @subsection Key Bindings
6215 @kindex t (Address Manager)
6216 @findex wl-addrmgr-set-to
6217 Add @samp{To:} mark.
6220 @kindex c (Address Manager)
6221 @findex wl-addrmgr-set-cc
6222 Add @samp{Cc:} mark.
6225 @kindex b (Address Manager)
6226 @findex wl-addrmgr-set-bcc
6227 Add @samp{Bcc:} mark.
6230 @kindex u (Address Manager)
6231 @findex wl-addrmgr-unmark
6235 @kindex x (Address Manager)
6236 @findex wl-addrmgr-apply
6238 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6239 buffer and quit address manager. When no draft buffer, make new draft
6240 with insert marked addresses.
6242 If no mark, quit address manager.
6246 @kindex q (Address Manager)
6247 @findex wl-addrmgr-quit
6248 Quit address manager.
6251 @kindex a (Address Manager)
6252 @findex wl-addrmgr-add
6256 @kindex d (Address Manager)
6257 @findex wl-addrmgr-delete
6261 @kindex e (Address Manager)
6262 @findex wl-addrmgr-edit
6267 @node Customization, Terminology, Address Book, Top
6268 @chapter Customizing Wanderlust
6269 @cindex Customization
6272 * Living with other packages:: Cooperating with other packages
6273 * Highlights:: Highlights
6274 * Biff:: Notify Mail arrival
6275 * Advanced Settings:: Advanced Settings
6276 * Customizable Variables:: Customizable Variables
6281 @node Living with other packages, Highlights, Customization, Customization
6282 @section Living with other packages
6284 Examples with other packages.
6287 * imput:: imput (im-wl.el)
6289 * supercite:: supercite.el
6290 * mu-cite:: mu-cite.el
6291 * X-Face:: x-face,bitmap-mule
6292 * dired-dd:: dired-dd.el
6294 * Addrbook:: Addrbook
6295 * mime-w3m:: mime-w3m.el
6299 @node imput, BBDB, Living with other packages, Living with other packages
6304 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6307 If @command{imput} is on the @code{exec-path} at the installation,
6308 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6312 (autoload 'wl-draft-send-with-imput-async "im-wl")
6313 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6318 @node BBDB, supercite, imput, Living with other packages
6322 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6325 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6326 byte-compiled and installed.
6334 ;; @r{enable pop-ups}
6335 (setq bbdb-use-pop-up t)
6336 ;; @r{auto collection}
6337 (setq bbdb/mail-auto-create-p t)
6338 ;; @r{exceptional folders against auto collection}
6339 (setq bbdb-wl-ignore-folder-regexp "^@@")
6340 (setq signature-use-bbdb t)
6341 (setq bbdb-north-american-phone-numbers-p nil)
6342 ;; @r{shows the name of bbdb in the summary} :-)
6343 (setq wl-summary-from-function 'bbdb-wl-from-func)
6344 ;; @r{automatically add mailing list fields}
6345 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6346 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6350 You can complete address with BBDB by @kbd{M-@key{TAB}}
6354 @node supercite, mu-cite, BBDB, Living with other packages
6355 @subsection sc.el(supercite), sc-register.el
6359 The same setting as usual mailers should be OK. The following is an
6360 example of settings:
6364 (autoload 'sc-cite-original "supercite" nil t)
6365 (add-hook 'mail-citation-hook 'sc-cite-original)
6370 @node mu-cite, X-Face, supercite, Living with other packages
6371 @subsection mu-cite.el
6374 The same setting as usual mailers should be OK. The following is an
6375 example of settings.
6377 If you use mu-cite version 8.0 or earlier:
6381 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6382 (setq mail-citation-hook 'mu-cite/cite-original)
6386 If you use mu-cite version 8.1 or later:
6390 (autoload 'mu-cite-original "mu-cite" nil t)
6391 (add-hook 'mail-citation-hook (function mu-cite-original))
6395 @node X-Face, dired-dd, mu-cite, Living with other packages
6399 If you have installed one of the following, you can decode
6400 @samp{X-Face:} field in message buffer and you will see face image.
6403 * x-face-xmas:: XEmacs case
6404 * x-face-mule:: Emacs case
6407 If there is an encoded X-Face string in a file @file{~/.xface} (the
6408 value of the variable @code{wl-x-face-file}), it is inserted as a
6409 @samp{X-Face:} field in the draft buffer (if
6410 @code{wl-auto-insert-x-face} is non-nil).
6412 @node x-face-xmas, x-face-mule, X-Face, X-Face
6413 @subsubsection x-face-xmas (for XEmacs)
6416 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6417 1.3.6.13 or later, do the following:
6421 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6422 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6426 @node x-face-mule, , x-face-xmas, X-Face
6427 @subsubsection x-face-mule (for Emacs)
6431 If you use @file{x-face-mule.el} in bitmap-mule
6432 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6436 (autoload 'x-face-decode-message-header "x-face-mule")
6437 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6441 @subsubsection x-face-e21 (for Emacs 21.x)
6444 With Emacs 21.x, you can use @file{x-face-e21.el}
6445 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6446 to display X-Face. In this case, bitmap-mule is not required.
6451 (autoload 'x-face-decode-message-header "x-face-e21")
6452 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6457 @node dired-dd, MHC, X-Face, Living with other packages
6458 @subsection dired-dd(Dired-DragDrop)
6459 @pindex Dired-DragDrop
6461 @cindex Drag and Drop
6463 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6464 compose multi-part by simple Drag-and-Drop from dired to the draft
6465 buffer being edited in GNU Emacs (this feature is not Wanderlust
6466 specific, but general-purpose for SEMI).
6470 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6476 ;; @r{Set dired-x variables here.}
6477 ;; @r{To and flo@dots{}}
6479 (progn (require 'dired-dd)
6480 (require 'dired-dd-mime))))))
6484 @node MHC, Addrbook, dired-dd, Living with other packages
6488 Message Harmonized Calendaring system
6489 (@uref{http://www.quickhack.net/mhc/})
6491 By using MHC, you can make a calendar from the messages.
6497 (setq mhc-mailer-package 'wl)
6498 (autoload 'mhc-mode "mhc" nil t)
6499 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6500 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6508 (autoload 'mhc-wl-setup "mhc-wl")
6509 (add-hook 'wl-init-hook 'mhc-wl-setup)
6513 @node Addrbook, mime-w3m, MHC, Living with other packages
6514 @subsection wl-addrbook.el
6518 (@uref{http://www.mew.org/})
6520 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6521 @code{load-path} and do the following settings.
6525 (require 'wl-addrbook)
6530 @node mime-w3m, , Addrbook, Living with other packages
6531 @subsection mime-w3m.el
6534 You can display html part by using @file{mime-w3m.el}
6535 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6536 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6539 @node Highlights, Biff, Living with other packages, Customization
6542 @subsection Customizable Variables
6545 @item wl-summary-highlight
6546 @vindex wl-summary-highlight
6547 The initial setting is @code{t}.
6548 If non-nil, the summary is highlighted.
6550 @item wl-highlight-max-summary-lines
6551 @vindex wl-highlight-max-summary-lines
6552 The initial setting is 10000.
6553 The summary is not highlighted if it has more lines than this value.
6555 @item wl-summary-highlight-partial-threshold
6556 @vindex wl-summary-highlight-partial-threshold
6557 The initial setting is 1000.
6558 This is a threshold whether the whole summary is highlighted.
6559 If there are more lines of messages in the summary, it is partially
6562 @item wl-summary-partial-highlight-above-lines
6563 @vindex wl-summary-partial-highlight-above-lines
6564 The initial setting is 30. If there are more lines of messages than
6565 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6566 after the point that is the same number of lines as this value above the
6567 cursor line are highlighted partially. (If this value is @code{nil},
6568 the last same number of lines as the value of
6569 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6571 @item wl-highlight-body-too
6572 @vindex wl-highlight-body-too
6573 The initial setting is @code{t}.
6574 If non-nil, bodies of drafts and messages are also highlighted.
6576 @item wl-highlight-message-header-alist
6577 @vindex wl-highlight-message-header-alist
6578 When highlighting headers of drafts and messages, this variable
6579 specifies which faces are allocated to important
6580 (@code{wl-highlight-message-important-header-contents}), secondly
6581 important (@code{wl-highlight-message-important-header-contents2}), and
6582 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6584 Similarly, it can be used for allocating arbitrary faces to arbitrary
6585 regular expressions.
6587 @item wl-highlight-citation-prefix-regexp
6588 @vindex wl-highlight-citation-prefix-regexp
6589 Specifies a regular expression to which quoted lines in bodies of
6590 drafts and messages match.
6591 Bodies matching to this regular expression are highlighted by the faces
6592 specified by (@code{wl-highlight-message-cited-text-*}).
6594 @item wl-highlight-highlight-citation-too
6595 @vindex wl-highlight-highlight-citation-too
6596 The initial setting is @code{nil}.
6597 If non-nil, the quoting regular expression itself given by
6598 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6600 @item wl-highlight-citation-header-regexp
6601 @vindex wl-highlight-citation-header-regexp
6602 Specifies a regular expression that denotes beginning of quotation.
6603 Bodies matching to this regular expression are highlighted by the face
6604 specified by @code{wl-highlight-message-headers}.
6606 @item wl-highlight-max-header-size
6607 @vindex wl-highlight-max-header-size
6608 The initial setting is @code{nil}. If a header size is larger than this
6609 value, it will not be highlighted. If @code{nil}, always highlighted
6610 (ignore header size).
6612 @item wl-highlight-max-message-size
6613 @vindex wl-highlight-max-message-size
6614 The initial setting is 10000.
6615 If a message is larger than this value, it will not be highlighted.
6616 With this variable, highlight is suppressed for uuencode or huge digest
6619 @item wl-highlight-signature-separator
6620 @vindex wl-highlight-signature-separator
6621 Specifies regular expressions that denotes the boundary of a signature.
6622 It can be a regular expression, or a list of ones.
6623 Messages after the place that matches this regular expression are
6624 highlighted by the face specified by
6625 @code{wl-highlight-message-signature}.
6627 @item wl-max-signature-size
6628 @vindex wl-max-signature-size
6629 The initial setting is 400.
6630 This is the largest size for a signature to be highlighted.
6632 @item wl-use-highlight-mouse-line
6633 @vindex wl-use-highlight-mouse-line
6634 The initial setting is @code{t}.
6635 If non-nil, the line pointed by the mouse is highlighted in the folder
6636 mode, summary mode, and the like.
6639 @subsection Setting Colors and Fonts of the Characters
6641 If you want to change colors or fonts of the characters, you need to
6642 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6643 want to change fonts, and @code{set-face-foreground} for colors, and so
6644 on. You cannot write face settings in @file{.emacs}; write in
6647 For example, if you want to change the color for signatures to yellow,
6651 (set-face-foreground 'wl-highlight-message-signature "yellow")
6657 Faces defined in Wanderlust:
6660 @item wl-highlight-message-headers
6661 The face for field names of message headers.
6663 @item wl-highlight-message-header-contents
6664 The face for field bodies of message headers.
6666 @item wl-highlight-message-important-header-contents
6667 The face for important parts of message headers.
6668 Per default, this face is used for a body of @samp{Subject:} field.
6669 You can change its value by editing
6670 @code{wl-highlight-message-header-alist}.
6672 @item wl-highlight-message-important-header-contents2
6673 The face for secondly important parts of message headers.
6674 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6675 fields. You can change its value by editing
6676 @code{wl-highlight-message-header-alist}.
6678 @item wl-highlight-message-unimportant-header-contents
6679 The face for unimportant parts of message headers.
6680 Per default, this face is used for bodies of @samp{X-} fields
6681 @samp{User-Agent:} fields. You can change its value by editing
6682 @code{wl-highlight-message-header-alist}.
6684 @item wl-highlight-message-citation-header
6685 The face for headers of quoted messages.
6687 @item wl-highlight-message-cited-text-*
6688 The face for texts of quoted messages. The last @samp{*} is a
6689 @var{single figure} so that 10 different colors can be used according to
6692 @item wl-highlight-message-signature
6693 The face for signatures of messages. The initial settings are
6694 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6695 dark background colors.
6697 @item wl-highlight-header-separator-face
6698 The face for header separators of draft messages.
6700 @item wl-highlight-summary-important-face
6701 The face for message lines with important marks in the summary.
6703 @item wl-highlight-summary-new-face
6704 The face for message lines with new marks in the summary.
6706 @item wl-highlight-summary-displaying-face
6707 The face for the message line that is currently displayed.
6708 This face is overlaid.
6710 @item wl-highlight-thread-indent-face
6711 The face for the threads that is currently displayed.
6713 @item wl-highlight-summary-unread-face
6714 The face for message lines with unread marks in the summary.
6716 @item wl-highlight-summary-deleted-face
6717 The face for message lines with delete marks in the summary.
6719 @item wl-highlight-summary-refiled-face
6720 The face for message lines with re-file marks in the summary.
6722 @item wl-highlight-refile-destination-face
6723 The face for re-file information part of message lines with re-file
6724 marks in the summary.
6726 @item wl-highlight-summary-copied-face
6727 The face for message lines with copy marks in the summary.
6729 @item wl-highlight-summary-target-face
6730 The face for message lines with target marks @samp{*} in the summary.
6732 @item wl-highlight-summary-thread-top-face
6733 The face for message lines that are on the top of the thread in the
6736 @item wl-highlight-summary-normal-face
6737 The face for message lines that are not on top of the thread in the
6740 @item wl-highlight-folder-unknown-face
6741 The face for folders that are not known to have how many unsync messages
6744 @item wl-highlight-folder-zero-face
6745 The face for folders that have no unsync messages in the folder mode.
6747 @item wl-highlight-folder-few-face
6748 The face for folders that have some unsync messages in the folder mode.
6750 @item wl-highlight-folder-many-face
6751 The face for folders that have many unsync messages in the folder mode.
6752 The boundary between `some' and `many' is specified by the variable
6753 @code{wl-folder-many-unsync-threshold}.
6755 @item wl-highlight-folder-unread-face
6756 The face for folders that have no unsync but unread messages in the
6759 @item wl-highlight-folder-killed-face
6760 The face for folders that are deleted from the access group in the
6763 @item wl-highlight-folder-opened-face
6764 The face for open groups in the folder mode.
6765 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6766 @code{nil} or a @var{number}.
6768 @item wl-highlight-folder-closed-face
6769 The face for close groups in the folder mode.
6770 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6771 @code{nil} or a @var{number}.
6773 @item wl-highlight-folder-path-face
6774 The face for the path to the currently selected folder in the folder
6777 @item wl-highlight-logo-face
6778 The face for logo in the demo.
6780 @item wl-highlight-demo-face
6781 The face for strings (for example, a version number) in the demo.
6785 @node Biff, Advanced Settings, Highlights, Customization
6786 @section Notify Mail arrival
6789 Following setting is to notify mail arrival of @samp{%inbox}
6790 by the indicator on the modeline
6793 (setq wl-biff-check-folder-list '("%inbox"))
6796 @subsection Customizable Variables
6798 @item wl-biff-check-folder-list
6799 @vindex wl-biff-check-folder-list
6800 The initial setting is @code{nil}.
6801 This is the list of folders to check mail arrival.
6802 If @code{nil}, wl doesn't check mail arrival.
6804 @item wl-biff-check-interval
6805 @vindex wl-biff-check-interval
6806 The initial setting is 40 (in seconds).
6807 Check mail arrival in this period.
6809 @item wl-biff-notify-hook
6810 @vindex wl-biff-notify-hook
6811 This hook is run at the arrival of new mail.
6812 To beep with mail arrival(initial setting), set as follows.
6814 (setq wl-biff-notify-hook '(ding))
6816 For silence, set to @code{nil}.
6820 @node Advanced Settings, Customizable Variables, Biff, Customization
6821 @section Advanced Settings
6824 * Draft for Reply:: Draft for Reply
6825 * Thread Format:: Appearance of Thread
6826 * User-Agent Field:: @samp{User-Agent:} Header Field
6830 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6831 @subsection Draft for Replay
6832 @vindex wl-draft-reply-with-argument-list
6833 @vindex wl-draft-reply-without-argument-list
6834 @vindex wl-draft-reply-myself-with-argument-list
6835 @vindex wl-draft-reply-myself-without-argument-list
6837 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
6838 The addressee for the draft is decided by following rules.
6840 For example, you can set as follows:
6844 (setq wl-draft-reply-without-argument-list
6845 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6846 ("Followup-To" . (nil nil ("Followup-To")))
6847 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6848 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6852 Where each element of the list @code{wl-draft-reply-without-argument-list}
6856 (key . (to-list cc-list newsgroup-list))
6859 and if the field designated by @samp{key} exist in the parent message,
6860 parent's field values designated by @samp{to-list} are copied to @samp{To:}
6861 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
6862 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
6863 the draft respectively.
6868 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6871 Match if the parent has @samp{Mail-Followup-To} field.
6872 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
6873 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
6877 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6880 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
6881 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
6884 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
6887 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
6888 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
6891 These are evaluated in order and first matched one is used.
6893 Moreover, the behavior of @kbd{a} with prefix argument can
6894 be directed by @code{wl-draft-reply-with-argument-list} as well.
6896 By the way, you can use some function (will be evaluated in the parent
6897 message buffer) in the place of @samp{key} or @samp{to-list} etc.
6898 For example, if you only want to reply to mailing lists in
6899 @code{wl-subscribed-mailing-list} if the parent has some of them,
6904 (defun wl-mailing-list-addresses ()
6908 (nth 1 (std11-extract-address-components addr)))
6911 (elmo-multiple-fields-body-list (list "To" "Cc"))
6913 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
6914 (setq list-addrs (cons to list-addrs))))
6915 (nreverse list-addrs)))
6917 (setq wl-draft-reply-with-argument-list
6918 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
6919 ("Reply-To" . (("Reply-To") nil nil))
6920 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
6921 ("From" . (("From") nil nil))))
6926 Note: To set the behavior when you reply to the message written by yourself,
6927 use @code{wl-draft-reply-myself-without-argument-list} and
6928 @code{wl-draft-reply-myself-with-argument-list} instead of them.
6930 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6931 @subsection Appearance of Threads
6935 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6936 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6937 391 09/18(Fri)19:24 +-[ Murata-san ]
6938 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6939 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6940 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6941 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6942 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6943 412 09/22(Tue)09:28 | +-[ Teranishi ]
6944 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6945 416 09/22(Tue)12:38 | +-[ Teranishi ]
6946 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6947 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6951 Settings to make appearance of threads like shown above:
6955 (setq wl-thread-indent-level 2)
6956 (setq wl-thread-have-younger-brother-str "+")
6957 (setq wl-thread-youngest-child-str "+")
6958 (setq wl-thread-vertical-str "|")
6959 (setq wl-thread-horizontal-str "-")
6960 (setq wl-thread-space-str " ")
6964 If you do not want to see branches, do the following:
6968 (setq wl-thread-indent-level 2)
6969 (setq wl-thread-have-younger-brother-str " ")
6970 (setq wl-thread-youngest-child-str " ")
6971 (setq wl-thread-vertical-str " ")
6972 (setq wl-thread-horizontal-str " ")
6973 (setq wl-thread-space-str " ")
6978 @node User-Agent Field, , Thread Format, Advanced Settings
6979 @subsection User-Agent Field
6983 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6984 @samp{User-Agent:} fields, define a function that generate appropriate
6985 strings as you like, and set it to variable
6986 @code{wl-generate-mailer-string-function}.
6988 If you do not want verbose @samp{User-Agent:} field, do the following:
6992 (setq wl-generate-mailer-string-function
6993 'wl-generate-user-agent-string-1)
6997 The following is a example:
7001 (setq wl-generate-mailer-string-function nil)
7002 (setq wl-draft-additional-header-alist
7004 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7009 @node Customizable Variables, Hooks, Advanced Settings, Customization
7010 @section Customizable Variables
7012 Customizable variables that have not been described yet:
7015 @item wl-default-folder
7016 @vindex wl-default-folder
7017 The initial setting is @samp{%inbox}. This is the default value for moving to
7018 a folder and the like.
7020 @item wl-draft-folder
7021 @vindex wl-draft-folder
7022 The initial setting is @samp{+draft}. It is the folder to which drafts are
7023 saved. It must be a localdir folder.
7025 @item wl-trash-folder
7026 @vindex wl-trash-folder
7027 The initial setting is @samp{+trash}. It is the wastebasket folder.
7028 If you changed this variable, you had better restart Wanderlust.
7030 @item wl-interactive-exit
7031 @vindex wl-interactive-exit
7032 The initial setting is @code{t}.
7033 If non-nil, you are asked for confirmation when Wanderlust terminates.
7035 @item wl-interactive-send
7036 @vindex wl-interactive-send
7037 The initial setting is @code{t}.
7038 If non-nil, you are asked for confirmation when mail is sent.
7040 @item wl-folder-sync-range-alist
7041 @vindex wl-folder-sync-range-alist
7042 The initial setting is the alist shown below:
7047 ("^\\+draft$\\|^\\+queue$" . "all"))
7052 This is an associative list of regular expressions of folder names and
7053 update range of the summary. Update range is one of the @samp{all},
7054 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
7055 @samp{last}. If a folder do not match, @samp{update} is used.
7058 @vindex wl-ask-range
7059 The initial setting is @code{t}.
7060 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7061 for updating the summary when you changed folders.
7063 @item wl-mime-charset
7064 @vindex wl-mime-charset
7065 The initial setting is @code{x-ctext}.
7066 This is the MIME charset for messages that are not MIME (e.g. without
7067 @samp{Content-Type:}). This value also used as default charset for
7068 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7069 this value as @code{iso-2022-jp}.)
7071 @item wl-highlight-folder-with-icon
7072 @vindex wl-highlight-folder-with-icon
7073 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7074 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7076 @item wl-strict-diff-folders
7077 @vindex wl-strict-diff-folders
7078 This is a list of regular expressions of folders.
7079 Unread messages are checked, for example when you press @kbd{s} in
7080 the folder mode, usually in a brief way (rapidly processed but not
7082 The folders matching this variable are seriously checked.
7083 You may want to set this variable so as to match conditional filter
7084 folders for IMAP4 folders.
7085 The initial setting is @code{nil}.
7087 @item wl-folder-use-server-diff
7088 @vindex wl-folder-use-server-diff
7089 When unread messages are checked, for example when you press @kbd{s} in
7090 the folder mode, usually (the number of messages on the server) @minus{}
7091 (the number of local messages) will be the number of unread messages.
7092 However, if this variable is non-nil, the number of unread messages on
7093 the server is checked. This affects IMAP4 folders only, but IMAP4
7094 folders in mail boxes matching
7095 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7096 the number of unread messages on the server, even if they matches this
7097 variable. The initial setting is @code{t}.
7099 @item wl-auto-check-folder-name
7100 @vindex wl-auto-check-folder-name
7101 The initial setting is @code{nil}.
7102 You can specify a folder or a group which is checked for unread message
7103 at the start. You can also specify a list of folders (groups) to be checked.
7104 If the value is @code{nil}, whole Desktop is checked at the start.
7105 If it is @code{none}, no folders are checked.
7107 @item wl-auto-uncheck-folder-list
7108 @vindex wl-auto-uncheck-folder-list
7109 The initial setting is the list shown below:
7118 You can set a list of regular expressions to specify folders
7119 which are not automatically checked even if they are included
7120 in some groups assigned by @code{wl-auto-check-folder-name}.
7122 @item wl-auto-check-folder-list
7123 @vindex wl-auto-check-folder-list
7124 The initial setting is @code{nil}.
7125 You can set a list of regular expressions to specify exceptions
7126 for @code{wl-auto-uncheck-folder-list}.
7128 @item wl-no-save-folder-list
7129 @vindex wl-no-save-folder-list
7130 The initial setting is the list shown below:
7139 This is a list of regular expressions of folders not to be saved.
7141 @item wl-save-folder-list
7142 @vindex wl-save-folder-list
7143 The initial setting is @code{nil}.
7144 This is a list of regular expressions of folders to be saved.
7145 This takes precedence over @code{wl-no-save-folder-list}.
7147 @item wl-folder-mime-charset-alist
7148 @vindex wl-folder-mime-charset-alist
7149 The initial setting is the alist shown below:
7153 (("^-alt\\.chinese" . big5)
7154 ("^-relcom\\." . koi8-r)
7156 ("^-han\\." . euc-kr))
7161 This is an associative list of regular expressions of folder names and
7163 If a folder do not match, @code{wl-mime-charset} is used.
7165 @item wl-folder-init-load-access-folders
7166 @vindex wl-folder-init-load-access-folders
7167 The initial setting is @code{nil}.
7168 This is a list of access groups to be loaded specifically at the start.
7169 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7171 @item wl-folder-init-no-load-access-folders
7172 @vindex wl-folder-init-no-load-access-folders
7173 The initial setting is @code{nil}.
7174 This is a list of access groups not to be loaded specifically at the
7176 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7178 @item wl-delete-folder-alist
7179 @vindex wl-delete-folder-alist
7180 The initial setting is the alist shown below:
7189 This list determines disposition of messages with delete marks.
7190 Each item in the list is a folder and destination; you can specify any
7191 one of the following in the place of destination:
7194 @code{remove} or @code{null} : deletes the messages instantly.
7195 string : moves the messages to the specific folder.
7196 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7199 @item wl-refile-policy-alist
7200 @vindex wl-refile-policy-alist
7201 The initial setting is the list shown below:
7211 This list determines whether messages with re-file marks are moved or
7212 copied. Each item in the list is a cons cell of a folder and
7213 @code{copy} or @code{move}.
7215 @item wl-x-face-file
7216 @vindex wl-x-face-file
7217 The initial setting is @file{~/.xface}.
7218 The name of the file that contains encoded X-Face strings.
7221 @item wl-demo-display-logo
7222 @vindex wl-demo-display-logo
7223 If non-nil, bitmap image is shown on the opening demo. If you set
7224 @code{xpm} or @code{xbm}, (if possible) display selected image type
7227 @item elmo-use-database
7228 @vindex elmo-use-database
7229 This is meaningful for XEmacs only. The initial setting depends on
7230 XEmacs (@code{t} for XEmacs with dbm).
7231 If non-nil, Message-ID is controlled by dbm.
7233 @item elmo-passwd-alist-file-name
7234 @vindex elmo-passwd-alist-file-name
7235 The initial setting is @file{passwd}.
7236 This is the name of the file in which passwords are saved.
7237 @code{elmo-passwd-alist-save} saves current passwords to the file.
7239 @item elmo-nntp-list-folders-use-cache
7240 @vindex elmo-nntp-list-folders-use-cache
7241 The initial setting is 600 (in seconds).
7242 This is period in seconds during which results of @samp{list} and
7243 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7246 @item elmo-nntp-max-number-precedes-list-active
7247 @vindex elmo-nntp-max-number-precedes-list-active
7248 The initial setting is @code{nil}.
7249 If non-nil, the number of article obtained by @samp{list active} in NNTP
7250 are used as the maximum article number of the folder.
7251 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7252 and if the number of read messages is not correct.
7254 @item elmo-nntp-default-use-listgroup
7255 @vindex elmo-nntp-default-use-listgroup
7256 The initial setting is @code{t}.
7257 If non-nil, @samp{listgroup} is used for checking the total number of
7258 articles. If it is @code{nil}, @samp{group} is used. In the latter
7259 case, the processing will be a little faster at the sacrifice of
7262 @item elmo-pop3-send-command-synchronously
7263 @vindex elmo-pop3-send-command-synchronously
7264 The initial setting is @code{nil}.
7265 If non-nil, POP3 commands are issued synchronously. Some implementation
7266 of POP3 server fails to get summary information without this setting.
7267 You may have to set this variable to @code{t}, if the process hangs
7268 while looking up POP3.
7270 @item elmo-dop-flush-confirm
7271 @vindex elmo-dop-flush-confirm
7272 The initial setting is @code{t}.
7273 If non-nil, you are asked for confirmation if accumulated off-line
7274 operations are executed.
7276 @item elmo-display-progress-threshold
7277 @vindex elmo-display-progress-threshold
7278 The initial setting is 20.
7279 Threshold for display of progress gauge. If number of renewal is more than
7280 this value, display progress gauge.
7284 @node Hooks, , Customizable Variables, Customization
7289 @node Terminology, Mailing List, Customization, Top
7290 @chapter Terminology around Wanderlust
7293 Here we explain terminologies used in this manual.
7297 A container in which messages are stored.
7300 A set consists of some folders.
7303 A special group consists of automatically collected folders under
7304 some specified path.
7305 @xref{Folder Definition}.
7307 @item summary buffer
7308 A buffer for displaying list of messages in some folder.
7310 @item sticky summary
7311 Compared with ordinary summary buffer which will be destroyed after
7312 exiting from it, this type of summary will be remain even after exiting
7313 by @kbd{q} or @kbd{g}.
7314 @xref{Sticky Summary}.
7317 To delete or put into the archive expired messages.
7324 To cache messages beforehand in order to read messages after you will be
7325 disconnected from the server.
7329 @node Mailing List, Addition, Terminology, Top
7330 @chapter Wanderlust Mailing List
7334 Topics related to Wanderlust are discussed in following mailing lists.
7335 The latest version is also announced there.
7338 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7341 In this list Japanese is mainly used for discussion. We also have a list
7342 for discussion in English:
7345 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7347 (Messages posted to this list are also forwarded to the former one.)
7349 A guide can be obtained automatically by sending mail to
7350 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7351 the English one) with the body
7357 Please send bug reports or patches to one of those lists. You can post to
7358 the mailing list even though you are not a member of it.
7360 If you send a bug report, please attach Backtrace with it.
7361 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7364 I would like to express my thanks to the members of the mailing list for
7365 valuable advice and many pieces of code they contributed.
7368 @node Addition, Index, Mailing List, Top
7369 @chapter Additional Information
7371 @section Brief History
7374 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7375 3/10 Made a msgdb mechanism by elisp.
7376 3/26 IMAP and NNTP can be displayed in threads.
7377 4/13 Began to assemble thread display modules as elmo.
7378 5/01 Finished 0.1.0, initial version with many defects.
7379 6/12 I made a slip of the tongue and said I was writing elisp
7380 mailer supporting IMAP
7381 6/16 0.1.3 was announced at tm-ja, elisp ML.
7382 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7383 7/01 Support for mm-backend (0.3.0).
7384 8/25 multi folder added (0.5.0).
7385 8/28 filter folder added (0.5.1).
7386 9/10 You can open/close threads (0.6.0).
7387 9/11 fldmgr by Murata-san made editing folders easy.
7388 9/18 lha folders added by Okunishi-san (0.6.3).
7389 9/24 Display of branches of threads (0.6.5).
7390 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7391 10/28 Off-line operations (0.7.4).
7392 12/09 Becomes beta version.
7393 12/21 wl-expire by Murata-san.
7394 1999 2/03 auto-refile by Tsumura-san.
7395 4/28 wl-template by Murata-san.
7396 5/18 Released 1.0.0 stable.
7397 7/05 Scoring by Murata-san (2.1.0).
7398 9/26 New plugged system by Murata-san (2.2.2).
7399 12/20 Support Modified UTF7.
7400 2000 3/24 Released 1.1.0 stable.
7401 4/03 CVS development started.
7402 5/07 Thread restoration & Its speed up with Murata-san.
7403 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7404 7/11 killed message feature.
7405 7/18 Use UIDL in POP3.
7406 9/12 biff feature with Satata-san & Yamaoka-san.
7407 10/17 expire-hide by Okada-san.
7408 11/08 Released 2.4.0 stable.
7409 2001 7/04 Released 2.6.0 stable.
7410 8/21 wl-addrmgr by Kitamoto-san.
7411 12/27 Released 2.8.1 stable.
7414 See @file{ChangeLog} for details.
7418 According to a dictionary, Wanderlust has the meaning:
7422 n eager longing for or impulse towards travelling in distant lands
7423 [Ger, fr wandern to wander + lust desire, pleasure]
7427 but I had no profound intention. (if farfetched, IMAP @result{} you can
7428 read mail anywhere @result{} desire to wander ?)
7430 Elmo is the abbreviation of @samp{Elisp Library for Message
7431 Orchestration}. At first I meant the red puppet in the Sesame Street,
7432 but you may associate it with Wandering @result{} Drifting @result{}
7433 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7437 Each versions has code names (they are almost jokes).
7438 Currently they are picked up alphabetically from the top 40 hits of
7439 U.S. Billboard magazines in 1980s.
7441 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7444 @node Index, , Addition, Top
7448 * Concept Index:: Concept Index
7449 * Key Index:: Key Index
7450 * Variable Index:: Variable Index
7451 * Function Index:: Function Index
7454 @node Concept Index, Key Index, Index, Index
7455 @unnumberedsec Concept Index
7458 @node Key Index, Variable Index, Concept Index, Index
7459 @unnumberedsec Key Index
7462 @node Variable Index, Function Index, Key Index, Index
7463 @unnumberedsec Variable Index
7466 @node Function Index, , Variable Index, Index
7467 @unnumberedsec Function Index