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 * Split messages:: Splitting messages
123 * Address Book:: Management of Address Book
124 * Customization:: Customizing Wanderlust
125 * Terminology:: Terminologies
126 * Mailing List:: Wanderlust mailing list
127 * Addition:: Additional Information
132 @node Introduction, Start Me Up, Top, Top
133 @chapter Introduction of Wanderlust
136 Wanderlust is an mail/news management system on Emacsen.
137 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
139 The main features of Wanderlust:
142 @item Pure elisp implementation.
143 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
144 @item Unified access method to messages based on Mew-like Folder Specification.
145 @item Mew-like Key-bind and mark handling.
146 @item Manages unread messages.
147 @item Interactive thread display.
148 @item Folder Mode shows the list of subscribed folders.
149 @item Message Cache, Disconnected Operation (Read Only).
150 @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
151 @item MIME compliant (by SEMI).
152 @item Transmission of news and mail are unified by Message transmitting draft.
153 @item Graphical list of folders (XEmacs and Emacs 21).
154 @item View a part of message without retrieving the whole message (IMAP4).
155 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
156 @item Virtual Folders.
157 @item Supports compressed folder using common archiving utilities.
158 @item Old articles in folders are automatically removed/archived (Expiration).
159 @item Automatic re-file.
160 @item Template function makes it convenient to send fixed form messages.
166 We confirm Wanderlust works on following Emacsen:
169 @item Mule 2.3 based on Emacs 19.34
170 @item Emacs 20.2 or later
171 @item XEmacs 20.4 or later
172 @item Meadow 1.00 or later
173 @item NTEmacs 20.4 or later
177 IMAP4 connectivity with following imapd are confirmed to work with
181 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
182 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
183 @item Courier-IMAP 1.3.2 or later
184 @item AIR MAIL (AIRC imapd release 2.00)
186 @item Microsoft Exchange Server 5.5
187 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
190 LDAP connectivity with following LDAPd are confirmed to work with
194 @item OpenLDAP 2.0.6 or later
198 @node Start Me Up, Folders, Introduction, Top
199 @chapter Start up Wanderlust
202 The necessary procedure for starting Wanderlust is explained in steps
205 (Of course, you need a mail/news readable environment in advance)
208 * MIME Modules:: Installing the MIME modules
209 * Download:: Download and extract the packages
210 * Install:: Byte-compile and install
211 * Minimal Settings:: @file{.emacs} setup
212 * Folder Definition:: Folder definition
213 * Start Wanderlust:: Starting Wanderlust
214 * Overview:: Basic components of Wanderlust
218 @node MIME Modules, Download, Start Me Up, Start Me Up
219 @section Installing MIME modules
225 You must install SEMI beforehand to use Wanderlust.
227 SEMI can be downloaded from following site:
231 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
235 You need packages named APEL and FLIM to use SEMI.
236 You can download APEL and FLIM from following URLs:
240 APEL: ftp://ftp.m17n.org/pub/mule/apel/
241 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
245 You have to install APEL, FLIM and SEMI in this order. Generally,
246 @samp{make install} will do the job. (In XEmacs 21, @samp{make
249 Refer to the documents of each package for detailed installation
250 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
251 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
255 Recommended combination of APEL, FLIM and SEMI are following:
258 @item APEL 10.4, FLIM 1.14.4 and SEMI 1.14.5
261 You can also use many other FLIM/SEMI variants. Combination of the
262 latest versions should work. For example, the following combination are
266 @item APEL 10.4, SLIM 1.14.9, SEMI 1.14.5
267 @item APEL 10.4, CLIME 1.14.5, EMIKO 1.14.1
270 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
273 @node Download, Install, MIME Modules, Start Me Up
274 @section Download and Extract the Package
277 You can download Wanderlust package from following sites:
281 ftp://ftp.gohome.org/wl/
284 Mirrored ftp/http sites:
288 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
289 http://www.jpl.org/elips/wl/
290 http://www.ring.gr.jp/archives/text/elisp/wl/
291 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
292 ftp://opaopa.org/pub/mirror/elisp/wl/
293 @c ftp://roguelife.org/pub/tsumura/wl/
297 Extract the obtained package to your working directory:
302 % tar zxvf wl-@var{version}.tar.gz
303 % cd wl-@var{version}
307 @subsection To use SSL (Secure Socket Layer)
312 SSL (Secure Socket Layer) can be used for
313 SMTP, IMAP, NNTP and POP connections in Wanderlust.
315 There are two ways to use SSL. One is to start SSL negotiation just
316 after the connection establishment (generic way). The other one is to
317 start SSL negotiation by invoking STARTTLS command in the each session.
319 To use the formal SSL (generic SSL), you must set @env{PATH} to the
320 directory that OpenSSL commands are installed.
322 To use the latter SSL(STARTTLS), you must install starttls package in
324 You can download starttls package from the following site.
327 ftp://opaopa.org/pub/elisp/
330 @node Install, Minimal Settings, Download, Start Me Up
331 @section Byte-compile and install
338 @subsection Installation
340 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
341 Set the Emacs's command name to @code{EMACS}.
342 Set package installation directory to @code{LISPDIR}.
343 Then, please execute following commands.
352 Destination directory is auto-probed if you leave @code{LISPDIR}
353 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
355 If you are using an Emacs variant which does not merge specified directory
356 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
357 then you will see the error message:
360 Cannot open load file: mime-setup
364 In this case, either add destination directories of custom, APEL, FLIM
365 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
366 @code{load-path} in @file{WL-CFG} in extracted directory.
368 If you want to handle shimbun folders or to use BBDB, add directory
369 where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
370 modules will be byte-compiled and installed.
371 @xref{Shimbun Folder}, @xref{BBDB}.
373 @subsection @file{WL-CFG}
375 Contents of the file @file{WL-CFG} is loaded under installation if a file
376 with that name exists in extracted directory. You can use @file{WL-CFG} to
377 configure @code{load-path} to extra packages such as SEMI if needed.
379 If you want to specify the install directory of Wanderlust related
380 files, then set following variables in @file{WL-CFG}
384 A directory to install WL modules.
385 This directory is relative directory from @code{LISPDIR}.
386 WL modules include @file{wl*.el}, @file{wl*.elc} files.
387 @c Modules under the directory @file{util/} are also installed if
388 @c it detected as necessary.
391 A directory to install ELMO modules.
392 This directory is relative directory from @code{LISPDIR}.
393 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
394 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
398 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
400 If you want to install ELMO related files under a sub-directory
401 such as "elmo" then add following to @file{WL-CFG}:
404 (setq ELMO_PREFIX "elmo")
407 @subsection Install as a XEmacs package
408 @cindex XEmacs package
409 @cindex XEmacs package install
410 @cindex Package, XEmacs
411 @cindex Package install, XEmacs
412 @c @cindex install-package
414 It is possible to install Wanderlust as one of packages of XEmacs (21.0
415 or later). Configuration for autoload and icon-path in local
416 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
419 Follow the next example to install Wanderlust as an XEmacs package.
425 % make install-package
429 package directory is auto-probed, if SEMI is installed.
430 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
432 @subsection Run in place
434 If wl and elmo directories are defined in @code{load-path}, then
435 byte-compilation and installation are not necessary to start Wanderlust.
436 For example, if package is extracted in @file{~/work}, Wanderlust can be
437 invoked with following setting in @file{~/.emacs}.
441 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
442 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
448 Manual is described in Info format. Please do following.
457 If you install Wanderlust as a XEmacs package, Info file is already
458 installed too, so there are no need of these commands.
460 Manual directory is automatically detected. Of course, it can be
461 configured by @code{INFODIR} in @file{Makefile}.
463 You can read manual at the following URL:
466 http://www.gohome.org/wl/doc/wl_toc.html
469 @node Minimal Settings, Folder Definition, Install, Start Me Up
470 @section Set up .emacs
471 @cindex Minimal Settings
473 @cindex Configuration
477 The Wanderlust package contains two module groups.
480 @item ELMO (elmo-*.el)
481 These modules show everything as folders. This is the back-end for WL.
483 These modules controls the behavior of main body of Wanderlust.
484 They are also the front-end for ELMO.
487 You can customize the behavior of Wanderlust by changing the value
488 of environmental variables which begins with @code{elmo-} and @code{wl-}.
490 The minimal requirement for settings is as the following.
494 ;; @r{autoload configuration}
495 ;; @r{(Not required if you have installed Wanderlust 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{(Not required if the default value points 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 autoload configuration can be written
522 @subsection @code{mail-user-agent}
523 @cindex Default Mailer
524 @cindex Mailer, Default
525 @vindex mail-user-agent
528 If you write following setting in your @file{~/.emacs}, you can
529 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
530 This means it enables you to run Wanderlust as a default mail composer
533 It is effective only when your Emacs can define @code{mail-user-agent}.
534 @xref{Mail Methods, , ,emacs, The Emacs Editor}.
538 (autoload 'wl-user-agent-compose "wl-draft" nil t)
539 (if (boundp 'mail-user-agent)
540 (setq mail-user-agent 'wl-user-agent))
541 (if (fboundp 'define-mail-user-agent)
542 (define-mail-user-agent
544 'wl-user-agent-compose
553 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
554 @section Folder Definition
555 @cindex Folder Definition
558 You can skip this section because it is possible to add/edit the
559 subscribe folders from the buffer for list of folders.
560 @xref{Folder Manager}.
562 Define the folders you want to subscribe in file @file{~/.folders}. The
563 contents written in @file{~/.folders} become the folders which you
564 subscribe to as it is.
566 Format for @file{~/.folders} is very simple. Here is an example:
571 # @r{Lines begin with @samp{#} are comment.}
572 # @r{Empty lines are ignored}
574 # @var{folder name} "@var{folder nickname}"
575 # @r{(nicknames are not necessary)}
580 %#mh/Backup@@my.imap.example.com "Sent"
583 %#mh/spool/wl "Wanderlust ML"
584 %#mh/spool/elips "ELIPS ML"
585 %#mh/spool/apel-ja "APEL Japanese ML"
586 %#mh/spool/xemacs-beta "XEmacs beta"
587 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
588 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
591 # @r{If folder name ends with @samp{/}, that means an `access group',}
592 # @r{all subfolders automatically included in one folder group.}
594 %#mh/expire@@localhost /
595 # @r{All MH folders are included in one folder group.}
600 Each line contains one folder you want to read. The definition of
601 folders will be explained in detail in the next section.
603 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
604 become one folder group. One folder group is treated as a directory
605 which can be opened and closed in folder mode. It is convenient for
606 collecting some folders and putting them in order.
608 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
609 line and you have to write it that way (It is because the parser sucks).
611 There are two types of groups. One is like @samp{Emacsen} from above
612 example which the user chooses his favorite folders as a group.
614 The other one is @dfn{access group} like @samp{+ /} from above example.
615 It collects all sub-folders in the folder to make a group. (Its
616 behavior differs by the type of the folder. For example, @samp{+}
617 followed by @samp{/} makes entire MH sub-directories to one group)
619 This behavior is better understood if you try it and confirmed the
620 function first. You can write and try a small folder definition, so you
621 will know the idea of the folder function before writing the real one.
623 @node Start Wanderlust, Overview, Folder Definition, Start Me Up
624 @section Start Wanderlust
625 @cindex Start Wanderlust
627 If installation and configuration worked well, you can invoke Wanderlust by
628 typing following command in Emacs.
635 After initialization, Folder Mode which shows the list of folders will
636 appear. That means the folders you defined in the @file{~/.folders} are
639 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
640 can skip folder checking.
643 @node Overview, , Start Wanderlust, Start Me Up
647 Basically, you will handle messages in wanderlust while you come and go
648 from/to each of the following buffers. Details of each ones are
649 explained in following chapters.
653 You can see the list of folders. You can select some folder and go into the summary
654 of it. You can subscribe new folder or edit subscription list.
656 You can see the list of messages in the folder. You can select message
657 and view its contents, and reply to some message. You can delete ones or
658 move ones to another folder.
660 You can see the contents of the message. You can save part to disk or
661 open in external programs.
663 You can edit message.
667 @node Folders, Folder, Start Me Up, Top
668 @chapter Wanderlust's folders
671 This chapter describes the folder types which Wanderlust is able to handle.
673 Wanderlust uses ELMO as it's interface, so you can use every folder types
676 As of version @value{VERSION}, 11 types of folders are predefined. These are
677 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
678 Pipe and Internal folder types.
681 * IMAP Folder:: @samp{%} -- IMAP folder
682 * NNTP Folder:: @samp{-} -- NNTP folder
683 * MH Folder:: @samp{+} -- MH folder
684 * Maildir Folder:: @samp{.} -- Maildir folder
685 * News Spool Folder:: @samp{=} -- News spool folder
686 * Archive Folder:: @samp{$} -- Archive folder
687 * POP Folder:: @samp{&} -- POP folder
688 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
689 * Namazu Folder:: @samp{[} -- Namazu Folder
690 * Multi Folder:: @samp{*} -- Multi folder
691 * Filter Folder:: @samp{/} -- Filter folder
692 * Pipe Folder:: @samp{|} -- Pipe folder
693 * Internal Folder:: @samp{'} -- Internal folder
697 @node IMAP Folder, NNTP Folder, Folders, Folders
705 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
711 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
715 You can specify @code{login} (encoded password transmission),
716 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
717 authentication) or @code{clear} (or @code{nil}, plain password
718 transmission) as @var{authenticate-type}.
723 @var{username} -> The value of @code{elmo-imap4-default-user}.
724 Initial setting is @env{USER} environment variable or
725 @env{LOGNAME} environment variable or return value of
726 @code{(user-login-name)}.
727 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
728 Initial setting is "auth".
729 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
730 Initial setting is "localhost".
731 @var{port} -> The value of @code{elmo-imap4-default-port}.
732 Initial setting is 143.
735 You can omit the @var{hostname} from folder names if you set
736 @code{elmo-imap4-default-server} as your main IMAP server.
737 For example, you can specify a folder as @samp{foo%imap@@gateway} even
738 if you have to go through a firewall.
742 ;; @r{Example: imap4.exaple.org as main IMAP server}
743 (setq elmo-imap4-default-server "imap4.example.org")
747 SSL (Secure Socket Layer) connection will be used if a folder name ends
748 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
749 is @code{ssl}, SSL will be the default connection. If a folder name
750 ends with @samp{!!}, STARTTLS connection will be established. If the
751 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
752 STARTTLS will be the default connection.
756 ;; @r{Example: Use SSL connection}
757 (setq elmo-imap4-default-stream-type 'ssl)
761 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
762 authentication method, the password is sent in encoded form. But, if
763 your server is unable to receive an encoded password, authentication
764 will fall back to @code{clear} (that is, sending password in raw format)
765 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
766 authentication will fall back to @code{clear} without confirmation
767 (default value is @code{nil}).
771 ;; @r{Example: password in raw format}
772 (setq elmo-imap4-default-authenticate-type 'clear)
780 %inbox -> IMAP mailbox "inbox"
781 %#mh/inbox -> IMAP mailbox "#mh/inbox"
783 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
784 %inbox:hoge/clear@@server1
785 -> server1's IMAP mailbox "inbox"
786 of user "hoge", with plain password authentication
791 @subsection International mailbox names (Modified UTF7)
792 @cindex Modified UTF7
799 You can use international mailbox names in @var{mailbox} part, if you
800 are using Emacs with UTF-7 support and
801 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
802 value is @code{nil}).
804 Currently, Mule-UCS package is required to use UTF-7.
805 Mule-UCS works on following Emacsen.
808 @item Emacs 20.3 or later
809 @item XEmacs 21.2.37 or later
812 You can obtain Mule-UCS package from following URL.
815 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
818 @node NNTP Folder, MH Folder, IMAP Folder, Folders
829 A folder to access USENET news via NNTP protocol (RFC 977).
830 One newsgroup is treated as a folder.
836 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
842 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
843 Initial setting is @samp{localhost}.
844 @var{username} -> The value of @code{elmo-nntp-default-user}.
845 Initial setting is @code{nil}.
846 @var{port} -> The value of @code{elmo-nntp-default-port}.
847 Initial setting is 119.
850 AUTHINFO is used as authentication method if the @var{username} is
851 non-nil. SSL will be default method if
852 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
853 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
854 STARTTLS connection will be established. if the value of
855 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
856 be the default connection.
862 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
863 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
868 @node MH Folder, Maildir Folder, NNTP Folder, Folders
875 A folder to access MH format mail (1 file is 1 mail).
880 @samp{+} @var{directory-name}
883 Normally, @var{directory-name} is an relative path to the variable
884 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
885 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
886 (this is also true for drive-letters).
888 Message number is used for the name of the message file.
894 +inbox -> @file{~/Mail/inbox}
895 +from/teranisi -> @file{~/Mail/from/teranisi}
896 +~/test -> @file{~/test}
901 @node Maildir Folder, News Spool Folder, MH Folder, Folders
902 @section Maildir Folder
904 @cindex Maildir Folder
908 A folder to access Maildir format (1 file is 1 mail).
913 @samp{.} [@var{directory-name}]
916 Normally, @var{directory-name} is a relative path to the variable
917 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
918 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
919 (this is also true for drive-letters).
921 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
922 Messages are contained in the @file{cur} directory. All message files
923 in the @file{new} directory are moved to @file{cur} directory when you
924 access the folder. All message files contained in the @file{tmp}
925 directory and not accessed for 36 hours are deleted.
927 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
933 . -> @file{~/Maildir}
934 .inbox -> @file{~/Maildir/inbox}
935 .from/teranisi -> @file{~/Maildir/from/teranisi}
936 .~/test -> @file{~/test}
941 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
942 @section News Spool Folder
944 @cindex News spool Folder
947 This folder handles locally saved news articles which are proposed by
948 Mew/IM. You can also read articles directly from a spool-file which is
949 retrieved by an utility like @command{gnspool}.
954 @samp{=} @var{directory-name}
957 @var{directory-name} is a sub-directory to the directory defined by
958 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
959 You can use @samp{.} as directory delimiter as well as @samp{/}.
965 =fj/os/os2 -> @file{~/News/fj/os/os2}
966 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
971 @node Archive Folder, POP Folder, News Spool Folder, Folders
972 @section Archive Folder
974 @cindex Archive Folder
977 This method can handle archive files, which are compressed by utilities
978 such as Info-ZIP or LHA, as one folder.
984 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
988 @var{path-name} is the relative path from
989 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
990 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
991 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
992 also permitted under the environment of ange-ftp, efs.
994 The actual file name of the archive folder is
995 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
996 under the @var{path-name}. If a file named @var{path-name} exists, it is
997 treated as folder. The suffix is automatically decided for
1000 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1001 (Initial setting is @code{zip}) is referred.
1003 @var{prefix} specifies the internal directory structure of the archive.
1004 For example, if the ML server is fml, @file{msend.tar.gz} has a
1005 structure like @file{spool/1}, so you have to specify @samp{spool} as
1012 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1013 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1014 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1015 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1016 $ml;zip/ -> Access group consists of archive folders
1017 under @file{~/Mail/ml}
1022 * Archiver:: Supported Archivers
1023 * Archive Tips:: TIPS
1024 * Archive Vars:: Customization
1028 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1029 @subsection Supported Archives
1039 By default, following archives are supported.
1043 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1044 GNU TAR('tgz, 'tar) ;; read-only
1048 If your archiver can include multiple files in one archive, you have a
1049 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1050 of the candidate. TAR is supported read-only because it cannot delete
1051 file in the archive (@code{mv})).
1053 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1054 archiver of Wanderlust because they cannot include multiple
1055 files. Archivers that cannot extract files to standard output are also
1058 @subsection OS specific information about archiver.
1060 Behaviors of the following archivers are confirmed by further experiences.
1061 (@samp{*} mark means recommended archiver).
1064 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1065 LHA OS/2 version Rel.2.06b Feb 18, 1998
1066 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1067 *Zip 2.2 (November 3rd 1997).
1068 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1069 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1070 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1072 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1073 LHa for UNIX V 1.14c
1074 UnZip 5.32 of 3 November 1997
1075 Zip 2.2 (November 3rd 1997)
1076 GNU tar 1.12 (1.11.x is no good)
1077 gzip 1.2.4 (18 Aug 93)
1079 [Win32] Win.98/Meadow
1083 GNU tar 1.11.8 + 1.5(WIN32)
1090 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1091 Hiramatsu version of LHA is only supported.
1092 In Win32, LHa32 is only supported (DOS version is no good).
1094 * Caution about GNU tar
1096 You have to take care about GNU tar's version because many version has
1097 problem on deleting file from archive.
1099 Please test @option{--delete} @option{-f} options work. Otherwise, your
1100 archive will be destroyed. No problem is reported on above versions of
1104 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1106 @cindex Archive Tips
1108 For comfortable migration, usage of @code{wl-summary-archive}
1109 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1110 archive folders created by expiration, you must set non-nil value to
1111 @code{elmo-archive-treat-file}.
1113 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1114 in processing speed. For comfortable use, Emacs20 is recommended.
1115 (If re-search's performance is the problem, 19.3x or later may be okay.)
1117 If many files are included in one archive,
1118 it takes long time to access the archive folder because
1119 archiver starting overhead is increased (especially LHA).
1120 150-200 messages in one archive is recommended.
1122 Of course, following is possible @t{:-)}
1123 (meanings of these variables are described later.)
1127 (setq wl-fcc "$backup")
1128 (setq wl-trash-folder "$trash;lha")
1132 @node Archive Vars, , Archive Tips, Archive Folder
1133 @subsection Variables About Archive Folder
1134 @cindex Archive variables
1137 @item elmo-archive-default-type
1138 @vindex elmo-archive-default-type
1139 The initial setting is @code{zip}.
1140 Set archiver type by symbol.
1142 @item elmo-archive-@var{type}-method-alist
1143 @vindex elmo-archive-TYPE-method-alist
1144 Define archiver @var{type}'s methods.
1145 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1146 Each element of the alist is following.
1150 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1151 (@var{action} . @var{function}) ;; function
1155 Currently available actions are following.
1159 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1160 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1167 actions enclosed with braces are optional (They are used for better
1170 @item elmo-archive-suffix-alist
1171 @vindex elmo-archive-suffix-alist
1172 An alist of archiver-type (symbol) and suffix.
1174 @item elmo-archive-file-regexp-alist
1175 @vindex elmo-archive-file-regexp-alist
1176 An alist of a regexp to get file number from list output of archiver
1177 and archiver-type (symbol).
1179 @item elmo-archive-method-list
1180 @vindex elmo-archive-method-list
1181 A list of elmo-archive-@var{type}-method-alist
1182 (@var{type} is a symbol of archiver-type).
1184 @item elmo-archive-lha-dos-compatible
1185 @vindex elmo-archive-lha-dos-compatible
1186 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1187 DOS (Mr. Yoshizaki original) compatible.
1189 @item elmo-archive-cmdstr-max-length
1190 @vindex elmo-archive-cmdstr-max-length
1191 The initial setting is 8000.
1193 Max length of command line argument for external archiver program.
1194 Emacs does not have a limit of command line byte length, but some OS
1195 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1196 this limit because it calls external archiver program directly (not
1197 called via shell). For example, you cannot delete messages if archiver
1198 program must receive larger bytes of arguments to delete. OS/2 have a
1199 command line argument limit of 8190 bytes, so we defined default as 8000
1202 However, you don't have an influence of command line argument limit
1203 if the archiver has `actions' to receive target file information from
1204 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1208 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1216 A folder to access e-mails via POP3 protocol (RFC 1939).
1222 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1227 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1228 as @var{authenticate-type}.
1230 You can specify @samp{uidl} (use UIDL command for message numbering) or
1231 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1235 @var{username} -> The value of @code{elmo-pop3-default-user}.
1236 Initial setting is @env{USER} environment variable or
1237 @env{LOGNAME} environment variable or return value of
1238 @code{(user-login-name)}.
1239 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1240 Initial setting is @samp{user}.
1241 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1242 If t, use UIDL for numbering. Initial setting is t.
1243 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1244 Initial setting is @samp{localhost}.
1245 @var{port} -> The value of @code{elmo-pop3-default-port}.
1246 Initial setting is 110.
1253 &hoge@@localhost -> access localhost as user @samp{hoge}.
1254 &hoge@@popserver:109 -> access the server "popserver" on port 109
1255 as user @samp{hoge}.
1259 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1260 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1261 @file{utils/sasl/lisp/} or Emacs/W3 package
1262 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1265 If the last character of the folder name is @samp{!}, Wanderlust
1266 connects to the POP server via SSL (Secure Socket Layer). If you set
1267 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1268 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1269 with @samp{!!}, STARTTLS connection will be established. if the value
1270 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1274 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1275 @section Shimbun Folder
1277 @cindex Shimbun Folder
1278 @cindex Folder, Shimbun
1283 A folder for watching "shimbun" (means "newspaper" in Japanese),
1284 news site and mailing list archives on WWW by using emacs-w3m
1285 (@uref{http://emacs-w3m.namazu.org/}).
1287 You should possess w3m and emacs-w3m to use this.
1293 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1297 Admissible values of @var{module-name} and @var{folder-name} are
1298 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1304 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1305 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1309 @subsection Variables About Shimbun Folder
1312 @item elmo-shimbun-update-overview-folder-list
1313 @vindex elmo-shimbun-update-overview-folder-list
1314 The initial setting is @code{nil}. You can specify a list of regular
1315 expressions of shimbun folder names. The overview of matched shimbun
1316 folder is updated when messages are fetched.
1317 You should @kbd{s rescan} after fetching to update summary.
1321 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1322 @section Namazu Folder
1324 @cindex Namazu Folder
1325 @cindex Folder, Namazu
1326 @cindex Folder, Text Search
1329 A folder to access messages found in namazu-index with some condition.
1330 It uses namazu (@uref{http://www.namazu.org/}) for search.
1336 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1340 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1346 [wanderlust] -> search messages matched with
1347 "wanderlust" from the default index
1348 [semi flim]~/Mail/semi -> search "semi flim" from the index
1349 in the directory "~/Mail/semi"
1355 @subsubsection Enter space to separate keywords
1357 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1359 @subsubsection Alias name for index
1361 You can define an alias name for index.
1366 (setq elmo-nmz-index-alias-alist
1367 '(("cache" . "~/.elmo/cache")
1368 ("docs" . "~/documents")))
1371 Above definition defines two index aliases.
1378 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1379 directory @file{~/.elmo/cache}.
1381 @subsubsection Multiple indices
1383 You can specify a list for @code{elmo-nmz-default-index-path} and
1384 @code{elmo-nmz-index-alias-alist}.
1385 When list is specified, all index contained in the list is used as the
1391 (setq elmo-nmz-index-alias-alist
1392 '(("all" . ("~/.elmo/cache" "~/documents"))
1393 ("cache" . "~/.elmo/cache")))
1396 Using above alias setting, you can specify
1402 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1403 directory @file{~/.elmo/cache} and @file{~/documents}.
1405 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1406 @section Multi Folder
1408 @cindex Multi Folder
1409 @cindex Folder, Multiple
1410 @cindex Folder, Marge
1412 A folder to access virtual folder which collects messages from
1419 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1423 After @samp{*} character, specify multiple folders you want to collect
1424 separated by @samp{,} like
1425 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1431 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1432 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1433 treated as one folder.
1435 *+inbox,-fj.rec.tv,%inbox
1436 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1441 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1442 @section Filter Folder
1444 @cindex Filter Folder
1445 @cindex Folder, Filtering
1446 @cindex Folder, Virtual
1447 @cindex Folder, Conditional
1449 A folder to access virtual folder which collects all messages that
1450 satisfy a condition.
1455 @samp{/} @var{condition} @samp{/} @var{target-folder}
1458 In the @var{condition} part, you can specify following.
1462 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1464 first: @var{number} messages are picked from top of folder.
1465 last: @var{number} messages are picked from bottom of folder.
1471 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1472 /first:20/%inbox -> First 20 messages from %inbox are picked.
1477 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1479 since: only messages arrived since @var{date} are picked.
1480 before: only messages arrived before @var{date} are picked.
1482 You can specify following as @var{date}.
1486 yesterday -> a day before today.
1487 lastweek -> same day of last week.
1488 lastmonth -> same day of last month.
1489 lastyear -> same day of last year.
1490 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1491 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1499 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1501 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1507 Field filter: @samp{@var{field}:@var{value}}
1509 All messages that have @var{field} and its value is @var{value} are picked.
1510 @var{field} and @var{value} are case insensitive.
1516 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1517 and its value includes "teranisi" string are picked.
1518 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1526 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1527 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1529 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1530 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1536 /from:teranisi&!to:teranisi/+inbox
1537 -> In +inbox, messages are picked if the message's
1538 From: field includes "teranisi" and
1539 To: field doesn't include "teranisi".
1541 /tocc:"Yuuichi Teranishi"/+inbox
1542 -> In +inbox, messages are picked if the
1543 message's To: field or Cc: field includes
1544 "Yuuichi Teranishi".
1546 /(from:yt|from:teranisi)&subject:report/+inbox
1547 -> In +inbox, messages are picked if the message's
1548 From: field includes "yt" or "teranisi", and
1549 Subject includes "report".
1555 Tip for string description:
1557 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1558 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1559 should be escaped with @samp{\} in it). You can enclose the string with
1560 @samp{"} even it does not contain these characters.
1566 *%inbox,/from:teranisi/%inbox@@server
1567 -> Messages in %inbox or
1568 message is in the %inbox@@server folder and it's From field
1569 includes "teranisi" are collected.
1571 /last:100//to:teranisi/*+inbox,%inbox
1572 -> Latest 100 messages which is in the +inbox or %inbox folder
1573 and To: field matches "teranisi".
1575 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1576 -> Pick messages which have From: field and it includes "hogehoge"
1577 from latest 20 messages in the %#mh/inbox@@localhost
1578 and To: or Cc: field includes "teranisi".
1581 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1582 @section Pipe Folder
1586 @cindex Download Message
1587 @cindex Incorporate Message
1589 In the pipe folder, messages are automatically transferred from the source
1590 folder to destination folder.
1595 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1598 When you access the pipe folder, messages are automatically transferred
1599 from @var{source-folder} to @var{destination-folder}.
1600 It is convenient if you want to download messages to local disk via POP.
1601 For example, if you specify following
1604 |&username@@popserver|+inbox
1608 and access it, Wanderlust downloads messages from
1609 @samp{&username@@popserver} to @samp{+inbox} automatically.
1611 On the other hand, if you put @samp{|:} instead of second @samp{|},
1612 then messages are copied to the destination folder (not deleted from
1613 source-folder). At the next time you access that folder, copies new
1617 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1620 If you want to copy messages from POP server and view them, specify the
1624 |&username@@popserver|:+inbox
1627 where messages will be kept on the server.
1633 |%inbox|%myinbox -> Download %inbox to %myinbox.
1634 |*&user@@popserver1,&user@@popserver2|+inbox
1635 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1636 |-gnu.emacs.sources|:+sources
1637 -> Copy messages from -gnu.emacs.sources to +sources.
1641 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1643 @node Internal Folder, , Pipe Folder, Folders
1644 @section Internal folder
1646 @cindex Internal Folder
1647 @cindex Folder, @samp{$} mark
1649 @c @cindex Folder, Null
1651 A folder to access internal messages of Wanderlust.
1663 A folder named @samp{'mark} is a special virtual folder which collects
1664 messages which have important mark @samp{$}.
1666 You can review important messages at once after you put important marks
1667 on the messages in the different folders.
1669 In this folder, if you delete message, important mark @samp{$} put on
1670 the message is removed. If you append messages to this folder, the
1671 message will have @samp{$} mark.
1673 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1674 folder. If you want IMAP folder's message remove from @samp{'mark}
1675 folder, remove important mark at IMAP Folder.)
1678 A folder named @samp{'sendlog} is a virtual folder which collects
1679 cached messages which are recoded on @file{~/.elmo/sendlog}.
1680 It might be useful when you forgot to add cc for yourself.
1681 To use this, you should set @code{wl-draft-use-cache} to non-nil
1682 so that sent messages are cached.
1685 You can access cached messages fetched via network by accessing
1686 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1687 the name of the subdirectories of the cache directory
1688 (@file{~/.elmo/cache}).
1691 @node Folder, Summary, Folders, Top
1692 @chapter Folder mode
1695 After you start Wanderlust, folder mode is appeared firstly.
1696 It contains folder list you subscribed.
1697 You can select and edit folders in this mode.
1700 * Selecting Folder:: Select folder you want to read
1701 * Folder Manager:: Editing folders
1705 @node Selecting Folder, Folder Manager, Folder, Folder
1706 @section Selecting Folder
1707 @cindex Selecting Folder
1709 @subsection Usage (TIPS)
1711 @subsubsection Check new, unread number
1713 Folder mode looks like this.
1714 (In XEmacs, it looks much nicer @t{;-)})
1718 [-]Desktop:14186/35580/67263
1723 [-]Emacsen:0/34/4837
1724 Wanderlust ML:0/0/558
1727 XEmacs Beta:0/29/255
1738 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1742 @kbd{s} key on the folder line updates these numbers.
1743 It changes its color if it has many new messages.
1745 The whole folder mode is a folder group named @samp{Desktop}.
1746 Folder group open/close by return key.
1747 A operation to a folder group is treated as operations on the
1749 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1750 six children folders update its unread number status.
1752 @subsubsection Select Folder
1754 To enter summary mode of the folder, type return (or space) key on
1756 If the variable @code{wl-stay-folder-window} has non-nil value,
1757 summary window appears on the right of the folder mode window.
1759 @subsection Key bindings
1761 Folder mode's key binding (related to selecting folders) is following.
1766 @kindex @key{SPC} (Folder)
1767 @kindex @key{RET} (Folder)
1768 @findex wl-folder-jump-to-current-entity
1769 Enter to the summary mode of the folder at the current cursor point.
1770 With prefix argument, enter the sticky summary.
1771 If the cursor is on the top of folder group line,
1772 the folder group is opened or closed.
1773 When the cursor is on the access group and this command is called
1774 with prefix argument, folder children list is updated to the newest one.
1775 (Children list is updated recursively if the access folder has hierarchical
1777 (@code{wl-folder-jump-to-current-entity})
1780 @kindex M-@key{RET} (Folder)
1781 @findex wl-folder-update-recursive-current-entity
1782 Folder children list of the access group at the current cursor point
1783 is updated to the newest one.
1784 (Children list is updated recursively if the access folder has hierarchical
1786 (@code{wl-folder-update-recursive-current-entity})
1791 Create a new draft message.
1796 @findex wl-folder-write-current-folder
1797 If the current cursor point is on the NNTP folder, create a new draft
1798 message which already has @samp{Newsgroups:} field. If the current
1799 cursor point is on the folder for mailing list (refile destination),
1800 create a new draft message which already has @samp{To:} field with
1801 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1803 (@code{wl-folder-write-current-folder})
1806 @kindex C-c C-o (Folder)
1807 @findex wl-jump-to-draft-buffer
1808 Move to the draft buffer if available. If multiple draft buffer exists,
1809 moved to one after another. If prefix argument is specified, load draft
1810 folder's message to the draft buffer and jump to it.
1811 (@code{wl-jump-to-draft-buffer})
1815 @findex wl-folder-check-current-entity
1816 Update new and unread number information of the folder at the current
1818 (@code{wl-folder-check-current-entity})
1822 @findex wl-folder-sync-current-entity
1823 Update summary information of the folder at the current cursor point.
1824 (@code{wl-folder-sync-current-entity})
1827 @kindex r s (Folder)
1828 @findex wl-folder-check-region
1829 Update new and unread number information of the folders in the currently
1831 (@code{wl-folder-check-region})
1834 @kindex r S (Folder)
1835 @findex wl-folder-sync-region
1836 Update summary information of the folders in the currently selected region.
1837 (@code{wl-folder-sync-region})
1841 @findex wl-status-update
1842 Sync up address book status with @file{~/.addresses}'s content.
1843 (@code{wl-status-update})
1847 @findex wl-folder-prev-unread
1848 Jump cursor to the folder which have unread messages on the upward from
1849 current cursor point.
1850 (@code{wl-folder-prev-unread})
1854 Jump cursor to the folder which have unread messages on the downward
1855 from current cursor point.
1856 (@code{wl-folder-next-unread})
1860 Move cursor to the folder on the previous line.
1861 (@code{wl-folder-prev-entity})
1865 Move cursor to the folder on the next line.
1866 (@code{wl-folder-next-entity})
1870 Jump to the folder specified by the user input.
1871 (@code{wl-folder-jump-folder})
1875 @findex wl-folder-prefetch-current-entity
1876 Prefetch new messages of the folder at the current cursor point by
1877 @code{wl-summary-incorporate}.
1878 If the cursor is on the folder group, it is executed recursively.
1879 (@code{wl-folder-prefetch-current-entity})
1883 @findex wl-folder-mark-as-read-all-current-entity
1884 Mark all unread messages of the folder at the current cursor point as read.
1885 If the cursor is on the folder group, it is executed recursively.
1886 (@code{wl-folder-mark-as-read-all-current-entity})
1890 @findex wl-folder-goto-first-unread-folder
1891 Enter summary mode of the first unread folder.
1892 (@code{wl-folder-goto-first-unread-folder})
1896 @findex wl-folder-empty-trash
1898 (@code{wl-folder-empty-trash})
1902 @findex wl-folder-flush-queue
1904 (@code{wl-folder-flush-queue})
1908 @findex wl-folder-virtual
1909 Move to the virtual folder with the condition specified.
1910 (@code{wl-folder-virtual})
1914 @findex wl-folder-pick
1915 Search the folders with the condition specified.
1916 (@code{wl-folder-pick})
1920 @findex wl-folder-open-all-unread-folder
1921 All unread folder is opened.
1922 (@code{wl-folder-open-all-unread-folder})
1926 @findex wl-folder-open-close
1927 Folder group is opened/closed.
1928 (@code{wl-thread-open-close})
1932 All folder group is opened.
1933 (@code{wl-folder-open-all})
1937 All folder group is closed.
1938 (@code{wl-folder-close-all})
1948 (@code{wl-folder-suspend})
1951 @kindex M-s (Folder)
1952 Save current folder status.
1956 @kindex M-t (Folder)
1957 Toggle Wanderlust's offline/online status.
1958 (@code{wl-toggle-plugged})
1961 @kindex C-t (Folder)
1962 Start Wanderlust's plug-status manager.
1963 (@code{wl-plugged-change})
1966 @subsection Customize variables
1969 @item wl-folders-file
1970 @vindex wl-folders-file
1971 The initial setting is @file{~/.folders}.
1972 Subscribed folders are described (saved) in this file.
1974 @item wl-folder-info-save
1975 @vindex wl-folder-info-save
1976 The initial setting is @code{t}. If non-nil, unread information is
1977 saved and used in the next Wanderlust session.
1979 @item wl-stay-folder-window
1980 @vindex wl-stay-folder-window
1981 The initial setting is @code{nil}.
1982 If non-nil, summary window is appeared on the right side of the folder buffer.
1984 @item wl-folder-window-width
1985 @vindex wl-folder-window-width
1986 The initial setting is 20.
1987 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1989 @item wl-folder-use-frame
1990 @vindex wl-folder-use-frame
1991 The initial setting is @code{nil}.
1992 If non-nil, use new frame for the folder window.
1994 @item wl-folder-many-unsync-threshold
1995 @vindex wl-folder-many-unsync-threshold
1996 The initial setting is 70.
1997 If the number of unread messages is more than this value,
1998 folder color is changed.
2000 @item wl-highlight-folder-by-numbers
2001 @vindex wl-highlight-folder-by-numbers
2002 This option controls how to highlight each line in the folder buffer.
2003 The default value is @code{t}, highlighting with various colors based on
2004 the message numbers. If it is @code{nil}, highlighting with various
2005 colors based on the folder status. In addition, if it is a number
2006 (e.g. 1), highlighting will be done based on both the message numbers
2007 and the folder status.
2009 @item wl-folder-desktop-name
2010 @vindex wl-folder-desktop-name
2011 The initial setting is @samp{Desktop}.
2012 The name of top folder group.
2014 @item wl-folder-petname-alist
2015 @vindex wl-folder-petname-alist
2016 The initial setting is @code{nil}.
2017 An alist of folder's realname and its nickname.
2019 @item wl-folder-access-subscribe-alist
2020 @vindex wl-folder-access-subscribe-alist
2021 The initial setting is @code{nil}.
2023 Control automatic subscribing and unsubscribing of the children list
2029 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2033 If @var{subscribe-flag} is non-nil, folders which have name matched to
2034 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2035 already unsubscribed folder is not displayed even when the
2036 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2043 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2044 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2045 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2046 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2050 @item wl-folder-hierarchy-access-folders
2051 @vindex wl-folder-hierarchy-access-folders
2052 The initial setting is the list shown below:
2061 A list of regular expressions for access groups which creates children
2062 folder list hierarchically.
2064 For example, if you specify
2065 @code{wl-folder-hierarchy-access-folders} like following,
2069 (setq wl-folder-hierarchy-access-folders
2070 '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
2075 you obtain the access group hierarchy as follows.
2081 -fj.comp.announce:0/0/2
2082 -fj.comp.dev.cdrom:0/0/0
2084 [+]-japan:238/238/1688
2087 -comp.unix.admin:0/0/0
2088 -comp.unix.dos-under-unix:0/0/0
2089 -comp.unix.programmer:0/0/0
2090 [-]-comp.unix.bsd:0/0/23
2091 -comp.unix.bsd.freebsd.announce:0/0/0
2096 If you opened @samp{-} in this example, only the direct children is created
2097 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2098 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2099 is not created until the children access group is opened.
2103 @node Folder Manager, , Selecting Folder, Folder
2104 @section Editing Folders
2105 @cindex Folder Manager
2106 @cindex Folder, Edit
2107 @cindex Folder, Subscribe
2108 @cindex Folder, Unsubscribe
2110 As described before, subscribed folder list is saved in @file{~/.folders} file.
2111 But you don't have to edit @file{~/.folders} directly.
2112 You can append, delete, edit folders from folder mode.
2114 @subsection Usage (Tips)
2116 @subsubsection Append Folder
2118 @kbd{m a} appends new folder to the folder mode.
2119 @kbd{m g} appends new folder group.
2120 To append new folder to this group, firstly open it,
2121 then execute append command in the next line.
2123 @subsubsection Edit Folder
2125 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2126 Thus, you can change folder position as if you were editing a normal file.
2128 @subsubsection Create Multi Folder.
2132 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2134 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2136 Type @kbd{m m}, then you can create multi folder.
2139 @subsubsection Delete Nickname, Filter
2141 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2142 minibuffer while appending.
2144 @subsubsection Append Folder to Empty Group
2146 To append new folder to the empty folder group
2147 (after you create folder group by typing @kbd{m g}),
2148 firstly open it, then execute append command in the next line.
2149 If it is closed, folder is appended on the same level with
2150 the folder group above. It is difficult to explain by words so try it.
2151 In other words, appended position depends on the
2152 open/close status of the upper one.
2154 @subsubsection Charset of the Folders File.
2156 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2158 @subsubsection Create Filter
2160 @kbd{m f} adds filter to the folder at the current cursor point. To
2161 create new filter folder and leave the current folder unchanged, copy it
2162 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2163 filter can be specified while appending filter. If you put
2164 ``''(@var{NULL}), filter is deleted.
2166 @subsubsection Sort Folders
2168 Sorting of the folders is executed by the function specified by
2169 @code{wl-fldmgr-sort-function}.
2170 The initial setting is @code{wl-fldmgr-sort-standard},
2171 which sorts alphabetically.
2172 Sorting affects only on the current folder group. It does not
2173 affect on the child groups.
2175 @subsubsection Hiding Folders in the Access Group
2177 Usually, access group displays all children folders, but you can set
2178 some folders hidden. Following operations are only available on access
2181 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2182 (subscribe/unsubscribe) of the folder at current cursor point. Against
2183 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2186 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2187 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2188 argument and if the argument has positive number, the unsubscribe it.
2189 If the prefix argument has negative value, folder becomes visible and if
2190 zero, folder visibility is toggled.
2192 The other commands, @code{wl-fldmgr-subscribe} and
2193 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2196 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2197 executed in the access group, they have a same effect with
2198 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2199 The difference is that cut commands deletes folders from the current
2202 @subsubsection Operations in the Access Group
2204 You can insert and delete folders in the access group like usual folder
2205 group. But insert and delete commands can be only available for the
2206 children folders of the access group and they only sets the subscribe
2207 status. In other words, insertion of the folder means subscribing,
2208 deletion means unsubscribing.
2209 @footnote{In the current implementation,
2210 it is faster to delete region than to unsubscribe region.}
2212 To update the access group when children folders are inserted or deleted
2213 by other way (other than Wanderlust),
2214 open the access group by typing @kbd{C-u @key{RET}}.
2215 @xref{Selecting Folder}.
2217 The order of children folders of access group is saved after
2218 insertion/deletion/sorting.
2219 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2220 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2221 newly created folders are inserted on the top of the access group.
2223 @subsection Key bindings
2224 @cindex Keybind, Folder Mode
2225 @cindex Keybind, Folder Buffer
2227 Key bindings on the folder mode related to folder editing are shown below.
2228 All bindings starts with @kbd{m}, and primary commands are binded to
2229 one stroke key binding.
2233 @kindex m a (Folder)
2234 @findex wl-fldmgr-add
2236 (@code{wl-fldmgr-add})
2241 @kindex m g (Folder)
2242 @findex wl-fldmgr-make-group
2243 Create a folder group.
2244 (@code{wl-fldmgr-make-group})
2247 @kindex m A (Folder)
2248 @findex wl-fldmgr-make-access-group
2249 Create an access group.
2250 (@code{wl-fldmgr-make-access-group})
2253 @kindex m d (Folder)
2254 @findex wl-fldmgr-delete
2255 Delete folder itself and msgdb.
2256 If the folder itself cannot be deleted like NNTP folder,
2257 only msgdb is deleted.
2258 (@code{wl-fldmgr-delete})
2263 @kindex m R (Folder)
2264 @findex wl-fldmgr-rename
2265 Change the name of folder or folder group.
2266 msgdb's path is also changed.
2267 (@code{wl-fldmgr-rename})
2273 @findex wl-fldmgr-make-multi
2274 Create a multi folders in the cutlist (cut, copied folders).
2275 (@code{wl-fldmgr-make-multi})
2280 @kindex m f (Folder)
2281 @findex wl-fldmgr-make-filter
2282 Create a filter folder. (Put a filter on the folder).
2283 (@code{wl-fldmgr-make-filter})
2287 @kindex M-c (Folder)
2288 @kindex m c (Folder)
2289 @findex wl-fldmgr-copy
2290 Copy folder (it is not available on folder group).
2291 (@code{wl-fldmgr-copy})
2295 @kindex M-w (Folder)
2296 @kindex m W (Folder)
2297 @findex wl-fldmgr-copy-region
2298 Copy folders in the specified region.
2299 (@code{wl-fldmgr-copy-region})
2303 @kindex C-k (Folder)
2304 @kindex m k (Folder)
2305 @findex wl-fldmgr-cut
2306 Cut folder. Folder itself is not deleted.
2307 (@code{wl-fldmgr-cut})
2311 @kindex C-w (Folder)
2312 @kindex m C-w (Folder)
2313 @findex wl-fldmgr-cut-region
2314 Cut folders in the specified region.
2315 (@code{wl-fldmgr-cut-region})
2319 @kindex C-y (Folder)
2320 @kindex m y (Folder)
2321 @findex wl-fldmgr-yank
2322 Paste folders that are copied or cut (folders in the cut-list).
2323 (@code{wl-fldmgr-yank})
2326 @kindex m p (Folder)
2327 @findex wl-fldmgr-set-petname
2328 Put nickname on the folder.
2329 (@code{wl-fldmgr-set-petname})
2332 @kindex m q (Folder)
2333 @findex wl-fldmgr-clear-cut-entity-list
2334 Clear the cut-list. (cut, copied folder information is cleared,
2335 you cannot paste after this)
2336 (@code{wl-fldmgr-clear-cut-entity-list})
2339 @kindex m s (Folder)
2340 @findex wl-fldmgr-sort
2341 Sort folders in the current folder group.
2342 (@code{wl-fldmgr-sort})
2345 @kindex m C-s (Folder)
2346 @findex wl-fldmgr-save
2347 Save current folder view to the @file{wl-folders-file}.
2348 (@code{wl-fldmgr-save})
2351 [Following commands are only available on the access groups]
2357 @kindex m u (Folder)
2358 @findex wl-fldmgr-unsubscribe
2359 Set the visibility of folder (subscribe/unsubscribe).
2360 (@code{wl-fldmgr-unsubscribe})
2365 @kindex r u (Folder)
2366 @findex wl-fldmgr-unsubscribe-region
2367 Set the visibility of the folders (subscribe/unsubscribe) in the
2369 (@code{wl-fldmgr-unsubscribe-region})
2374 @kindex m l (Folder)
2375 @findex wl-fldmgr-access-display-normal
2376 List folders that are currently available.
2377 (@code{wl-fldmgr-access-display-normal})
2382 @kindex m L (Folder)
2383 @findex wl-fldmgr-access-display-all
2384 List all folders regardless of the subscription status.
2385 (@code{wl-fldmgr-access-display-all})
2389 @subsection Customize variables
2392 @item wl-interactive-save-folders
2393 @vindex wl-interactive-save-folders
2394 The initial setting is @code{t}. If non-nil and folder view is
2395 modified, confirm saving it before Wanderlust or Emacs exits. If
2396 @code{nil}, save without confirmation.
2398 @item wl-fldmgr-make-backup
2399 @vindex wl-fldmgr-make-backup
2400 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2401 created before saving the folder status.
2403 @item wl-fldmgr-sort-function
2404 @vindex wl-fldmgr-sort-function
2405 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2406 sort folders. By default function, folders are sorted alphabetically
2407 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2410 @item wl-fldmgr-sort-group-first
2411 @vindex wl-fldmgr-sort-group-first
2412 The initial setting is @code{t}. If non-nil,
2413 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2414 does not care whether it is folder group or not.
2416 @item wl-folder-check-async
2417 @vindex wl-folder-check-async
2418 The initial setting is @code{t}. If non-nil, check folder's unread
2419 status asynchronously. It boosts newsgroup checking.
2421 @item wl-folder-check-fast
2422 @vindex wl-folder-check-fast
2423 The initial setting is @code{nil}.
2424 If non-nil, it does not update folder status while checking.
2426 @item wl-folder-notify-deleted
2427 @vindex wl-folder-notify-deleted
2428 The initial setting is @code{nil}.
2430 If non-nil, negative value is displayed when the message is deleted. If
2431 @code{sync}, folder is synchronized when the message is deleted. If
2432 @code{nil}, message deletion is ignored.
2434 @item wl-fldmgr-add-complete-with-current-folder-list
2435 @vindex wl-fldmgr-add-complete-with-current-folder-list
2436 The initial setting is @code{nil}.
2437 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2438 candidate for @code{wl-fldmgr-add}.
2441 @subsection Miscellanea
2443 Following is a note for folder editing.
2447 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2448 paste(yank) command pastes the folders on one cut or copy command
2449 (If copy command is executed by region, folders in the region are pasted
2450 by one paste command)
2453 You cannot cut @samp{Desktop} group.
2454 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2457 You cannot copy folder group.
2460 Operations on the access group are only available for the folders
2461 in the same access group.
2464 You cannot create a folder which has same name with the folders already exist.
2467 You cannot insert folders which have same name in one group.
2468 You can insert them in the different groups.
2469 You cannot put same nickname to the different folders.
2473 @node Summary, Message, Folder, Top
2474 @chapter Summary Mode
2476 After you select the folder via folder mode, you enter to the summary
2480 * Usage of Summary Mode:: TIPS
2481 * Thread Operations:: Thread operations
2482 * Cache:: File cache, Buffer cache, and Prefetch
2483 * Auto Refile:: Auto refile settings
2484 * Sticky Summary:: Summary make sticky
2485 * Summary View:: Format of summary lines
2486 * Key Bindings of Summary:: Key bindings
2487 * Variables of Summary:: Customize Summary Mode
2491 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2492 @section Usage (Tips)
2494 @subsection Summary Content
2496 In the summary mode, messages are displayed like following.
2500 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2501 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2502 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2503 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2510 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2514 If you want to know how to change the format for this, please refer
2515 the section format of Summary lines.
2516 @xref{Summary View}.
2518 @var{Message number} is the message's unique number in the folder. In
2519 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2520 in the MH folder, it is the filename of the message.
2522 @var{Temporal mark} and @var{Persistent mark} are described later.
2524 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2525 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2526 Japanese, but if you want to display it in English, set the value of
2527 @code{wl-summary-weekday-name-lang} as @samp{en}.
2529 @var{Sender}'s indentation corresponds to the depth of the thread.
2530 Sender name is displayed as nickname if it is defined in the address
2531 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2532 displaying with nickname.
2534 If number is printed at the head of @var{Sender} part like @samp{+2},
2535 that means the message have 2 follow messages.
2537 @var{Subject} is the @samp{Subject:} header field of the message. If
2538 the message have same @samp{Subject:} with the parent message, it is not
2539 displayed. Some mailing list puts its sequence number in the
2540 @samp{Subject:} field, but it is
2541 ignored. @code{wl-summary-no-subject-message} is displayed when the
2542 message has empty subject field.
2544 @subsection Temporary Marks
2545 @cindex Mark, Temporary
2547 There are four temporary marks,
2548 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2549 Temporary marks indicates message operations.
2554 You can execute a command on the all messages that have @samp{*} mark,
2555 with the key bindings which begins with @kbd{m}.
2558 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2562 After you type @kbd{o} key, prompt appears to input refile destination.
2563 Your answer is printed in the summary line.
2567 You can put this mark by typing @kbd{O} key.
2568 The difference between this mark and refile mark is,
2569 this mark does not delete the message while latter does.
2572 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2574 @subsection Persistent Marks
2576 There are five persistent marks,
2577 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2579 The persistent mark indicates the message's status and it is saved.
2580 Each persistent mark indicates:
2586 It is unread message.
2588 It is unread but cached message.
2590 It is read but it is not cached.
2592 It is important message. You can put @samp{$} mark by typing @kbd{$}
2593 key (if already exists, the mark is deleted). It is convenient to put
2594 this mark on the messages to remember (If you want to remember to write
2595 a reply for the message, for example) because this mark remains after
2596 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2597 @samp{'mark} folder even the message itself is deleted in the actual folder.
2600 If the message is read and cached (or local message),there are no
2604 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2605 cache. Messages with the marks other than these, you can read them in
2606 the offline status even they are in the IMAP folder or netnews folder.
2608 Among messages with persistent marks, ones with marks specified by
2609 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2610 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2612 @subsection How To Read
2614 Basically, you can read messages only typing space key again and again.
2616 To update summary status to the newest status (synchronize),
2619 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2620 moves cursor to the next message.
2621 Enter message buffer by typing @kbd{j} key.
2622 To operate multipart, you have to enter to the message buffer.
2625 @subsection Pack the Message Numbers
2626 You can pack the message numbers in Summary by
2627 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2628 News Spool Folder and Maildir Folder are supported folder types.
2631 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2632 @section Thread Operations
2634 For example, the following line indicates one thread (a context of a topic).
2637 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2641 If you type @kbd{/} on this line, the thread is opened and it changes
2642 the appearance like following.
2646 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2647 388 09/17(Thu)22:34 +-[ Murata san ]
2651 (Message 388 is the replied message to the message 384.)
2652 If you type @kbd{/} key once again, the thread is closed.
2653 With prefix argument, @kbd{/} opens all children threads.
2655 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2658 Commands with the key binding that begins with @kbd{t} executes commands
2659 on the messages in the thread.
2660 @xref{Key Bindings of Summary}.
2662 @subsection reconstruct thread by hand
2664 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2665 (@code{wl-summary-save-current-message}) at the corresponding message,
2666 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2667 message then you have the reconstructed thread.
2670 @node Cache, Auto Refile, Thread Operations, Summary
2673 @subsection Cache File
2675 The messages which have to access via network (e.x. IMAP, NNTP folder)
2676 are cached as a local file so as to save network traffic or to enable
2677 off-line operation. The cache file is saved under the directory
2678 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2679 elmo-cache-expire-by-size}. The command deletes cache files to the
2680 specified size by the order of last accessed time.
2682 @subsection Buffer Cache and Prefetching
2684 The messages that are read are kept in the cache buffer so as to make
2685 the behavior fast when you are to read the message again. It is called
2686 `buffer cache'. The number of cache buffer is specified by
2687 @code{wl-message-buffer-cache-size}.
2689 There are message prefetching mechanism in the Wanderlust that
2690 prefetches next message while you are reading.
2692 You can control the message prefetching mechanism by these two
2696 @item wl-message-buffer-prefetch-folder-type-list
2697 @vindex wl-message-buffer-prefetch-folder-type-list
2698 The initial setting is @code{t}. In this case, prefetch messages in all
2700 If it is a list of folder types, it specifies the folder types in which
2701 message prefetching is enabled.
2702 Following is an example (prefetch messages in nntp and imap4 folders)
2706 (setq wl-message-buffer-prefetch-folder-type-list
2711 In this case, multi folder that contains localdir and imap4 prefetches
2712 only imap4 messages. This variable precedes the value of
2713 @code{wl-message-buffer-prefetch-folder-list}.
2715 @item wl-message-buffer-prefetch-folder-list
2716 @vindex wl-message-buffer-prefetch-folder-list
2717 The initial setting is @code{nil}.
2718 A list of regexp of folders to enable message prefetching.
2720 @item wl-message-buffer-prefetch-depth
2721 @vindex wl-message-buffer-prefetch-depth
2722 The initial setting is 3. The number of messages for automatical prefetch.
2724 @item wl-message-buffer-prefetch-idle-time
2725 @vindex wl-message-buffer-prefetch-idle-time
2726 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2728 @item wl-message-buffer-prefetch-threshold
2729 @vindex wl-message-buffer-prefetch-threshold
2730 The initial setting is 30000 (bytes). If prefetching message has larger
2731 size than this value, Wanderlust does not prefetch automatically.
2732 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2733 the message is not checked for the size.
2735 @item wl-auto-prefetch-first
2736 @vindex wl-auto-prefetch-first
2737 The initial setting is @code{nil}.
2738 If non-nil, first message is automatically prefetched to the buffer
2739 when you enter the folder.
2743 @node Auto Refile, Sticky Summary, Cache, Summary
2744 @section Auto Refile
2745 @vindex elmo-msgdb-extra-fields
2746 @vindex wl-refile-rule-alist
2747 @findex wl-summary-auto-refile
2749 You can refile messages automatically, by typing @kbd{C-o}
2750 (@code{wl-summary-auto-refile}). It decides destination of refile by
2751 the content of the message header information (information in the msgdb).
2753 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2754 available. If you want to decide destination by other header fields,
2755 set the variable @code{elmo-msgdb-extra-fields} like following.
2759 (setq elmo-msgdb-extra-fields
2769 By this setting, Wanderlust saves extra fields in the msgdb. You have
2770 to type @kbd{s all} to get extra fields for the messages that are
2771 already exists in the summary.
2773 Then, specify the refile rule. The refile target folder of auto
2774 refiling is decided by the value of @code{wl-refile-rule-alist}.
2775 @code{wl-refile-rule-alist} is a list of a rule:
2779 (@var{field} (@var{regexp} . @var{target})
2780 (@var{regexp} . @var{target})
2785 Each rule means `if @var{field} value matches @var{regexp},
2786 then refile to @var{target} folder'.
2787 The rule matched first is applied.
2789 @var{field} is a string of field name. You can specify a list of field name
2790 string, too. In this case, if one of these fields is matched, then the
2791 rule is fired (i.e. OR condition).
2793 @var{regexp} is a regular expression for field value. @var{target} is a target
2794 folder string. You can specify a rule at @var{target} part, too. In this
2795 case, If the field value of the rule and the current rule is matched,
2796 then the current rule is fired (i.e. AND condition).
2798 You can refer matched substring of @var{regexp} to specify @var{target} part.
2799 To refer substring, use following keys:
2803 means substitute original matched text.
2806 means substitute what matched the @var{N}th `\(@dots{}\)'.
2807 (@var{N} is a number.)
2810 Following is an example of @code{wl-refile-rule-alist}.
2814 (setq wl-refile-rule-alist
2816 ("^Wanderlust" . "+wl")
2817 ("^Elisp" . "+elisp"))
2819 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2821 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2822 "+from-me-to-you"))))))
2826 After these settings, refile marks are automatically put on the condition
2827 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2829 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2831 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2832 with these persistent marks are not automatically refiled.
2833 It means Wanderlust does not execute auto refile on unread messages by
2834 the default setting.
2835 To execute auto refile on all messages, set following.
2838 (setq wl-summary-auto-refile-skip-marks nil)
2842 @node Sticky Summary, Summary View, Auto Refile, Summary
2843 @section Sticky Summary
2844 @cindex Summary, Sticky
2845 @cindex Sticky Summary
2847 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2849 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2850 @kbd{G} in some suummary sticky summary buffer is created.
2851 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2852 makes current one sticky.
2854 The buffer name of the sticky summary becomes like
2855 @samp{Summary:@var{folder-name}}.
2856 You can visit the sticky summary at any time by @kbd{C-x b}
2857 (@code{switch-to-buffer}), or you can go round summary buffers by
2858 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2859 (@code{wl-summary-next-buffer}) in summary mode.
2861 In sticky summary, the summary buffer is preserved after @kbd{g} or
2862 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2863 another summary by @kbd{C-u g}. Other operations in the sticky summary
2864 are same as normal summary.
2866 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2867 are automatically stuck.
2870 @node Summary View, Key Bindings of Summary, Sticky Summary, Summary
2871 @section Format of summary lines
2872 @cindex Format of summary lines
2873 You can alter the format of lines in Summary mode.
2875 Summary line format is specified by @code{wl-summary-line-format}.
2876 You can use control strings defined by
2877 @code{wl-summary-line-format-spec-alist}.
2883 ;; @r{number temporary-mark persistent-mark date branch}
2884 ;; @r{[ (number-of-children) sender ] subject}
2885 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2889 Where the number set the column number of the field (for negative value,
2892 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2893 are displayed in the following list.
2904 %t branch of the thread
2905 %[ [ (< for re-connected child)
2906 %] ] (> for re-connected child)
2910 %c +number-of-children: (display only for opened thread)
2911 %C [+number-of-children] (display only for opened thread)
2912 %T temporary mark (mandatory)
2913 %P persistent mark (mandatory)
2917 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
2918 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
2919 the constant column. For example, if you specify @samp{%T} or
2920 @samp{%P} after the @samp{%t}, which changes its length by thread
2921 position, marks are not treated correctly.
2923 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
2924 column of the enclosed region is justified to the `number'. Multiple
2925 level @samp{%number(} parenthesis can be defined. It is useful to
2926 justify the column of the multiple control strings. For example, in the
2927 above @code{wl-summary-line-format},
2933 means ``Adjust number-of-children and sender string to the 17 column''.
2935 You can specify the format by each folders with
2936 @code{wl-folder-summary-line-format-alist}. Please set regular
2937 expression for folder names and summary line format as the following
2942 (setq wl-folder-summary-line-format-alist
2943 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
2944 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
2948 @subsection on the format for sender name
2950 The format string @samp{%f} displays the return value of the function specified
2951 by @code{wl-summary-from-function}. If you use the function
2952 @code{wl-summary-default-from} (default), it displays sender name ordinarily,
2953 while displays the recipient names if the folder name matches with
2954 @code{wl-summary-showto-folder-regexp} and the sender is yourself.
2955 If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
2957 For example, to display recipient names for the message in @samp{+backup} if
2958 its sender is yourself, set up as follows.
2961 (setq wl-summary-showto-folder-regexp "^\\+backup$")
2965 @node Key Bindings of Summary, Variables of Summary, Summary View, Summary
2966 @section Key bindings
2967 @cindex Keybind, Summary Mode
2968 @cindex Keybind, Summary Buffer
2970 Key bindings of the summary mode are shown below.
2974 @kindex @key{SPC} (Summary)
2975 @findex wl-summary-read
2976 Proceed reading a message at the current cursor point.
2977 (@code{wl-summary-read})
2981 @findex wl-summary-redisplay
2982 Redisplay a message at the current cursor point.
2983 If this command is called with prefix argument,
2984 Redisplay message regardless of the message cache (message is re-loaded
2986 (@code{wl-summary-redisplay})
2990 @findex wl-summary-display-top
2991 Display the top message in the folder.
2992 (@code{wl-summary-display-top})
2996 @findex wl-summary-display-bottom
2997 Display the bottom message in the folder.
2998 (@code{wl-summary-display-bottom})
3002 @kindex @key{BS} (Summary)
3003 @kindex @key{DEL} (Summary)
3004 Display the previous page of the message at the current cursor point.
3005 @findex wl-summary-prev-page
3006 (@code{wl-summary-prev-page})
3009 @kindex @key{RET} (Summary)
3010 @findex wl-summary-next-line-content
3011 Display the next line of the message at the current cursor point.
3012 Display the message at the current cursor point if it is not displayed yet.
3013 (@code{wl-summary-next-line-content})
3018 @kindex M-@key{RET} (Summary)
3019 @findex wl-summary-prev-line-content
3020 Display the previous line of the message at the current cursor point.
3021 Display the message at the current cursor point if it is not displayed yet.
3022 (@code{wl-summary-prev-line-content})
3026 @findex wl-thread-open-close
3027 Toggle open or close the thread at the current cursor point.
3028 (@code{wl-thread-open-close})
3033 @findex wl-thread-open-all
3034 (@code{wl-thread-open-all})
3039 @findex wl-thread-close-all
3040 (@code{wl-thread-close-all})
3044 @findex wl-summary-goto-folder
3046 (@code{wl-summary-goto-folder})
3050 Mark all messages in the folder as read.
3051 @findex wl-summary-mark-as-read-all
3052 (@code{wl-summary-mark-as-read-all})
3056 @findex wl-summary-reply
3057 Prepare a draft for reply the message at the current cursor point.
3058 (@code{wl-summary-reply})
3062 @findex wl-summary-reply-with-citation
3063 Prepare a draft for reply the message at the current cursor point.
3064 (@code{wl-summary-reply-with-citation})
3068 @findex wl-summary-cancel-message
3069 If the message at current cursor point is your own netnews article,
3071 (@code{wl-summary-cancel-message})
3075 @findex wl-summary-reedit
3076 Prepare a draft for re-editing the message at current cursor point.
3077 If the message at current cursor point is your own netnews article,
3078 a draft for `supersedes message' for the message is prepared.
3079 (@code{wl-summary-reedit})
3082 @kindex M-e (Summary)
3083 @findex wl-summary-resend-bounced-mail
3084 If the message at current cursor point is a bounced message,
3085 a draft for re-sending original message is prepared.
3086 (@code{wl-summary-resend-bounced-mail})
3090 @findex wl-summary-forward
3091 A draft for forwarding the message at current cursor point is prepared.
3092 (@code{wl-summary-forward})
3096 @findex wl-summary-mark-as-important
3097 Put @samp{$} mark on the message at current cursor point.
3098 If already marked as @samp{$}, delete it.
3099 (@code{wl-summary-mark-as-important})
3105 Save the message at current cursor point.
3106 @findex wl-summary-save
3107 (@code{wl-summary-save})
3111 @findex wl-summary-next
3112 Move cursor to the next message.
3113 If message is marked with a temporal mark in
3114 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3115 In the offline mode, cursor is not moved to the messages which are not cached
3117 (@code{wl-summary-next})
3121 @findex wl-summary-prev
3122 Move cursor to the previous message.
3123 If message is marked with a temporal mark in
3124 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3125 In the offline mode, cursor is not moved to the messages which are not cached
3127 (@code{wl-summary-prev})
3131 @findex wl-summary-down
3132 Move cursor to the downward message which is unread or marked
3134 In the offline mode, cursor is not moved to the messages which are not cached
3136 If there are messages which have target mark @samp{*} in the summary,
3137 cursor is moved to the downward message which have a target mark.
3138 This behavior is changed according to the value of @code{wl-summary-move-order}.
3139 (@code{wl-summary-down})
3143 @findex wl-summary-up
3144 Move cursor to the upward message which is unread or marked
3146 In the offline mode, cursor is not moved to the messages which are not cached
3148 If there are messages which have target mark @samp{*} in the summary,
3149 cursor is moved to the downward message which have a target mark.
3150 This behavior is changed according to the value of @code{wl-summary-move-order}.
3151 (@code{wl-summary-up})
3155 @findex wl-summary-write
3156 Prepare a new draft.
3157 (@code{wl-summary-write})
3161 @findex wl-summary-write-current-folder
3162 Prepare a new draft. If the current folder is NNTP folder,
3163 @samp{Newsgroups:} field is completed. If the current folder is mailing
3164 list folder (refile destination), guess @samp{To:} field and completed
3165 (If @code{wl-subscribed-mailing-list} is valid list)
3166 (@code{wl-summary-write-current-folder})
3170 @findex wl-summary-redisplay-all-header
3171 Redisplay the message at current cursor point with all header fields.
3172 (@code{wl-summary-redisplay-all-header})
3176 @findex wl-summary-redisplay-no-mime
3177 Redisplay the message at current cursor point without MIME analysis.
3178 (@code{wl-summary-redisplay-no-mime})
3182 @findex wl-summary-burst
3183 If the message at current cursor point has
3184 encapsulates multiple messages using MIME,
3185 de-capsulate and extract them on the current folder.
3186 If it is invoked in non-writable folder or it is called with prefix
3187 argument, it asks the destination folder.
3188 (@code{wl-summary-burst})
3191 @kindex @@ (Summary)
3192 @findex wl-summary-edit-addresses
3193 Append/change/delete the message's sender information to the address
3194 book @file{~/.addresses} interactively. If this command is called with
3195 prefix argument, arbitrary address can be edited.
3196 (@code{wl-summary-edit-petname})
3200 @findex wl-status-update
3201 Sync up address book status with @file{~/.addresses}'s content.
3202 (@code{wl-status-update})
3206 @findex wl-summary-pipe-message
3207 Pipe current message's content to the external process.
3208 (@code{wl-summary-pipe-message})
3212 @findex wl-summary-print-message
3213 Print out current message's content.
3214 It uses @code{ps-print} module in Emacs 20.x.
3215 If you don't use color printer, you might want to set
3216 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3219 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3222 (@code{wl-summary-print-message})
3226 @findex wl-summary-exit
3227 Exit current folder.
3228 (@code{wl-summary-exit})
3232 @findex wl-summary-jump-to-current-message
3233 Jump cursor to the currently displayed message's window.
3234 (@code{wl-summary-jump-to-current-message})
3238 Jump cursor to the other message.
3239 @findex wl-summary-jump-to-msg
3240 (@code{wl-summary-jump-to-msg})
3244 Update summary status and
3245 prefetch all messages which have marks included in the
3246 @code{wl-summary-incorporate-marks}.
3247 @findex wl-summary-incorporate
3248 (@code{wl-summary-incorporate})
3251 @kindex M-j (Summary)
3252 @findex wl-summary-jump-to-msg-by-message-id
3253 Jump cursor to the message which have specified @samp{Message-Id:}. If
3254 @code{elmo-use-database} is non-nil, other folder is also searched.
3255 (@code{wl-summary-jump-to-msg-by-message-id})
3259 Jump to parent message.
3260 @findex wl-summary-jump-to-parent-message
3261 (@code{wl-summary-jump-to-parent-message})
3265 @findex wl-summary-mark-as-unread
3266 Mark as unread the message at current cursor point.
3267 (@code{wl-summary-mark-as-unread})
3271 @findex wl-summary-sync
3272 Synchronize summary view after prompting the update range
3273 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3277 all ...Discard current summary and update all message.
3278 all-visible ...Discard current summary and update all visible message.
3279 update ...Update the difference between summary and the folder itself.
3280 rescan ...Rescan the msgdb and display again.
3281 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3282 cache-status ...Sync the all marks with the real status of cache.
3283 first, last ...Move to the filter folder(partial filter).
3288 (@code{wl-summary-sync})
3292 @findex wl-summary-sort
3294 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3295 (@code{wl-summary-sort})
3299 @findex wl-summary-toggle-thread
3300 Toggle the threading.
3301 Threading status is displayed on the modeline.
3302 @samp{@{S@}} means threading is off (Sequence) and
3303 @samp{@{T@}} means threading is on (Thread).
3304 (@code{wl-summary-toggle-thread})
3308 @findex wl-summary-toggle-disp-folder
3309 Toggle displaying of folder window.
3310 (@code{wl-summary-toggle-disp-folder})
3314 Toggle displaying of message window.
3315 @findex wl-summary-toggle-disp-msg
3316 (@code{wl-summary-toggle-disp-msg})
3320 Move to the virtual folder with the condition specified.
3321 If called with prefix argument and current folder is virtual, exit it.
3322 @findex wl-summary-virtual
3323 (@code{wl-summary-virtual})
3326 @kindex @key{TAB} (Summary)
3327 @findex wl-summary-goto-last-displayed-msg
3328 Jump to the message which is displayed last.
3329 (@code{wl-summary-goto-last-displayed-msg})
3333 Put @samp{*} mark on the messages that satisfies the specified condition.
3334 @findex wl-summary-pick
3335 (@code{wl-summary-pick})
3339 @findex wl-summary-mark-as-read
3340 Mark as read the message at the current cursor point.
3341 (@code{wl-summary-mark-as-read})
3345 Prefetch the message at the current cursor point.
3346 With prefix argument, prefetch the message even if it is cached.
3347 @findex wl-summary-prefetch
3348 (@code{wl-summary-prefetch})
3352 Execute @samp{D}, @samp{o} and @samp{O} marks.
3353 @findex wl-summary-exec
3354 (@code{wl-summary-exec})
3358 @findex wl-summary-target-mark-line
3359 Put target mark on the message at the current cursor point.
3360 (@code{wl-summary-target-mark-line})
3364 Put refile mark on the message at the current cursor point.
3365 @findex wl-summary-refile
3366 (@code{wl-summary-refile})
3369 @kindex C-o (Summary)
3370 Execute auto refile.
3371 @findex wl-summary-auto-refile
3372 (@code{wl-summary-auto-refile})
3376 Put copy mark on the message at the current cursor point.
3377 @findex wl-summary-copy
3378 (@code{wl-summary-copy})
3381 @kindex M-o (Summary)
3382 Put refile mark on the message at the current cursor point with the destination
3383 previously specified.
3384 @findex wl-summary-refile-prev-destination
3385 (@code{wl-summary-refile-prev-destination})
3389 @findex wl-summary-delete
3390 Put delete mark on the message at the current cursor point.
3391 (@code{wl-summary-delete})
3395 @findex wl-summary-unmark
3396 Unmark the temporal mark on the message at the current cursor point.
3397 (@code{wl-summary-unmark})
3401 Unmark all the temporal marks.
3402 @findex wl-summary-unmark-all
3403 (@code{wl-summary-unmark-all})
3406 @kindex r R (Summary)
3407 @findex wl-summary-mark-as-read-region
3408 Mark as read messages in the specified region.
3409 (@code{wl-summary-mark-as-read-region})
3412 @kindex r $ (Summary)
3413 @findex wl-summary-mark-as-important-region
3414 Mark as important @samp{$} messages in the specified region.
3415 If @samp{$} already exists, it is deleted.
3416 (@code{wl-summary-mark-as-important-region})
3419 @kindex r ! (Summary)
3420 @findex wl-summary-mark-as-unread-region
3421 Mark as unread messages in the specified region.
3422 (@code{wl-summary-mark-as-unread-region})
3425 @kindex r i (Summary)
3426 @findex wl-summary-prefetch-region
3427 Prefetch messages in the specified region.
3428 (@code{wl-summary-prefetch-region})
3431 @kindex r x (Summary)
3432 @findex wl-summary-exec-region
3433 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3435 (@code{wl-summary-exec-region})
3438 @kindex r * (Summary)
3439 @findex wl-summary-target-mark-region
3440 Put target mark on the messages in the specified region.
3441 (@code{wl-summary-target-mark-region})
3444 @kindex r o (Summary)
3445 @findex wl-summary-refile-region
3446 Put refile mark on the messages in the specified region.
3447 (@code{wl-summary-refile-region})
3450 @kindex r O (Summary)
3451 @findex wl-summary-copy-region
3452 Put copy mark on the messages in the specified region.
3453 (@code{wl-summary-copy-region})
3456 @kindex r d (Summary)
3457 @findex wl-summary-delete-region
3458 Put delete mark on the messages in the specified region.
3459 (@code{wl-summary-delete-region})
3462 @kindex r u (Summary)
3463 @findex wl-summary-unmark-region
3464 Delete temporal mark on the messages in the specified region.
3465 (@code{wl-summary-unmark-region})
3468 @kindex r y (Summary)
3469 Save messages in the specified region.
3470 @findex wl-summary-save-region
3471 (@code{wl-summary-save-region})
3474 @kindex t R (Summary)
3475 @findex wl-thread-mark-as-read
3476 Mark as read messages which are the descendant of the current thread.
3477 With prefix argument, it affects on the all messages in the thread tree.
3478 (@code{wl-thread-mark-as-read})
3481 @kindex t $ (Summary)
3482 @findex wl-thread-mark-as-important
3483 Put important mark @samp{$} on the messages which are the
3484 descendant of the current thread.
3485 If @samp{$} mark exists, it is deleted.
3486 With prefix argument, it affects on the all messages in the thread tree.
3487 (@code{wl-thread-mark-as-important})
3490 @kindex t ! (Summary)
3491 @findex wl-thread-mark-as-unread
3492 Mark as unread messages which are the descendant of the current thread.
3493 With prefix argument, it affects on the all messages in the thread tree.
3494 (@code{wl-thread-mark-as-unread})
3497 @kindex t i (Summary)
3498 @findex wl-thread-prefetch
3499 Prefetch messages which are the descendant of the current thread.
3500 With prefix argument, it affects on the all messages in the thread tree.
3501 (@code{wl-thread-prefetch})
3504 @kindex t x (Summary)
3505 @findex wl-thread-exec
3506 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3507 the descendant of the current thread. With prefix argument, it affects
3508 on the all messages in the thread tree.
3509 (@code{wl-thread-exec})
3512 @kindex t * (Summary)
3513 @findex wl-thread-target-mark
3514 Put target mark @samp{*} on the messages which are the descendant of the
3515 current thread. With prefix argument, it affects on the all messages in
3517 (@code{wl-thread-target-mark})
3520 @kindex t o (Summary)
3521 @findex wl-thread-refile
3522 Put refile mark on the messages which are the descendant of the current thread.
3523 With prefix argument, it affects on the all messages in the thread tree.
3524 (@code{wl-thread-refile})
3527 @kindex t O (Summary)
3528 @findex wl-thread-copy
3529 Put copy mark on the messages which are the descendant of the current thread.
3530 With prefix argument, it affects on the all messages in the thread tree.
3531 (@code{wl-thread-copy})
3534 @kindex t d (Summary)
3535 @findex wl-thread-delete
3536 Put delete mar on the messages which are the descendant of the current thread.
3537 With prefix argument, it affects on the all messages in the thread tree.
3538 (@code{wl-thread-delete})
3541 @kindex t u (Summary)
3542 @findex wl-thread-unmark
3543 Unmark temporal mark on the messages which are the descendant of the
3544 current thread. With prefix argument, it affects on the all messages in
3546 (@code{wl-thread-unmark})
3549 @kindex t y (Summary)
3550 @findex wl-thread-save
3551 Save messages which are the descendant of the current thread.
3552 With prefix argument, it affects on the all messages in the thread tree.
3553 (@code{wl-thread-save})
3556 @kindex m i (Summary)
3557 @findex wl-summary-target-mark-prefetch
3558 Prefetch all messages which have target mark @samp{*}.
3559 With prefix argument, prefetch all targets even if some of them are cached.
3560 (@code{wl-summary-target-mark-prefetch})
3563 @kindex m R (Summary)
3564 @findex wl-summary-target-mark-mark-as-read
3565 Mark as read all messages which have target mark @samp{*}.
3566 (@code{wl-summary-target-mark-mark-as-read})
3569 @kindex m $ (Summary)
3570 @findex wl-summary-target-mark-mark-as-important
3571 Mark as important all messages which have target mark @samp{*}.
3572 If already marked as @samp{$}, it is deleted.
3573 (@code{wl-summary-target-mark-mark-as-important})
3576 @kindex m ! (Summary)
3577 @findex wl-summary-target-mark-mark-as-unread
3578 Mark as unread all messages which have target mark @samp{*}.
3579 (@code{wl-summary-target-mark-mark-as-unread})
3582 @kindex m o (Summary)
3583 @findex wl-summary-target-mark-refile
3584 Put refile mark on the messages which have target mark @samp{*}.
3585 (@code{wl-summary-target-mark-refile})
3588 @kindex m O (Summary)
3589 @findex wl-summary-target-mark-copy
3590 Put copy mark on the messages which have target mark @samp{*}.
3591 (@code{wl-summary-target-mark-copy})
3594 @kindex m d (Summary)
3595 @findex wl-summary-target-mark-delete
3596 Put delete mark on the messages which have target mark @samp{*}.
3597 (@code{wl-summary-target-mark-delete})
3600 @kindex m y (Summary)
3601 @findex wl-summary-target-mark-save
3602 Save messages which have target mark @samp{*}.
3603 (@code{wl-summary-target-mark-save})
3606 @kindex m u (Summary)
3607 Unmark all temporal marks.
3608 (@code{wl-summary-delete-all-temp-marks})
3609 @findex wl-summary-delete-all-temp-marks
3612 @kindex m a (Summary)
3613 Put target mark @samp{*} on the all messages.
3614 (@code{wl-summary-target-mark-all})
3615 @findex wl-summary-target-mark-all
3618 @kindex m t (Summary)
3619 Put target mark @samp{*} on the messages in the current thread.
3620 @findex wl-summary-target-mark-thread
3621 (@code{wl-summary-target-mark-thread})
3624 @kindex m r (Summary)
3625 @findex wl-summary-target-mark-region
3626 Put target mark @samp{*} on the messages in the specified region.
3627 (@code{wl-summary-target-mark-region})
3630 @kindex m A (Summary)
3631 @findex wl-summary-target-mark-reply-with-citation
3632 Prepare a draft which cites all messages which have target mark @samp{*}.
3633 (@code{wl-summary-target-mark-reply-with-citation})
3636 @kindex m f (Summary)
3637 @findex wl-summary-target-mark-forward
3638 Prepare a draft which forwards all messages which have target mark @samp{*}.
3639 (@code{wl-summary-target-mark-forward})
3642 @kindex m U (Summary)
3643 @findex wl-summary-target-mark-uudecode
3644 Uudecode the messages which have target mark @samp{*}.
3645 (@code{wl-summary-target-mark-uudecode})
3648 @kindex m ? (Summary)
3649 @findex wl-summary-target-mark-pick
3650 Pick messages from the @samp{*} marked messages.
3651 That is, @samp{*} marks on the messages are remained
3652 if the specified condition is satisfied.
3653 (@code{wl-summary-target-mark-pick})
3656 @kindex m # (Summary)
3657 @findex wl-summary-target-mark-print
3658 Print out all messages which have target mark @samp{*}.
3659 (@code{wl-summary-target-mark-print})
3662 @kindex m | (Summary)
3663 @findex wl-summary-target-mark-pipe
3664 Pipe content of each message with target mark @samp{*} to some specified
3666 (@code{wl-summary-target-mark-pipe})
3670 @findex wl-summary-erase
3671 Actually erase the message at once, without moving it to trash.
3672 (@code{wl-summary-erase})
3675 @kindex M-t (Summary)
3676 @findex wl-toggle-plugged
3677 Toggle offline/online status of Wanderlust.
3678 (@code{wl-toggle-plugged})
3681 @kindex C-t (Summary)
3682 Start Wanderlust's plug-status manager.
3683 (@code{wl-plugged-change})
3686 @kindex C-c C-o (Summary)
3687 @findex wl-jump-to-draft-buffer
3688 Move to the draft buffer if available. If multiple draft buffer exists,
3689 moved to one after another. If prefix argument is specified, load draft
3690 folder's message to the draft buffer and jump to it.
3691 (@code{wl-jump-to-draft-buffer})
3694 @kindex M-w (Summary)
3695 @findex wl-summary-save-current-message
3696 Save the message at the current cursor point.
3697 (@code{wl-summary-save-current-message})
3700 @kindex C-y (Summary)
3701 @findex wl-summary-yank-saved-message
3702 Regard the message at the current cursor point as
3703 parent, connect the message saved by
3704 @code{wl-summary-save-current-message}
3706 (@code{wl-summary-yank-saved-message})
3709 @kindex C-x C-s (Summary)
3710 @findex wl-summary-save-status
3711 Save the current summary.
3712 (@code{wl-summary-save-status})
3716 @node Variables of Summary, , Key Bindings of Summary, Summary
3717 @section Customiziable variables
3720 @item wl-summary-move-order
3721 @vindex wl-summary-move-order
3722 The initial setting is @code{unread}. Specify cursor moving policy. If
3723 you want to precede new messages, set @code{new}. If you want to
3724 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3727 @item wl-auto-select-first
3728 @vindex wl-auto-select-first
3729 The initial setting is @code{nil}.
3730 If non-nil, first message is automatically displayed when you enter
3733 @item wl-auto-select-next
3734 @vindex wl-auto-select-next
3735 The initial setting is @code{nil}. This controls behavior when there is
3736 no unread message in current summary.
3739 nil: asks whether you want to go back to folder mode
3740 'unread: asks whether you want to go to next unread folder
3741 If the next one comes to be possessing no unread message
3742 by treatment of cross-posted messages or Scoring, then
3743 asks whether you want to go to next to next folder.
3744 'skip-no-unread: similar as unread
3745 But does not ask before going to next to next folder.
3746 otherwise: asks whether you want to go to next unread folder
3749 It might be useful to set @code{'skip-no-unread} for people who
3750 want to continue reading by just pressing and pressing space key.
3752 @item wl-thread-insert-opened
3753 @vindex wl-thread-insert-opened
3754 The initial setting is @code{nil}.
3755 If non-nil, thread is inserted as opened.
3757 @item wl-thread-open-reading-thread
3758 @vindex wl-thread-open-reading-thread
3759 The initial setting is @code{t}. If non-nil, reading thread is
3760 automatically opened though it is closed thread.
3762 @item wl-summary-exit-next-move
3763 @vindex wl-summary-exit-next-move
3764 The initial setting is @code{t}. If non-nil, move to next folder at
3767 @item wl-folder-move-cur-folder
3768 @vindex wl-folder-move-cur-folder
3769 The initial setting is @code{nil}. If non-nil, cursor position on the
3772 @item wl-summary-weekday-name-lang
3773 @vindex wl-summary-weekday-name-lang
3774 The initial setting is @samp{ja}. Specify language of the weekday.
3775 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3776 displays Deutsch. You should rescan summary view after changing this value.
3778 @item wl-summary-fix-timezone
3779 @vindex wl-summary-fix-timezone
3780 The initial setting is @code{nil}.
3781 Time zone of the date string in summary mode is adjusted using this value.
3782 If @code{nil}, it is adjust to the default time zone information
3783 (system's default time zone or environment variable @samp{TZ}).
3785 @item wl-use-petname
3786 @vindex wl-use-petname
3787 The initial setting is @code{t}.
3788 If non-nil, sender part displays nickname.
3790 @item wl-break-pages
3791 @vindex wl-break-pages
3792 The initial setting is @code{t}.
3793 If non-nil, message is split as pages by @samp{^L}.
3795 @item wl-message-window-size
3796 @vindex wl-message-window-size
3797 The initial setting is '(1 . 4).
3798 A cons cell to specify the rate of summary and message window.
3799 car:cdr corresponds summary:message.
3801 @item wl-summary-no-from-message
3802 @vindex wl-summary-no-from-message
3803 The initial setting is @samp{nobody@@nowhere?}. A string which is
3804 displayed when there's no @samp{From:} field in the message.
3806 @item wl-summary-no-subject-message
3807 @vindex wl-summary-no-subject-message
3808 The initial setting is @samp{(WL:No Subject in original.)}. A string
3809 which is displayed when there's no @samp{Subject:} field in the message.
3811 @item wl-summary-use-frame
3812 @vindex wl-summary-use-frame
3813 The initial setting is @code{nil}.
3814 If non-nil, use new frame for the summary.
3816 @item wl-use-folder-petname
3817 @vindex wl-use-folder-petname
3818 The initial setting is the list shown below:
3827 A list of display policy (symbol) of folder nickname. Available symbols
3832 Display folder petname on modeline.
3834 Destination folder is notified as nickname if
3835 @code{wl-auto-select-next} is non-nil.
3837 You can input folder name by nickname in the function
3838 @code{wl-summary-read-folder}.
3841 @item wl-summary-move-direction-toggle
3842 @vindex wl-summary-move-direction-toggle
3843 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3844 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3845 want to aware of reading direction, set this to @code{t}.
3847 @item wl-summary-width
3848 @vindex wl-summary-width
3849 The initial setting is 80.
3850 Width of summary line. If @code{nil}, summary line's width is as is.
3852 @item wl-summary-from-width
3853 @vindex wl-summary-from-width
3854 The initial setting is 17.
3855 Width of sender part of summary line.
3857 @item wl-summary-indent-length-limit
3858 @vindex wl-summary-indent-length-limit
3859 The initial setting is 46.
3860 Specify the limit of thread indent level. @code{nil} means unlimited
3862 If you set this to @code{nil} you should set @code{wl-summary-width}
3865 @item wl-summary-recenter
3866 @vindex wl-summary-recenter
3867 The initial setting is t.
3868 If non-nil, cursor point is moved to the center of the summary window.
3870 @item wl-summary-divide-thread-when-subject-changed
3871 @vindex wl-summary-divide-thread-when-subject-changed
3872 The initial setting is @code{nil}. If non-nil, thread is split if
3873 the subject is changed.
3875 @item wl-summary-search-via-nntp
3876 @vindex wl-summary-search-via-nntp
3877 The initial setting is @code{confirm}.
3879 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3880 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3881 from the NNTP server @code{elmo-nntp-default-server}. The value of
3882 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3883 @code{elmo-nntp-default-stream-type} are used.
3885 If @code{confirm}, server name can be specified. You can specify NNTP
3886 folder format like @samp{-:username@@servername:119!}.
3888 @item wl-summary-keep-cursor-command
3889 @vindex wl-summary-keep-cursor-command
3890 The initial setting is the list shown below:
3894 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3899 When you entered to summary by these commands and the target summary
3900 buffer already exists, summary status is not automatically updated and
3901 cursor position is saved.
3903 @item elmo-folder-update-threshold
3904 @vindex elmo-folder-update-threshold
3905 The initial setting is 500. If updated message number is larger than
3906 this value, confirm whether drop them or not (in the case where the value
3907 of @code{elmo-folder-update-confirm} is non-nil).
3909 @item elmo-folder-update-confirm
3910 @vindex elmo-folder-update-confirm
3911 The initial setting is @code{t}. If the value is non-nil, do check with
3912 @code{elmo-folder-update-threshold}.
3914 @item wl-summary-always-sticky-folder-list
3915 @vindex wl-summary-always-sticky-folder-list
3916 The initial setting is @code{nil}.
3917 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3918 are automatically stuck. Each element is regexp of folder name.
3920 @item wl-summary-reserve-mark-list
3921 @vindex wl-summary-reserve-mark-list
3922 The initial setting is the list shown below:
3931 If a message is already marked as temporal marks in this list, the
3932 message is not marked by any mark command.
3934 @item wl-summary-skip-mark-list
3935 @vindex wl-summary-skip-mark-list
3936 The initial setting is the list shown below:
3945 If a message is already marked as temporal marks in this list, the
3946 message is skipped at cursor move.
3948 @item elmo-message-fetch-threshold
3949 @vindex elmo-message-fetch-threshold
3950 The initial setting is 30000 (bytes). If displaying message has larger
3951 size than this value, Wanderlust confirms whether fetch the message or
3952 not (in the case where the value of @code{elmo-message-fetch-confirm}
3955 @item elmo-message-fetch-confirm
3956 @vindex elmo-message-fetch-confirm
3957 The initial setting is @code{t}. If the value is non-nil, do check with
3958 @code{elmo-message-fetch-threshold}.
3960 @item wl-prefetch-threshold
3961 @vindex wl-prefetch-threshold
3962 The initial setting is 30000 (bytes). If prefetching message has larger
3963 size than this value and @code{wl-prefetch-confirm} is non-nil,
3964 Wanderlust confirms whether prefetch the message or not. If
3965 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3966 without confirmation.
3968 @item wl-prefetch-confirm
3969 @vindex wl-prefetch-confirm
3970 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3971 prefetch the message or not if the message has larger size than
3972 @code{wl-prefetch-threshold}.
3974 @item elmo-imap4-use-cache
3975 @vindex elmo-imap4-use-cache
3976 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3979 @item elmo-nntp-use-cache
3980 @vindex elmo-nntp-use-cache
3981 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3984 @item elmo-pop3-use-cache
3985 @vindex elmo-pop3-use-cache
3986 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3989 @item elmo-shimbun-use-cache
3990 @vindex elmo-shimbun-use-cache
3991 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3994 @item wl-folder-process-duplicates-alist
3995 @vindex wl-folder-process-duplicates-alist
3996 The initial setting is @code{nil}.
3997 This list determines how to deal with duplicated messages in the same folder.
3998 Each item in the list is regexp of folder name and action; you can specify any
3999 one of the following in the place of action:
4002 @code{nil} : do nothing for duplicated messages.
4003 @code{hide} : hide duplicated messages from the summary.
4004 @code{read} : set duplicated messages as read.
4008 Following is an example (hide duplicated messages in multi folders)
4012 (setq wl-folder-process-duplicates-alist
4013 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4014 ("^\\*.*" . hide) (".*" . read)))
4020 @node Message, Draft, Summary, Top
4021 @chapter Message Buffer
4023 Message Buffers utilize MIME-View mode of SEMI. For operational
4024 procedures and key bindings, refer to respective documents.
4025 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4026 You can also see help by @kbd{?} in message buffer.
4028 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4029 brings you back to Summary mode. @kbd{l} toggles display of Summary
4032 @section Key Bindings
4038 @findex wl-message-toggle-disp-summary
4039 Toggles display of Summary buffer.
4040 (@code{wl-message-toggle-disp-summary})
4043 @findex wl-message-refer-article-or-url
4044 @kindex Button-2 (Message)
4045 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4046 corresponding message if found.
4047 (@code{wl-message-refer-article-or-url})
4049 @item Button-4 (upward movement of a wheel)
4050 @kindex Button-4 (Message)
4051 @findex wl-message-wheel-down
4052 Scrolls the message backwards. When the top of the message is hit,
4053 moves to the previous message.
4054 (@code{wl-message-wheel-down})
4056 @item Button-5 (downward movement of a wheel)
4057 @kindex Button-5 (Message)
4058 @findex wl-message-wheel-up
4059 Scrolls the message forward. When the bottom of the message is hit,
4060 moves to the next message.
4061 (@code{wl-message-wheel-up})
4065 @findex wl-message-delete-current-part
4066 Delete the part under cursor. In fact it appends modified message to
4067 the current folder then moves old one to trash folder. Therefore the
4068 message number will be changed.
4069 (@code{wl-message-delete-current-part})
4072 @section Customizable Variables
4075 @item wl-message-window-size
4076 @vindex wl-message-window-size
4077 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4078 its car and cdr value corresponds to the ratio of Summary and Message
4081 @item wl-message-ignored-field-list
4082 @vindex wl-message-ignored-field-list
4083 (SEMI only) Initial setting is @code{nil}.
4084 All fields that match this list will be hidden in message buffer.
4085 Each elements are regexp of field-name.
4086 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4088 @item wl-message-visible-field-list
4089 @vindex wl-message-visible-field-list
4090 (SEMI only) Initial setting is @code{nil}.
4091 All fields that match this list will be display in message buffer.
4092 Each elements are regexp of field-name. This value precedes
4093 @code{wl-message-ignored-field-list}.
4094 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4096 @item wl-message-sort-field-list
4097 @vindex wl-message-sort-field-list
4098 (SEMI only) Initial setting is
4099 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4100 Header fields in message buffer are ordered by this value.
4101 Each elements are regexp of field-name.
4103 @item wl-message-truncate-lines
4104 @vindex wl-message-truncate-lines
4105 The initial value is the value of @code{default-truncate-lines}.
4106 If it is non-nil, truncate long lines in message buffer.
4109 @node Draft, Disconnected Operations, Message, Top
4110 @chapter Draft Buffer
4112 At Summary mode, pressing @kbd{w} and the like creates a new draft
4113 buffer. You can edit and send mail and news articles in this buffer.
4115 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4116 with those if possible.
4119 * Usage of Draft Mode:: TIPS
4120 * Key Bindings of Draft:: Key bindings
4121 * Variables of Draft Mode:: Customize Draft Mode
4124 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4127 Basically it is Emacs-standard mail mode.
4131 * Editing Message Body::
4132 * Dynamical Message Re-arrangement::
4137 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4138 @subsection Editing Message Header
4140 You can freely edit header region above @samp{--text follows this line--},
4141 until you invoke the sending operation.
4143 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4144 addresses. @kbd{@key{TAB}} completes them.
4146 You can use following headers to specify recipients. Add some of them
4147 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4150 @item @samp{Newsgroups:}
4151 Specify newsgroups to which you post the news article.
4154 Specify addresses to send a copy (Carbon Copy) of the message.
4157 Following ones are removed from the header contents before sending.
4161 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4164 Specify folders in which a copy of the message is saved.
4167 Specify recipients to send encapsulated copy of the message.
4170 You can add initial headers by following variables.
4176 The initial setting is @code{nil}.
4177 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4178 the draft when it is prepared. If function is specified, its return
4183 The initial setting is @code{nil}.
4184 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4185 the draft when it is prepared.
4188 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4189 @subsection Editing Messages
4191 As a matter of course, editing message body can be performed in the same
4192 way as usual writing. You may write message body under
4193 @samp{--text follows this line--} line. (NOTE: Be sure to leave the line
4194 @samp{--text follows this line--} intact.)
4196 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4197 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4198 a MIME user interface for GNU Emacs}.
4199 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4201 If you save the draft buffer you are editing, it is appended to the
4202 folder specified by @code{wl-draft-folder}.
4204 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4205 @subsection Dynamic Modification of Messages
4206 @vindex wl-draft-config-alist
4207 @c @cindex Change Message
4208 @c @cindex Message, Change Dynamic
4210 You can set @code{wl-draft-config-alist} so that header and body of the
4211 message will automatically modified depending on information of header
4214 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4216 In the example below, the header is modified when
4217 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4218 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4219 before sending the message.
4223 (setq wl-draft-config-alist
4224 '(((string-match "aaa\\.example\\.com$" (system-name))
4225 ;; @r{applied if the expression is non-nil}
4226 (wl-smtp-posting-server . "mailserver-B")
4227 (wl-nntp-posting-server . "newsserver-B")
4228 ;; @r{settings of temporary variables}
4230 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4231 ;; @r{applied if it matches the header of the draft buffer}
4232 ("Organization" . (format "Go %s" my-webpage)))
4233 ;; @r{you can write elisp expressions here (eval only)}
4234 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4235 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4240 The format of @code{wl-draft-config-alist} is:
4244 '(("@var{regexp of the header}" or @var{elisp expression}
4245 ("@var{Field}" . value(@var{elisp expression}))
4246 (@var{variable} . value(@var{elisp expression}))
4247 (@var{sub-function} . value(@var{elisp expression}))
4250 ("@var{regexp of the header}" or @var{elisp expression}
4251 ("@var{Field}" . value(@var{elisp expression}))
4256 Per default, there are 10 following sub-functions.
4259 'header: Inserts the specified string at the bottom of the header.
4260 'header-top: Inserts the specified string at the top of the header.
4261 'header-file: Inserts the specified file at the bottom of the header.
4262 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4263 'top: Inserts the specified string at the top of the body.
4264 'top-file: Inserts the specified file at the top of the body.
4265 'body: Replaces the body with the specified string.
4266 Specifying @code{nil} deletes the entire body string.
4267 'body-file: Replaces the body with the content of the specified file.
4268 'bottom: Inserts the specified string at the bottom of the body.
4269 'bottom-file: Inserts the specified file at the top of the body.
4270 'part-top: Inserts the specified string at the top of the current part.
4271 'part-bottom: Inserts the specified string at the bottom of the current part.
4272 'template: Applies the specified template.
4273 (refer to the next subsection)
4276 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4277 change them or add your own functions. If you read the code, you can
4278 easily find how to write the functions.
4280 At the first of each item, @var{a regular expression of the header} or
4281 an @var{elisp expression} should be specified. In the case of an elisp
4282 expression, the item is applied when the expression is evaluated
4285 Per default, when multiple items match or are evaluated non-nil, all
4286 such items are applied, but if you set a variable
4287 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4290 At the second of the item, a cons or a list of functions should be
4291 specified. The car part of the cons should be a header field, a
4292 variable, or a sub-function. When a header field is specified, the
4293 field will be modified. If a variable is specified, the value of the
4294 variable will be modified temporarily.
4296 In the cdr part of a cons, not only a variable but also an elisp
4297 expression can be specified as is. If the car part is a header field
4298 and the cdr part is @code{nil}, the field will be deleted.
4300 See the next example as well:
4304 (setq wl-draft-config-alist
4306 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4307 ;; @r{applied if it matches the header of the buffer being replied}
4308 (body . " Hello.\n")
4309 (template . "default")
4314 As in the (1) above, if a header regexp is prepended with @code{reply},
4315 it is applied when the draft is prepared by @code{wl-summary-reply} for
4316 example, and when it matches the header being replied. It is ignored
4317 when there is no buffer being replied, like after @code{wl-draft} was
4320 If you want to use name of parent folder, you can refer the buffer local
4321 variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
4322 changes From according to the folder name of the summary in which the draft
4327 (setq wl-draft-config-alist
4328 '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
4329 (\"From\" . \"user@@domain1\"))
4330 ((string-match \".*@@domain2$\" wl-draft-parent-folder)
4331 (\"From\" . \"user@@domain2\"))))
4336 Note that @code{wl-draft-config-alist} is applied only once when
4337 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4338 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4339 aborting transmission, execute @kbd{C-c C-e}
4340 (@code{wl-draft-config-exec}) explicitly.
4342 If you don't want to apply @code{wl-draft-config-alist} when
4343 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4347 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4350 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4351 prepared, do the following:
4354 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4357 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4358 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4362 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4365 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4366 @subsection Inserting Templates
4368 @cindex Apply Template
4370 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4371 @kbd{M-x wl-template-select} in the draft buffer.
4373 The format of @code{wl-template-alist} is almost the same as
4374 @code{wl-draft-config-alist}.
4378 (setq wl-template-alist
4381 ("Organization" . "Example Co.Ltd.")
4382 (body . "Hello.\n"))
4384 (template . "default") ;; @r{(a)}
4385 ("To" . "boss@@example.com")
4386 ("Subject" . "Report")
4387 (body-file . "~/work/report.txt")
4393 As you can see, the only difference is item (template) names such as
4394 @samp{default} and @samp{report}, instead of a regexp of header.
4395 Because definition of each item is the same as
4396 @code{wl-draft-config-alist}, you can call another template, like (a).
4398 Executing the command @code{wl-template-select} results in template
4399 selection, but the result differs depending on variable
4400 @code{wl-template-visible-select}.
4402 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4403 window is shown below the draft buffer. You can select a template by
4404 @kbd{n} and @kbd{p} seeing the buffer window.
4406 Press the @key{RET} key and the template is actually applied to the draft
4407 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4408 adjust the window size by @code{wl-template-buffer-lines}.
4410 If @code{wl-template-visible-select} is @code{nil}, you should type the
4411 name of the template in the mini buffer.
4413 As shown in the example in @code{wl-draft-config-alist}, you can select
4414 @samp{default} template by writing:
4417 (template . "default")
4420 @node POP-before-SMTP, , Template, Usage of Draft Mode
4421 @subsection Sending mail by POP-before-SMTP
4422 @cindex POP-before-SMTP
4424 You can send mail by POP-before-SMTP with this single line:
4427 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4431 Configure the following variables if you need.
4434 @item wl-pop-before-smtp-user
4435 The POP user name for POP-before-SMTP authentication.
4436 If unset, @code{elmo-pop3-default-user} is used.
4438 @item wl-pop-before-smtp-server
4439 The POP server name for POP-before-SMTP authentication.
4440 If unset, @code{elmo-pop3-default-server} is used.
4442 @item wl-pop-before-smtp-authenticate-type
4443 The POP authentication method for POP-before-SMTP authentication.
4444 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4446 @item wl-pop-before-smtp-port
4447 The POP port number for POP-before-SMTP authentication.
4448 If unset, @code{elmo-pop3-default-port} is used.
4450 @item wl-pop-before-smtp-stream-type
4451 If non-nil, POP connection is established using SSL. If
4452 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4453 unset, @code{elmo-pop3-default-stream-type} is used.
4456 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4457 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4459 Therefore, if SMTP server and POP server are actually the same, and if
4460 POP folder per default (such as @samp{&}) is available, no settings are
4463 Refer to the following URL about POP-before-SMTP.
4467 http://spam.ayamura.org/tools/smPbS.html
4468 http://www.iecc.com/pop-before-smtp.html
4473 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4474 @section Key Bindings
4475 @cindex Keybind, Draft Mode
4476 @cindex Keybind, Draft Buffer
4481 @kindex C-c C-y (Draft)
4482 @findex wl-draft-yank-original
4483 Cites the content of the current message buffer (the part under cursor).
4484 If the region is active, cites the region (it affects only if
4485 @code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
4486 (on XEmacs) is Non-nil).
4487 (@code{wl-draft-yank-original})
4490 @kindex C-c C-p (Draft)
4491 @findex wl-draft-preview-message
4492 Previews the content of the current draft.
4493 This is useful for previewing MIME multi-part messages.
4494 (@code{wl-draft-preview-message})
4497 @kindex C-c C-s (Draft)
4498 @findex wl-draft-send
4499 Sends the content of the current draft. Does not erase the draft buffer.
4500 This is useful for sending multiple messages, which are a little different
4502 (@code{wl-draft-send})
4505 @kindex C-c C-c (Draft)
4506 @findex wl-draft-send-and-exit
4507 Sends the content of the current draft and erases the draft buffer.
4508 (@code{wl-draft-send-and-exit})
4511 @kindex C-x C-s (Draft)
4512 @findex wl-draft-save
4513 Save the current draft.
4514 (@code{wl-draft-save})
4517 @kindex C-c C-k (Draft)
4518 @findex wl-draft-kill
4519 Kills the current draft.
4520 (@code{wl-draft-kill})
4523 @kindex C-x k (Draft)
4524 @findex wl-draft-mimic-kill-buffer
4525 Kills the current draft.
4526 (@code{wl-draft-mimic-kill-buffer})
4529 @kindex C-c C-z (Draft)
4530 @findex wl-draft-save-and-exit
4531 Saves the current draft, and erases the draft buffer.
4532 This is useful if you want to suspend editing of the draft.
4533 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4534 the @samp{+draft} folder.
4535 (@code{wl-draft-save-and-exit})
4538 @kindex C-c C-r (Draft)
4539 @findex wl-caesar-region
4540 Encodes or decodes the specified region in Caesar cipher.
4541 (@code{wl-caesar-region})
4545 @findex wl-draft-highlight-and-recenter
4546 Recenter and rehighlight current draft.
4547 (@code{wl-draft-highlight-and-recenter})
4551 @findex wl-toggle-plugged
4552 Toggles off-line/on-line states of Wanderlust.
4553 (@code{wl-toggle-plugged})
4556 @kindex C-c C-o (Draft)
4557 @findex wl-jump-to-draft-buffer
4558 Jumps to the other draft buffer, if exists.
4559 With prefix argument, reads a file (if any) from the draft folder when
4560 there is no such buffer.
4561 (@code{wl-jump-to-draft-buffer})
4564 @kindex C-c C-e (Draft)
4565 @findex wl-draft-config-exec
4566 Applies @code{wl-draft-config-alist}.
4567 (@code{wl-draft-config-exec})
4570 @kindex C-c C-j (Draft)
4571 @findex wl-template-select
4573 (@code{wl-template-select})
4576 @kindex C-c C-a (Draft)
4578 Enter Address Manager.
4579 @xref{Address Manager}.
4583 @kindex C-c C-d (Draft)
4584 @findex wl-draft-elide-region
4585 Elide the text between point and mark (@code{wl-draft-elide-region}).
4586 The text is killed and replaced with the contents of the variable
4587 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4591 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4592 @section Customizable Variables
4595 @item wl-subscribed-mailing-list
4596 @vindex wl-subscribed-mailing-list
4597 The initial setting is @code{nil}. Mailing lists to which you
4598 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4599 field of a reply draft, removes your own address from
4600 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4601 contained in @samp{To:} or @samp{Cc:} field of a message to be
4602 automatically re-filed, the destination folder will be leaned in
4603 connection with the address.
4609 (setq wl-subscribed-mailing-list
4610 '("wl@@lists.airs.net"
4612 "emacs-mime-ja@@m17n.org"))
4616 @item wl-insert-mail-followup-to
4617 @vindex wl-insert-mail-followup-to
4618 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4619 field is automatically inserted in the draft buffer.
4621 @item wl-insert-mail-reply-to
4622 @vindex wl-insert-mail-reply-to
4623 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4624 field is automatically inserted in the draft buffer.
4626 @item wl-auto-insert-x-face
4627 @vindex wl-auto-insert-x-face
4628 The initial setting is @code{t}. If non-nil and there is an encoded
4629 X-Face string in a file @file{~/.xface} (the value of the variable
4630 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4631 draft buffer. If @code{nil}, it is not automatically inserted.
4633 @item wl-insert-message-id
4634 @vindex wl-insert-message-id
4635 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4636 is automatically inserted on the transmission.
4638 @item wl-message-id-use-wl-from
4639 @vindex wl-message-id-use-wl-from
4640 The initial setting is @code{nil}. If non-nil, the value of
4641 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4643 @item wl-local-domain
4644 @vindex wl-local-domain
4645 The initial setting is @code{nil}. If @code{nil}, the return value of
4646 the function @code{system-name} will be used as the domain part of
4649 If @code{system-name} does not return FQDN (i.e. the full name of the
4650 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4651 to the string of the local domain name without hostname (like
4652 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4653 @samp{.} @code{wl-local-domain} is used as domain part of the
4656 If your terminal does not have global IP, set the value of
4657 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4658 you use invalid @samp{Message-ID:}.)
4660 Moreover, concatenation of @code{system-name} @samp{.}
4661 @code{wl-local-domain} will be used as an argument to the HELO command
4664 @item wl-message-id-domain
4665 @vindex wl-message-id-domain
4666 The initial setting is @code{nil}. If non-nil, this value is used as a
4667 domain part of the @samp{Message-ID:}. If your terminal does not have
4668 global IP address, set unique string to this value (e.x. your e-mail
4671 @item wl-unique-id-suffix
4672 @vindex wl-unique-id-suffix
4673 The initial setting is @samp{.wl}. You can specify the string in generated
4674 Message-ID which appear just before @samp{@@}.
4676 @item wl-draft-config-alist
4677 @vindex wl-draft-config-alist
4678 The initial setting is @code{nil}. Modifies the draft message just
4679 before the transmission. The content of @code{wl-draft-config-alist}
4680 will be automatically applied only once on the transmission. If you
4681 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4684 @item wl-template-alist
4685 @vindex wl-template-alist
4686 The initial setting is @code{nil}.
4687 This variable specifies the template to be applied in the draft buffer.
4689 @item wl-draft-config-matchone
4690 @vindex wl-draft-config-matchone
4691 The initial setting is @code{nil}. If non-nil, only the first matching
4692 item is used when @code{wl-draft-config-alist} is applied. If
4693 @code{nil}, all matching items are used.
4695 @item wl-template-visible-select
4696 @vindex wl-template-visible-select
4697 The initial setting is @code{t}.
4698 If non-nil, you can preview the result of the template selection in
4701 @item wl-template-confirm
4702 @vindex wl-template-confirm
4703 The initial setting is @code{nil}.
4704 If non-nil, asks for confirmation when you press the enter key to select
4705 template while previewing.
4707 @item wl-template-buffer-lines
4708 @vindex wl-template-buffer-lines
4709 The initial setting is 7.
4710 If @code{wl-template-visible-select} is non-nil, this variable specifies
4711 the size of the preview window.
4713 @item wl-draft-buffer-style
4714 @vindex wl-draft-buffer-style
4715 The initial setting is @code{full}.
4716 Style of draft buffer window (except for replying and forwarding).
4717 @code{keep} is to use current window,
4718 @code{full} is to use full frame window,
4719 @code{split} is to split current window and use it.
4720 If some function is specified, it is called with the draft buffer
4723 @item wl-draft-reply-buffer-style
4724 @vindex wl-draft-reply-buffer-style
4725 The initial setting is @code{split}.
4726 Style of draft buffer for replying and forwarding.
4727 @code{keep} is to use message buffer window,
4728 @code{full} is to use full frame window,
4729 @code{split} is to split message buffer window and use it.
4730 If some function is specified, it is called with the draft buffer
4733 @item wl-draft-use-frame
4734 @vindex wl-draft-use-frame
4735 The initial setting is @code{nil}.
4736 If non-nil, use new frame for the draft.
4738 @item wl-draft-truncate-lines
4739 @vindex wl-draft-truncate-lines
4740 The initial value is the value of @code{default-truncate-lines}.
4741 If it is non-nil, truncate long lines in draft buffer.
4745 The initial setting is the value of the variable
4746 @code{user-mail-address}. The value of this variable is inserted as a
4747 @samp{From:} field of the draft when it is prepared.
4749 @item wl-envelope-from
4750 @vindex wl-envelope-from
4751 The initial setting is @code{nil}.
4752 The value of this variable is used for envelope from (MAIL FROM).
4753 If @code{nil}, the address part of @code{wl-from} is used.
4755 @item wl-user-mail-address-list
4756 @vindex wl-user-mail-address-list
4757 The initial setting is @code{nil}.
4758 This is the User's address list. If you have multiple addresses,
4761 @item wl-reply-subject-prefix
4762 @vindex wl-reply-subject-prefix
4763 The initial setting is @samp{Re: }.
4764 In the @samp{Subject:} of the reply draft, this string is prepended to
4765 the @samp{Subject:} of being replied.
4767 @item wl-forward-subject-prefix
4768 @vindex wl-forward-subject-prefix
4769 The initial setting is @samp{Forward: }.
4770 In the @samp{Subject:} of the forwarding draft, this string is prepended
4771 to the @samp{Subject:} of being forwarded.
4773 @item wl-draft-reply-use-address-with-full-name
4774 @vindex wl-draft-reply-use-address-with-full-name
4775 The initial setting is @code{t}.
4776 If non-nil, insert her full name with address when prepare a draft for
4777 reply a message. If it is @code{nil}, insert her address only.
4779 @item wl-draft-enable-queuing
4780 @vindex wl-draft-enable-queuing
4781 The initial setting is @code{t}.
4782 This flag controls off-line transmission. If non-nil, the draft is
4785 @item wl-draft-use-cache
4786 @vindex wl-draft-use-cache
4787 The initial setting is @code{nil}. If the value is non-nil and
4788 @code{wl-insert-message-id} is nil, cache the message which is sent.
4790 @item wl-fcc-force-as-read
4791 @vindex wl-fcc-force-as-read
4792 The initial setting is @code{nil}. If the value is non-nil,
4793 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4795 @item wl-auto-flush-queue
4796 @vindex wl-auto-flush-queue
4797 The initial setting is t.
4798 This flag controls automatic transmission of the queue when Wanderlust
4799 becomes on-line. If non-nil, the queue is automatically transmitted
4800 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4801 manually, press @kbd{F} in the folder mode.
4803 @item wl-ignored-forwarded-headers
4804 @vindex wl-ignored-forwarded-headers
4805 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4806 All headers that match this regexp will be deleted when forwarding a message.
4808 @item wl-ignored-resent-headers
4809 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4810 All headers that match this regexp will be deleted when resending a message.
4812 @item wl-draft-always-delete-myself
4813 @vindex wl-draft-always-delete-myself
4814 If non-nil, always removes your own address from @samp{To:} and
4815 @samp{Cc:} when you are replying to the mail addressed to you.
4817 @item wl-draft-delete-myself-from-bcc-fcc
4818 @vindex wl-draft-delete-myself-from-bcc-fcc
4819 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4820 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4822 @item wl-smtp-posting-server
4823 @vindex wl-smtp-posting-server
4824 The initial setting is @code{nil}.
4825 This is the SMTP server name for mail transmission.
4827 @item wl-smtp-posting-port
4828 @vindex wl-smtp-posting-port
4829 The initial setting is @code{nil}.
4830 This is the SMTP port number for mail transmission.
4831 If @code{nil}, default SMTP port number (25) is used.
4833 @item wl-smtp-posting-user
4834 @vindex wl-smtp-posting-user
4835 The initial setting is @code{nil}.
4836 This is the user name for SMTP AUTH authentication. If @code{nil},
4837 @code{smtp-authenticate-user} is used.
4839 @item wl-smtp-authenticate-type
4840 @vindex wl-smtp-authenticate-type
4841 The initial setting is @code{nil}.
4842 This is the authentication method for SMTP AUTH authentication. If
4843 @code{nil}, @code{smtp-authenticate-type} is used. If
4844 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4847 @item wl-smtp-connection-type
4848 @vindex wl-smtp-connection-type
4849 The initial setting is @code{nil}.
4850 This variable specifies how to establish SMTP connections.
4851 If @code{nil}, @code{smtp-connection-type} is used.
4852 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4854 @item wl-nntp-posting-server
4855 @vindex wl-nntp-posting-server
4856 The initial setting is @code{nil}.
4857 This is the NNTP server name used for news submission.
4858 If @code{nil}, @code{elmo-nntp-default-server} is used.
4860 @item wl-nntp-posting-user
4861 @vindex wl-nntp-posting-user
4862 The initial setting is @code{nil}.
4863 This is the user name for AUTHINFO authentication on news submission.
4864 If @code{nil}, @code{elmo-nntp-default-user} is used.
4865 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4867 @item wl-nntp-posting-port
4868 @vindex wl-nntp-posting-port
4869 The initial setting is @code{nil}.
4870 This is the port number of the NNTP server used for news submission.
4871 If @code{nil}, @code{elmo-nntp-default-server} is used.
4873 @item wl-nntp-posting-stream-type
4874 @vindex wl-nntp-posting-stream-type
4875 The initial setting is @code{nil}.
4876 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4877 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4878 connection will be established.
4880 @item wl-nntp-posting-function
4881 @vindex wl-nntp-posting-function
4882 The initial setting is @code{elmo-nntp-post}.
4883 This is the function to post NNTP message.
4885 @item wl-nntp-posting-config-alist
4886 @vindex wl-nntp-posting-config-alist
4887 The initial setting is @code{nil}.
4888 The value takes an alist to define NNTP server like following example.
4889 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
4893 (setq wl-nntp-posting-config-alist
4894 '((",?gmane\\." . "news.gmane.org")
4896 ((server . "news-server")
4897 (user . "newsmaster")
4899 (function . elmo-nntp-post)))
4900 (".*" . "default-news-server")))
4904 @item wl-pop-before-smtp-user
4905 @vindex wl-pop-before-smtp-user
4906 The initial setting is @code{nil}.
4907 This is the POP user name for POP-before-SMTP.
4908 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4910 @item wl-pop-before-smtp-server
4911 @vindex wl-pop-before-smtp-server
4912 The initial setting is @code{nil}.
4913 This is the POP server name for POP-before-SMTP.
4914 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4916 @item wl-pop-before-smtp-authenticate-type
4917 @vindex wl-pop-before-smtp-authenticate-type
4918 The initial setting is @code{nil}.
4919 This is the authentication method for POP-before-SMTP authentication.
4920 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4922 @item wl-pop-before-smtp-port
4923 @vindex wl-pop-before-smtp-port
4924 The initial setting is @code{nil}.
4925 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4926 @code{elmo-pop3-default-port} is used.
4928 @item wl-pop-before-smtp-stream-type
4929 @vindex wl-pop-before-smtp-stream-type
4930 The initial setting is @code{nil}.
4931 This flag controls the use of SSL for POP-before-SMTP. If it is
4932 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4933 STARTTLS (RFC2595) connection will be established.
4935 @item wl-draft-queue-save-variables
4936 @vindex wl-draft-queue-save-variables
4937 Specifies a list of variable to which queued messages are saved on the
4938 off-line transmission.
4940 @item wl-draft-sendlog
4941 @vindex wl-draft-sendlog
4942 The initial setting is @code{t}.
4943 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4947 @item drafts are sent by smtp or qmail
4948 @item saved into folders by fcc
4949 @item saved into folders by queuing
4952 (it is written even if the transmission fails).
4953 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4954 and left to the logging function of @command{imput}.
4957 @item wl-draft-sendlog-max-size
4958 @vindex wl-draft-sendlog-max-size
4959 The initial setting is 20000 (in bytes).
4960 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4961 beyond the size specified by this variable.
4965 The initial setting is @code{nil}.
4966 If non-nil, address completion uses LDAP.
4968 @item wl-ldap-server
4969 @vindex wl-ldap-server
4970 The initial setting is @samp{localhost}.
4971 LDAP server name for address completion.
4974 @vindex wl-ldap-port
4975 The initial setting is @code{nil}.
4976 If non-nil, the value is used as port number.
4979 @vindex wl-ldap-base
4980 The initial setting is @samp{c=US}.
4981 LDAP search starting point (base) for address completion.
4983 @item wl-draft-remove-group-list-contents
4984 @vindex wl-draft-remove-group-list-contents
4985 The initial setting is @code{t}.
4986 If non-nil, remove the group-lists' members in the recipients when
4987 sending the message (group-list means the description such as
4988 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4991 @node Disconnected Operations, Expire and Archive, Draft, Top
4992 @chapter Off-line Management
4993 @cindex Disconnected Operations
4995 Wanderlust has on-line and off-line states.
4998 * Off-line State:: Wanderlust has on-line and off-line states
4999 * Enable Operations:: Enable Disconnected Operations
5000 * Plugged Mode:: Switching On-line/Off-line per Server/Port
5001 * Off-line State settings:: Invoking Wanderlust in the Off-line State
5002 * Variables of Plugged Mode:: Customize Plugged Mode
5006 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
5007 @section Off-line State
5009 Wanderlust has on-line and off-line states. In the off-line state, you
5010 cannot access messages via network, unless they are cached.
5012 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
5013 in the mode line indicates the off-line state. In folder or summary
5014 modes, press @kbd{M-t} to switch between off- and on-line.
5016 You can invoke Wanderlust in the off-line state by setting
5017 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
5019 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
5020 ignores uncached messages.
5023 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
5024 @section Enable Disconeected Operations
5026 Even in the off-line state, provided that relevant messages are cached,
5027 and the variable @code{elmo-enable-disconnected-operation} (described
5028 later) is non-nil, you can following operations:
5029 @xref{Plugged Mode}, @xref{Off-line State settings}.
5032 * Send Messages off-line:: Transmit Messages
5033 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
5034 * Creation of Folders:: Create Folders off-line (IMAP4)
5035 * Marking:: Mark (IMAP4)
5036 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
5039 As soon as Wanderlust becomes on-line, such operations invoked off-line
5040 are reflected in the servers via network.
5043 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
5044 @subsection Transmission of Messages
5046 You can proceed sending operation for mail/news messages while you are
5047 off-line, then it will be reserved for sending (if you are using
5048 @file{im-wl.el}, it is irrelevant).
5049 Messages reserved for sending while off-line are accumulated in the
5050 queue folder, @samp{+queue}. These messages are transmitted at once when
5051 Wanderlust becomes on-line.
5053 You can visit @samp{+queue} in the off-line state and confirm content of
5054 messages in the queue. You can also remove messages. Removed messages
5055 are not transmitted even in the on-line state.
5058 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5059 @subsection Re-file and Copy (IMAP4)
5061 Re-file and copy operations to IMAP folders invoked during the off-line
5062 state are accumulated in the queue, and reflected in the server side
5063 when Wanderlust becomes on-line. If you visit destination folders after
5064 off-line re-file or copy, it looks as if messages were appended even in
5067 For the safety reasons, messages re-filed off-line are removed from
5068 source folders only if their @samp{Message-ID:} match messages on the
5069 servers. While the queue is processed, messages that failed to be
5070 re-filed or copied to the specified folders are appended to the folder
5074 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5075 @subsection Creation of Folders (IMAP4)
5077 You can create IMAP folders off-line. The creation of folders are
5078 reflected in the servers when Wanderlust becomes on-line. If the creation
5079 of those folders fails at that time for some reasons, messages
5080 to be re-filed into those are appended to the folder @samp{+lost+found}
5084 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5085 @subsection Marking (IMAP4)
5087 Off-line changes in unread/read and importance mark @samp{$} information
5088 are also reflected in the servers when Wanderlust becomes on-line.
5091 @node Pre-fetching Reservations, , Marking, Enable Operations
5092 @subsection Pre-fetching (IMAP4, NNTP)
5094 You can make reservations for pre-fetching messages in IMAP or NNTP
5095 folders. Reserved messages are marked with @samp{!} but not cached
5096 yet. When Wanderlust becomes on-line, they are pre-fetched from
5099 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5100 these off-line operations for IMAP4 and NNTP do not take place, and
5101 off-line re-file, copy or suchlike simply results in error.
5103 Because off-line operations use cache files, it is a bad idea to erase
5104 them by hand; it may cause Wanderlust to malfunction.
5106 If you want to remove caches, be sure to execute @kbd{M-x
5107 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5108 remove caches for messages relevant to off-line operations.
5111 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5112 @section Switching On-line/Off-line per Server/Port
5114 @kbd{M-t} described above switches networking states as a whole, but you
5115 can switch on-line/off-line per server/port.
5117 Pressing @kbd{C-t} in the folder or summary modes brings you in
5118 wl-plugged-mode shown below, in which you can change the plugged state
5123 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5126 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5127 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5129 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5130 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5136 The first line indicates status of the following three variables, and
5137 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5138 column modifies the values of these variables.
5142 "Queuing" @code{wl-draft-enable-queuing}
5143 "AutoFlushQueue" @code{wl-auto-flush-queue}
5144 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5148 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5151 The second and after lines indicate on-line/off-line states of servers
5152 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5153 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5154 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5156 @dfn{sending queue} means messages accumulated in the folder
5157 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5158 off-line operations when @code{elmo-enable-disconnected-operation} is
5160 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5161 @c off-line operations are enabled.
5163 They are displayed if there are any of them. In the example above, in
5164 the sending queue there are two messages (the first and the second in
5165 the queue folder) for smtp to hosta and one (the third) for nntp to
5166 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5169 If you change @samp{(wl-plugged)} in the second line, the variable
5170 @code{wl-plugged} is changed, so that the mode line indicator and
5171 plugged states of all ports are affected. If you change plugged states
5172 of any servers or ports, @samp{(wl-plugged)} in the second line is
5173 affected depending on @code{elmo-plugged-condition} settings and the
5174 plugged state of each port.
5177 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5178 @section Invoking Wanderlust in the Off-line State
5180 As described before, if you set @code{wl-plugged} to @code{nil} in
5181 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5182 off-line state. You can specify off-line state on a per server or port
5183 basis. Refer to @code{wl-reset-plugged-alist} also.
5185 Usually, when Wanderlust starts up, the plugged state of each port is
5186 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5187 @code{wl-nntp-posting-server} and so on. If you want to change the
5188 plugged state of these ports or to add other ports, configure
5189 @code{wl-make-plugged-hook} with a function.
5193 (add-hook 'wl-make-plugged-hook
5195 (elmo-set-plugged plugged-value(t/nil) server port)
5196 ;; @r{add or change plugged states of the port of the server}
5197 (elmo-set-plugged plugged-value(t/nil) server)
5198 ;; @r{if the port is omitted, all ports are affected}
5199 ;; @r{(you cannot omit the port if you newly add the server)}
5205 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5206 @section Customizable Variables
5211 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5212 mode from the beginning.
5214 @item wl-queue-folder
5215 @vindex wl-queue-folder
5216 The initial setting is @samp{+queue}.
5217 This is the folder in which messages in the transmission queue are
5220 @item wl-auto-flush-queue
5221 @vindex wl-auto-flush-queue
5222 The initial setting is @code{t}.
5223 This flag controls automatic transmission of the queue when Wanderlust
5224 becomes on-line. If non-nil, the queue is automatically transmitted
5225 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5226 manually, press @kbd{F} in the folder mode.
5228 @item elmo-enable-disconnected-operation
5229 @vindex elmo-enable-disconnected-operation
5230 The initial setting is @code{t}. Controls off-line operations
5231 regarding IMAP4. If non-nil, off-line operations are carried out.
5233 @item elmo-lost+found-folder
5234 @vindex elmo-lost+found-folder
5235 The initial setting is @samp{+lost+found}.
5236 This is the folder to which messages are saved when they fails to be
5237 appended while the off-line re-file/copy queue is processed.
5239 @item elmo-plugged-condition
5240 @vindex elmo-plugged-condition
5241 The initial setting is @code{one}.
5242 The value of @code{wl-plugged} reflects the return value of the function
5243 @code{elmo-plugged-p} (without arguments).
5244 This variable @code{elmo-plugged-condition} specifies the condition on
5245 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5246 plugged state of each port.
5249 'one : plugged if one or more ports are plugged.
5250 'all : plugged if all ports are plugged.
5251 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5252 states of the ports.
5253 @var{function} : reflects the return value of the @var{function}
5254 functions available per default
5255 'elmo-plug-on-by-servers
5256 : reflects the plugged state of the servers specified by the
5257 variable elmo-plug-on-servers.
5258 'elmo-plug-on-by-exclude-servers
5259 : reflects the plugged state of the servers that are not
5260 in elmo-plug-on-exclude-servers.
5261 elmo-plug-on-exclude-servers defaults to
5264 (system-name)without the domain part)
5270 (setq elmo-plugged-condition 'all)
5272 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5273 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5275 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5276 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5280 @item wl-reset-plugged-alist
5281 @vindex wl-reset-plugged-alist
5282 The initial setting is @code{t}. If non-nil, plugged states are
5283 initialized on a per server or port basis when Wanderlust starts up.
5285 If @code{nil}, plugged states are retained while Emacs is running. In
5286 other words, they are initialized when Emacs is restarted even if the
5287 value is @code{nil}.
5291 @node Expire and Archive, Scoring, Disconnected Operations, Top
5292 @chapter Automatic Expiration and Archiving of Messages
5293 @cindex Expire and Archive
5296 * Expire:: Expiration and Archiving
5297 * Archive:: Archiving All Messages
5301 @node Expire, Archive, Expire and Archive, Expire and Archive
5303 @cindex Expire Message
5305 Expiration means deletion of old messages which have outlasted a
5306 certain period of time.
5308 @code{wl-expire} supports not only simple deletion, but also moving to
5309 specified archiving folders.
5313 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5314 or @kbd{M-e} in the summary mode.
5316 @subsection Configuring @code{wl-expire-alist}
5318 An example configuration of @code{wl-expire-alist} is shown below.
5319 Everything in this @code{wl-expire-alist} makes a great difference in
5320 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5321 to @code{t}, especially in the initial stage.
5325 (setq wl-expire-alist
5326 '(("^\\+trash$" (date 14) remove)
5328 ("^\\+tmp$" (date 7) trash)
5329 ;; @r{re-file to @code{wl-trash-folder}}
5330 ("^\\+outbox$" (number 300) "$outbox;lha")
5331 ;; @r{re-file to the specific folder}
5333 ;; @r{do not expire}
5334 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5335 ;; @r{archive by message number (retaining numbers)}
5336 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5337 ;; @r{archive by a fixed number (retaining numbers)}
5338 ("^\\+diary$" (date 30) wl-expire-archive-date)
5339 ;; @r{archive by year and month (numbers discarded)}
5344 Items in the list has the format of:
5347 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5351 The folder is examined if it matches @var{regexp-for-folders} from the
5352 beginning of the list. If you invoke expiration on the folder that does
5353 not match any of them, nothing will happen. And if either the second or
5354 the third element of the item is @code{nil}, expiration will not take
5357 You can use any one of the following for
5358 @var{specification-of-message-to-be-deleted}:
5361 @item (number @var{n1} [@var{n2}])
5362 deletes messages depending on the number of messages in the folder.
5364 @var{n1} is the number of messages which should survive deletion, for example
5365 if its value is 500, the newest 500 messages survive and the rests are
5368 @var{n2} is the number of messages in the folder on which expiration should
5369 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5370 folders with 510 or more messages are expired.
5371 If you configured automatic expiration, frequently used folders may
5372 expire every time it receive messages, and you may be annoyed with the
5373 long delay in reading mail.
5374 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5375 expiration would not take place until a certain number of messages
5378 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5379 with important/new/unread) are not deleted.
5380 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5381 will expire so as to have 500 messages including such ones.
5382 Otherwise, it will have 500 messages except such ones.
5384 @item (date @var{d1})
5385 deletes messages depending on the dates.
5387 Messages dated @var{d1} or more days ago are deleted, for example if its
5388 value is seven, messages seven days old or more are deleted. Note that
5389 the date is the one in the @samp{Date:} field of the message, not when
5390 the message entered the folder.
5392 Messages with no or invalid @samp{Date:} field does not expire; you
5393 might have to delete them by hand.
5396 You can use any one of the following in the place of @var{destination}:
5400 deletes the messages instantly.
5403 hide the messages from summary (messages are not deleted).
5406 moves the messages to @code{wl-trash-folder}.
5408 @item @var{string}(folder)
5409 moves the messages to the folder specified with @var{string}.
5411 It would be useful for specifying an archiving folder, but because this
5412 does not move important messages, it might be better to use the
5413 standard functions described below.
5415 @item @var{function}
5416 invokes the specified @var{function}.
5418 To the @var{function}, three arguments are passed: a folder name, a list
5419 of messages to be deleted, and msgdb information of the summary. You
5420 can specify function-specific arguments after the name of the
5421 @var{function}. Note that the list contains messages with marks in
5422 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5425 These are four standard functions; three of them move messages to an archive
5426 folder in the specified way. This means old messages can be compressed
5427 and saved in a file, being deleted from the original folder.
5428 The last one divides messages to some MH folders.
5431 @item wl-expire-archive-number1
5432 re-files to archiving folders corresponding to the message numbers of
5433 the messages being deleted. For example, a message numbered 102 will be
5434 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5435 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5436 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5438 The archiving folders to which messages are re-filed are determined by
5439 the name of the folder as follows (in this case, archiving folders are
5440 handled as if @code{elmo-archive-treat-file} were non-nil).
5443 @item If the folder type is localdir:
5444 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5446 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5447 (@file{~/Mail/ml/wl-00100.zip}).
5449 @item The folder type is other than localdir:
5450 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5452 For example, @samp{%#mh/ml/wl} corresponds to
5453 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5456 As you can see, in the case of localdir, the folder type is not included
5457 in the path name, but otherwise it is included.
5458 And you can control the prefix to the archiving folder name by
5459 @code{wl-expire-archive-folder-prefix}.
5460 Refer to @code{wl-expire-archive-folder-prefix} for details.
5462 @item wl-expire-archive-number2
5463 re-files every certain number of messages to archiving folders.
5465 This differs from @samp{wl-expire-archive-number1} in that this re-files
5466 to the folder up to the specified number regardless of message numbers.
5467 The archiving folders to which messages are re-filed are determined in the
5468 same way as @code{wl-expire-archive-number1}.
5470 @item wl-expire-archive-date
5471 re-files messages depending on its date (year and month) to archive
5474 For example, a message dated December 1998 is re-filed to
5475 @code{$folder-199812;zip}. The name of the archiving folders except the
5476 date part are determined in the same way as
5477 @code{wl-expire-archive-number1}.
5480 You can set the first argument to these three standard functions to non-nil
5481 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5482 For example, it can be specified just after the name of the function:
5485 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5488 If you omit the argument, consecutive numbers from 1 are assigned for
5489 each archiving folder.
5491 @item wl-expire-localdir-date
5492 divedes messages depending on its date (year and month) to MH folders
5493 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5497 @subsection Treatment for Important or Unread Messages
5499 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5500 standard function, messages with marks in
5501 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5502 messages} thereafter) are retained.
5504 Per default, this variable include the important, new, and unread marks,
5505 so that messages with these marks are not removed.
5506 Note that you cannot include the temporary mark (i.e. temporary marks
5507 are removed anyway), and be sure to process temporary marks before you
5510 @subsection Auto Expiration
5512 The following setup invokes expiration when you move into the summary
5513 mode. There will be no confirmation, so make sure you made no mistake
5514 in regexp and other settings before you set up this.
5518 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5522 In the folder mode, you can invoke expiration per group as well as per
5523 folder. Therefore, if you specify @samp{Desktop} group, all folders
5524 matching @code{wl-expire-alist} expire.
5528 @subsection Treating archive folders.
5529 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5530 you must set non-nil value to @code{elmo-archive-treat-file}.
5532 @subsection Confirming
5534 If you are to use @code{remove}, try @code{trash} at first and see
5535 messages move to @code{wl-trash-folder} as expected, then replace it
5536 with @code{remove}. It would be dangerous to use @code{remove} from the
5539 If you are to use @code{wl-expire-archive-number1} and the like, try to
5540 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5541 you can append messages to it. Even if settings in
5542 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5543 would not be saved anywhere and disappeared in case the archiver program
5546 After you make sure you can archive to the folder correctly, you can
5547 invoke expiration and utilize the log.
5549 If you set @code{wl-expire-use-log} to @code{t},
5550 @file{~/.elmo/expired-log} should contain the log, for example:
5554 delete +ml/wl (593 594 595 596 597 598 599)
5555 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5559 The first column indicates the operation, i.e. @samp{delete},
5560 @samp{copy}, or @samp{move}. The next is the name of the folder that
5561 expired. In the case of @samp{copy} and @samp{move}, the destination
5562 folder is recorded after @samp{->}. The last is the list of message
5563 numbers that are actually deleted or moved (in the case of @samp{copy}
5564 and @samp{move}, the number is the one in the source folder, rather than
5565 the destination folder).
5567 @subsection Re-filing Reserved Messages
5569 The three standard functions copy reserved messages to the archive
5570 folder, but do not delete them from the source folder. Because
5571 reserved messages and the like always remain, they are recorded in
5572 @file{~/.elmo/expired-alist} so that they are not copied over and over
5573 again. They are not recorded if copied by @code{wl-summary-archive}.
5575 If you enabled logging, usually @samp{move} is recorded for re-filing,
5576 but instead @samp{copy} and @samp{delete} are recorded separately if
5577 reserved messages are involved. This is because it actually copies
5578 messages including reserved, then deletes ones except reserved in that
5581 @section Customizable Variables
5584 @item wl-expire-alist
5585 @vindex wl-expire-alist
5586 The initial setting is @code{nil}.
5587 This variable specifies folders and methods to expire. For details,
5588 refer to @code{wl-expire-alist} settings above.
5590 @item wl-summary-expire-reserve-marks
5591 @vindex wl-summary-expire-reserve-marks
5592 The initial setting is the list below.
5596 (list wl-summary-important-mark
5598 wl-summary-unread-mark
5599 wl-summary-unread-uncached-mark
5600 wl-summary-unread-cached-mark)
5604 Messages with these marks are retained in the folder, even after
5606 Only permanent marks can be listed, not temporary marks.
5608 You can list marks one by one as in the default; you can use the
5609 following settings as well:
5613 All messages with permanent marks are retained,
5614 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5618 All messages are handled as usual ones that are already read, no matter
5619 what marks they have; even important messages are deleted.
5622 @item wl-expire-archive-files
5623 @vindex wl-expire-archive-files
5624 The initial setting is 100.
5625 This variable specifies the number of messages to be retained in one
5628 @item wl-expire-number-with-reserve-marks
5629 @vindex wl-expire-number-with-reserve-marks
5630 The initial setting is @code{nil}.
5631 If non-nil, if expiring messages are specified by @code{number},
5632 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5634 @item wl-expire-archive-get-folder-function
5635 @vindex wl-expire-archive-get-folder-function
5636 The initial setting is @code{wl-expire-archive-get-folder}.
5638 This variable specifies a function that returns the name of an archiving
5639 folder for standard functions in the place of @var{destination}.
5640 You can use the following three variables for simple modification of
5641 folder names; if you want more complex settings, define your own
5642 function in this variable.
5644 @code{wl-expire-archive-get-folder} can be customized by these
5647 @item @code{wl-expire-archive-folder-name-fmt}
5648 @item @code{wl-expire-archive-folder-type}
5649 @item @code{wl-expire-archive-folder-prefix}
5652 @item wl-expire-archive-folder-name-fmt
5653 @vindex wl-expire-archive-folder-name-fmt
5654 The initial setting is @samp{%s-%%05d;%s}.
5655 This is a @code{format} string for archiving folders used in
5656 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5657 Note that you must specify the message number by @samp{%%d}, because it
5658 is parsed twice by @code{format}.
5660 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5663 @item wl-expire-archive-date-folder-name-fmt
5664 @vindex wl-expire-archive-date-folder-name-fmt
5665 The initial setting is @samp{%s-%%04d%%02d;%s}.
5666 This is a @code{format} string for archiving folders used in
5667 @code{wl-expire-archive-date}. Note that you must specify the message
5668 number by @samp{%%d}, because it is parsed twice by @code{format}.
5669 There should be @samp{%%d} twice, one for the year and the other for the
5672 If you modify this, adjust
5673 @code{wl-expire-archive-date-folder-num-regexp} as well.
5675 @item wl-expire-archive-folder-type
5676 @vindex wl-expire-archive-folder-type
5677 The initial setting is @code{zip}.
5678 This variable specifies an archiver type of the archiving folders.
5680 @item wl-expire-archive-folder-prefix
5681 @vindex wl-expire-archive-folder-prefix
5682 The initial setting is @code{nil}.
5683 This variable specifies the prefix (directory structure) to archiving
5685 Exercise extreme caution in using this feature, as it has not been
5687 In the worst case, there is a fear of destructing archiving folders.
5691 There will be no prefix.
5694 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5695 @samp{$ml/wl-00000;zip;wl}.
5698 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5701 @samp{$ml/wl-00000;zip;ml/wl}.
5704 @item wl-expire-archive-folder-num-regexp
5705 @vindex wl-expire-archive-folder-num-regexp
5706 The initial setting is @samp{-\\([-0-9]+\\);}.
5707 This variable specifies the regular expression to be used for getting
5708 message numbers from multiple archiving folders specified by
5709 @code{elmo-list-folders}.
5710 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5712 @item wl-expire-archive-date-folder-num-regexp
5713 @vindex wl-expire-archive-date-folder-num-regexp
5714 The initial setting is @samp{-\\([-0-9]+\\);}.
5715 This is the regular expression to be used for getting message numbers
5716 from multiple archiving folders specified by @code{elmo-list-folders}.
5717 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5719 @item wl-expire-delete-oldmsg-confirm
5720 @vindex wl-expire-delete-oldmsg-confirm
5721 The initial setting is @code{t}.
5722 If non-nil, messages older than the one with the largest number will be
5723 deleted with confirmation.
5724 If @code{nil}, they are deleted without confirmation.
5726 This feature is valid only if non-nil is specified as a argument to the
5727 standard functions so as to retain numbers.
5729 @item wl-expire-use-log
5730 @vindex wl-expire-use-log
5731 The initial setting is @code{nil}.
5732 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5733 They are appended but not truncated or rotated automatically; you might
5734 need to remove it manually.
5736 @item wl-expire-add-seen-list
5737 @vindex wl-expire-add-seen-list
5738 The initial setting is @code{t}.
5740 If non-nil, when messages are re-filed by expiration, read/unread
5741 information is passed to the destination folder.
5743 However if you do not read the destination folder from Wanderlust,
5744 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5745 want to set this to @code{nil} if you are simply saving to some
5746 archiving folders. Even if its value is @code{nil}, messages in the
5747 archiving folders are simply treated as unread; it does not affect
5750 @item wl-expire-folder-update-msgdb
5751 @vindex wl-expire-folder-update-msgdb
5752 The initial setting is @code{t}.
5753 If @code{t}, in the folder mode, expiration is carried out after
5754 updating summary information. If you specified a list of regular
5755 expressions of folder names, summary information is updated for matching
5760 @node Archive, , Expire, Expire and Archive
5761 @section Archiving Messages
5763 @subsection Archiving Messages
5764 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5765 folders. If there are the archiving folders already, only new messages
5768 You can use @code{wl-archive-alist} in order to specify how messages are
5769 archived according to their folder names, as in @code{wl-expire-alist}.
5774 (setq wl-archive-alist
5775 '(("^\\+tmp$" wl-archive-date)
5776 ("^\\+outbox$" wl-archive-number2)
5777 (".*" wl-archive-number1)))
5781 Each item in the list has the following format:
5784 (@var{folders-regexp} @var{deleting-function})
5787 As you can see, you can only use a function after @var{folders-regexp}.
5788 Per default, there are three functions:
5791 @item @code{wl-archive-number1}
5792 @item @code{wl-archive-number2}
5793 @item @code{wl-archive-date}
5796 As inferred from their names, they work similarly to "expire" versions,
5797 other than the following points:
5800 @item No messages are deleted
5801 @item Message numbers are retained even if invoked without arguments
5804 These functions are good to archive all messages in a folder by their
5805 numbers or by their dates.
5806 These are also useful for backup or confirmation purposes before
5808 If you try to re-file them after they are archived, they are deleted but
5811 Per default, the archiving folders to which messages are copied are
5812 determined automatically by @code{wl-expire-archive-get-folder-function}.
5813 You can copy to a specific folder by invoking with a prefix argument,
5814 i.e. @kbd{C-u M-x wl-summary-archive}.
5816 Note that this feature has not been seriously tested, because you can
5817 simply copy to an archiving folder, for example by
5818 @code{wl-summary-copy-region}.
5820 The archiving folders are determined by the same logic as in
5821 @code{wl-summary-expire}; the following customizable variables are
5825 @item @code{wl-expire-archive-files}
5826 @item @code{wl-expire-archive-get-folder-function}
5827 @item @code{wl-expire-archive-folder-name-fmt}
5828 @item @code{wl-expire-archive-folder-type}
5829 @item @code{wl-expire-archive-folder-prefix}
5830 @item @code{wl-expire-archive-folder-num-regexp}
5833 @subsection Customizable Variables
5836 @item wl-archive-alist
5837 @vindex wl-archive-alist
5838 The initial setting is the list shown below:
5842 ((".*" wl-archive-number1))
5847 This variable specifies a function that copies to archiving folders.
5848 To the function, three arguments are passed: a folder name, a list of
5849 messages in the folder, and msgdb information of the summary.
5850 Needless to say, you can use your own function.
5854 @node Scoring, Split messages, Expire and Archive, Top
5855 @chapter Score of the Messages
5857 @c @cindex Kill File
5859 Scoring is the function that associates a score (value) with each
5860 message, and marks as read or deletes from the summary according to it.
5862 You can put target or important marks on essential messages, or read marks
5863 on the ones you do not want to read, for example spam articles.
5865 This scoring function has a capability and a format similar to the one
5866 that Gnus has, although there are some unsupported features and
5867 Wanderlust specifics.
5868 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5871 * Score Commands:: Score Commands
5872 * Score File Format:: Score File Format
5876 @node Score Commands, Score File Format, Scoring, Scoring
5877 @section Score Commands
5878 @cindex Score Commands
5880 @subsection Score File Specification
5882 @code{wl-score-folder-alist} specifies score files or variables in which
5883 scores are defined, corresponding to folder names.
5887 (setq wl-score-folder-alist
5896 If paths to the score files are omitted, the directory specified in the
5897 variable @code{wl-score-files-directory} is assumed.
5899 No matter what you write in @code{wl-score-folder-alist}, the default
5900 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5901 read (it does not have to exist).
5902 Therefore, in the example above, the three score files,
5903 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5904 the folders that matches @samp{^-.*}.
5906 @subsection Scored Messages
5908 Scores are attached to the messages that are specified by
5909 @code{wl-summary-score-marks} temporarily when the summary is updated;
5910 when you exit from the summary, the scores are removed and reverts to
5913 @subsection Creation of Score Files
5915 In the summary buffer, move to an appropriate message and type @kbd{L}.
5916 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5917 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5919 This makes @minus{}1000 are scored for messages with the same
5920 @samp{Subject:} as the string you entered. That is, such a score file
5921 is created automatically.
5923 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5924 The score file you just made appears.
5925 This buffer is called @dfn{score editing buffer} thereafter.
5926 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5927 as you are previously; type @kbd{a}. Then a score entry for "From"
5929 In this way, you can create a score file easily either in the summary
5930 buffer or in the score editing buffer.
5932 By the way, you might be aware the numbers of key strokes are different
5933 between @kbd{s s p} and @kbd{a}.
5934 This is determined by @code{wl-score-header-default-entry}.
5935 This variable specifies the default score entries corresponding to
5937 For example, for "subject" field, a type and a time limit are prompted,
5938 but for "from" field, they are fixed upon automatically as substring and
5939 permanent respectively.
5940 However, score values can be modified by the prefix argument.
5941 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5944 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5945 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5946 erasing contents of the buffer deletes the score file being edited.
5950 @subsubsection Selecting Score Files
5952 You can change score files to which scores are appended by
5953 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5954 @code{wl-score-change-score-file}.
5956 @subsubsection Summing Up the Score
5958 If you add the same entries by @code{wl-summary-increase-score},
5959 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5960 scores for the entry is summed up.
5962 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5963 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5964 @minus{}1200 will be created as a result.
5966 @subsubsection Creating Thread Key
5968 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5969 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5971 @subsubsection Creating Followup Key
5973 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5974 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5975 at the cursor to @samp{References} key.
5976 If @code{wl-score-auto-make-followup-entry} is non-nil,
5977 @samp{Message-ID} of all messages to be followed up within dates
5978 specified by @code{wl-score-expiry-days}.
5980 @subsection Key Bindings
5985 @findex wl-summary-increase-score
5986 Increases the score for the current message.
5987 And the score entry is appended to the score file at the same moment.
5988 You can specify the score value by a prefix argument.
5992 @findex wl-summary-lower-score
5993 Decreases the score for the current message.
5994 And the score entry is appended to the score file at the same moment.
5995 You can specify the score value by a prefix argument.
5998 @kindex h R (Summary)
5999 @findex wl-summary-rescore
6000 Re-applies the scoring.
6001 However, already scored messages are not scored anew.
6004 @kindex h c (Summary)
6005 @findex wl-score-change-score-file
6006 Changes the score file currently selected.
6009 @kindex h e (Summary)
6010 @findex wl-score-edit-current-scores
6011 Edits the score file currently selected.
6012 If there are multiple score files, the previously specified one is
6016 @kindex h f (Summary)
6017 @findex wl-score-edit-file
6018 Edits an arbitrary score file and selects it.
6021 @kindex h F (Summary)
6022 @findex wl-score-flush-cache
6023 Erases caches associated to the score files that are read.
6024 If you modified score files directly (from other than Wanderlust), you
6025 need to re-read them after erasing the cache.
6028 @kindex h m (Summary)
6029 @findex wl-score-set-mark-below
6030 Specifies the criterion for scores to be marked as read.
6031 Messages with scores less than this value are marked as read.
6034 @kindex h x (Summary)
6035 @findex wl-score-set-expunge-below
6036 Specifies the criterion for scores to be deleted from the summary.
6037 Messages with scores less than this value are deleted.
6038 "Deleted" means it is not shown; they are not removed from the summary
6039 information or the folder.
6040 The deleted messages can be shown by rescan-noscore again.
6043 @subsection Key Bindings in the Score Editing Buffer
6047 @kindex C-c C-k (Score Mode)
6048 @findex wl-score-edit-kill
6049 Abandons the file being edited.
6052 @kindex C-c C-c (Score Mode)
6053 @findex wl-score-edit-exit
6054 Saves the file being edited, and quits from the edit mode.
6057 @kindex C-c C-p (Score Mode)
6058 @findex wl-score-pretty-print
6062 @kindex C-c C-d (Score Mode)
6063 @findex wl-score-edit-insert-date
6064 Inserts the number of dates from Dec. 31, 1 B.C.
6065 It is used for creating the third factor of time-limited scores.
6068 @kindex C-c C-s (Score Mode)
6069 @findex wl-score-edit-insert-header
6070 Inserts the header of the message selected in the summary buffer.
6073 @kindex C-c C-e (Score Mode)
6074 @findex wl-score-edit-insert-entry
6075 Inserts the score entry of the message selected in the summary buffer.
6078 @subsection Customizable Variables
6081 @item wl-summary-default-score
6082 @vindex wl-summary-default-score
6083 The initial setting is 0 (zero).
6084 This variable specifies the default value of the score.
6085 The score is increased or decreased based upon this value.
6087 @item wl-summary-important-above
6088 @vindex wl-summary-important-above
6089 The initial setting is @code{nil}.
6090 Messages with scores larger than this value are attached with the
6091 important mark (@samp{$}).
6092 If @code{nil}, no important marks are attached.
6094 @item wl-summary-target-above
6095 @vindex wl-summary-target-above
6096 The initial setting is @code{nil}.
6097 Messages with scores larger than this value are attached with the target
6099 If @code{nil}, no target marks are attached.
6101 @item wl-summary-mark-below
6102 @vindex wl-summary-mark-below
6103 The initial setting is 0 (zero).
6104 Messages with scores smaller than this value are marked as read.
6106 @item wl-summary-expunge-below
6107 @vindex wl-summary-expunge-below
6108 The initial setting is @code{nil}.
6109 Messages with scores smaller than this value are deleted from the
6111 If @code{nil}, they are not deleted.
6113 @item wl-summary-score-marks
6114 @vindex wl-summary-score-marks
6115 The initial setting is the list shown below:
6119 (list wl-summary-new-mark)
6124 Messages with these marks are scored.
6126 @item wl-use-scoring
6127 @vindex wl-use-scoring
6128 The initial setting is t.
6129 If non-nil, scoring is enabled.
6131 @item wl-score-files-directory
6132 @vindex wl-score-files-directory
6133 The initial setting is @file{~/.elmo/}.
6134 The default directory for score files.
6136 @item wl-score-interactive-default-score
6137 @vindex wl-score-interactive-default-score
6138 The initial setting is 1000.
6139 This value is used as a score when a score factor is @code{nil} in the
6140 score file. It is also used in @code{wl-summary-increase-score} and
6141 @code{wl-summary-lower-score}, on condition that the value of
6142 @code{wl-score-header-default-entry} is @code{nil}.
6144 @item wl-score-expiry-days
6145 @vindex wl-score-expiry-days
6146 The initial setting is 7.
6147 This is the number of days before time-limited scores are deleted.
6149 @item wl-score-update-entry-dates
6150 @vindex wl-score-update-entry-dates
6151 The initial setting is @code{t}.
6152 If non-nil, it enables deletion of time-limited scores.
6154 @item wl-score-header-default-entry
6155 @vindex wl-score-header-default-entry
6156 Specifies the default value for each header field for score entries
6157 created by @code{wl-summary-increase-score},
6158 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6160 @item wl-score-simplify-fuzzy-regexp
6161 @vindex wl-score-simplify-fuzzy-regexp
6162 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6163 regular expression to be deleted from the string.
6164 Because this is usually used for Subject, the default is prefixes that
6165 are attached by mailing list programs.
6167 @item wl-summary-rescore-partial-threshold
6168 @vindex wl-summary-rescore-partial-threshold
6169 The initial setting is 200.
6170 When sync-all or rescan is executed, if there are messages more than
6171 this value, only the last same number of messages as this value are
6174 @item wl-summary-auto-sync-marks
6175 @vindex wl-summary-auto-sync-marks
6176 If non-nil, unread/important marks are synchronized when the summary
6178 Unread marks reflect information on the IMAP4 server.
6179 Important marks reflect information on the IMAP4 server (flagged or
6180 not), and contents of @samp{'mark} folder.
6181 The initial setting is @code{t}.
6185 @node Score File Format, , Score Commands, Scoring
6186 @section Score File Format
6187 @cindex Score File Format
6189 The format of score files are the same as Gnus, and basically you can
6190 use Gnus score files as they are. But they are not fully compatible
6191 because some keys are not supported and there are Wanderlust specifics.
6192 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6197 ("for sale" -1000 nil s)
6198 ("profit" -1000 nil s))
6200 ("spam@@spamspamspam" -10000 nil s))
6202 ("my@@address" 3001 nil s))
6204 (1000000 -10 nil >))
6214 If the key is a string, it is the name of the header to be matched.
6215 The following keys are available:
6216 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6217 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6218 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6219 @code{Chars} and @code{Lines} mean the size and the number of lines of
6220 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6221 are described later.
6222 The rest corresponds the field of the same name.
6224 Arbitrary numbers of core entries are specified after the key.
6225 Each score entry consists of these five factors:
6229 A factor that matches header. This should be a number in the cases of
6230 @code{lines} and @code{chars}, otherwise a string.
6233 A score factor. When the first item matches, the score of the message
6234 is increased or decreased by this value.
6237 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6238 of a number, the score is deleted if it does not match for days
6239 (@code{wl-score-expiry-days}) from the date specified by this.
6240 The date is since Dec. 31, 1 B.C.
6243 A type factor. This specifies the way the first factor matches.
6244 Available types depend on keys.
6247 @item From, Subject, References, Message-ID
6248 For these keys in string, @code{r} and @code{R} (regexp),
6249 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6250 as well as @code{f} and @code{F} (fuzzy) can be used.
6251 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6254 For these keys, the following five numerical relative operators can be
6255 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6258 This key matches @code{From} header, and scores all follow-ups to the
6260 For example, it would be useful for increasing scores for follow-ups to
6263 You can use the same types as @code{From} except for @code{f}.
6264 And a @samp{Followup} entry is automatically appended to the score file.
6267 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6268 A @samp{Thread} entry is automatically appended for each article that
6269 has @var{x} in the @code{References} header.
6270 You can make sure the whole thread including messages that does not have
6271 all ancestors @code{Message-ID} in @code{References} is scored.
6273 You can use the same types as @code{References} except for @code{f}.
6274 And a @samp{Thread} entry is automatically appended to the score file.
6278 A factor for extension header. This is meaningful only if the key is
6280 This specifies headers to be matched other than standard headers like
6281 @code{Subject} and @code{From}.
6282 Note that you should specify the header in
6283 @code{elmo-msgdb-extra-fields} also.
6284 Therefore it does not work in folders where extension headers cannot be
6289 The sum of these scores @emph{after all factors are applied} becomes the
6290 score of the message.
6292 @cindex Score File Atoms
6294 Messages with a score less than this value is marked as read.
6295 The default is @code{wl-summary-mark-below}.
6298 Messages with a score less than this value is deleted from the summary.
6299 The default is @code{wl-summary-expunge-below}.
6301 @item mark-and-expunge
6302 Both @code{mark} and @code{expunge} are applied,
6303 i.e. messages with a score less than this value is marked as read and
6304 deleted from the summary.
6307 Messages with a score greater than this value is attached with temp
6309 The default is @code{wl-summary-target-above}.
6312 Messages with a score greater than this value is attached with important
6314 The default is @code{wl-summary-important-above}.
6319 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6320 are used, you need to set @code{elmo-msgdb-extra-fields}.
6323 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6326 There are other restrictions as shown below:
6329 @item Because @samp{References} field in the summary information
6330 contains only the last @samp{Message-ID}, @code{references} key matches
6334 Keys that can be seen by folder of types:
6338 chars lines xref extra
6339 localdir,localnews Y E E E
6340 nntp (supporting xover) Y E E N
6346 N: cannot be seen (ignored)
6347 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6352 @node Split messages, Address Book, Scoring, Top
6353 @chapter Message splitting
6354 @cindex Split messages
6356 You can use @code{elmo-split} to split message in folder
6357 @code{elmo-split-folder} a la @command{procmail} according to some
6358 specified rules. To use this feature, set as follows in your
6359 @file{~/.emacs} at first.
6362 (autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
6365 Then you can invoke @kbd{M-x elmo-split} to split messages according to
6366 @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
6367 to do a rehearsal (do not split actually).
6369 We will describe how to specify the rule. First of all, see following
6374 (setq elmo-split-rule
6375 ;; @r{Store messages from spammers into @samp{+junk}}
6376 '(((or (address-equal from "i.am@@spammer")
6377 (address-equal from "dull-work@@dull-boy")
6378 (address-equal from "death-march@@software")
6379 (address-equal from "ares@@aon.at")
6380 (address-equal from "get-money@@richman"))
6382 ;; @r{Store messages from mule mailing list into @samp{%mule}}
6383 ((equal x-ml-name "mule") "%mule")
6384 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
6385 ;; @r{and continue evaluating following rules}
6386 ((equal x-ml-name "wanderlust") "%wanderlust" continue)
6387 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
6388 ((match from "\\(.*\\)@@yahoo\\.com")
6390 ;; @r{Store unmatched mails into @samp{+inbox}}
6395 The basic unit of the rule is a combination like
6398 (@samp{CONDITION} @samp{ACTION} [@code{continue}])
6401 If @samp{CONDITION} is true, @samp{ACTION} is performed.
6402 The 1st element @samp{CONDITION} is a condition represented by a
6403 balanced expression (sexp). Its grammar will be explained below.
6404 The 2nd element @samp{ACTION} is the name of the folder to split
6405 messages into, or a symbol. When the 3rd element @code{continue} is
6406 specified as symbol, evaluating rules is not stopped even when the
6407 condition is satisfied.
6409 The grammar for @samp{CONDITION} is as follows. See example above to
6410 learn how to write the condition practically.
6414 Functions which accept argument @samp{FIELD-NAME} and @samp{VALUE}.
6415 (@samp{FIELD-NAME} is a symbol that describes the field name)
6419 True if the field value equals to @samp{VALUE}.
6420 Case of the letters are ignored.
6422 True if the field value matches to VALUE.
6423 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6424 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6425 @item @code{address-equal}
6426 True if one of the addresses in the field equals to
6427 @samp{VALUE}. Case of the letters are ignored.
6428 @item @code{address-match}
6429 True if one of the addresses in the field matches to
6431 @samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
6432 from matching @code{\(\)} patterns in the previous @samp{VALUE}.
6436 Functions which accept any number of arguments.
6440 True if one of the argument returns true.
6442 True if all of the arguments return true.
6448 When a symbol is specified, it is evaluated.
6451 You can specify followings as 2nd @samp{ACTION}.
6457 If some string is specified, it will be regarded as the destination
6458 folder, and the message will be appended to it.
6463 If the symbol @samp{delete} is specified, delete the substance of the
6464 message in @code{elmo-split-folder}
6469 If the symbol @samp{noop} is specified, do nothing on the message and
6475 If some function is specified, execute it.
6478 If the message passes all rules, it will be dealed along @samp{ACTION}
6479 specified by @code{elmo-split-default-action}.
6482 @node Address Book, Customization, Split messages, Top
6483 @chapter Address Book
6484 @cindex Address Book
6486 With address book, you can utilize address completion, and you have
6487 summary displayed with nicknames.
6490 * Mail Addresses:: Definition of Address Book
6491 * Address Manager:: Address Manager
6494 @node Mail Addresses, Address Manager, Address Book, Address Book
6495 @section Address book
6496 @cindex Address book Definition
6498 @cindex Alias, Address
6500 The file @file{~/.addresses} is a simple address book for Wanderlust.
6501 Make address file @file{~/.addresses}, and edit to suit your requirement.
6503 The data written in @file{~/.addresses} are used for address completion
6504 under draft editing mode. Furthermore, they are used when showing names
6505 in summary display mode. You can safely skip this section, if you don't
6506 want to customize address completion and summary display.
6507 It is possible to add/change/remove addresses from @file{~/.addresses} in
6508 summary buffer after Wanderlust is invoked. @refill
6510 The format is very simple. Like this. @refill
6515 # @r{Lines begin with @samp{#} are comment.}
6516 # @r{Empty lines are ignored}
6518 # @r{Format of each line:}
6519 # @var{email-address} "@var{nickname} "@var{realname}"
6521 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6522 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6523 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6528 One line defines one persons description.
6530 Actually, in default setup, @var{nickname} is used in summary-mode and
6531 @var{realname} is used in draft preparation mode. This behavior is
6532 better understood if you try it and confirmed the function first. You
6533 can write and try a small definition, so you will know the idea of the
6534 address book before writing a big one.
6536 And, if MH alias file is specified in variable @code{wl-alias-file},
6537 it is used as an address information in the draft preparation mode.
6539 If variable @code{wl-use-ldap} is non-nil (initial setting is
6540 @code{nil}), address completion in draft mode uses LDAP information.
6542 If you use LDAP, you have to set @code{wl-ldap-server},
6543 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6544 not have LDAP feature as built-in feature (Currently only XEmacs can
6545 have built-in LDAP feature), you have to set command exec @env{PATH} to
6546 the program @command{ldapsearch}.
6549 @node Address Manager, , Mail Addresses, Address Book
6550 @section Address Manager
6551 @cindex Address Manager
6553 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6554 the address book and insert address to draft buffer.
6556 @subsection Key Bindings
6560 @kindex t (Address Manager)
6561 @findex wl-addrmgr-set-to
6562 Add @samp{To:} mark.
6565 @kindex c (Address Manager)
6566 @findex wl-addrmgr-set-cc
6567 Add @samp{Cc:} mark.
6570 @kindex b (Address Manager)
6571 @findex wl-addrmgr-set-bcc
6572 Add @samp{Bcc:} mark.
6575 @kindex u (Address Manager)
6576 @findex wl-addrmgr-unmark
6580 @kindex x (Address Manager)
6581 @findex wl-addrmgr-apply
6583 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6584 buffer and quit address manager. When no draft buffer, make new draft
6585 with insert marked addresses.
6587 If no mark, quit address manager.
6591 @kindex q (Address Manager)
6592 @findex wl-addrmgr-quit
6593 Quit address manager.
6596 @kindex a (Address Manager)
6597 @findex wl-addrmgr-add
6601 @kindex d (Address Manager)
6602 @findex wl-addrmgr-delete
6606 @kindex e (Address Manager)
6607 @findex wl-addrmgr-edit
6612 @node Customization, Terminology, Address Book, Top
6613 @chapter Customizing Wanderlust
6614 @cindex Customization
6617 * Living with other packages:: Cooperating with other packages
6618 * Highlights:: Highlights
6619 * Biff:: Notify Mail arrival
6620 * Advanced Settings:: Advanced Settings
6621 * Customizable Variables:: Customizable Variables
6626 @node Living with other packages, Highlights, Customization, Customization
6627 @section Living with other packages
6629 Examples with other packages.
6632 * imput:: imput (im-wl.el)
6633 * BBDB:: The Insidious Big Brother Database
6634 * LSDB:: The Lovely Sister Database
6635 * supercite:: supercite.el
6636 * mu-cite:: mu-cite.el
6637 * X-Face:: x-face,bitmap-mule
6638 * dired-dd:: dired-dd.el
6640 * Addrbook:: Addrbook
6641 * mime-w3m:: mime-w3m.el
6645 @node imput, BBDB, Living with other packages, Living with other packages
6650 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6653 If @command{imput} is on the @code{exec-path} at the installation,
6654 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6658 (autoload 'wl-draft-send-with-imput-async "im-wl")
6659 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6664 @node BBDB, LSDB, imput, Living with other packages
6668 To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
6669 with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
6670 and do the following settings.
6672 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6673 byte-compiled and installed.
6681 ;; @r{enable pop-ups}
6682 (setq bbdb-use-pop-up t)
6683 ;; @r{auto collection}
6684 (setq bbdb/mail-auto-create-p t)
6685 ;; @r{exceptional folders against auto collection}
6686 (setq bbdb-wl-ignore-folder-regexp "^@@")
6687 (setq signature-use-bbdb t)
6688 (setq bbdb-north-american-phone-numbers-p nil)
6689 ;; @r{shows the name of bbdb in the summary} :-)
6690 (setq wl-summary-from-function 'bbdb-wl-from-func)
6691 ;; @r{automatically add mailing list fields}
6692 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6693 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6697 You can complete address with BBDB by @kbd{M-@key{TAB}}
6701 @node LSDB, supercite, BBDB, Living with other packages
6705 The following is an example setting to use
6706 The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
6713 (add-hook 'wl-draft-mode-hook
6715 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
6719 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
6720 (complete address with LSDB).
6723 @node supercite, mu-cite, LSDB, Living with other packages
6724 @subsection sc.el(supercite), sc-register.el
6728 The same setting as usual mailers should be OK. The following is an
6729 example of settings:
6733 (autoload 'sc-cite-original "supercite" nil t)
6734 (add-hook 'mail-citation-hook 'sc-cite-original)
6739 @node mu-cite, X-Face, supercite, Living with other packages
6740 @subsection mu-cite.el
6743 The same setting as usual mailers should be OK. The following is an
6744 example of settings.
6746 If you use mu-cite version 8.0 or earlier:
6750 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6751 (setq mail-citation-hook 'mu-cite/cite-original)
6755 If you use mu-cite version 8.1 or later:
6759 (autoload 'mu-cite-original "mu-cite" nil t)
6760 (add-hook 'mail-citation-hook (function mu-cite-original))
6764 @node X-Face, dired-dd, mu-cite, Living with other packages
6768 If you have installed one of the following, you can decode
6769 @samp{X-Face:} field in message buffer and you will see face image.
6772 * x-face-xmas:: XEmacs case
6773 * x-face-mule:: Emacs case
6776 If there is an encoded X-Face string in a file @file{~/.xface} (the
6777 value of the variable @code{wl-x-face-file}), it is inserted as a
6778 @samp{X-Face:} field in the draft buffer (if
6779 @code{wl-auto-insert-x-face} is non-nil).
6781 @node x-face-xmas, x-face-mule, X-Face, X-Face
6782 @subsubsection x-face-xmas (for XEmacs)
6785 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6786 1.3.6.13 or later, do the following:
6790 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6791 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6795 @node x-face-mule, , x-face-xmas, X-Face
6796 @subsubsection x-face-mule (for Emacs)
6800 If you use @file{x-face-mule.el} in bitmap-mule
6801 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6805 (autoload 'x-face-decode-message-header "x-face-mule")
6806 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6810 @subsubsection x-face-e21 (for Emacs 21.x)
6813 With Emacs 21.x, you can use @file{x-face-e21.el}
6814 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6815 to display X-Face. In this case, bitmap-mule is not required.
6820 (autoload 'x-face-decode-message-header "x-face-e21")
6821 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6826 @node dired-dd, MHC, X-Face, Living with other packages
6827 @subsection dired-dd(Dired-DragDrop)
6828 @pindex Dired-DragDrop
6830 @cindex Drag and Drop
6832 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6833 compose multi-part by simple Drag-and-Drop from dired to the draft
6834 buffer being edited in GNU Emacs (this feature is not Wanderlust
6835 specific, but general-purpose for SEMI).
6839 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6845 ;; @r{Set dired-x variables here.}
6846 ;; @r{To and flo@dots{}}
6848 (progn (require 'dired-dd)
6849 (require 'dired-dd-mime))))))
6853 @node MHC, Addrbook, dired-dd, Living with other packages
6857 Message Harmonized Calendaring system
6858 (@uref{http://www.quickhack.net/mhc/})
6860 By using MHC, you can make a calendar from the messages.
6866 (setq mhc-mailer-package 'wl)
6867 (autoload 'mhc-mode "mhc" nil t)
6868 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6869 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6877 (autoload 'mhc-wl-setup "mhc-wl")
6878 (add-hook 'wl-init-hook 'mhc-wl-setup)
6882 @node Addrbook, mime-w3m, MHC, Living with other packages
6883 @subsection wl-addrbook.el
6887 (@uref{http://www.mew.org/})
6889 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6890 @code{load-path} and do the following settings.
6894 (require 'wl-addrbook)
6899 @node mime-w3m, , Addrbook, Living with other packages
6900 @subsection mime-w3m.el
6903 You can display html part by using @file{mime-w3m.el}
6904 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6905 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6908 @node Highlights, Biff, Living with other packages, Customization
6911 @subsection Customizable Variables
6914 @item wl-summary-highlight
6915 @vindex wl-summary-highlight
6916 The initial setting is @code{t}.
6917 If non-nil, the summary is highlighted.
6919 @item wl-highlight-max-summary-lines
6920 @vindex wl-highlight-max-summary-lines
6921 The initial setting is 10000.
6922 The summary is not highlighted if it has more lines than this value.
6924 @item wl-summary-highlight-partial-threshold
6925 @vindex wl-summary-highlight-partial-threshold
6926 The initial setting is 1000.
6927 This is a threshold whether the whole summary is highlighted.
6928 If there are more lines of messages in the summary, it is partially
6931 @item wl-summary-partial-highlight-above-lines
6932 @vindex wl-summary-partial-highlight-above-lines
6933 The initial setting is 30. If there are more lines of messages than
6934 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6935 after the point that is the same number of lines as this value above the
6936 cursor line are highlighted partially. (If this value is @code{nil},
6937 the last same number of lines as the value of
6938 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6940 @item wl-highlight-body-too
6941 @vindex wl-highlight-body-too
6942 The initial setting is @code{t}.
6943 If non-nil, bodies of drafts and messages are also highlighted.
6945 @item wl-highlight-message-header-alist
6946 @vindex wl-highlight-message-header-alist
6947 When highlighting headers of drafts and messages, this variable
6948 specifies which faces are allocated to important
6949 (@code{wl-highlight-message-important-header-contents}), secondly
6950 important (@code{wl-highlight-message-important-header-contents2}), and
6951 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6953 Similarly, it can be used for allocating arbitrary faces to arbitrary
6954 regular expressions.
6956 @item wl-highlight-citation-prefix-regexp
6957 @vindex wl-highlight-citation-prefix-regexp
6958 Specifies a regular expression to which quoted lines in bodies of
6959 drafts and messages match.
6960 Bodies matching to this regular expression are highlighted by the faces
6961 specified by (@code{wl-highlight-message-cited-text-*}).
6963 @item wl-highlight-highlight-citation-too
6964 @vindex wl-highlight-highlight-citation-too
6965 The initial setting is @code{nil}.
6966 If non-nil, the quoting regular expression itself given by
6967 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6969 @item wl-highlight-citation-header-regexp
6970 @vindex wl-highlight-citation-header-regexp
6971 Specifies a regular expression that denotes beginning of quotation.
6972 Bodies matching to this regular expression are highlighted by the face
6973 specified by @code{wl-highlight-message-headers}.
6975 @item wl-highlight-max-header-size
6976 @vindex wl-highlight-max-header-size
6977 The initial setting is @code{nil}. If a header size is larger than this
6978 value, it will not be highlighted. If @code{nil}, always highlighted
6979 (ignore header size).
6981 @item wl-highlight-max-message-size
6982 @vindex wl-highlight-max-message-size
6983 The initial setting is 10000.
6984 If a message is larger than this value, it will not be highlighted.
6985 With this variable, highlight is suppressed for uuencode or huge digest
6988 @item wl-highlight-signature-separator
6989 @vindex wl-highlight-signature-separator
6990 Specifies regular expressions that denotes the boundary of a signature.
6991 It can be a regular expression, or a list of ones.
6992 Messages after the place that matches this regular expression are
6993 highlighted by the face specified by
6994 @code{wl-highlight-message-signature}.
6996 @item wl-max-signature-size
6997 @vindex wl-max-signature-size
6998 The initial setting is 400.
6999 This is the largest size for a signature to be highlighted.
7001 @item wl-use-highlight-mouse-line
7002 @vindex wl-use-highlight-mouse-line
7003 The initial setting is @code{t}.
7004 If non-nil, the line pointed by the mouse is highlighted in the folder
7005 mode, summary mode, and the like.
7008 @subsection Setting Colors and Fonts of the Characters
7010 If you want to change colors or fonts of the characters, you need to
7011 modify faces defined in Wanderlust. Use @code{set-face-font} if you
7012 want to change fonts, and @code{set-face-foreground} for colors, and so
7013 on. You cannot write face settings in @file{.emacs}; write in
7016 For example, if you want to change the color for signatures to yellow,
7020 (set-face-foreground 'wl-highlight-message-signature "yellow")
7026 Faces defined in Wanderlust:
7029 @item wl-highlight-message-headers
7030 The face for field names of message headers.
7032 @item wl-highlight-message-header-contents
7033 The face for field bodies of message headers.
7035 @item wl-highlight-message-important-header-contents
7036 The face for important parts of message headers.
7037 Per default, this face is used for a body of @samp{Subject:} field.
7038 You can change its value by editing
7039 @code{wl-highlight-message-header-alist}.
7041 @item wl-highlight-message-important-header-contents2
7042 The face for secondly important parts of message headers.
7043 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
7044 fields. You can change its value by editing
7045 @code{wl-highlight-message-header-alist}.
7047 @item wl-highlight-message-unimportant-header-contents
7048 The face for unimportant parts of message headers.
7049 Per default, this face is used for bodies of @samp{X-} fields
7050 @samp{User-Agent:} fields. You can change its value by editing
7051 @code{wl-highlight-message-header-alist}.
7053 @item wl-highlight-message-citation-header
7054 The face for headers of quoted messages.
7056 @item wl-highlight-message-cited-text-*
7057 The face for texts of quoted messages. The last @samp{*} is a
7058 @var{single figure} so that 10 different colors can be used according to
7061 @item wl-highlight-message-signature
7062 The face for signatures of messages. The initial settings are
7063 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
7064 dark background colors.
7066 @item wl-highlight-header-separator-face
7067 The face for header separators of draft messages.
7069 @item wl-highlight-summary-important-face
7070 The face for message lines with important marks in the summary.
7072 @item wl-highlight-summary-new-face
7073 The face for message lines with new marks in the summary.
7075 @item wl-highlight-summary-displaying-face
7076 The face for the message line that is currently displayed.
7077 This face is overlaid.
7079 @item wl-highlight-thread-indent-face
7080 The face for the threads that is currently displayed.
7082 @item wl-highlight-summary-unread-face
7083 The face for message lines with unread marks in the summary.
7085 @item wl-highlight-summary-deleted-face
7086 The face for message lines with delete marks in the summary.
7088 @item wl-highlight-summary-refiled-face
7089 The face for message lines with re-file marks in the summary.
7091 @item wl-highlight-refile-destination-face
7092 The face for re-file information part of message lines with re-file
7093 marks in the summary.
7095 @item wl-highlight-summary-copied-face
7096 The face for message lines with copy marks in the summary.
7098 @item wl-highlight-summary-target-face
7099 The face for message lines with target marks @samp{*} in the summary.
7101 @item wl-highlight-summary-thread-top-face
7102 The face for message lines that are on the top of the thread in the
7105 @item wl-highlight-summary-normal-face
7106 The face for message lines that are not on top of the thread in the
7109 @item wl-highlight-folder-unknown-face
7110 The face for folders that are not known to have how many unsync messages
7113 @item wl-highlight-folder-zero-face
7114 The face for folders that have no unsync messages in the folder mode.
7116 @item wl-highlight-folder-few-face
7117 The face for folders that have some unsync messages in the folder mode.
7119 @item wl-highlight-folder-many-face
7120 The face for folders that have many unsync messages in the folder mode.
7121 The boundary between `some' and `many' is specified by the variable
7122 @code{wl-folder-many-unsync-threshold}.
7124 @item wl-highlight-folder-unread-face
7125 The face for folders that have no unsync but unread messages in the
7128 @item wl-highlight-folder-killed-face
7129 The face for folders that are deleted from the access group in the
7132 @item wl-highlight-folder-opened-face
7133 The face for open groups in the folder mode.
7134 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7135 @code{nil} or a @var{number}.
7137 @item wl-highlight-folder-closed-face
7138 The face for close groups in the folder mode.
7139 It is meaningful when @code{wl-highlight-folder-by-numbers} is
7140 @code{nil} or a @var{number}.
7142 @item wl-highlight-folder-path-face
7143 The face for the path to the currently selected folder in the folder
7146 @item wl-highlight-logo-face
7147 The face for logo in the demo.
7149 @item wl-highlight-demo-face
7150 The face for strings (for example, a version number) in the demo.
7154 @node Biff, Advanced Settings, Highlights, Customization
7155 @section Notify Mail arrival
7158 Following setting is to notify mail arrival of @samp{%inbox}
7159 by the indicator on the modeline
7162 (setq wl-biff-check-folder-list '("%inbox"))
7165 @subsection Customizable Variables
7167 @item wl-biff-check-folder-list
7168 @vindex wl-biff-check-folder-list
7169 The initial setting is @code{nil}.
7170 This is the list of folders to check mail arrival.
7171 If @code{nil}, wl doesn't check mail arrival.
7173 @item wl-biff-check-interval
7174 @vindex wl-biff-check-interval
7175 The initial setting is 40 (in seconds).
7176 Check mail arrival in this period.
7178 @item wl-biff-notify-hook
7179 @vindex wl-biff-notify-hook
7180 This hook is run at the arrival of new mail.
7181 To beep with mail arrival(initial setting), set as follows.
7183 (setq wl-biff-notify-hook '(ding))
7185 For silence, set to @code{nil}.
7189 @node Advanced Settings, Customizable Variables, Biff, Customization
7190 @section Advanced Settings
7193 * Draft for Reply:: Draft for Reply
7194 * Thread Format:: Appearance of Thread
7195 * User-Agent Field:: @samp{User-Agent:} Header Field
7199 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7200 @subsection Draft for Replay
7201 @vindex wl-draft-reply-with-argument-list
7202 @vindex wl-draft-reply-without-argument-list
7203 @vindex wl-draft-reply-myself-with-argument-list
7204 @vindex wl-draft-reply-myself-without-argument-list
7206 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7207 The addressee for the draft is decided by following rules.
7209 For example, you can set as follows:
7213 (setq wl-draft-reply-without-argument-list
7214 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7215 ("Followup-To" . (nil nil ("Followup-To")))
7216 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7217 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7221 Where each element of the list @code{wl-draft-reply-without-argument-list}
7225 (key . (to-list cc-list newsgroup-list))
7228 and if the field designated by @samp{key} exist in the parent message,
7229 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7230 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7231 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7232 the draft respectively.
7237 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7240 Match if the parent has @samp{Mail-Followup-To} field.
7241 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7242 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7246 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7249 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7250 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7253 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7256 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7257 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7260 These are evaluated in order and first matched one is used.
7262 Moreover, the behavior of @kbd{a} with prefix argument can
7263 be directed by @code{wl-draft-reply-with-argument-list} as well.
7265 By the way, you can use some function (will be evaluated in the parent
7266 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7267 For example, if you only want to reply to mailing lists in
7268 @code{wl-subscribed-mailing-list} if the parent has some of them,
7273 (defun wl-mailing-list-addresses ()
7277 (nth 1 (std11-extract-address-components addr)))
7280 (elmo-multiple-fields-body-list (list "To" "Cc"))
7282 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
7283 (setq list-addrs (cons to list-addrs))))
7284 (nreverse list-addrs)))
7286 (setq wl-draft-reply-with-argument-list
7287 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
7288 ("Reply-To" . (("Reply-To") nil nil))
7289 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
7290 ("From" . (("From") nil nil))))
7295 Note: To set the behavior when you reply to the message written by yourself,
7296 use @code{wl-draft-reply-myself-without-argument-list} and
7297 @code{wl-draft-reply-myself-with-argument-list} instead of them.
7299 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
7300 @subsection Appearance of Threads
7304 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
7305 390 09/18(Fri)07:25 +-[ Tsumura-san ]
7306 391 09/18(Fri)19:24 +-[ Murata-san ]
7307 392 09/20(Sun)21:49 +-[ Okunishi-san ]
7308 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
7309 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
7310 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
7311 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
7312 412 09/22(Tue)09:28 | +-[ Teranishi ]
7313 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
7314 416 09/22(Tue)12:38 | +-[ Teranishi ]
7315 395 09/20(Sun)21:49 +-[ Okunishi-san ]
7316 397 09/21(Mon)00:15 +-[ Okunishi-san ]
7320 Settings to make appearance of threads like shown above:
7324 (setq wl-thread-indent-level 2)
7325 (setq wl-thread-have-younger-brother-str "+")
7326 (setq wl-thread-youngest-child-str "+")
7327 (setq wl-thread-vertical-str "|")
7328 (setq wl-thread-horizontal-str "-")
7329 (setq wl-thread-space-str " ")
7333 If you do not want to see branches, do the following:
7337 (setq wl-thread-indent-level 2)
7338 (setq wl-thread-have-younger-brother-str " ")
7339 (setq wl-thread-youngest-child-str " ")
7340 (setq wl-thread-vertical-str " ")
7341 (setq wl-thread-horizontal-str " ")
7342 (setq wl-thread-space-str " ")
7347 @node User-Agent Field, , Thread Format, Advanced Settings
7348 @subsection User-Agent Field
7352 If you are eccentric enough to elaborate @samp{X-Mailer:} or
7353 @samp{User-Agent:} fields, define a function that generate appropriate
7354 strings as you like, and set it to variable
7355 @code{wl-generate-mailer-string-function}.
7357 If you do not want verbose @samp{User-Agent:} field, do the following:
7361 (setq wl-generate-mailer-string-function
7362 'wl-generate-user-agent-string-1)
7366 The following is a example:
7370 (setq wl-generate-mailer-string-function nil)
7371 (setq wl-draft-additional-header-alist
7373 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7378 @node Customizable Variables, Hooks, Advanced Settings, Customization
7379 @section Customizable Variables
7381 Customizable variables that have not been described yet:
7384 @item wl-default-folder
7385 @vindex wl-default-folder
7386 The initial setting is @samp{%inbox}. This is the default value for moving to
7387 a folder and the like.
7389 @item wl-draft-folder
7390 @vindex wl-draft-folder
7391 The initial setting is @samp{+draft}. It is the folder to which drafts are
7392 saved. It must be a localdir folder.
7394 @item wl-trash-folder
7395 @vindex wl-trash-folder
7396 The initial setting is @samp{+trash}. It is the wastebasket folder.
7397 If you changed this variable, you had better restart Wanderlust.
7399 @item wl-interactive-exit
7400 @vindex wl-interactive-exit
7401 The initial setting is @code{t}.
7402 If non-nil, you are asked for confirmation when Wanderlust terminates.
7404 @item wl-interactive-send
7405 @vindex wl-interactive-send
7406 The initial setting is @code{t}.
7407 If non-nil, you are asked for confirmation when mail is sent.
7409 @item wl-folder-sync-range-alist
7410 @vindex wl-folder-sync-range-alist
7411 The initial setting is the alist shown below:
7416 ("^\\+draft$\\|^\\+queue$" . "all"))
7421 This is an associative list of regular expressions of folder names and
7422 update range of the summary. Update range is one of the @samp{all},
7423 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
7424 @samp{last}. If a folder do not match, @samp{update} is used.
7427 @vindex wl-ask-range
7428 The initial setting is @code{t}.
7429 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7430 for updating the summary when you changed folders.
7432 @item wl-mime-charset
7433 @vindex wl-mime-charset
7434 The initial setting is @code{x-ctext}.
7435 This is the MIME charset for messages that are not MIME (e.g. without
7436 @samp{Content-Type:}). This value also used as default charset for
7437 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7438 this value as @code{iso-2022-jp}.)
7440 @item wl-highlight-folder-with-icon
7441 @vindex wl-highlight-folder-with-icon
7442 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7443 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7445 @item wl-strict-diff-folders
7446 @vindex wl-strict-diff-folders
7447 This is a list of regular expressions of folders.
7448 Unread messages are checked, for example when you press @kbd{s} in
7449 the folder mode, usually in a brief way (rapidly processed but not
7451 The folders matching this variable are seriously checked.
7452 You may want to set this variable so as to match conditional filter
7453 folders for IMAP4 folders.
7454 The initial setting is @code{nil}.
7456 @item wl-folder-use-server-diff
7457 @vindex wl-folder-use-server-diff
7458 When unread messages are checked, for example when you press @kbd{s} in
7459 the folder mode, usually (the number of messages on the server) @minus{}
7460 (the number of local messages) will be the number of unread messages.
7461 However, if this variable is non-nil, the number of unread messages on
7462 the server is checked. This affects IMAP4 folders only, but IMAP4
7463 folders in mail boxes matching
7464 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7465 the number of unread messages on the server, even if they matches this
7466 variable. The initial setting is @code{t}.
7468 @item wl-auto-check-folder-name
7469 @vindex wl-auto-check-folder-name
7470 The initial setting is @code{nil}.
7471 You can specify a folder or a group which is checked for unread message
7472 at the start. You can also specify a list of folders (groups) to be checked.
7473 If the value is @code{nil}, whole Desktop is checked at the start.
7474 If it is @code{none}, no folders are checked.
7476 @item wl-auto-uncheck-folder-list
7477 @vindex wl-auto-uncheck-folder-list
7478 The initial setting is the list shown below:
7487 You can set a list of regular expressions to specify folders
7488 which are not automatically checked even if they are included
7489 in some groups assigned by @code{wl-auto-check-folder-name}.
7491 @item wl-auto-check-folder-list
7492 @vindex wl-auto-check-folder-list
7493 The initial setting is @code{nil}.
7494 You can set a list of regular expressions to specify exceptions
7495 for @code{wl-auto-uncheck-folder-list}.
7497 @item wl-no-save-folder-list
7498 @vindex wl-no-save-folder-list
7499 The initial setting is the list shown below:
7508 This is a list of regular expressions of folders not to be saved.
7510 @item wl-save-folder-list
7511 @vindex wl-save-folder-list
7512 The initial setting is @code{nil}.
7513 This is a list of regular expressions of folders to be saved.
7514 This takes precedence over @code{wl-no-save-folder-list}.
7516 @item wl-folder-mime-charset-alist
7517 @vindex wl-folder-mime-charset-alist
7518 The initial setting is the alist shown below:
7522 (("^-alt\\.chinese" . big5)
7523 ("^-relcom\\." . koi8-r)
7525 ("^-han\\." . euc-kr))
7530 This is an associative list of regular expressions of folder names and
7532 If a folder do not match, @code{wl-mime-charset} is used.
7534 @item wl-folder-init-load-access-folders
7535 @vindex wl-folder-init-load-access-folders
7536 The initial setting is @code{nil}.
7537 This is a list of access groups to be loaded specifically at the start.
7538 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7540 @item wl-folder-init-no-load-access-folders
7541 @vindex wl-folder-init-no-load-access-folders
7542 The initial setting is @code{nil}.
7543 This is a list of access groups not to be loaded specifically at the
7545 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7547 @item wl-delete-folder-alist
7548 @vindex wl-delete-folder-alist
7549 The initial setting is the alist shown below:
7558 This list determines disposition of messages with delete marks.
7559 Each item in the list is a folder and destination; you can specify any
7560 one of the following in the place of destination:
7563 @code{remove} or @code{null} : deletes the messages instantly.
7564 string : moves the messages to the specific folder.
7565 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7568 @item wl-refile-policy-alist
7569 @vindex wl-refile-policy-alist
7570 The initial setting is the list shown below:
7580 This list determines whether messages with re-file marks are moved or
7581 copied. Each item in the list is a cons cell of a folder and
7582 @code{copy} or @code{move}.
7584 @item wl-x-face-file
7585 @vindex wl-x-face-file
7586 The initial setting is @file{~/.xface}.
7587 The name of the file that contains encoded X-Face strings.
7590 @item wl-demo-display-logo
7591 @vindex wl-demo-display-logo
7592 If non-nil, bitmap image is shown on the opening demo. If you set
7593 @code{xpm} or @code{xbm}, (if possible) display selected image type
7596 @item elmo-use-database
7597 @vindex elmo-use-database
7598 This is meaningful for XEmacs only. The initial setting depends on
7599 XEmacs (@code{t} for XEmacs with dbm).
7600 If non-nil, Message-ID is controlled by dbm.
7602 @item elmo-passwd-alist-file-name
7603 @vindex elmo-passwd-alist-file-name
7604 The initial setting is @file{passwd}.
7605 This is the name of the file in which passwords are saved.
7606 @code{elmo-passwd-alist-save} saves current passwords to the file.
7608 @item elmo-nntp-list-folders-use-cache
7609 @vindex elmo-nntp-list-folders-use-cache
7610 The initial setting is 600 (in seconds).
7611 This is period in seconds during which results of @samp{list} and
7612 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7615 @item elmo-nntp-max-number-precedes-list-active
7616 @vindex elmo-nntp-max-number-precedes-list-active
7617 The initial setting is @code{nil}.
7618 If non-nil, the number of article obtained by @samp{list active} in NNTP
7619 are used as the maximum article number of the folder.
7620 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7621 and if the number of read messages is not correct.
7623 @item elmo-nntp-default-use-listgroup
7624 @vindex elmo-nntp-default-use-listgroup
7625 The initial setting is @code{t}.
7626 If non-nil, @samp{listgroup} is used for checking the total number of
7627 articles. If it is @code{nil}, @samp{group} is used. In the latter
7628 case, the processing will be a little faster at the sacrifice of
7631 @item elmo-pop3-send-command-synchronously
7632 @vindex elmo-pop3-send-command-synchronously
7633 The initial setting is @code{nil}.
7634 If non-nil, POP3 commands are issued synchronously. Some implementation
7635 of POP3 server fails to get summary information without this setting.
7636 You may have to set this variable to @code{t}, if the process hangs
7637 while looking up POP3.
7639 @item elmo-dop-flush-confirm
7640 @vindex elmo-dop-flush-confirm
7641 The initial setting is @code{t}.
7642 If non-nil, you are asked for confirmation if accumulated off-line
7643 operations are executed.
7645 @item elmo-display-progress-threshold
7646 @vindex elmo-display-progress-threshold
7647 The initial setting is 20.
7648 Threshold for display of progress gauge. If number of renewal is more than
7649 this value, display progress gauge.
7653 @node Hooks, , Customizable Variables, Customization
7658 @node Terminology, Mailing List, Customization, Top
7659 @chapter Terminology around Wanderlust
7662 Here we explain terminologies used in this manual.
7666 A container in which messages are stored.
7669 A set consists of some folders.
7672 A special group consists of automatically collected folders under
7673 some specified path.
7674 @xref{Folder Definition}.
7676 @item summary buffer
7677 A buffer for displaying list of messages in some folder.
7679 @item sticky summary
7680 Compared with ordinary summary buffer which will be destroyed after
7681 exiting from it, this type of summary will be remain even after exiting
7682 by @kbd{q} or @kbd{g}.
7683 @xref{Sticky Summary}.
7686 To delete or put into the archive expired messages.
7693 To cache messages beforehand in order to read messages after you will be
7694 disconnected from the server.
7698 @node Mailing List, Addition, Terminology, Top
7699 @chapter Wanderlust Mailing List
7703 Topics related to Wanderlust are discussed in following mailing lists.
7704 The latest version is also announced there.
7707 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7710 In this list Japanese is mainly used for discussion. We also have a list
7711 for discussion in English:
7714 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7716 (Messages posted to this list are also forwarded to the former one.)
7718 A guide can be obtained automatically by sending mail to
7719 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7720 the English one) with the body
7726 Please send bug reports or patches to one of those lists. You can post to
7727 the mailing list even though you are not a member of it.
7729 If you send a bug report, please attach Backtrace with it.
7730 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7733 I would like to express my thanks to the members of the mailing list for
7734 valuable advice and many pieces of code they contributed.
7737 @node Addition, Index, Mailing List, Top
7738 @chapter Additional Information
7740 @section Brief History
7743 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7744 3/10 Made a msgdb mechanism by elisp.
7745 3/26 IMAP and NNTP can be displayed in threads.
7746 4/13 Began to assemble thread display modules as elmo.
7747 5/01 Finished 0.1.0, initial version with many defects.
7748 6/12 I made a slip of the tongue and said I was writing elisp
7749 mailer supporting IMAP
7750 6/16 0.1.3 was announced at tm-ja, elisp ML.
7751 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7752 7/01 Support for mm-backend (0.3.0).
7753 8/25 multi folder added (0.5.0).
7754 8/28 filter folder added (0.5.1).
7755 9/10 You can open/close threads (0.6.0).
7756 9/11 fldmgr by Murata-san made editing folders easy.
7757 9/18 lha folders added by Okunishi-san (0.6.3).
7758 9/24 Display of branches of threads (0.6.5).
7759 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7760 10/28 Off-line operations (0.7.4).
7761 12/09 Becomes beta version.
7762 12/21 wl-expire by Murata-san.
7763 1999 2/03 auto-refile by Tsumura-san.
7764 4/28 wl-template by Murata-san.
7765 5/18 Released 1.0.0 stable.
7766 7/05 Scoring by Murata-san (2.1.0).
7767 9/26 New plugged system by Murata-san (2.2.2).
7768 12/20 Support Modified UTF7.
7769 2000 3/24 Released 1.1.0 stable.
7770 4/03 CVS development started.
7771 5/07 Thread restoration & Its speed up with Murata-san.
7772 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7773 7/11 killed message feature.
7774 7/18 Use UIDL in POP3.
7775 9/12 biff feature with Satata-san & Yamaoka-san.
7776 10/17 expire-hide by Okada-san.
7777 11/08 Released 2.4.0 stable.
7778 2001 7/04 Released 2.6.0 stable.
7779 8/21 wl-addrmgr by Kitamoto-san.
7780 12/27 Released 2.8.1 stable.
7783 See @file{ChangeLog} for details.
7787 According to a dictionary, Wanderlust has the meaning:
7791 n eager longing for or impulse towards travelling in distant lands
7792 [Ger, fr wandern to wander + lust desire, pleasure]
7796 but I had no profound intention. (if farfetched, IMAP @result{} you can
7797 read mail anywhere @result{} desire to wander ?)
7799 Elmo is the abbreviation of @samp{Elisp Library for Message
7800 Orchestration}. At first I meant the red puppet in the Sesame Street,
7801 but you may associate it with Wandering @result{} Drifting @result{}
7802 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7806 Each versions has code names (they are almost jokes).
7807 Currently they are picked up alphabetically from the top 40 hits of
7808 U.S. Billboard magazines in 1980s.
7810 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7813 @node Index, , Addition, Top
7817 * Concept Index:: Concept Index
7818 * Key Index:: Key Index
7819 * Variable Index:: Variable Index
7820 * Function Index:: Function Index
7823 @node Concept Index, Key Index, Index, Index
7824 @unnumberedsec Concept Index
7827 @node Key Index, Variable Index, Concept Index, Index
7828 @unnumberedsec Key Index
7831 @node Variable Index, Function Index, Key Index, Index
7832 @unnumberedsec Variable Index
7835 @node Function Index, , Variable Index, Index
7836 @unnumberedsec Function Index