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 @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 @w{Yuuichi Teranishi},
69 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
70 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
71 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
73 This manual is for Wanderlust version @value{VERSION}.
75 Permission is granted to make and distribute verbatim copies of this
76 manual provided the copyright notice and this permission notice are
77 preserved on all copies.
79 Permission is granted to copy and distribute modified versions of this
80 manual under the conditions for verbatim copying, provided that the
81 entire resulting derived work is distributed under the terms of a
82 permission notice identical to this one.
84 Permission is granted to copy and distribute translations of this manual
85 into another language, under the above conditions for modified versions.
91 @node Top, Introduction, (dir), (dir)
92 @top Wanderlust User's Manual
107 This manual is for Wanderlust @value{VERSION}.
112 * Introduction:: Read this first
113 * Start Me Up:: Invoking Wanderlust
114 * Folders:: How to specify folders
115 * Folder:: Selecting and editing folders
116 * Summary:: Reading and refiling messages
117 * Message:: Saving and playing MIME multipart entities
118 * Draft:: Draft buffer, sending mail and news
119 * Disconnected Operations:: Off-Line management
120 * Expire and Archive:: Automatic expiration and archiving of messages
121 * Scoring:: Score of the messages
122 * Address Book:: Management of Address Book
123 * Customization:: Customizing Wanderlust
124 * Mailing List:: Wanderlust mailing list
125 * Addition:: Additional Information
130 @node Introduction, Start Me Up, Top, Top
131 @chapter Introduction of Wanderlust
134 Wanderlust is an mail/news management system on Emacsen.
135 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
137 The main features of Wanderlust:
140 @item Pure elisp implementation.
141 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
142 @item Unified access method to messages based on Mew-like Folder Specification.
143 @item Mew-like Key-bind and mark handling.
144 @item Manages unread messages.
145 @item Interactive thread display.
146 @item Folder Mode shows the list of subscribed folders.
147 @item Message Cache, Disconnected Operation (Read Only).
148 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
149 @item MIME compliant (by SEMI).
150 @item Transmission of news and mail are unified by Message transmitting draft.
151 @item Graphical list of folders (XEmacs and Emacs 21).
152 @item View a part of message without retrieving the whole message (IMAP4).
153 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
154 @item Virtual Folders.
155 @item Supports compressed folder using common archiving utilities.
156 @item Old articles in folders are automatically removed/archived (Expiration).
157 @item Automatic re-file.
158 @item Template function makes it convenient to send fixed form messages.
164 Wanderlust is supposed to run on following Emacsen:
167 @item Mule 2.3 based on Emacs 19.34
168 @item Emacs 20.2 or later
169 @item XEmacs 20.4 or later
170 @item Meadow 1.00 or later
171 @item NTEmacs 20.4 or later
175 IMAP4 connectivity with following imapd are confirmed to work with
179 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
180 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
181 @item Courier-IMAP 1.3.2 or later
182 @item AIR MAIL (AIRC imapd release 2.00)
184 @item Microsoft Exchange Server 5.5
185 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
188 LDAP connectivity with following LDAPd are confirmed to work with
192 @item OpenLDAP 2.0.6 or later
196 @node Start Me Up, Folders, Introduction, Top
197 @chapter Start up Wanderlust
200 The necessary procedure for starting Wanderlust is explained in steps
203 (Of course, you need a mail/news readable environment in advance)
206 * MIME Modules:: Installing the MIME modules
207 * Download:: Download and extract the packages
208 * Install:: Byte-compile and install
209 * Minimal Settings:: @file{.emacs} setup
210 * Folder Definition:: Folder definition
211 * Start Wanderlust:: Starting Wanderlust
215 @node MIME Modules, Download, Start Me Up, Start Me Up
216 @section Installing MIME modules
222 SEMI must be installed to make Wanderlust work correctly.
224 SEMI can be downloaded from these sites:
228 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
232 You need packages named APEL and FLIM to use SEMI.
233 You can download APEL and FLIM from following URLs:
237 APEL: ftp://ftp.m17n.org/pub/mule/apel/
238 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
242 You have to install APEL, FLIM and SEMI in this order. Generally,
243 @samp{make install} will do the job. (In XEmacs 21, @samp{make
246 Refer to the documents of each package for detailed installation
247 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
248 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
252 Recommended combination of APEL, FLIM and SEMI are following:
255 @item APEL 10.3, FLIM 1.14.3 and SEMI 1.14.3
258 You can also use many other FLIM/SEMI variants. Combination of the
259 latest versions should work. For example, the following combination are
263 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
264 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
267 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
270 @node Download, Install, MIME Modules, Start Me Up
271 @section Download and Extract the Package
274 You can download Wanderlust package from following sites:
278 ftp://ftp.gohome.org/wl/
281 Mirrored ftp/http sites:
285 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
286 http://www.jpl.org/elips/wl/
287 http://www.ring.gr.jp/archives/text/elisp/wl/
288 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
289 ftp://opaopa.org/pub/mirror/elisp/wl/
290 @c ftp://roguelife.org/pub/tsumura/wl/
294 Extract the obtained package to your working directory:
299 % tar zxvf wl-@var{version}.tar.gz
300 % cd wl-@var{version}
304 @subsection To use SSL (Secure Socket Layer)
309 SSL (Secure Socket Layer) can be used for
310 SMTP, IMAP, NNTP and POP connections in Wanderlust.
312 There are two ways to use SSL. One is to start SSL negotiation just
313 after the connection establishment (generic way). The other one is to
314 start SSL negotiation by invoking STARTTLS command in the each session.
316 To use the formal SSL (generic SSL), you must set @env{PATH} to the
317 directory that OpenSSL commands are installed.
319 To use the latter SSL(STARTTLS), you must install starttls package in
321 You can download starttls package from the following site.
324 ftp://opaopa.org/pub/elisp/
327 @node Install, Minimal Settings, Download, Start Me Up
328 @section Byte-compile and install
335 @subsection Installation
337 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
338 Set the Emacs's command name to @code{EMACS}.
339 Set package installation directory to @code{LISPDIR}.
340 Then, please execute following commands.
349 Destination directory is auto-probed if you leave @code{LISPDIR}
350 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
352 If you are using an Emacs variant which does not merge specified directory
353 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
354 then you will see the error message:
357 Cannot open load file: mime-setup
361 In this case, either add destination directories of custom, APEL, FLIM
362 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
363 @code{load-path} in @file{WL-CFG} in extracted directory.
365 If you want to use BBDB, then the necessary modules are byte-compiled
366 and installed when BBDB directory is added to @code{load-path}.
369 @subsection @file{WL-CFG}
371 Contents of the file @file{WL-CFG} is loaded under installation if a file
372 with that name exists in extracted directory. You can use @file{WL-CFG} to
373 configure @code{load-path} to extra packages such as SEMI if needed.
375 If you want to specify the install directory of Wanderlust related
376 files, then set following variables in @file{WL-CFG}
380 A directory to install WL modules.
381 This directory is relative directory from @code{LISPDIR}.
382 WL modules include @file{wl*.el}, @file{wl*.elc} files.
383 @c Modules under the directory @file{util/} are also installed if
384 @c it detected as necessary.
387 A directory to install ELMO modules.
388 This directory is relative directory from @code{LISPDIR}.
389 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
390 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
394 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
396 If you want to install ELMO related files under a sub-directory
397 such as "elmo" then add following to @file{WL-CFG}:
400 (setq ELMO_PREFIX "elmo")
403 @subsection Install as a XEmacs package
404 @cindex XEmacs package
405 @cindex XEmacs package install
406 @cindex Package, XEmacs
407 @cindex Package install, XEmacs
408 @c @cindex install-package
410 It is possible to install Wanderlust as one of packages of XEmacs (21.0
411 or later). Configuration for autoload and icon-path in local
412 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
415 Follow the next example to install Wanderlust as an XEmacs package.
421 % make install-package
425 package directory is auto-probed, if SEMI is installed.
426 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
428 @subsection Run in place
430 If wl and elmo directories are defined in @code{load-path}, then
431 byte-compilation and installation are not necessary to start Wanderlust.
432 For example, if package is extracted in @file{~/work}, Wanderlust can be
433 invoked with following setting in @file{~/.emacs}.
437 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
438 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
444 Manual is described in Info format. Please do following.
453 If you install Wanderlust as a XEmacs package, Info file is already
454 installed too, so there are no need of these commands.
456 Manual directory is automatically detected. Of course, it can be
457 configured by @code{INFODIR} in @file{Makefile}.
459 You can read manual at the following URL:
462 http://www.gohome.org/wl/doc/wl-euc_toc.html
465 @node Minimal Settings, Folder Definition, Install, Start Me Up
466 @section Set up .emacs
467 @cindex Minimal Settings
469 @cindex Configuration
473 The Wanderlust package contains two module groups.
476 @item ELMO (elmo-*.el)
477 These modules show everything as folders. This is the back-end for WL.
479 These modules controls the behavior of main body of Wanderlust.
480 They are also the front-end for ELMO.
483 You can customize the behavior of Wanderlust by changing the value
484 of environmental variables which begins with @code{elmo-} and @code{wl-}.
486 The minimal requirement for settings is as the following.
490 ;; @r{The setting to use SEMI}
491 (require 'mime-setup)
493 ;; @r{autoload configuration}
494 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
495 (autoload 'wl "wl" "Wanderlust" t)
496 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
498 ;; @r{Directory where icons are placed.}
499 ;; @r{Default: the peculiar value to the running version of Emacs.}
500 ;; @r{(This is not required if the default value has been set properly)}
501 (setq wl-icon-directory "~/work/wl/etc")
503 ;; @r{SMTP server for mail posting. Default: @code{nil}}
504 (setq wl-smtp-posting-server "your.smtp.example.com")
505 ;; @r{NNTP server for news posting. Default: @code{nil}}
506 (setq wl-nntp-posting-server "your.nntp.example.com")
510 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
511 file exists). So it is convenient to gather Wanderlust specific settings
512 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
513 because you can't write them in @file{.emacs}
514 (if you write it to @file{.emacs}, you'll get an error).
517 All above described settings except @samp{(require 'mime-setup)} and autoload
518 configuration can be written in
521 @subsection @code{mail-user-agent}
522 @cindex Default Mailer
523 @cindex Mailer, Default
524 @vindex mail-user-agent
527 If you write following setting in you @file{.emacs}, you can
528 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
529 This means it enables you to run Wanderlust as a default mail composer
532 It is effective only when your Emacs can define @code{mail-user-agent}.
533 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
537 (autoload 'wl-user-agent-compose "wl-draft" nil t)
538 (if (boundp 'mail-user-agent)
539 (setq mail-user-agent 'wl-user-agent))
540 (if (fboundp 'define-mail-user-agent)
541 (define-mail-user-agent
543 'wl-user-agent-compose
552 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
553 @section Folder Definition
554 @cindex Folder Definition
557 You can skip this section because it is possible to add/edit the
558 subscribe folders from the buffer for list of folders.
559 @xref{Folder Manager}.
561 Define the folders you want to subscribe in file @file{~/.folders}. The
562 contents written in @file{~/.folders} become the folders which you
563 subscribe to as it is.
565 Format for @file{~/.folders} is very simple. Here is an example:
570 # @r{Lines begin with @samp{#} are comment.}
571 # @r{Empty lines are ignored}
573 # @var{folder name} "@var{folder nickname}"
574 # @r{(nicknames are not necessary)}
579 %#mh/Backup@@my.imap.example.com "Sent"
582 %#mh/spool/wl "Wanderlust ML"
583 %#mh/spool/elips "ELIPS ML"
584 %#mh/spool/apel-ja "APEL Japanese ML"
585 %#mh/spool/xemacs-beta "XEmacs beta"
586 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
587 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
590 # @r{If folder name ends with @samp{/}, that means an `access group',}
591 # @r{all subfolders automatically included in one folder group.}
593 %#mh/expire@@localhost /
594 # @r{All MH folders are included in one folder group.}
599 Each line contains one folder you want to read. The definition of
600 folders will be explained in detail in the next section.
602 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
603 become one folder group. One folder group is treated as a directory
604 which can be opened and closed in folder mode. It is convenient for
605 collecting some folders and putting them in order.
607 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
608 line and you have to write it that way (It is because the parser sucks).
610 There are two types of groups. One is like @samp{Emacsen} from above
611 example which the user chooses his favorite folders as a group.
613 The other one is @dfn{access group} like @samp{+ /} from above example.
614 It makes all the sub-folders in a folder to a group. (It differs from
615 the type of the folder. For example, @samp{+} followed by @samp{/}
616 makes entire MH sub-directories to one group)
618 This behavior is better understood if you try it and confirmed the
619 function first. You can write and try a small folder definition, so you
620 will know the idea of the folder function before writing the real one.
622 @node Start Wanderlust, , Folder Definition, Start Me Up
623 @section Start Wanderlust
624 @cindex Start Wanderlust
626 If installation and configuration worked well, you can invoke Wanderlust by
627 typing following command in Emacs.
634 After initialization, Folder Mode which shows the list of folders will appear.
635 That means the folders you defined in the @file{~/.folders} are listed
636 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
637 can skip folder checking.
639 Basically, you will handle messages in wanderlust while you come and go
640 from/to each of the following buffers.
644 You can see the list of folders. You can select some folder and go into the summary
645 of it. You can subscribe new folder or edit subscription list.
647 You can see the list of messages in the folder. You can select message and view its
648 contents, and reply to some message. You can delete ones or move ones to another
651 You can see the contents of the message. You can save part to disk or open in external
654 You can edit message.
657 Details of each ones are explained later.
660 @node Folders, Folder, Start Me Up, Top
661 @chapter Wanderlust's folders
664 This chapter describes the folder types which Wanderlust is able to handle.
666 Wanderlust uses ELMO as it's interface, so every folder types supported
667 by ELMO is usable in Wanderlust.
669 As of version @value{VERSION}, 11 types of folders are predefined. These are
670 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
671 Pipe and Internal folder types.
674 * IMAP Folder:: @samp{%} -- IMAP folder
675 * NNTP Folder:: @samp{-} -- NNTP folder
676 * MH Folder:: @samp{+} -- MH folder
677 * Maildir Folder:: @samp{.} -- Maildir folder
678 * News Spool Folder:: @samp{=} -- News spool folder
679 * Archive Folder:: @samp{$} -- Archive folder
680 * POP Folder:: @samp{&} -- POP folder
681 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
682 * Namazu Folder:: @samp{[} -- Namazu Folder
683 * Multi Folder:: @samp{*} -- Multi folder
684 * Filter Folder:: @samp{/} -- Filter folder
685 * Pipe Folder:: @samp{|} -- Pipe folder
686 * Internal Folder:: @samp{'} -- Internal folder
690 @node IMAP Folder, NNTP Folder, Folders, Folders
698 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
704 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
708 You can specify @code{login} (encoded password transmission),
709 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
710 authentication) or @code{clear} (or @code{nil}, plain password
711 transmission) as @var{authenticate-type}.
716 @var{username} -> The value of @code{elmo-imap4-default-user}.
717 Initial setting is @env{USER} environment variable or
718 @env{LOGNAME} environment variable or return value of
719 @code{(user-login-name)}.
720 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
721 Initial setting is "auth".
722 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
723 Initial setting is "localhost".
724 @var{port} -> The value of @code{elmo-imap4-default-port}.
725 Initial setting is 143.
728 You can omit the @var{hostname} from folder names if you set
729 @code{elmo-imap4-default-server} as your main IMAP server.
730 For example, you can specify a folder as @samp{foo%imap@@gateway} even
731 if you have to go through a firewall.
735 ;; @r{Example: imap4.exaple.org as main IMAP server}
736 (setq elmo-imap4-default-server "imap4.example.org")
740 SSL (Secure Socket Layer) connection will be used if a folder name ends
741 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
742 is @code{ssl}, SSL will be the default connection. If a folder name
743 ends with @samp{!!}, STARTTLS connection will be established. If the
744 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
745 STARTTLS will be the default connection.
749 ;; @r{Example: Use SSL connection}
750 (setq elmo-imap4-default-stream-type 'ssl)
754 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
755 authentication method, the password is sent in encoded form. But, if
756 your server is unable to receive an encoded password, authentication
757 will fall back to @code{clear} (that is, sending password in raw format)
758 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
759 authentication will fall back to @code{clear} without confirmation
760 (default value is @code{nil}).
764 ;; @r{Example: password in raw format}
765 (setq elmo-imap4-default-authenticate-type 'clear)
773 %inbox -> IMAP mailbox "inbox"
774 %#mh/inbox -> IMAP mailbox "#mh/inbox"
776 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
777 %inbox:hoge/clear@@server1
778 -> server1's IMAP mailbox "inbox"
779 of user "hoge", with plain password authentication
784 @subsection International mailbox names (Modified UTF7)
785 @cindex Modified UTF7
792 You can use international mailbox names in @var{mailbox} part, if you
793 are using Emacs which can treat unicode and
794 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
795 value is @code{nil}).
797 Currently, following Emacsen can treat unicode.
800 @item Emacs 20.3 or later + Mule-UCS
802 If you installed Mule-UCS package, Emacs can treat unicode.
803 You can obtain Mule-UCS package from following URL.
806 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
809 @item XEmacs 21.2.13 or later + ucs-conv package
811 By default, XEmacs 21 cannot treat unicodes, but if you installed
812 ucs-conv package, it can.
813 You can obtain ucs-conv package from following anonymous CVS.
817 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
818 Password: @var{NULL} (Just enter return key)
819 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
823 You also need utf7 conversion programs, @command{u7tou8} and
824 @command{u8tou7} to use international mailbox name in the current
825 XEmacs. These programs are included in the UTF7 package which can be
826 obtained from following URL.
829 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
834 @node NNTP Folder, MH Folder, IMAP Folder, Folders
845 A folder to access USENET news via NNTP protocol (RFC 977).
846 One newsgroup is treated as a folder.
852 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
858 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
859 Initial setting is @samp{localhost}.
860 @var{username} -> The value of @code{elmo-nntp-default-user}.
861 Initial setting is @code{nil}.
862 @var{port} -> The value of @code{elmo-nntp-default-port}.
863 Initial setting is 119.
866 AUTHINFO is used as authentication method if the @var{username} is
867 non-nil. SSL will be default method if
868 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
869 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
870 STARTTLS connection will be established. if the value of
871 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
872 be the default connection.
878 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
879 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
884 @node MH Folder, Maildir Folder, NNTP Folder, Folders
891 A folder to access MH format mail (1 file is 1 mail).
896 @samp{+} @var{directory-name}
899 Normally, @var{directory-name} is an relative path to the variable
900 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
901 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
902 (this is also true for drive-letters).
904 Message number is used for the name of the message file.
910 +inbox -> @file{~/Mail/inbox}
911 +from/teranisi -> @file{~/Mail/from/teranisi}
912 +~/test -> @file{~/test}
917 @node Maildir Folder, News Spool Folder, MH Folder, Folders
918 @section Maildir Folder
920 @cindex Maildir Folder
924 A folder to access Maildir format (1 file is 1 mail).
929 @samp{.} [@var{directory-name}]
932 Normally, @var{directory-name} is a relative path to the variable
933 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
934 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
935 (this is also true for drive-letters).
937 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
938 Messages are contained in the @file{cur} directory. All message files
939 in the @file{new} directory are moved to @file{cur} directory when you
940 access the folder. All message files contained in the @file{tmp}
941 directory and not accessed for 36 hours are deleted.
943 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
949 . -> @file{~/Maildir}
950 .inbox -> @file{~/Maildir/inbox}
951 .from/teranisi -> @file{~/Maildir/from/teranisi}
952 .~/test -> @file{~/test}
957 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
958 @section News Spool Folder
960 @cindex News spool Folder
963 This folder handles locally saved news articles which are proposed by
964 Mew/IM. You can also read articles directly from a spool-file which is
965 retrieved by an utility like @command{gnspool}.
970 @samp{=} @var{directory-name}
973 @var{directory-name} is a sub-directory to the directory defined by
974 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
975 You can use @samp{.} as directory delimiter as well as @samp{/}.
981 =fj/os/os2 -> @file{~/News/fj/os/os2}
982 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
987 @node Archive Folder, POP Folder, News Spool Folder, Folders
988 @section Archive Folder
990 @cindex Archive Folder
993 This method can handle archive files, which are compressed by utilities
994 such as Info-ZIP or LHA, as one folder.
1000 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1004 @var{path-name} is the relative path from
1005 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1006 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1007 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1008 also permitted under the environment of ange-ftp, efs.
1010 The actual file name of the archive folder is
1011 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1012 under the @var{path-name}. If a file named @var{path-name} exists, it is
1013 treated as folder. The suffix is automatically decided for
1014 @var{archiver-type}.
1016 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1017 (Initial setting is @code{zip}) is referred.
1019 @var{prefix} specifies the internal directory structure of the archive.
1020 For example, if the ML server is fml, @file{msend.tar.gz} has a
1021 structure like @file{spool/1}, so you have to specify @samp{spool} as
1028 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1029 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1030 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1031 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1036 * Archiver:: Supported Archivers
1037 * Archive Tips:: TIPS
1038 * Archive Vars:: Customization
1042 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1043 @subsection Supported Archives
1053 By default, following archives are supported.
1057 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1058 GNU TAR('tgz, 'tar) ;; read-only
1062 If your archiver can include multiple files in one archive, you have a
1063 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1064 of the candidate. TAR is supported read-only because it cannot delete
1065 file in the archive (@code{mv})).
1067 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1068 archiver of Wanderlust because they cannot include multiple
1069 files. Archivers that cannot extract files to standard output are also
1072 @subsection OS specific information about archiver.
1074 Behaviors of the following archivers are confirmed by further experiences.
1075 (@samp{*} mark means recommended archiver).
1078 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1079 LHA OS/2 version Rel.2.06b Feb 18, 1998
1080 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1081 *Zip 2.2 (November 3rd 1997).
1082 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1083 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1084 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1086 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1087 LHa for UNIX V 1.14c
1088 UnZip 5.32 of 3 November 1997
1089 Zip 2.2 (November 3rd 1997)
1090 GNU tar 1.12 (1.11.x is no good)
1091 gzip 1.2.4 (18 Aug 93)
1093 [Win32] Win.98/Meadow
1097 GNU tar 1.11.8 + 1.5(WIN32)
1104 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1105 Hiramatsu version of LHA is only supported.
1106 In Win32, LHa32 is only supported (DOS version is no good).
1108 * Caution about GNU tar
1110 You have to take care about GNU tar's version because many version has
1111 problem on deleting file from archive.
1113 Please test @option{--delete} @option{-f} options work. Otherwise, your
1114 archive will be destroyed. No problem is reported on above versions of
1118 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1120 @cindex Archive Tips
1122 For comfortable migration, usage of @code{wl-summary-archive}
1123 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1124 archive folders created by expiration, you must set non-nil value to
1125 @code{elmo-archive-treat-file}.
1127 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1128 in processing speed. For comfortable use, Emacs20 is recommended.
1129 (If re-search's performance is the problem, 19.3x or later may be okay.)
1131 If many files are included in one archive,
1132 it takes long time to access the archive folder because
1133 archiver starting overhead is increased (especially LHA).
1134 150-200 messages in one archive is recommended.
1136 Of course, following is possible @t{:-)}
1137 (meanings of these variables are described later.)
1141 (setq wl-fcc "$backup")
1142 (setq wl-trash-folder "$trash;lha")
1146 @node Archive Vars, , Archive Tips, Archive Folder
1147 @subsection Variables About Archive Folder
1148 @cindex Archive variables
1151 @item elmo-archive-default-type
1152 @vindex elmo-archive-default-type
1153 The initial setting is @code{zip}.
1154 Set archiver type by symbol.
1156 @item elmo-archive-@var{type}-method-alist
1157 @vindex elmo-archive-TYPE-method-alist
1158 Define archiver @var{type}'s methods.
1159 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1160 Each element of the alist is following.
1164 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1165 (@var{action} . @var{function}) ;; function
1169 Currently available actions are following.
1173 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1174 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1181 actions enclosed with braces are optional (They are used for better
1184 @item elmo-archive-suffix-alist
1185 @vindex elmo-archive-suffix-alist
1186 An alist of archiver-type (symbol) and suffix.
1188 @item elmo-archive-file-regexp-alist
1189 @vindex elmo-archive-file-regexp-alist
1190 An alist of a regexp to get file number from list output of archiver
1191 and archiver-type (symbol).
1193 @item elmo-archive-method-list
1194 @vindex elmo-archive-method-list
1195 A list of elmo-archive-@var{type}-method-alist
1196 (@var{type} is a symbol of archiver-type).
1198 @item elmo-archive-lha-dos-compatible
1199 @vindex elmo-archive-lha-dos-compatible
1200 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1201 DOS (Mr. Yoshizaki original) compatible.
1203 @item elmo-archive-cmdstr-max-length
1204 @vindex elmo-archive-cmdstr-max-length
1205 The initial setting is 8000.
1207 Max length of command line argument for external archiver program.
1208 Emacs does not have a limit of command line byte length, but some OS
1209 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1210 this limit because it calls external archiver program directly (not
1211 called via shell). For example, you cannot delete messages if archiver
1212 program must receive larger bytes of arguments to delete. OS/2 have a
1213 command line argument limit of 8190 bytes, so we defined default as 8000
1216 However, you don't have an influence of command line argument limit
1217 if the archiver has `actions' to receive target file information from
1218 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1222 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1230 A folder to access e-mails via POP3 protocol (RFC 1939).
1236 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1241 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1242 as @var{authenticate-type}.
1246 @var{username} -> The value of @code{elmo-pop3-default-user}.
1247 Initial setting is @env{USER} environment variable or
1248 @env{LOGNAME} environment variable or return value of
1249 @code{(user-login-name)}.
1250 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1251 Initial setting is @samp{user}.
1252 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1253 Initial setting is @samp{localhost}.
1254 @var{port} -> The value of @code{elmo-pop3-default-port}.
1255 Initial setting is 110.
1262 &hoge@@localhost -> access localhost as user @samp{hoge}.
1263 &hoge@@popserver:109 -> access the server "popserver" on port 109
1264 as user @samp{hoge}.
1268 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1269 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1270 @file{utils/sasl/lisp/} or Emacs/W3 package
1271 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1274 If the last character of the folder name is @samp{!}, Wanderlust
1275 connects to the POP server via SSL (Secure Socket Layer). If you set
1276 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1277 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1278 with @samp{!!}, STARTTLS connection will be established. if the value
1279 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1283 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1284 @section Shimbun Folder
1286 @cindex Shimbun Folder
1287 @cindex Folder, Shimbun
1292 A folder for watching "shimbun" (means "newspaper" in Japanese),
1293 news site and mailing list archives on WWW by using emacs-w3m
1294 (@uref{http://emacs-w3m.namazu.org/}).
1296 You should possess w3m and emacs-w3m to use this.
1302 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1306 Admissible values of @var{module-name} and @var{folder-name} are
1307 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1313 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1314 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1319 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1320 @section Namazu Folder
1322 @cindex Namazu Folder
1323 @cindex Folder, Namazu
1324 @cindex Folder, Text Search
1327 A folder to access messages found in namazu-index with some condition.
1328 It uses namazu (@uref{http://www.namazu.org/}) for search.
1334 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1338 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1344 [wanderlust] -> search messages matched with
1345 "wanderlust" from the default index
1346 [semi flim]~/Mail/semi -> search "semi flim" from the index
1347 in the directory "~/Mail/semi"
1353 @subsubsection Enter space to separate keywords
1355 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1357 @subsubsection Alias name for index
1359 You can define an alias name for index.
1364 (setq elmo-nmz-index-alias-alist
1365 '(("cache" . "~/.elmo/cache")
1366 ("docs" . "~/documents")))
1369 Above definition defines two index aliases.
1376 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1377 directory @file{~/.elmo/cache}.
1379 @subsubsection Multiple indices
1381 You can specify a list for @code{elmo-nmz-default-index-path} and
1382 @code{elmo-nmz-index-alias-alist}.
1383 When list is specified, all index contained in the list is used as the
1389 (setq elmo-nmz-index-alias-alist
1390 '(("all" . ("~/.elmo/cache" "~/documents"))
1391 ("cache" . "~/.elmo/cache")))
1394 Using above alias setting, you can specify
1400 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1401 directory @file{~/.elmo/cache} and @file{~/documents}.
1403 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1404 @section Multi Folder
1406 @cindex Multi Folder
1407 @cindex Folder, Multiple
1408 @cindex Folder, Marge
1410 A folder to access virtual folder which collects messages from
1417 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1421 After @samp{*} character, specify multiple folders you want to collect
1422 separated by @samp{,} like
1423 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1429 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1430 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1431 treated as one folder.
1433 *+inbox,-fj.rec.tv,%inbox
1434 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1439 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1440 @section Filter Folder
1442 @cindex Filter Folder
1443 @cindex Folder, Filtering
1444 @cindex Folder, Virtual
1445 @cindex Folder, Conditional
1447 A folder to access virtual folder which collects all messages that
1448 satisfy a condition.
1453 @samp{/} @var{condition} @samp{/} @var{target-folder}
1456 In the @var{condition} part, you can specify following.
1460 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1462 first: @var{number} messages are picked from top of folder.
1463 last: @var{number} messages are picked from bottom of folder.
1469 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1470 /first:20/%inbox -> First 20 messages from %inbox are picked.
1475 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1477 since: only messages arrived since @var{date} are picked.
1478 before: only messages arrived before @var{date} are picked.
1480 You can specify following as @var{date}.
1484 yesterday -> a day before today.
1485 lastweek -> same day of last week.
1486 lastmonth -> same day of last month.
1487 lastyear -> same day of last year.
1488 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1489 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1497 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1499 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1505 Field filter: @samp{@var{field}:@var{value}}
1507 All messages that have @var{field} and its value is @var{value} are picked.
1508 @var{field} and @var{value} are case insensitive.
1514 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1515 and its value includes "teranisi" string are picked.
1516 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1524 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1525 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1527 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1528 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1534 /from:teranisi&!to:teranisi/+inbox
1535 -> In +inbox, messages are picked if the message's
1536 From: field includes "teranisi" and
1537 To: field doesn't include "teranisi".
1539 /tocc:"Yuuichi Teranishi"/+inbox
1540 -> In +inbox, messages are picked if the
1541 message's To: field or Cc: field includes
1542 "Yuuichi Teranishi".
1544 /(from:yt|from:teranisi)&subject:report/+inbox
1545 -> In +inbox, messages are picked if the message's
1546 From: field includes "yt" or "teranisi", and
1547 Subject includes "report".
1553 Tip for string description:
1555 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1556 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1557 should be escaped with @samp{\} in it). You can enclose the string with
1558 @samp{"} even it does not contain these characters.
1564 *%inbox,/from:teranisi/%inbox@@server
1565 -> Messages in %inbox or
1566 message is in the %inbox@@server folder and it's From field
1567 includes "teranisi" are collected.
1569 /last:100//to:teranisi/*+inbox,%inbox
1570 -> Latest 100 messages which is in the +inbox or %inbox folder
1571 and To: field matches "teranisi".
1573 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1574 -> Pick messages which have From: field and it includes "hogehoge"
1575 from latest 20 messages in the %#mh/inbox@@localhost
1576 and To: or Cc: field includes "teranisi".
1579 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1580 @section Pipe Folder
1584 @cindex Download Message
1585 @cindex Incorporate Message
1587 In the pipe folder, messages are automatically transferred from the source
1588 folder to destination folder.
1593 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1596 When you access the pipe folder, messages are automatically transferred
1597 from @var{source-folder} to @var{destination-folder}.
1598 It is convenient if you want to download messages to local disk via POP.
1599 For example, if you specify following
1602 |&username@@popserver|+inbox
1606 and access it, messages are downloaded automatically from
1607 @samp{&username@@popserver} to @samp{+inbox}.
1609 On the other hand, if you put @samp{|:} instead of second @samp{|},
1610 then messages are copied to the destination folder (not deleted from
1611 source-folder). At the next time you access that folder, only new
1612 messages will be copied.
1615 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1618 If you want to copy messages from POP server and view them, specify the
1622 |&username@@popserver|:+inbox
1625 where messages will be kept on the server.
1631 |%inbox|%myinbox -> Download %inbox to %myinbox.
1632 |*&user@@popserver1,&user@@popserver2|+inbox
1633 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1634 |-gnu.emacs.sources|:+sources
1635 -> Copy messages from -gnu.emacs.sources to +sources.
1639 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1641 @node Internal Folder, , Pipe Folder, Folders
1642 @section Internal folder
1644 @cindex Internal Folder
1645 @cindex Folder, @samp{$} mark
1647 @c @cindex Folder, Null
1649 A folder to access internal messages of Wanderlust.
1661 A folder named @samp{'mark} is a special virtual folder which collects
1662 messages which have important mark @samp{$}.
1664 You can review important messages at once after you put important marks
1665 on the messages in the different folders.
1667 In this folder, if you delete message, important mark @samp{$} put on
1668 the message is removed. If you append messages to this folder, the
1669 message will have @samp{$} mark.
1671 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1672 folder. If you want IMAP folder's message remove from @samp{'mark}
1673 folder, remove important mark at IMAP Folder.)
1676 A folder named @samp{'sendlog} is a virtual folder which collects
1677 cached messages which are recoded on @file{~/.elmo/sendlog}.
1678 It might be useful when you forgot to add cc for yourself.
1679 To use this, you should set @code{wl-draft-use-cache} to non-nil
1680 so that sent messages are cached.
1683 You can access cached messages fetched via network by accessing
1684 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1685 the name of the subdirectories of the cache directory
1686 (@file{~/.elmo/cache}).
1689 @node Folder, Summary, Folders, Top
1690 @chapter Folder mode
1693 After you start Wanderlust, folder mode is appeared firstly.
1694 It contains folder list you subscribed.
1695 You can select and edit folders in this mode.
1698 * Selecting Folder:: Select folder you want to read
1699 * Folder Manager:: Editing folders
1703 @node Selecting Folder, Folder Manager, Folder, Folder
1704 @section Selecting Folder
1705 @cindex Selecting Folder
1707 @subsection Usage (TIPS)
1709 @subsubsection Check new, unread number
1711 Folder mode looks like this.
1712 (In XEmacs, it looks much nicer @t{;-)})
1716 [-]Desktop:14186/35580/67263
1721 [-]Emacsen:0/34/4837
1722 Wanderlust ML:0/0/558
1725 XEmacs Beta:0/29/255
1736 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1740 @kbd{s} key on the folder line updates these numbers.
1741 It changes its color if it has many new messages.
1743 The whole folder mode is a folder group named @samp{Desktop}.
1744 Folder group open/close by return key.
1745 A operation to a folder group is treated as operations on the
1747 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1748 six children folders update its unread number status.
1750 @subsubsection Select Folder
1752 To enter summary mode of the folder, type return (or space) key on
1754 If the variable @code{wl-stay-folder-window} has non-nil value,
1755 summary window appears on the right of the folder mode window.
1757 @subsection Key bindings
1759 Folder mode's key binding (related to selecting folders) is following.
1764 @kindex @key{SPC} (Folder)
1765 @kindex @key{RET} (Folder)
1766 @findex wl-folder-jump-to-current-entity
1767 Enter to the summary mode of the folder at the current cursor point.
1768 If the cursor is on the top of folder group line,
1769 the folder group is opened or closed.
1770 When the cursor is on the access group and this command is called
1771 with prefix argument, folder children list is updated to the newest one.
1772 (Children list is updated recursively if the access folder has hierarchical
1774 (@code{wl-folder-jump-to-current-entity})
1777 @kindex M-@key{RET} (Folder)
1778 @findex wl-folder-update-recursive-current-entity
1779 Folder children list of the access group at the current cursor point
1780 is updated to the newest one.
1781 (Children list is updated recursively if the access folder has hierarchical
1783 (@code{wl-folder-update-recursive-current-entity})
1788 Create a new draft message.
1793 @findex wl-folder-write-current-folder
1794 If the current cursor point is on the NNTP folder, create a new draft
1795 message which already has @samp{Newsgroups:} field. If the current
1796 cursor point is on the folder for mailing list (refile destination),
1797 create a new draft message which already has @samp{To:} field with
1798 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1800 (@code{wl-folder-write-current-folder})
1803 @kindex C-c C-o (Folder)
1804 @findex wl-jump-to-draft-buffer
1805 Move to the draft buffer if available. If multiple draft buffer exists,
1806 moved to one after another. If prefix argument is specified, load draft
1807 folder's message to the draft buffer and jump to it.
1808 (@code{wl-jump-to-draft-buffer})
1812 @findex wl-folder-check-current-entity
1813 Update new and unread number information of the folder at the current
1815 (@code{wl-folder-check-current-entity})
1819 @findex wl-folder-sync-current-entity
1820 Update summary information of the folder at the current cursor point.
1821 (@code{wl-folder-sync-current-entity})
1824 @kindex r s (Folder)
1825 @findex wl-folder-check-region
1826 Update new and unread number information of the folders in the currently
1828 (@code{wl-folder-check-region})
1831 @kindex r S (Folder)
1832 @findex wl-folder-sync-region
1833 Update summary information of the folders in the currently selected region.
1834 (@code{wl-folder-sync-region})
1838 @findex wl-status-update
1839 Sync up address book status with @file{~/.addresses}'s content.
1840 (@code{wl-status-update})
1844 @findex wl-folder-prev-unread
1845 Jump cursor to the folder which have unread messages on the upward from
1846 current cursor point.
1847 (@code{wl-folder-prev-unread})
1851 Jump cursor to the folder which have unread messages on the downward
1852 from current cursor point.
1853 (@code{wl-folder-next-unread})
1857 Move cursor to the folder on the previous line.
1858 (@code{wl-folder-prev-entity})
1862 Move cursor to the folder on the next line.
1863 (@code{wl-folder-next-entity})
1867 Jump to the folder specified by the user input.
1868 (@code{wl-folder-jump-folder})
1872 @findex wl-folder-prefetch-current-entity
1873 Prefetch new messages of the folder at the current cursor point by
1874 @code{wl-summary-incorporate}.
1875 If the cursor is on the folder group, it is executed recursively.
1876 (@code{wl-folder-prefetch-current-entity})
1880 @findex wl-folder-mark-as-read-all-current-entity
1881 Mark all unread messages of the folder at the current cursor point as read.
1882 If the cursor is on the folder group, it is executed recursively.
1883 (@code{wl-folder-mark-as-read-all-current-entity})
1887 @findex wl-folder-goto-first-unread-folder
1888 Enter summary mode of the first unread folder.
1889 (@code{wl-folder-goto-first-unread-folder})
1893 @findex wl-folder-empty-trash
1895 (@code{wl-folder-empty-trash})
1899 @findex wl-folder-open-all-unread-folder
1900 All unread folder is opened.
1901 (@code{wl-folder-open-all-unread-folder})
1905 @findex wl-folder-open-close
1906 Folder group is opened/closed.
1907 (@code{wl-thread-open-close})
1911 All folder group is opened.
1912 (@code{wl-folder-open-all})
1916 All folder group is closed.
1917 (@code{wl-folder-close-all})
1927 (@code{wl-folder-suspend})
1930 @kindex M-s (Folder)
1931 Save current folder status.
1935 @kindex M-t (Folder)
1936 Toggle Wanderlust's offline/online status.
1937 (@code{wl-toggle-plugged})
1940 @kindex C-t (Folder)
1941 Start Wanderlust's plug-status manager.
1942 (@code{wl-plugged-change})
1945 @subsection Customize variables
1948 @item wl-folders-file
1949 @vindex wl-folders-file
1950 The initial setting is @file{~/.folders}.
1951 Subscribed folders are described (saved) in this file.
1953 @item wl-folder-info-save
1954 @vindex wl-folder-info-save
1955 The initial setting is @code{t}. If non-nil, unread information is
1956 saved and used in the next Wanderlust session.
1958 @item wl-stay-folder-window
1959 @vindex wl-stay-folder-window
1960 The initial setting is @code{nil}.
1961 If non-nil, summary window is appeared on the right side of the folder buffer.
1963 @item wl-folder-window-width
1964 @vindex wl-folder-window-width
1965 The initial setting is 20.
1966 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1968 @item wl-folder-use-frame
1969 @vindex wl-folder-use-frame
1970 The initial setting is @code{nil}.
1971 If non-nil, use new frame for the folder window.
1973 @item wl-folder-many-unsync-threshold
1974 @vindex wl-folder-many-unsync-threshold
1975 The initial setting is 70.
1976 If the number of unread messages is more than this value,
1977 folder color is changed.
1979 @item wl-highlight-folder-by-numbers
1980 @vindex wl-highlight-folder-by-numbers
1981 This option controls how to highlight each line in the folder buffer.
1982 The default value is @code{t}, highlighting with various colors based on
1983 the message numbers. If it is @code{nil}, highlighting with various
1984 colors based on the folder status. In addition, if it is a number
1985 (e.g. 1), highlighting will be done based on both the message numbers
1986 and the folder status.
1988 @item wl-folder-desktop-name
1989 @vindex wl-folder-desktop-name
1990 The initial setting is @samp{Desktop}.
1991 The name of top folder group.
1993 @item wl-folder-petname-alist
1994 @vindex wl-folder-petname-alist
1995 The initial setting is @code{nil}.
1996 An alist of folder's realname and its nickname.
1998 @item wl-folder-access-subscribe-alist
1999 @vindex wl-folder-access-subscribe-alist
2000 The initial setting is @code{nil}.
2002 Control automatic subscribing and unsubscribing of the children list
2008 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2012 If @var{subscribe-flag} is non-nil, folders which have name matched to
2013 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2014 already unsubscribed folder is not displayed even when the
2015 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2022 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2023 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2024 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2025 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2029 @item wl-folder-hierarchy-access-folders
2030 @vindex wl-folder-hierarchy-access-folders
2031 The initial setting is the list shown below:
2040 A list of access groups which creates children folder list hierarchically.
2042 For example, if you specify
2043 @code{wl-folder-hierarchy-access-folders} like following,
2047 (setq wl-folder-hierarchy-access-folders
2048 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
2053 such access group hierarchy is obtained.
2059 -fj.comp.announce:0/0/2
2060 -fj.comp.dev.cdrom:0/0/0
2062 [+]-japan:238/238/1688
2065 -comp.unix.admin:0/0/0
2066 -comp.unix.dos-under-unix:0/0/0
2067 -comp.unix.programmer:0/0/0
2068 [-]-comp.unix.bsd:0/0/23
2069 -comp.unix.bsd.freebsd.announce:0/0/0
2074 If you opened @samp{-} in this example, only the direct children is created
2075 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2076 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2077 is not created until the children access group is opened.
2081 @node Folder Manager, , Selecting Folder, Folder
2082 @section Editing Folders
2083 @cindex Folder Manager
2084 @cindex Folder, Edit
2085 @cindex Folder, Subscribe
2086 @cindex Folder, Unsubscribe
2088 As described before, subscribed folder list is saved in @file{~/.folders} file.
2089 But you don't have to edit @file{~/.folders} directly.
2090 You can append, delete, edit folders from folder mode.
2092 @subsection Usage (Tips)
2094 @subsubsection Append Folder
2096 @kbd{m a} appends new folder to the folder mode.
2097 @kbd{m g} appends new folder group.
2098 To append new folder to this group, firstly open it,
2099 then execute append command in the next line.
2101 @subsubsection Edit Folder
2103 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2104 Thus, you can change folder position as if you were editing a normal file.
2106 @subsubsection Create Multi Folder.
2110 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2112 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2114 Type @kbd{m m}, then you can create multi folder.
2117 @subsubsection Delete Nickname, Filter
2119 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2120 minibuffer while appending.
2122 @subsubsection Append Folder to Empty Group
2124 To append new folder to the empty folder group
2125 (after you create folder group by typing @kbd{m g}),
2126 firstly open it, then execute append command in the next line.
2127 If it is closed, folder is appended on the same level with
2128 the above folder group. It is difficult to explain by words so try it.
2129 In other words, appended position depends on the
2130 above folder group's open/close status.
2132 @subsubsection Charset of the Folders File.
2134 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2136 @subsubsection Create Filter
2138 @kbd{m f} adds filter to the folder at the current cursor point. To
2139 create new filter folder and leave the current folder unchanged, copy it
2140 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2141 filter can be specified while appending filter. If you put
2142 ``''(@var{NULL}), filter is deleted.
2144 @subsubsection Sort Folders
2146 Sorting of the folders is executed by the function specified by
2147 @code{wl-fldmgr-sort-function}.
2148 The initial setting is @code{wl-fldmgr-sort-standard},
2149 which sorts alphabetically.
2150 Sorting affects only on the current folder group. It does not
2151 affect on the child groups.
2153 @subsubsection Hiding Folders in the Access Group
2155 Usually, access group displays all children folders, but you can set
2156 some folders hidden. Following operations are only available on access
2159 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2160 (subscribe/unsubscribe) of the folder at current cursor point. Against
2161 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2164 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2165 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2166 argument and if the argument has positive number, the unsubscribe it.
2167 If the prefix argument has negative value, folder becomes visible and if
2168 zero, folder visibility is toggled.
2170 The other commands, @code{wl-fldmgr-subscribe} and
2171 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2174 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2175 executed in the access group, they have a same effect with
2176 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2177 The difference is that cut commands deletes folders from the current
2180 @subsubsection Operations in the Access Group
2182 You can insert and delete folders in the access group like usual folder
2183 group. But insert and delete commands can be only available for the
2184 children folders of the access group and they only sets the subscribe
2185 status. In other words, insertion of the folder means subscribing,
2186 deletion means unsubscribing.
2187 @footnote{In the current implementation,
2188 it is faster to delete region than to unsubscribe region.}
2190 To update the access group when children folders are inserted or deleted
2191 by other way (other than Wanderlust),
2192 open the access group by typing @kbd{C-u @key{RET}}.
2193 @xref{Selecting Folder}.
2195 The order of children folders of access group is saved after
2196 insertion/deletion/sorting.
2197 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2198 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2199 newly created folders are inserted on the top of the access group.
2201 @subsection Key bindings
2202 @cindex Keybind, Folder Mode
2203 @cindex Keybind, Folder Buffer
2205 Key bindings on the folder mode related to folder editing are shown below.
2206 All bindings starts with @kbd{m}, and primary commands are binded to
2207 one stroke key binding.
2211 @kindex m a (Folder)
2212 @findex wl-fldmgr-add
2214 (@code{wl-fldmgr-add})
2219 @kindex m g (Folder)
2220 @findex wl-fldmgr-make-group
2221 Create a folder group.
2222 (@code{wl-fldmgr-make-group})
2225 @kindex m A (Folder)
2226 @findex wl-fldmgr-make-access-group
2227 Create an access group.
2228 (@code{wl-fldmgr-make-access-group})
2231 @kindex m d (Folder)
2232 @findex wl-fldmgr-delete
2233 Delete folder itself and msgdb.
2234 If the folder itself cannot be deleted like NNTP folder,
2235 only msgdb is deleted.
2236 (@code{wl-fldmgr-delete})
2241 @kindex m R (Folder)
2242 @findex wl-fldmgr-rename
2243 Change the name of folder or folder group.
2244 msgdb's path is also changed.
2245 (@code{wl-fldmgr-rename})
2251 @findex wl-fldmgr-make-multi
2252 Create a multi folders in the cutlist (cut, copied folders).
2253 (@code{wl-fldmgr-make-multi})
2258 @kindex m f (Folder)
2259 @findex wl-fldmgr-make-filter
2260 Create a filter folder. (Put a filter on the folder).
2261 (@code{wl-fldmgr-make-filter})
2265 @kindex M-c (Folder)
2266 @kindex m c (Folder)
2267 @findex wl-fldmgr-copy
2268 Copy folder (it is not available on folder group).
2269 (@code{wl-fldmgr-copy})
2273 @kindex M-w (Folder)
2274 @kindex m W (Folder)
2275 @findex wl-fldmgr-copy-region
2276 Copy folders in the specified region.
2277 (@code{wl-fldmgr-copy-region})
2281 @kindex C-k (Folder)
2282 @kindex m k (Folder)
2283 @findex wl-fldmgr-cut
2284 Cut folder. Folder itself is not deleted.
2285 (@code{wl-fldmgr-cut})
2289 @kindex C-w (Folder)
2290 @kindex m C-w (Folder)
2291 @findex wl-fldmgr-cut-region
2292 Cut folders in the specified region.
2293 (@code{wl-fldmgr-cut-region})
2297 @kindex C-y (Folder)
2298 @kindex m y (Folder)
2299 @findex wl-fldmgr-yank
2300 Paste folders that are copied or cut (folders in the cut-list).
2301 (@code{wl-fldmgr-yank})
2304 @kindex m p (Folder)
2305 @findex wl-fldmgr-set-petname
2306 Put nickname on the folder.
2307 (@code{wl-fldmgr-set-petname})
2310 @kindex m q (Folder)
2311 @findex wl-fldmgr-clear-cut-entity-list
2312 Clear the cut-list. (cut, copied folder information is cleared,
2313 you cannot paste after this)
2314 (@code{wl-fldmgr-clear-cut-entity-list})
2317 @kindex m s (Folder)
2318 @findex wl-fldmgr-sort
2319 Sort folders in the current folder group.
2320 (@code{wl-fldmgr-sort})
2323 @kindex m C-s (Folder)
2324 @findex wl-fldmgr-save
2325 Save current folder view to the @file{wl-folders-file}.
2326 (@code{wl-fldmgr-save})
2329 [Following commands are only available on the access groups]
2335 @kindex m u (Folder)
2336 @findex wl-fldmgr-unsubscribe
2337 Set the visibility of folder (subscribe/unsubscribe).
2338 (@code{wl-fldmgr-unsubscribe})
2343 @kindex r u (Folder)
2344 @findex wl-fldmgr-unsubscribe-region
2345 Set the visibility of the folders (subscribe/unsubscribe) in the
2347 (@code{wl-fldmgr-unsubscribe-region})
2352 @kindex m l (Folder)
2353 @findex wl-fldmgr-access-display-normal
2354 List folders that are currently available.
2355 (@code{wl-fldmgr-access-display-normal})
2360 @kindex m L (Folder)
2361 @findex wl-fldmgr-access-display-all
2362 List all folders regardless of the subscription status.
2363 (@code{wl-fldmgr-access-display-all})
2367 @subsection Customize variables
2370 @item wl-interactive-save-folders
2371 @vindex wl-interactive-save-folders
2372 The initial setting is @code{t}. If non-nil and folder view is
2373 modified, confirm saving it before Wanderlust or Emacs exits. If
2374 @code{nil}, save without confirmation.
2376 @item wl-fldmgr-make-backup
2377 @vindex wl-fldmgr-make-backup
2378 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2379 created before saving the folder status.
2381 @item wl-fldmgr-sort-function
2382 @vindex wl-fldmgr-sort-function
2383 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2384 sort folders. By default function, folders are sorted alphabetically
2385 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2388 @item wl-fldmgr-sort-group-first
2389 @vindex wl-fldmgr-sort-group-first
2390 The initial setting is @code{t}. If non-nil,
2391 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2392 does not care whether it is folder group or not.
2394 @item wl-folder-check-async
2395 @vindex wl-folder-check-async
2396 The initial setting is @code{t}. If non-nil, check folder's unread
2397 status asynchronously. It boosts newsgroup checking.
2399 @item wl-folder-check-fast
2400 @vindex wl-folder-check-fast
2401 The initial setting is @code{nil}.
2402 If non-nil, it does not update folder status while checking.
2404 @item wl-folder-notify-deleted
2405 @vindex wl-folder-notify-deleted
2406 The initial setting is @code{nil}.
2408 If non-nil, negative value is displayed when the message is deleted. If
2409 @code{sync}, folder is synchronized when the message is deleted. If
2410 @code{nil}, message deletion is ignored.
2412 @item wl-fldmgr-add-complete-with-current-folder-list
2413 @vindex wl-fldmgr-add-complete-with-current-folder-list
2414 The initial setting is @code{nil}.
2415 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2416 candidate for @code{wl-fldmgr-add}.
2419 @subsection Miscellanea
2421 Following is a note for folder editing.
2425 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2426 paste(yank) command pastes the folders on one cut or copy command
2427 (If copy command is executed by region, folders in the region are pasted
2428 by one paste command)
2431 You cannot cut @samp{Desktop} group.
2432 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2435 You cannot copy folder group.
2438 Operations on the access group are only available for the folders
2439 in the same access group.
2442 You cannot create a folder which has same name with the folders already exist.
2445 You cannot insert folders which have same name in one group.
2446 You can insert them in the different groups.
2447 You cannot put same nickname to the different folders.
2451 @node Summary, Message, Folder, Top
2452 @chapter Summary Mode
2454 After you select the folder via folder mode, you enter to the summary
2458 * Usage of Summary Mode:: TIPS
2459 * Thread Operations:: Thread operations
2460 * Cache:: File cache, Buffer cache, and Prefetch
2461 * Auto Refile:: Auto refile settings
2462 * Sticky Summary:: Summary make sticky
2463 * Key Bindings of Summary:: Key bindings
2464 * Variables of Summary:: Customize Summary Mode
2468 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2469 @section Usage (Tips)
2471 @subsection Summary Content
2473 In the summary mode, messages are displayed like following.
2477 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2478 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2479 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2480 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2487 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2491 You cannot change this in the current version.
2493 @var{Message number} is the message's unique number in the folder. In
2494 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2495 in the MH folder, it is the filename of the message.
2497 @var{Temporal mark} and @var{Persistent mark} are described later.
2499 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2500 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2501 Japanese, but if you want to display it in English, set the value of
2502 @code{wl-summary-weekday-name-lang} as @samp{en}.
2504 @var{Sender}'s indentation corresponds to the depth of the thread.
2505 Sender name is displayed as nickname if it is defined in the address
2506 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2507 displaying with nickname.
2509 If number is printed at the head of @var{Sender} part like @samp{+2},
2510 that means the message have 2 follow messages.
2512 @var{Subject} is the @samp{Subject:} header field of the message. If
2513 the message have same @samp{Subject:} with the parent message, it is not
2514 displayed. Some mailing list puts its sequence number in the
2515 @samp{Subject:} field, but it is
2516 ignored. @code{wl-summary-no-subject-message} is displayed when the
2517 message has empty subject field.
2519 @subsection Temporary Marks
2520 @cindex Mark, Temporary
2522 There are four temporary marks,
2523 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2524 Temporary marks indicates message operations.
2529 You can execute a command on the all messages that have @samp{*} mark,
2530 with the key bindings which begins with @kbd{m}.
2533 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2537 After you type @kbd{o} key, prompt appears to input refile destination.
2538 Your answer is printed in the summary line.
2542 You can put this mark by typing @kbd{O} key.
2543 The difference between this mark and refile mark is,
2544 this mark does not delete the message while latter does.
2547 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2549 @subsection Persistent Marks
2551 There are five persistent marks,
2552 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2554 The persistent mark indicates the message's status and it is saved.
2555 Each persistent mark indicates:
2561 It is unread message.
2563 It is unread but cached message.
2565 It is read but it is not cached.
2567 It is important message. You can put @samp{$} mark by typing @kbd{$}
2568 key (if already exists, the mark is deleted). It is convenient to put
2569 this mark on the messages to remember (If you want to remember to write
2570 a reply for the message, for example) because this mark remains after
2571 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2572 even the message itself is deleted in the actual folder.
2575 If the message is read and cached (or local message),there are no
2579 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2580 cache. Messages with the marks other than these, you can read them in
2581 the offline status even they are in the IMAP folder or netnews folder.
2583 @subsection How To Read
2585 Basically, you can read messages only typing space key again and again.
2587 To update summary status to the newest status (synchronize),
2590 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2591 moves cursor to the next message.
2592 Enter message buffer by typing @kbd{j} key.
2593 To operate multipart, you have to enter to the message buffer.
2596 @subsection Pack the Message Numbers
2597 You can pack the message numbers in Summary by
2598 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2599 News Spool Folder and Maildir Folder are supported folder types.
2602 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2603 @section Thread Operations
2605 For example, the following line indicates one thread (a context of a topic).
2608 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2612 If you type @kbd{/} on this line, the thread is opened and it changes
2613 the appearance like following.
2617 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2618 388 09/17(Thu)22:34 +-[ Murata san ]
2622 (Message 388 is the replied message to the message 384.)
2623 If you type @kbd{/} key once again, the thread is closed.
2624 With prefix argument, @kbd{/} opens all children threads.
2626 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2629 Commands with the key binding that begins with @kbd{t} executes commands
2630 on the messages in the thread.
2631 @xref{Key Bindings of Summary}.
2633 @subsection reconstruct thread by hand
2635 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2636 (@code{wl-summary-save-current-message}) at the corresponding message,
2637 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2638 message then you have the reconstructed thread.
2641 @node Cache, Auto Refile, Thread Operations, Summary
2644 @subsection Cache File
2646 The messages which have to access via network (e.x. IMAP, NNTP folder)
2647 are cached as a local file. The cache file is saved under the directory
2648 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2649 elmo-cache-expire-by-size}. The command deletes cache files to the
2650 specified size by the order of last accessed time.
2652 @subsection Buffer Cache and Prefetching
2654 The messages that are read are kept in the cache buffer. It is called
2655 `buffer cache'. The number of cache buffer is specified by
2656 @code{wl-message-buffer-cache-size}.
2658 There are message prefetching mechanism in the Wanderlust that
2659 prefetches next message while you are reading.
2661 You can control the message prefetching mechanism by these two
2665 @item wl-message-buffer-prefetch-folder-type-list
2666 @vindex wl-message-buffer-prefetch-folder-type-list
2667 The initial setting is @code{t}. In this case, prefetch messages in all
2669 If it is a list of folder types, it specifies the folder types in which
2670 message prefetching is enabled.
2671 Following is an example (prefetch messages in nntp and imap4 folders)
2675 (setq wl-message-buffer-prefetch-folder-type-list
2680 In this case, multi folder that contains localdir and imap4 prefetches
2681 only imap4 messages. This variable precedes the value of
2682 @code{wl-message-buffer-prefetch-folder-list}.
2684 @item wl-message-buffer-prefetch-folder-list
2685 @vindex wl-message-buffer-prefetch-folder-list
2686 The initial setting is @code{nil}.
2687 A list of regexp of folders to enable message prefetching.
2691 @node Auto Refile, Sticky Summary, Cache, Summary
2692 @section Auto Refile
2693 @vindex elmo-msgdb-extra-fields
2694 @vindex wl-refile-rule-alist
2695 @findex wl-summary-auto-refile
2697 You can refile messages automatically, by typing @kbd{C-o}
2698 (@code{wl-summary-auto-refile}). It decides destination of refile by
2699 the content of the message header information (information in the msgdb).
2701 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2702 available. If you want to decide destination by other header fields,
2703 set the variable @code{elmo-msgdb-extra-fields} like following.
2707 (setq elmo-msgdb-extra-fields
2717 By this setting, Wanderlust saves extra fields in the msgdb. You have
2718 to type @kbd{s all} to get extra fields for the messages that are
2719 already exists in the summary.
2721 Then, specify the refile rule. The refile target folder of auto
2722 refiling is decided by the value of @code{wl-refile-rule-alist}.
2723 @code{wl-refile-rule-alist} is a list of a rule:
2727 (@var{field} (@var{regexp} . @var{target})
2728 (@var{regexp} . @var{target})
2733 Each rule means `if @var{field} value matches @var{regexp},
2734 then refile to @var{target} folder'.
2735 The rule matched first is applied.
2737 @var{field} is a string of field name. You can specify a list of field name
2738 string, too. In this case, if one of these fields is matched, then the
2739 rule is fired (i.e. OR condition).
2741 @var{regexp} is a regular expression for field value. @var{target} is a target
2742 folder string. You can specify a rule at @var{target} part, too. In this
2743 case, If the field value of the rule and the current rule is matched,
2744 then the current rule is fired (i.e. AND condition).
2746 In @var{target} part, you can refer matched substring of @var{regexp}.
2747 To refer substring, specify following in @var{target}:
2751 means substitute original matched text.
2754 means substitute what matched the @var{N}th `\(@dots{}\)'.
2755 (@var{N} is a number.)
2758 Following is an example of @code{wl-refile-rule-alist}.
2762 (setq wl-refile-rule-alist
2764 ("^Wanderlust" . "+wl")
2765 ("^Elisp" . "+elisp"))
2767 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2769 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2770 "+from-me-to-you"))))))
2774 After these settings, refile marks are automatically put on the condition
2775 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2777 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2779 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2780 with these persistent marks are not automatically refiled.
2781 It means Wanderlust does not execute auto refile on unread messages by
2782 the default setting.
2783 To execute auto refile on all messages, set following.
2786 (setq wl-summary-auto-refile-skip-marks nil)
2790 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2791 @section Sticky Summary
2792 @cindex Summary, Sticky
2793 @cindex Sticky Summary
2795 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2797 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2798 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2800 The buffer name of the sticky summary becomes like
2801 @samp{Summary:@var{folder-name}}.
2803 You can visit the sticky summary at any time by @kbd{C-x b}
2804 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2805 q}. Other operations in the sticky summary are same as normal summary.
2807 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2808 are automatically stuck.
2811 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2812 @section Key bindings
2813 @cindex Keybind, Summary Mode
2814 @cindex Keybind, Summary Buffer
2816 Key bindings of the summary mode are shown below.
2820 @kindex @key{SPC} (Summary)
2821 @findex wl-summary-read
2822 Proceed reading a message at the current cursor point.
2823 (@code{wl-summary-read})
2827 @findex wl-summary-redisplay
2828 Redisplay a message at the current cursor point.
2829 If this command is called with prefix argument,
2830 Redisplay message regardless of the message cache (message is re-loaded
2832 (@code{wl-summary-redisplay})
2836 @findex wl-summary-display-top
2837 Display the top message in the folder.
2838 (@code{wl-summary-display-top})
2842 @findex wl-summary-display-bottom
2843 Display the bottom message in the folder.
2844 (@code{wl-summary-display-bottom})
2848 @kindex @key{BS} (Summary)
2849 @kindex @key{DEL} (Summary)
2850 Display the previous page of the message at the current cursor point.
2851 @findex wl-summary-prev-page
2852 (@code{wl-summary-prev-page})
2855 @kindex @key{RET} (Summary)
2856 @findex wl-summary-next-line-content
2857 Display the next line of the message at the current cursor point.
2858 Display the message at the current cursor point if it is not displayed yet.
2859 (@code{wl-summary-next-line-content})
2864 @kindex M-@key{RET} (Summary)
2865 @findex wl-summary-prev-line-content
2866 Display the previous line of the message at the current cursor point.
2867 Display the message at the current cursor point if it is not displayed yet.
2868 (@code{wl-summary-prev-line-content})
2872 @findex wl-thread-open-close
2873 Toggle open or close the thread at the current cursor point.
2874 (@code{wl-thread-open-close})
2879 @findex wl-thread-open-all
2880 (@code{wl-thread-open-all})
2885 @findex wl-thread-close-all
2886 (@code{wl-thread-close-all})
2890 @findex wl-summary-goto-folder
2892 (@code{wl-summary-goto-folder})
2896 Mark all messages in the folder as read.
2897 @findex wl-summary-mark-as-read-all
2898 (@code{wl-summary-mark-as-read-all})
2902 @findex wl-summary-reply
2903 Prepare a draft for reply the message at the current cursor point.
2904 (@code{wl-summary-reply})
2908 @findex wl-summary-reply-with-citation
2909 Prepare a draft for reply the message at the current cursor point.
2910 (@code{wl-summary-reply-with-citation})
2914 @findex wl-summary-cancel-message
2915 If the message at current cursor point is your own netnews article,
2917 (@code{wl-summary-cancel-message})
2921 @findex wl-summary-reedit
2922 Prepare a draft for re-editing the message at current cursor point.
2923 If the message at current cursor point is your own netnews article,
2924 a draft for `supersedes message' for the message is prepared.
2925 (@code{wl-summary-reedit})
2928 @kindex M-e (Summary)
2929 @findex wl-summary-resend-bounced-mail
2930 If the message at current cursor point is a bounced message,
2931 a draft for re-sending original message is prepared.
2932 (@code{wl-summary-resend-bounced-mail})
2936 @findex wl-summary-forward
2937 A draft for forwarding the message at current cursor point is prepared.
2938 (@code{wl-summary-forward})
2942 @findex wl-summary-mark-as-important
2943 Put @samp{$} mark on the message at current cursor point.
2944 If already marked as @samp{$}, delete it.
2945 (@code{wl-summary-mark-as-important})
2951 Save the message at current cursor point.
2952 @findex wl-summary-save
2953 (@code{wl-summary-save})
2957 @findex wl-summary-next
2958 Move cursor to the next message.
2959 If message is marked with a temporal mark in
2960 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2961 In the offline mode, cursor is not moved to the messages which are not cached
2963 (@code{wl-summary-next})
2967 @findex wl-summary-prev
2968 Move cursor to the previous message.
2969 If message is marked with a temporal mark in
2970 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2971 In the offline mode, cursor is not moved to the messages which are not cached
2973 (@code{wl-summary-prev})
2977 @findex wl-summary-down
2978 Move cursor to the downward message which is unread or marked
2980 In the offline mode, cursor is not moved to the messages which are not cached
2982 If there are messages which have target mark @samp{*} in the summary,
2983 cursor is moved to the downward message which have a target mark.
2984 This behavior is changed according to the value of @code{wl-summary-move-order}.
2985 (@code{wl-summary-down})
2989 @findex wl-summary-up
2990 Move cursor to the upward message which is unread or marked
2992 In the offline mode, cursor is not moved to the messages which are not cached
2994 If there are messages which have target mark @samp{*} in the summary,
2995 cursor is moved to the downward message which have a target mark.
2996 This behavior is changed according to the value of @code{wl-summary-move-order}.
2997 (@code{wl-summary-up})
3001 @findex wl-summary-write
3002 Prepare a new draft.
3003 (@code{wl-summary-write})
3007 @findex wl-summary-write-current-folder
3008 Prepare a new draft. If the current folder is NNTP folder,
3009 @samp{Newsgroups:} field is completed. If the current folder is mailing
3010 list folder (refile destination), guess @samp{To:} field and completed
3011 (If @code{wl-subscribed-mailing-list} is valid list)
3012 (@code{wl-summary-write-current-folder})
3016 @findex wl-summary-redisplay-all-header
3017 Redisplay the message at current cursor point with all header fields.
3018 (@code{wl-summary-redisplay-all-header})
3022 @findex wl-summary-redisplay-no-mime
3023 Redisplay the message at current cursor point without MIME analysis.
3024 (@code{wl-summary-redisplay-no-mime})
3028 @findex wl-summary-burst
3029 If the message at current cursor point has
3030 encapsulates multiple messages using MIME,
3031 de-capsulate and extract them on the current folder.
3032 (@code{wl-summary-burst})
3035 @kindex @@ (Summary)
3036 @findex wl-summary-edit-addresses
3037 Append/change/delete the message's sender information to the address
3038 book @file{~/.addresses} interactively. If this command is called with
3039 prefix argument, arbitrary address can be edited.
3040 (@code{wl-summary-edit-petname})
3044 @findex wl-status-update
3045 Sync up address book status with @file{~/.addresses}'s content.
3046 (@code{wl-status-update})
3050 @findex wl-summary-pipe-message
3051 Pipe current message's content to the external process.
3052 (@code{wl-summary-pipe-message})
3056 @findex wl-summary-print-message
3057 Print out current message's content.
3058 It uses @code{ps-print} module in Emacs 20.x.
3059 If you don't use color printer, you might want to set
3060 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3063 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3066 (@code{wl-summary-print-message})
3070 @findex wl-summary-exit
3071 Exit current folder.
3072 (@code{wl-summary-exit})
3076 @findex wl-summary-jump-to-current-message
3077 Jump cursor to the currently displayed message's window.
3078 (@code{wl-summary-jump-to-current-message})
3082 Jump cursor to the other message.
3083 @findex wl-summary-jump-to-msg
3084 (@code{wl-summary-jump-to-msg})
3088 Update summary status and
3089 prefetch all messages which have marks included in the
3090 @code{wl-summary-incorporate-marks}.
3091 @findex wl-summary-incorporate
3092 (@code{wl-summary-incorporate})
3095 @kindex M-j (Summary)
3096 @findex wl-summary-jump-to-msg-by-message-id
3097 Jump cursor to the message which have specified @samp{Message-Id:}. If
3098 @code{elmo-use-database} is non-nil, other folder is also searched.
3099 (@code{wl-summary-jump-to-msg-by-message-id})
3103 Jump to parent message.
3104 @findex wl-summary-jump-to-parent-message
3105 (@code{wl-summary-jump-to-parent-message})
3109 @findex wl-summary-mark-as-unread
3110 Mark as unread the message at current cursor point.
3111 (@code{wl-summary-mark-as-unread})
3115 @findex wl-summary-sync
3116 Synchronize summary view after prompting the update range
3117 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3121 all ...Discard current summary and update all message.
3122 update ...Update the difference between summary and the folder itself.
3123 rescan ...Rescan the msgdb and display again.
3124 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3125 first, last ...Move to the filter folder(partial filter).
3130 (@code{wl-summary-sync})
3134 @findex wl-summary-sort
3136 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3137 (@code{wl-summary-sort})
3141 @findex wl-summary-toggle-thread
3142 Toggle the threading.
3143 Threading status is displayed on the modeline.
3144 @samp{@{S@}} means threading is off (Sequence) and
3145 @samp{@{T@}} means threading is on (Thread).
3146 (@code{wl-summary-toggle-thread})
3150 @findex wl-summary-toggle-disp-folder
3151 Toggle displaying of folder window.
3152 (@code{wl-summary-toggle-disp-folder})
3156 Toggle displaying of message window.
3157 @findex wl-summary-toggle-disp-msg
3158 (@code{wl-summary-toggle-disp-msg})
3162 Move to the virtual folder with the condition specified.
3163 If called with prefix argument and current folder is virtual, exit it.
3164 @findex wl-summary-virtual
3165 (@code{wl-summary-virtual})
3168 @kindex @key{TAB} (Summary)
3169 @findex wl-summary-goto-last-displayed-msg
3170 Jump to the message which is displayed last.
3171 (@code{wl-summary-goto-last-displayed-msg})
3175 Put @samp{*} mark on the messages that satisfies the specified condition.
3176 @findex wl-summary-pick
3177 (@code{wl-summary-pick})
3181 @findex wl-summary-mark-as-read
3182 Mark as read the message at the current cursor point.
3183 (@code{wl-summary-mark-as-read})
3187 Prefetch the message at the current cursor point.
3188 With prefix argument, prefetch the message even if it is cached.
3189 @findex wl-summary-prefetch
3190 (@code{wl-summary-prefetch})
3194 Execute @samp{D}, @samp{o} and @samp{O} marks.
3195 @findex wl-summary-exec
3196 (@code{wl-summary-exec})
3200 @findex wl-summary-target-mark-line
3201 Put target mark on the message at the current cursor point.
3202 (@code{wl-summary-target-mark-line})
3206 Put refile mark on the message at the current cursor point.
3207 @findex wl-summary-refile
3208 (@code{wl-summary-refile})
3211 @kindex C-o (Summary)
3212 Execute auto refile.
3213 @findex wl-summary-auto-refile
3214 (@code{wl-summary-auto-refile})
3218 Put copy mark on the message at the current cursor point.
3219 @findex wl-summary-copy
3220 (@code{wl-summary-copy})
3223 @kindex M-o (Summary)
3224 Put refile mark on the message at the current cursor point with the destination
3225 previously specified.
3226 @findex wl-summary-refile-prev-destination
3227 (@code{wl-summary-refile-prev-destination})
3231 @findex wl-summary-delete
3232 Put delete mark on the message at the current cursor point.
3233 (@code{wl-summary-delete})
3237 @findex wl-summary-unmark
3238 Unmark the temporal mark on the message at the current cursor point.
3239 (@code{wl-summary-unmark})
3243 Unmark all the temporal marks.
3244 @findex wl-summary-unmark-all
3245 (@code{wl-summary-unmark-all})
3248 @kindex r R (Summary)
3249 @findex wl-summary-mark-as-read-region
3250 Mark as read messages in the specified region.
3251 (@code{wl-summary-mark-as-read-region})
3254 @kindex r $ (Summary)
3255 @findex wl-summary-mark-as-important-region
3256 Mark as important @samp{$} messages in the specified region.
3257 If @samp{$} already exists, it is deleted.
3258 (@code{wl-summary-mark-as-important-region})
3261 @kindex r ! (Summary)
3262 @findex wl-summary-mark-as-unread-region
3263 Mark as unread messages in the specified region.
3264 (@code{wl-summary-mark-as-unread-region})
3267 @kindex r i (Summary)
3268 @findex wl-summary-prefetch-region
3269 Prefetch messages in the specified region.
3270 (@code{wl-summary-prefetch-region})
3273 @kindex r x (Summary)
3274 @findex wl-summary-exec-region
3275 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3277 (@code{wl-summary-exec-region})
3280 @kindex r * (Summary)
3281 @findex wl-summary-target-mark-region
3282 Put target mark on the messages in the specified region.
3283 (@code{wl-summary-target-mark-region})
3286 @kindex r o (Summary)
3287 @findex wl-summary-refile-region
3288 Put refile mark on the messages in the specified region.
3289 (@code{wl-summary-refile-region})
3292 @kindex r O (Summary)
3293 @findex wl-summary-copy-region
3294 Put copy mark on the messages in the specified region.
3295 (@code{wl-summary-copy-region})
3298 @kindex r d (Summary)
3299 @findex wl-summary-delete-region
3300 Put delete mark on the messages in the specified region.
3301 (@code{wl-summary-delete-region})
3304 @kindex r u (Summary)
3305 @findex wl-summary-unmark-region
3306 Delete temporal mark on the messages in the specified region.
3307 (@code{wl-summary-unmark-region})
3310 @kindex r y (Summary)
3311 Save messages in the specified region.
3312 @findex wl-summary-save-region
3313 (@code{wl-summary-save-region})
3316 @kindex t R (Summary)
3317 @findex wl-thread-mark-as-read
3318 Mark as read messages which are the descendant of the current thread.
3319 With prefix argument, it affects on the all messages in the thread tree.
3320 (@code{wl-thread-mark-as-read})
3323 @kindex t $ (Summary)
3324 @findex wl-thread-mark-as-important
3325 Put important mark @samp{$} on the messages which are the
3326 descendant of the current thread.
3327 If @samp{$} mark exists, it is deleted.
3328 With prefix argument, it affects on the all messages in the thread tree.
3329 (@code{wl-thread-mark-as-important})
3332 @kindex t ! (Summary)
3333 @findex wl-thread-mark-as-unread
3334 Mark as unread messages which are the descendant of the current thread.
3335 With prefix argument, it affects on the all messages in the thread tree.
3336 (@code{wl-thread-mark-as-unread})
3339 @kindex t i (Summary)
3340 @findex wl-thread-prefetch
3341 Prefetch messages which are the descendant of the current thread.
3342 With prefix argument, it affects on the all messages in the thread tree.
3343 (@code{wl-thread-prefetch})
3346 @kindex t x (Summary)
3347 @findex wl-thread-exec
3348 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3349 the descendant of the current thread. With prefix argument, it affects
3350 on the all messages in the thread tree.
3351 (@code{wl-thread-exec})
3354 @kindex t * (Summary)
3355 @findex wl-thread-target-mark
3356 Put target mark @samp{*} on the messages which are the descendant of the
3357 current thread. With prefix argument, it affects on the all messages in
3359 (@code{wl-thread-target-mark})
3362 @kindex t o (Summary)
3363 @findex wl-thread-refile
3364 Put refile mark on the messages which are the descendant of the current thread.
3365 With prefix argument, it affects on the all messages in the thread tree.
3366 (@code{wl-thread-refile})
3369 @kindex t O (Summary)
3370 @findex wl-thread-copy
3371 Put copy mark on the messages which are the descendant of the current thread.
3372 With prefix argument, it affects on the all messages in the thread tree.
3373 (@code{wl-thread-copy})
3376 @kindex t d (Summary)
3377 @findex wl-thread-delete
3378 Put delete mar on the messages which are the descendant of the current thread.
3379 With prefix argument, it affects on the all messages in the thread tree.
3380 (@code{wl-thread-delete})
3383 @kindex t u (Summary)
3384 @findex wl-thread-unmark
3385 Unmark temporal mark on the messages which are the descendant of the
3386 current thread. With prefix argument, it affects on the all messages in
3388 (@code{wl-thread-unmark})
3391 @kindex t y (Summary)
3392 @findex wl-thread-save
3393 Save messages which are the descendant of the current thread.
3394 With prefix argument, it affects on the all messages in the thread tree.
3395 (@code{wl-thread-save})
3398 @kindex m i (Summary)
3399 @findex wl-summary-target-mark-prefetch
3400 Prefetch all messages which have target mark @samp{*}.
3401 With prefix argument, prefetch all targets even if some of them are cached.
3402 (@code{wl-summary-target-mark-prefetch})
3405 @kindex m R (Summary)
3406 @findex wl-summary-target-mark-mark-as-read
3407 Mark as read all messages which have target mark @samp{*}.
3408 (@code{wl-summary-target-mark-mark-as-read})
3411 @kindex m $ (Summary)
3412 @findex wl-summary-target-mark-mark-as-important
3413 Mark as important all messages which have target mark @samp{*}.
3414 If already marked as @samp{$}, it is deleted.
3415 (@code{wl-summary-target-mark-mark-as-important})
3418 @kindex m ! (Summary)
3419 @findex wl-summary-target-mark-mark-as-unread
3420 Mark as unread all messages which have target mark @samp{*}.
3421 (@code{wl-summary-target-mark-mark-as-unread})
3424 @kindex m o (Summary)
3425 @findex wl-summary-target-mark-refile
3426 Put refile mark on the messages which have target mark @samp{*}.
3427 (@code{wl-summary-target-mark-refile})
3430 @kindex m O (Summary)
3431 @findex wl-summary-target-mark-copy
3432 Put copy mark on the messages which have target mark @samp{*}.
3433 (@code{wl-summary-target-mark-copy})
3436 @kindex m d (Summary)
3437 @findex wl-summary-target-mark-delete
3438 Put delete mark on the messages which have target mark @samp{*}.
3439 (@code{wl-summary-target-mark-delete})
3442 @kindex m y (Summary)
3443 @findex wl-summary-target-mark-save
3444 Save messages which have target mark @samp{*}.
3445 (@code{wl-summary-target-mark-save})
3448 @kindex m u (Summary)
3449 Unmark all temporal marks.
3450 (@code{wl-summary-delete-all-temp-marks})
3451 @findex wl-summary-delete-all-temp-marks
3454 @kindex m a (Summary)
3455 Put target mark @samp{*} on the all messages.
3456 (@code{wl-summary-target-mark-all})
3457 @findex wl-summary-target-mark-all
3460 @kindex m t (Summary)
3461 Put target mark @samp{*} on the messages in the current thread.
3462 @findex wl-summary-target-mark-thread
3463 (@code{wl-summary-target-mark-thread})
3466 @kindex m r (Summary)
3467 @findex wl-summary-target-mark-region
3468 Put target mark @samp{*} on the messages in the specified region.
3469 (@code{wl-summary-target-mark-region})
3472 @kindex m A (Summary)
3473 @findex wl-summary-target-mark-reply-with-citation
3474 Prepare a draft which cites all messages which have target mark @samp{*}.
3475 (@code{wl-summary-target-mark-reply-with-citation})
3478 @kindex m f (Summary)
3479 @findex wl-summary-target-mark-forward
3480 Prepare a draft which forwards all messages which have target mark @samp{*}.
3481 (@code{wl-summary-target-mark-forward})
3484 @kindex m U (Summary)
3485 @findex wl-summary-target-mark-uudecode
3486 Uudecode the messages which have target mark @samp{*}.
3487 (@code{wl-summary-target-mark-uudecode})
3490 @kindex m ? (Summary)
3491 @findex wl-summary-target-mark-pick
3492 Pick messages from the @samp{*} marked messages.
3493 That is, @samp{*} marks on the messages are remained
3494 if the specified condition is satisfied.
3495 (@code{wl-summary-target-mark-pick})
3498 @kindex M-t (Summary)
3499 @findex wl-toggle-plugged
3500 Toggle offline/online status of Wanderlust.
3501 (@code{wl-toggle-plugged})
3504 @kindex C-t (Summary)
3505 Start Wanderlust's plug-status manager.
3506 (@code{wl-plugged-change})
3509 @kindex C-c C-o (Summary)
3510 @findex wl-jump-to-draft-buffer
3511 Move to the draft buffer if available. If multiple draft buffer exists,
3512 moved to one after another. If prefix argument is specified, load draft
3513 folder's message to the draft buffer and jump to it.
3514 (@code{wl-jump-to-draft-buffer})
3517 @kindex M-w (Summary)
3518 @findex wl-summary-save-current-message
3519 Save the message at the current cursor point.
3520 (@code{wl-summary-save-current-message})
3523 @kindex C-y (Summary)
3524 @findex wl-summary-yank-saved-message
3525 Regard the message at the current cursor point as
3526 parent, connect the message saved by
3527 @code{wl-summary-save-current-message}
3529 (@code{wl-summary-yank-saved-message})
3533 @node Variables of Summary, , Key Bindings of Summary, Summary
3534 @section Customiziable variables
3537 @item wl-summary-move-order
3538 @vindex wl-summary-move-order
3539 The initial setting is @code{unread}. Specify cursor moving policy. If
3540 you want to precede new messages, set @code{new}. If you want to
3541 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3544 @item wl-auto-select-first
3545 @vindex wl-auto-select-first
3546 The initial setting is @code{nil}.
3547 If non-nil, first message is automatically displayed.
3549 @item wl-auto-select-next
3550 @vindex wl-auto-select-next
3551 The initial setting is @code{nil}. This controls behavior when there is
3552 no unread message in current summary.
3555 nil: asks whether you want to go back to folder mode
3556 'unread: asks whether you want to go to next unread folder
3557 If the next one comes to be possessing no unread message
3558 by treatment of cross-posted messages or Scoring, then
3559 asks whether you want to go to next to next folder.
3560 'skip-no-unread: similar as unread
3561 But does not ask before going to next to next folder.
3562 otherwise: asks whether you want to go to next unread folder
3565 It might be useful to set @code{'skip-no-unread} for people who
3566 want to continue reading by just pressing and pressing space key.
3568 @item wl-thread-insert-opened
3569 @vindex wl-thread-insert-opened
3570 The initial setting is @code{nil}.
3571 If non-nil, thread is inserted as opened.
3573 @item wl-thread-open-reading-thread
3574 @vindex wl-thread-open-reading-thread
3575 The initial setting is @code{t}. If non-nil, reading thread is
3576 automatically opened though it is closed thread.
3578 @item wl-summary-exit-next-move
3579 @vindex wl-summary-exit-next-move
3580 The initial setting is @code{t}. If non-nil, move to next folder at
3583 @item wl-folder-move-cur-folder
3584 @vindex wl-folder-move-cur-folder
3585 The initial setting is @code{nil}. If non-nil, cursor position on the
3588 @item wl-summary-weekday-name-lang
3589 @vindex wl-summary-weekday-name-lang
3590 The initial setting is @samp{ja}. Specify language of the weekday.
3591 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3592 displays Deutsch. You should rescan summary view after changing this value.
3594 @item wl-summary-fix-timezone
3595 @vindex wl-summary-fix-timezone
3596 The initial setting is @code{nil}.
3597 Time zone of the date string in summary mode is adjusted using this value.
3598 If @code{nil}, it is adjust to the default time zone information
3599 (system's default time zone or environment variable @samp{TZ}).
3601 @item wl-use-petname
3602 @vindex wl-use-petname
3603 The initial setting is @code{t}.
3604 If non-nil, sender part displays nickname.
3606 @item wl-break-pages
3607 @vindex wl-break-pages
3608 The initial setting is @code{t}.
3609 If non-nil, message is split as pages by @samp{^L}.
3611 @item wl-message-window-size
3612 @vindex wl-message-window-size
3613 The initial setting is '(1 . 4).
3614 A cons cell to specify the rate of summary and message window.
3615 car:cdr corresponds summary:message.
3617 @item wl-summary-no-from-message
3618 @vindex wl-summary-no-from-message
3619 The initial setting is @samp{nobody@@nowhere?}. A string which is
3620 displayed when there's no @samp{From:} field in the message.
3622 @item wl-summary-no-subject-message
3623 @vindex wl-summary-no-subject-message
3624 The initial setting is @samp{(WL:No Subject in original.)}. A string
3625 which is displayed when there's no @samp{Subject:} field in the message.
3627 @item wl-summary-use-frame
3628 @vindex wl-summary-use-frame
3629 The initial setting is @code{nil}.
3630 If non-nil, use new frame for the summary.
3632 @item wl-use-folder-petname
3633 @vindex wl-use-folder-petname
3634 The initial setting is the list shown below:
3643 A list of display policy (symbol) of folder nickname. Available symbols
3648 Display folder petname on modeline.
3650 Destination folder is notified as nickname if
3651 @code{wl-auto-select-next} is non-nil.
3653 You can input folder name by nickname in the function
3654 @code{wl-summary-read-folder}.
3657 @item wl-summary-move-direction-toggle
3658 @vindex wl-summary-move-direction-toggle
3659 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3660 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3661 want to aware of reading direction, set this to @code{t}.
3663 @item wl-summary-width
3664 @vindex wl-summary-width
3665 The initial setting is 80.
3666 Width of summary line. If @code{nil}, summary line's width is as is.
3668 @item wl-summary-from-width
3669 @vindex wl-summary-from-width
3670 The initial setting is 17.
3671 Width of sender part of summary line.
3673 @item wl-summary-subject-length-limit
3674 @vindex wl-summary-subject-length-limit
3675 The initial setting is @code{nil}. Specify the limit for the length of
3676 subject parts in summary. @code{nil} means unlimited.
3678 @item wl-summary-indent-length-limit
3679 @vindex wl-summary-indent-length-limit
3680 The initial setting is 46.
3681 Specify the limit of thread indent level. @code{nil} means unlimited
3683 If you set this to @code{nil} you should set @code{wl-summary-width}
3686 @item wl-summary-recenter
3687 @vindex wl-summary-recenter
3688 The initial setting is t.
3689 If non-nil, cursor point is moved to the center of the summary window.
3691 @item wl-summary-divide-thread-when-subject-changed
3692 @vindex wl-summary-divide-thread-when-subject-changed
3693 The initial setting is @code{nil}. If non-nil, thread is split if
3694 the subject is changed.
3696 @item wl-summary-search-via-nntp
3697 @vindex wl-summary-search-via-nntp
3698 The initial setting is @code{confirm}.
3700 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3701 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3702 from the NNTP server @code{elmo-nntp-default-server}. The value of
3703 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3704 @code{elmo-nntp-default-stream-type} are used.
3706 If @code{confirm}, server name can be specified. You can specify NNTP
3707 folder format like @samp{-:username@@servername:119!}.
3709 @item wl-summary-keep-cursor-command
3710 @vindex wl-summary-keep-cursor-command
3711 The initial setting is the list shown below:
3715 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3720 When you entered to summary by these commands and the target summary
3721 buffer already exists, summary status is not automatically updated and
3722 cursor position is saved.
3724 @item elmo-folder-update-threshold
3725 @vindex elmo-folder-update-threshold
3726 The initial setting is 500. If updated message number is larger than
3727 this value, confirm whether drop them or not (in the case where the value
3728 of @code{elmo-folder-update-confirm} is non-nil).
3730 @item elmo-folder-update-confirm
3731 @vindex elmo-folder-update-confirm
3732 The initial setting is @code{t}. If the value is non-nil, do check with
3733 @code{elmo-folder-update-threshold}.
3735 @item wl-summary-always-sticky-folder-list
3736 @vindex wl-summary-always-sticky-folder-list
3737 The initial setting is @code{nil}.
3738 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3739 are automatically stuck. Each element is regexp of folder name.
3741 @item wl-summary-reserve-mark-list
3742 @vindex wl-summary-reserve-mark-list
3743 The initial setting is the list shown below:
3752 If a message is already marked as temporal marks in this list, the
3753 message is not marked by any mark command.
3755 @item wl-summary-skip-mark-list
3756 @vindex wl-summary-skip-mark-list
3757 The initial setting is the list shown below:
3766 If a message is already marked as temporal marks in this list, the
3767 message is skipped at cursor move.
3769 @item elmo-message-fetch-threshold
3770 @vindex elmo-message-fetch-threshold
3771 The initial setting is 30000 (bytes). If displaying message has larger
3772 size than this value, Wanderlust confirms whether fetch the message or
3773 not (in the case where the value of @code{elmo-message-fetch-confirm}
3776 @item elmo-message-fetch-confirm
3777 @vindex elmo-message-fetch-confirm
3778 The initial setting is @code{t}. If the value is non-nil, do check with
3779 @code{elmo-message-fetch-threshold}.
3781 @item wl-prefetch-threshold
3782 @vindex wl-prefetch-threshold
3783 The initial setting is 30000 (bytes). If prefetching message has larger
3784 size than this value and @code{wl-prefetch-confirm} is non-nil,
3785 Wanderlust confirms whether prefetch the message or not. If
3786 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3787 without confirmation.
3789 @item wl-prefetch-confirm
3790 @vindex wl-prefetch-confirm
3791 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3792 prefetch the message or not if the message has larger size than
3793 @code{wl-prefetch-threshold}.
3795 @item elmo-imap4-use-cache
3796 @vindex elmo-imap4-use-cache
3797 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3800 @item elmo-nntp-use-cache
3801 @vindex elmo-nntp-use-cache
3802 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3805 @item elmo-pop3-use-cache
3806 @vindex elmo-pop3-use-cache
3807 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3810 @item elmo-shimbun-use-cache
3811 @vindex elmo-shimbun-use-cache
3812 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3815 @item wl-folder-process-duplicates-alist
3816 @vindex wl-folder-process-duplicates-alist
3817 The initial setting is @code{nil}.
3818 This list determines how to deal with duplicated messages in the same folder.
3819 Each item in the list is regexp of folder name and action; you can specify any
3820 one of the following in the place of action:
3823 @code{nil} : do nothing for duplicated messages.
3824 @code{hide} : hide duplicated messages from the summary.
3825 @code{read} : set duplicated messages as read.
3829 Following is an example (hide duplicated messages in multi folders)
3833 (setq wl-folder-process-duplicates-alist
3834 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3835 ("^\\*.*" . hide) (".*" . read)))
3841 @node Message, Draft, Summary, Top
3842 @chapter Message Buffer
3844 Message Buffers utilize MIME-View mode of SEMI. For operational
3845 procedures and key bindings, refer to respective documents.
3846 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3847 You can also see help by @kbd{?} in message buffer.
3849 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3850 brings you back to Summary mode. @kbd{l} toggles display of Summary
3853 @section Key Bindings
3859 @findex wl-message-toggle-disp-summary
3860 Toggles display of Summary mode buffer.
3861 (@code{wl-message-toggle-disp-summary})
3864 @findex wl-message-refer-article-or-url
3865 @kindex Button-2 (Message)
3866 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3867 corresponding message if found.
3868 (@code{wl-message-refer-article-or-url})
3870 @item Button-4 (upward movement of a wheel)
3871 @kindex Button-4 (Message)
3872 @findex wl-message-wheel-down
3873 Scrolls the message backwards. When the top of the message is hit,
3874 moves to the previous message.
3875 (@code{wl-message-wheel-down})
3877 @item Button-5 (downward movement of a wheel)
3878 @kindex Button-5 (Message)
3879 @findex wl-message-wheel-up
3880 Scrolls the message forward. When the bottom of the message is hit,
3881 moves to the next message.
3882 (@code{wl-message-wheel-up})
3885 @section Customizable Variables
3888 @item wl-message-window-size
3889 @vindex wl-message-window-size
3890 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3891 its car and cdr value corresponds to the ratio of Summary and Message
3894 @item wl-message-ignored-field-list
3895 @vindex wl-message-ignored-field-list
3896 (SEMI only) Initial setting is @code{nil}.
3897 All fields that match this list will be hidden in message buffer.
3898 Each elements are regexp of field-name.
3899 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3901 @item wl-message-visible-field-list
3902 @vindex wl-message-visible-field-list
3903 (SEMI only) Initial setting is @code{nil}.
3904 All fields that match this list will be display in message buffer.
3905 Each elements are regexp of field-name. This value precedes
3906 @code{wl-message-ignored-field-list}.
3907 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3909 @item wl-message-sort-field-list
3910 @vindex wl-message-sort-field-list
3911 (SEMI only) Initial setting is
3912 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3913 Header fields in message buffer are ordered by this value.
3914 Each elements are regexp of field-name.
3916 @item wl-message-truncate-lines
3917 @vindex wl-message-truncate-lines
3918 The initial value is the value of @code{default-truncate-lines}.
3919 If it is non-nil, truncate long lines in message buffer.
3922 @node Draft, Disconnected Operations, Message, Top
3923 @chapter Draft Buffer
3925 At Summary mode, pressing @kbd{w} and the like creates a new draft
3926 buffer. You can edit and send mail and news articles in this buffer.
3930 Basically it is Emacs-standard mail mode.
3932 @subsection Address Completion
3934 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3935 addresses. @kbd{@key{TAB}} completes them.
3937 If you want to submit a news article, add @samp{Newsgroups:} field by
3938 yourself. Field names can be completed by @kbd{@key{TAB}}.
3940 If you save the draft buffer you are editing, it is appended to the
3941 folder specified by @code{wl-draft-folder}.
3943 Using @samp{FCC:} field, you can specify the folder to which a copy of
3944 the message is saved when it is sent.
3946 @subsection Editing Messages
3948 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
3949 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
3950 a MIME user interface for GNU Emacs}.
3951 You can also see help by @kbd{C-c C-x ?} in draft buffer.
3953 @subsection Dynamic Modification of Messages
3954 @vindex wl-draft-config-alist
3955 @c @cindex Change Message
3956 @c @cindex Message, Change Dynamic
3958 You can set @code{wl-draft-config-alist} so that header and body of the
3959 message will automatically modified depending on information of header
3962 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3964 In the example below, the header is modified when
3965 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3966 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3967 before sending the message.
3971 (setq wl-draft-config-alist
3972 '(((string-match "aaa\\.example\\.com$" (system-name))
3973 ;; @r{applied if the expression is non-nil}
3974 (wl-smtp-posting-server . "mailserver-B")
3975 (wl-nntp-posting-server . "newsserver-B")
3976 ;; @r{settings of temporary variables}
3978 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
3979 ;; @r{applied if it matches the header of the draft buffer}
3980 ("Organization" . (format "Go %s" my-webpage)))
3981 ;; @r{you can write elisp expressions here (eval only)}
3982 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3983 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3988 The format of @code{wl-draft-config-alist} is:
3992 '(("@var{regexp of the header}" or @var{elisp expression}
3993 ("@var{Field}" . value(@var{elisp expression}))
3994 (@var{variable} . value(@var{elisp expression}))
3995 (@var{sub-function} . value(@var{elisp expression}))
3998 ("@var{regexp of the header}" or @var{elisp expression}
3999 ("@var{Field}" . value(@var{elisp expression}))
4004 Per default, there are 10 following sub-functions.
4007 'header: Inserts the specified string at the bottom of the header.
4008 'header-top: Inserts the specified string at the top of the header.
4009 'header-file: Inserts the specified file at the bottom of the header.
4010 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4011 'top: Inserts the specified string at the top of the body.
4012 'top-file: Inserts the specified file at the top of the body.
4013 'body: Replaces the body with the specified string.
4014 Specifying @code{nil} deletes the entire body string.
4015 'body-file: Replaces the body with the content of the specified file.
4016 'bottom: Inserts the specified string at the bottom of the body.
4017 'bottom-file: Inserts the specified file at the top of the body.
4018 'part-top: Inserts the specified string at the top of the current part.
4019 'part-bottom: Inserts the specified string at the bottom of the current part.
4020 'template: Applies the specified template.
4021 (refer to the next subsection)
4024 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4025 change them or add your own functions. If you read the code, you can
4026 easily find how to write the functions.
4028 At the first of each item, @var{a regular expression of the header} or
4029 an @var{elisp expression} should be specified. In the case of an elisp
4030 expression, the item is applied when the expression is evaluated
4033 Per default, when multiple items match or are evaluated non-nil, all
4034 such items are applied, but if you set a variable
4035 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4038 At the second of the item, a cons or a list of functions should be
4039 specified. The car part of the cons should be a header field, a
4040 variable, or a sub-function. When a header field is specified, the
4041 field will be modified. If a variable is specified, the value of the
4042 variable will be modified temporarily.
4044 In the cdr part of a cons, not only a variable but also an elisp
4045 expression can be specified as is. If the car part is a header field
4046 and the cdr part is @code{nil}, the field will be deleted.
4048 If you want to use name of parent folder, you can refer the buffer local
4049 variable @code{wl-draft-parent-folder}.
4051 See the next example as well:
4055 (setq wl-draft-config-alist
4057 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4058 ;; @r{applied if it matches the header of the buffer being replied}
4059 (body . " Hello.\n")
4060 (template . "default")
4065 As in the (1) above, if a header regexp is prepended with @code{reply},
4066 it is applied when the draft is prepared by @code{wl-summary-reply} for
4067 example, and when it matches the header being replied. It is ignored
4068 when there is no buffer being replied, like after @code{wl-draft} was
4071 Note that @code{wl-draft-config-alist} is applied only once when
4072 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4073 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4074 aborting transmission, execute @kbd{C-c C-e}
4075 (@code{wl-draft-config-exec}) explicitly.
4077 If you don't want to apply @code{wl-draft-config-alist} when
4078 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4082 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4085 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4086 prepared, do the following:
4089 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4092 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4093 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4097 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4100 @subsection Inserting Templates
4102 @cindex Apply Template
4104 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4105 @kbd{M-x wl-template-select} in the draft buffer.
4107 The format of @code{wl-template-alist} is almost the same as
4108 @code{wl-draft-config-alist}.
4112 (setq wl-template-alist
4115 ("Organization" . "~/.wl sample")
4116 (body . "Hello.\n"))
4118 (template . "default") ;; @r{(a)}
4119 ("To" . "boss@@example.com")
4120 ("Subject" . "Report")
4121 (body-file . "~/work/report.txt")
4127 As you can see, the only difference is item (template) names such as
4128 @samp{default} and @samp{report}, instead of a regexp of header.
4129 Because definition of each item is the same as
4130 @code{wl-draft-config-alist}, you can call another template, like (a).
4132 Executing the command @code{wl-template-select} results in template
4133 selection, but the result differs depending on variable
4134 @code{wl-template-visible-select}.
4136 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4137 window is shown below the draft buffer. You can select a template by
4138 @kbd{n} and @kbd{p} seeing the buffer window.
4140 Press the @key{RET} key and the template is actually applied to the draft
4141 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4142 adjust the window size by @code{wl-template-buffer-lines}.
4144 If @code{wl-template-visible-select} is @code{nil}, you should type the
4145 name of the template in the mini buffer.
4147 As shown in the example in @code{wl-draft-config-alist}, you can select
4148 @samp{default} template by writing:
4151 (template . "default")
4154 @subsection Sending mail by POP-before-SMTP
4155 @cindex POP-before-SMTP
4157 You can send mail by POP-before-SMTP with this single line:
4160 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4164 Configure the following variables if you need.
4167 @item wl-pop-before-smtp-user
4168 The POP user name for POP-before-SMTP authentication.
4169 If unset, @code{elmo-pop3-default-user} is used.
4171 @item wl-pop-before-smtp-server
4172 The POP server name for POP-before-SMTP authentication.
4173 If unset, @code{elmo-pop3-default-server} is used.
4175 @item wl-pop-before-smtp-authenticate-type
4176 The POP authentication method for POP-before-SMTP authentication.
4177 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4179 @item wl-pop-before-smtp-port
4180 The POP port number for POP-before-SMTP authentication.
4181 If unset, @code{elmo-pop3-default-port} is used.
4183 @item wl-pop-before-smtp-stream-type
4184 If non-nil, POP connection is established using SSL. If
4185 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4186 unset, @code{elmo-pop3-default-stream-type} is used.
4189 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4190 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4192 Therefore, if SMTP server and POP server are actually the same, and if
4193 POP folder per default (such as @samp{&}) is available, no settings are
4196 Refer to the following URL about POP-before-SMTP.
4200 http://spam.ayamura.org/tools/smPbS.html
4201 http://www.iecc.com/pop-before-smtp.html
4205 @section Key Bindings
4206 @cindex Keybind, Draft Mode
4207 @cindex Keybind, Draft Buffer
4212 @kindex C-c C-y (Draft)
4213 @findex wl-draft-yank-original
4214 Cites the content of the current message buffer.
4215 (@code{wl-draft-yank-original})
4218 @kindex C-c C-p (Draft)
4219 @findex wl-draft-preview-message
4220 Previews the content of the current draft.
4221 This is useful for previewing MIME multi-part messages.
4222 (@code{wl-draft-preview-message})
4225 @kindex C-c C-s (Draft)
4226 @findex wl-draft-send
4227 Sends the content of the current draft. Does not erase the draft buffer.
4228 This is useful for sending multiple messages, which are a little different
4230 (@code{wl-draft-send})
4233 @kindex C-c C-c (Draft)
4234 @findex wl-draft-send-and-exit
4235 Sends the content of the current draft and erases the draft buffer.
4236 (@code{wl-draft-send-and-exit})
4239 @kindex C-x C-s (Draft)
4240 @findex wl-draft-save
4241 Save the current draft.
4242 (@code{wl-draft-save})
4245 @kindex C-c C-k (Draft)
4246 @findex wl-draft-kill
4247 Kills the current draft.
4248 (@code{wl-draft-kill})
4251 @kindex C-x k (Draft)
4252 @findex wl-draft-mimic-kill-buffer
4253 Kills the current draft.
4254 (@code{wl-draft-mimic-kill-buffer})
4257 @kindex C-c C-z (Draft)
4258 @findex wl-draft-save-and-exit
4259 Saves the current draft, and erases the draft buffer.
4260 This is useful if you want to suspend editing of the draft.
4261 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4262 the @samp{+draft} folder.
4263 (@code{wl-draft-save-and-exit})
4266 @kindex C-c C-r (Draft)
4267 @findex wl-caesar-region
4268 Encodes or decodes the specified region in Caesar cipher.
4269 (@code{wl-caesar-region})
4273 @findex wl-draft-highlight-and-recenter
4274 Recenter and rehighlight current draft.
4275 (@code{wl-draft-highlight-and-recenter})
4279 @findex wl-toggle-plugged
4280 Toggles off-line/on-line states of Wanderlust.
4281 (@code{wl-toggle-plugged})
4284 @kindex C-c C-o (Draft)
4285 @findex wl-jump-to-draft-buffer
4286 Jumps to the other draft buffer, if exists.
4287 With prefix argument, reads a file (if any) from the draft folder when
4288 there is no such buffer.
4289 (@code{wl-jump-to-draft-buffer})
4292 @kindex C-c C-e (Draft)
4293 @findex wl-draft-config-exec
4294 Applies @code{wl-draft-config-alist}.
4295 (@code{wl-draft-config-exec})
4298 @kindex C-c C-j (Draft)
4299 @findex wl-template-select
4301 (@code{wl-template-select})
4304 @kindex C-c C-a (Draft)
4306 Enter Address Manager.
4307 @xref{Address Manager}.
4311 @kindex C-c C-d (Draft)
4312 @findex wl-draft-elide-region
4313 Elide the text between point and mark (@code{wl-draft-elide-region}).
4314 The text is killed and replaced with the contents of the variable
4315 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4319 @section Customizable Variables
4322 @item wl-subscribed-mailing-list
4323 @vindex wl-subscribed-mailing-list
4324 The initial setting is @code{nil}. Mailing lists to which you
4325 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4326 field of a reply draft, removes your own address from
4327 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4328 contained in @samp{To:} or @samp{Cc:} field of a message to be
4329 automatically re-filed, the destination folder will be leaned in
4330 connection with the address.
4336 (setq wl-subscribed-mailing-list
4337 '("wl@@lists.airs.net"
4339 "emacs-mime-ja@@m17n.org"))
4343 @item wl-insert-mail-followup-to
4344 @vindex wl-insert-mail-followup-to
4345 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4346 field is automatically inserted in the draft buffer.
4348 @item wl-insert-mail-reply-to
4349 @vindex wl-insert-mail-reply-to
4350 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4351 field is automatically inserted in the draft buffer.
4353 @item wl-auto-insert-x-face
4354 @vindex wl-auto-insert-x-face
4355 The initial setting is @code{t}. If non-nil and there is an encoded
4356 X-Face string in a file @file{~/.xface} (the value of the variable
4357 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4358 draft buffer. If @code{nil}, it is not automatically inserted.
4360 @item wl-insert-message-id
4361 @vindex wl-insert-message-id
4362 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4363 is automatically inserted on the transmission.
4365 @item wl-local-domain
4366 @vindex wl-local-domain
4367 The initial setting is @code{nil}. If @code{nil}, the return value of
4368 the function @code{system-name} will be used as the domain part of
4371 If @code{system-name} does not return FQDN (i.e. the full name of the
4372 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4373 to the string of the local domain name without hostname (like
4374 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4375 @samp{.} @code{wl-local-domain} is used as domain part of the
4378 If your terminal does not have global IP, set the value of
4379 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4380 you use invalid @samp{Message-ID:}.)
4382 Moreover, concatenation of @code{system-name} @samp{.}
4383 @code{wl-local-domain} will be used as an argument to the HELO command
4386 @item wl-message-id-domain
4387 @vindex wl-message-id-domain
4388 The initial setting is @code{nil}. If non-nil, this value is used as a
4389 domain part of the @samp{Message-ID:}. If your terminal does not have
4390 global IP address, set unique string to this value (e.x. your e-mail
4393 @item wl-message-id-domain
4394 @vindex wl-message-id-domain
4395 The initial setting is @code{nil}. If @code{nil}, the return value of
4396 the function @code{system-name} will be used as the domain part of
4397 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4398 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4399 @strong{must} set this variable to the string of the full name of the
4400 host. Otherwise, you might be beaten up on the Net News.
4402 @item wl-draft-config-alist
4403 @vindex wl-draft-config-alist
4404 The initial setting is @code{nil}. Modifies the draft message just
4405 before the transmission. The content of @code{wl-draft-config-alist}
4406 will be automatically applied only once on the transmission. If you
4407 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4410 @item wl-template-alist
4411 @vindex wl-template-alist
4412 The initial setting is @code{nil}.
4413 This variable specifies the template to be applied in the draft buffer.
4415 @item wl-draft-config-matchone
4416 @vindex wl-draft-config-matchone
4417 The initial setting is @code{nil}. If non-nil, only the first matching
4418 item is used when @code{wl-draft-config-alist} is applied. If
4419 @code{nil}, all matching items are used.
4421 @item wl-template-visible-select
4422 @vindex wl-template-visible-select
4423 The initial setting is @code{t}.
4424 If non-nil, you can preview the result of the template selection in
4427 @item wl-template-confirm
4428 @vindex wl-template-confirm
4429 The initial setting is @code{nil}.
4430 If non-nil, asks for confirmation when you press the enter key to select
4431 template while previewing.
4433 @item wl-template-buffer-lines
4434 @vindex wl-template-buffer-lines
4435 The initial setting is 7.
4436 If @code{wl-template-visible-select} is non-nil, this variable specifies
4437 the size of the preview window.
4439 @item wl-draft-reply-buffer-style
4440 @vindex wl-draft-reply-buffer-style
4441 The initial setting is @code{split}. @code{split} or @code{full} can be
4442 specified. In the case of @code{full}, the whole frame will be used for
4443 a reply draft buffer when it is prepared.
4445 @item wl-draft-use-frame
4446 @vindex wl-draft-use-frame
4447 The initial setting is @code{nil}.
4448 If non-nil, use new frame for the draft.
4450 @item wl-draft-truncate-lines
4451 @vindex wl-draft-truncate-lines
4452 The initial value is the value of @code{default-truncate-lines}.
4453 If it is non-nil, truncate long lines in draft buffer.
4457 The initial setting is the value of the variable
4458 @code{user-mail-address}. The value of this variable is inserted as a
4459 @samp{From:} field of the draft when it is prepared.
4461 @item wl-envelope-from
4462 @vindex wl-envelope-from
4463 The initial setting is @code{nil}.
4464 The value of this variable is used for envelope from (MAIL FROM).
4465 If @code{nil}, the address part of @code{wl-from} is used.
4467 @item wl-user-mail-address-list
4468 @vindex wl-user-mail-address-list
4469 The initial setting is @code{nil}.
4470 This is the User's address list. If you have multiple addresses,
4475 The initial setting is @code{nil}.
4476 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4477 the draft when it is prepared. If function is specified, its return
4482 The initial setting is @code{nil}.
4483 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4484 the draft when it is prepared.
4486 @item wl-reply-subject-prefix
4487 @vindex wl-reply-subject-prefix
4488 The initial setting is @samp{Re: }.
4489 In the @samp{Subject:} of the reply draft, this string is prepended to
4490 the @samp{Subject:} of being replied.
4492 @item wl-draft-reply-use-address-with-full-name
4493 @vindex wl-draft-reply-use-address-with-full-name
4494 The initial setting is @code{t}.
4495 If non-nil, insert her full name with address when prepare a draft for
4496 reply a message. If it is @code{nil}, insert her address only.
4498 @item wl-draft-enable-queuing
4499 @vindex wl-draft-enable-queuing
4500 The initial setting is @code{t}.
4501 This flag controls off-line transmission. If non-nil, the draft is
4504 @item wl-draft-use-cache
4505 @vindex wl-draft-use-cache
4506 The initial setting is @code{nil}. If the value is non-nil and
4507 @code{wl-insert-message-id} is nil, cache the message which is sent.
4509 @item wl-fcc-force-as-read
4510 @vindex wl-fcc-force-as-read
4511 The initial setting is @code{nil}. If the value is non-nil,
4512 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4514 @item wl-auto-flush-queue
4515 @vindex wl-auto-flush-queue
4516 The initial setting is t.
4517 This flag controls automatic transmission of the queue when Wanderlust
4518 becomes on-line. If non-nil, the queue is automatically transmitted
4519 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4520 manually, press @kbd{F} in the folder mode.
4522 @item wl-ignored-forwarded-headers
4523 @vindex wl-ignored-forwarded-headers
4524 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4525 All headers that match this regexp will be deleted when forwarding a message.
4527 @item wl-ignored-resent-headers
4528 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4529 All headers that match this regexp will be deleted when resending a message.
4531 @item wl-draft-always-delete-myself
4532 @vindex wl-draft-always-delete-myself
4533 If non-nil, always removes your own address from @samp{To:} and
4534 @samp{Cc:} when you are replying to the mail addressed to you.
4536 @item wl-draft-delete-myself-from-bcc-fcc
4537 @vindex wl-draft-delete-myself-from-bcc-fcc
4538 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4539 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4541 @item wl-smtp-posting-server
4542 @vindex wl-smtp-posting-server
4543 The initial setting is @code{nil}.
4544 This is the SMTP server name for mail transmission.
4546 @item wl-smtp-posting-user
4547 @vindex wl-smtp-posting-user
4548 The initial setting is @code{nil}.
4549 This is the user name for SMTP AUTH authentication. If @code{nil},
4550 @code{smtp-authenticate-user} is used.
4552 @item wl-smtp-authenticate-type
4553 @vindex wl-smtp-authenticate-type
4554 The initial setting is @code{nil}.
4555 This is the authentication method for SMTP AUTH authentication. If
4556 @code{nil}, @code{smtp-authenticate-type} is used. If
4557 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4560 @item wl-smtp-connection-type
4561 @vindex wl-smtp-connection-type
4562 The initial setting is @code{nil}.
4563 This variable specifies how to establish SMTP connections.
4564 If @code{nil}, @code{smtp-connection-type} is used.
4565 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4567 @item wl-nntp-posting-server
4568 @vindex wl-nntp-posting-server
4569 The initial setting is @code{nil}.
4570 This is the NNTP server name used for news submission.
4571 If @code{nil}, @code{elmo-nntp-default-server} is used.
4573 @item wl-nntp-posting-user
4574 @vindex wl-nntp-posting-user
4575 The initial setting is @code{nil}.
4576 This is the user name for AUTHINFO authentication on news submission.
4577 If @code{nil}, @code{elmo-nntp-default-user} is used.
4578 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4580 @item wl-nntp-posting-port
4581 @vindex wl-nntp-posting-port
4582 The initial setting is @code{nil}.
4583 This is the port number of the NNTP server used for news submission.
4584 If @code{nil}, @code{elmo-nntp-default-server} is used.
4586 @item wl-nntp-posting-stream-type
4587 @vindex wl-nntp-posting-stream-type
4588 The initial setting is @code{nil}.
4589 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4590 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4591 connection will be established.
4593 @item wl-pop-before-smtp-user
4594 @vindex wl-pop-before-smtp-user
4595 The initial setting is @code{nil}.
4596 This is the POP user name for POP-before-SMTP.
4597 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4599 @item wl-pop-before-smtp-server
4600 @vindex wl-pop-before-smtp-server
4601 The initial setting is @code{nil}.
4602 This is the POP server name for POP-before-SMTP.
4603 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4605 @item wl-pop-before-smtp-authenticate-type
4606 @vindex wl-pop-before-smtp-authenticate-type
4607 The initial setting is @code{nil}.
4608 This is the authentication method for POP-before-SMTP authentication.
4609 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4611 @item wl-pop-before-smtp-port
4612 @vindex wl-pop-before-smtp-port
4613 The initial setting is @code{nil}.
4614 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4615 @code{elmo-pop3-default-port} is used.
4617 @item wl-pop-before-smtp-stream-type
4618 @vindex wl-pop-before-smtp-stream-type
4619 The initial setting is @code{nil}.
4620 This flag controls the use of SSL for POP-before-SMTP. If it is
4621 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4622 STARTTLS (RFC2595) connection will be established.
4624 @item wl-draft-queue-save-variables
4625 @vindex wl-draft-queue-save-variables
4626 Specifies a list of variable to which queued messages are saved on the
4627 off-line transmission.
4629 @item wl-draft-sendlog
4630 @vindex wl-draft-sendlog
4631 The initial setting is @code{t}.
4632 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4636 @item drafts are sent by smtp or qmail
4637 @item saved into folders by fcc
4638 @item saved into folders by queuing
4641 (it is written even if the transmission fails).
4642 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4643 and left to the logging function of @command{imput}.
4646 @item wl-draft-sendlog-max-size
4647 @vindex wl-draft-sendlog-max-size
4648 The initial setting is 20000 (in bytes).
4649 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4650 beyond the size specified by this variable.
4654 The initial setting is @code{nil}.
4655 If non-nil, address completion uses LDAP.
4657 @item wl-ldap-server
4658 @vindex wl-ldap-server
4659 The initial setting is @samp{localhost}.
4660 LDAP server name for address completion.
4663 @vindex wl-ldap-port
4664 The initial setting is @code{nil}.
4665 If non-nil, the value is used as port number.
4668 @vindex wl-ldap-base
4669 The initial setting is @samp{c=US}.
4670 LDAP search starting point (base) for address completion.
4672 @item wl-draft-remove-group-list-contents
4673 @vindex wl-draft-remove-group-list-contents
4674 The initial setting is @code{t}.
4675 If non-nil, remove the group-lists' members in the recipients when
4676 sending the message (group-list means the description such as
4677 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4680 @node Disconnected Operations, Expire and Archive, Draft, Top
4681 @chapter Off-line Management
4682 @cindex Disconnected Operations
4684 Wanderlust has on-line and off-line states.
4687 * Off-line State:: Wanderlust has on-line and off-line states
4688 * Enable Operations:: Enable Disconnected Operations
4689 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4690 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4691 * Variables of Plugged Mode:: Customize Plugged Mode
4695 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4696 @section Off-line State
4698 Wanderlust has on-line and off-line states. In the off-line state, you
4699 cannot access messages via network, unless they are cached.
4701 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4702 in the mode line indicates the off-line state. In folder or summary
4703 modes, press @kbd{M-t} to switch between off- and on-line.
4705 You can invoke Wanderlust in the off-line state by setting
4706 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4708 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4709 ignores uncached messages.
4712 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4713 @section Enable Disconeected Operations
4715 Even in the off-line state, provided that relevant messages are cached,
4716 and the variable @code{elmo-enable-disconnected-operation} (described
4717 later) is non-nil, you can following operations:
4718 @xref{Plugged Mode}, @xref{Off-line State settings}.
4721 * Send Messages off-line:: Transmit Messages
4722 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4723 * Creation of Folders:: Create Folders off-line (IMAP4)
4724 * Marking:: Mark (IMAP4)
4725 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4728 As soon as Wanderlust becomes on-line, such operations invoked off-line
4729 are reflected in the servers via network.
4732 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4733 @subsection Transmission of Messages
4735 You can send mail/news messages off-line (if you are using
4736 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4737 accumulated in the queue folder, @samp{+queue}. These messages are
4738 transmitted at once when Wanderlust becomes on-line.
4740 You can visit @samp{+queue} in the off-line state and confirm content of
4741 messages in the queue. You can also remove messages. Removed messages
4742 are not transmitted even in the on-line state.
4745 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4746 @subsection Re-file and Copy (IMAP4)
4748 Re-file and copy operations to IMAP folders invoked during the off-line
4749 state are accumulated in the queue, and reflected in the server side
4750 when Wanderlust becomes on-line. If you visit destination folders after
4751 off-line re-file or copy, it looks as if messages were appended even in
4754 For the safety reasons, messages re-filed off-line are removed from
4755 source folders only if their @samp{Message-ID:} match messages on the
4756 servers. While the queue is processed, messages that failed to be
4757 re-filed or copied to the specified folders are appended to the folder
4761 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4762 @subsection Creation of Folders (IMAP4)
4764 You can create IMAP folders off-line. The creation of folders are
4765 reflected in the servers when Wanderlust becomes on-line. At that time,
4766 if folders failed to be created on the servers for any reasons, messages
4767 re-filed to such folders are appended to the folder @samp{+lost+found}.
4770 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4771 @subsection Marking (IMAP4)
4773 Off-line changes in unread/read and importance mark @samp{$} information
4774 are also reflected in the servers when Wanderlust becomes on-line.
4777 @node Pre-fetching Reservations, , Marking, Enable Operations
4778 @subsection Pre-fetching (IMAP4, NNTP)
4780 You can make reservations for pre-fetching messages in IMAP or NNTP
4781 folders. Reserved messages are marked with @samp{!} but not cached
4782 yet. When Wanderlust becomes on-line, they are pre-fetched from
4785 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4786 these off-line operations for IMAP4 and NNTP do not take place, and
4787 off-line re-file, copy or suchlike simply results in error.
4789 Because off-line operations use cache files, it is a bad idea to erase
4790 them by hand; it may cause Wanderlust to malfunction.
4792 If you want to remove caches, be sure to execute @kbd{M-x
4793 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4794 remove caches for messages relevant to off-line operations.
4797 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4798 @section Switching On-line/Off-line per Server/Port
4800 @kbd{M-t} described above switches networking states as a whole, but you
4801 can switch on-line/off-line per server/port.
4803 Pressing @kbd{C-t} in the folder or summary modes brings you in
4804 wl-plugged-mode shown below, in which you can change the plugged state
4809 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4812 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4813 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4815 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4816 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4822 The first line indicates status of the following three variables, and
4823 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4824 column modifies the values of these variables.
4828 "Queuing" @code{wl-draft-enable-queuing}
4829 "AutoFlushQueue" @code{wl-auto-flush-queue}
4830 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4834 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4837 The second and after lines indicate on-line/off-line states of servers
4838 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4839 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4840 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4842 @dfn{sending queue} means messages accumulated in the folder
4843 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4844 off-line operations when @code{elmo-enable-disconnected-operation} is
4846 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4847 @c off-line operations are enabled.
4849 They are displayed if there are any of them. In the example above, in
4850 the sending queue there are two messages (the first and the second in
4851 the queue folder) for smtp to hosta and one (the third) for nntp to
4852 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4855 If you change @samp{(wl-plugged)} in the second line, the variable
4856 @code{wl-plugged} is changed, so that the mode line indicator and
4857 plugged states of all ports are affected. If you change plugged states
4858 of any servers or ports, @samp{(wl-plugged)} in the second line is
4859 affected depending on @code{elmo-plugged-condition} settings and the
4860 plugged state of each port.
4863 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4864 @section Invoking Wanderlust in the Off-line State
4866 As described before, if you set @code{wl-plugged} to @code{nil} in
4867 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4868 off-line state. You can specify off-line state on a per server or port
4869 basis. Refer to @code{wl-reset-plugged-alist} also.
4871 Usually, when Wanderlust starts up, the plugged state of each port is
4872 read from @file{~/.folders} and @code{wl-smtp-posting-server},
4873 @code{wl-nntp-posting-server} and so on. If you want to change the
4874 plugged state of these ports or to add other ports, configure
4875 @code{wl-make-plugged-hook} with a function.
4879 (add-hook 'wl-make-plugged-hook
4881 (elmo-set-plugged plugged-value(t/nil) server port)
4882 ;; @r{add or change plugged states of the port of the server}
4883 (elmo-set-plugged plugged-value(t/nil) server)
4884 ;; @r{if the port is omitted, all ports are affected}
4885 ;; @r{(you cannot omit the port if you newly add the server)}
4891 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4892 @section Customizable Variables
4897 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4898 mode from the beginning.
4900 @item wl-queue-folder
4901 @vindex wl-queue-folder
4902 The initial setting is @samp{+queue}.
4903 This is the folder in which messages in the transmission queue are
4906 @item wl-auto-flush-queue
4907 @vindex wl-auto-flush-queue
4908 The initial setting is @code{t}.
4909 This flag controls automatic transmission of the queue when Wanderlust
4910 becomes on-line. If non-nil, the queue is automatically transmitted
4911 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4912 manually, press @kbd{F} in the folder mode.
4914 @item elmo-enable-disconnected-operation
4915 @vindex elmo-enable-disconnected-operation
4916 The initial setting is @code{nil}. Controls off-line operations
4917 regarding IMAP4. If non-nil, off-line operations are carried out.
4919 @item elmo-lost+found-folder
4920 @vindex elmo-lost+found-folder
4921 The initial setting is @samp{+lost+found}.
4922 This is the folder to which messages are saved when they fails to be
4923 appended while the off-line re-file/copy queue is processed.
4925 @item elmo-plugged-condition
4926 @vindex elmo-plugged-condition
4927 The initial setting is @code{one}.
4928 The value of @code{wl-plugged} reflects the return value of the function
4929 @code{elmo-plugged-p} (without arguments).
4930 This variable @code{elmo-plugged-condition} specifies the condition on
4931 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4932 plugged state of each port.
4935 'one : plugged if one or more ports are plugged.
4936 'all : plugged if all ports are plugged.
4937 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4938 states of the ports.
4939 @var{function} : reflects the return value of the @var{function}
4940 functions available per default
4941 'elmo-plug-on-by-servers
4942 : reflects the plugged state of the servers specified by the
4943 variable elmo-plug-on-servers.
4944 'elmo-plug-on-by-exclude-servers
4945 : reflects the plugged state of the servers that are not
4946 in elmo-plug-on-exclude-servers.
4947 elmo-plug-on-exclude-servers defaults to
4950 (system-name)without the domain part)
4956 (setq elmo-plugged-condition 'all)
4958 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4959 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4961 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4962 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4966 @item wl-reset-plugged-alist
4967 @vindex wl-reset-plugged-alist
4968 The initial setting is @code{t}. If non-nil, plugged states are
4969 initialized on a per server or port basis when Wanderlust starts up.
4971 If @code{nil}, plugged states are retained while Emacs is running. In
4972 other words, they are initialized when Emacs is restarted even if the
4973 value is @code{nil}.
4977 @node Expire and Archive, Scoring, Disconnected Operations, Top
4978 @chapter Automatic Expiration and Archiving of Messages
4979 @cindex Expire and Archive
4982 * Expire:: Expiration and Archiving
4983 * Archive:: Archiving All Messages
4987 @node Expire, Archive, Expire and Archive, Expire and Archive
4989 @cindex Expire Message
4991 Expiration means deletion of old messages which have outlasted a
4992 certain period of time.
4994 @code{wl-expire} supports not only simple deletion, but also moving to
4995 specified archiving folders.
4999 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5000 or @kbd{M-e} in the summary mode.
5002 @subsection Configuring @code{wl-expire-alist}
5004 An example configuration of @code{wl-expire-alist} is shown below.
5005 Everything in this @code{wl-expire-alist} makes a great difference in
5006 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5007 to @code{t}, especially in the initial stage.
5011 (setq wl-expire-alist
5012 '(("^\\+trash$" (date 14) remove)
5014 ("^\\+tmp$" (date 7) trash)
5015 ;; @r{re-file to @code{wl-trash-folder}}
5016 ("^\\+outbox$" (number 300) "$outbox;lha")
5017 ;; @r{re-file to the specific folder}
5019 ;; @r{do not expire}
5020 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5021 ;; @r{archive by message number (retaining numbers)}
5022 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5023 ;; @r{archive by a fixed number (retaining numbers)}
5024 ("^\\+diary$" (date 30) wl-expire-archive-date)
5025 ;; @r{archive by year and month (numbers discarded)}
5030 Items in the list has the format of:
5033 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5037 The folder is examined if it matches @var{regexp-for-folders} from the
5038 beginning of the list. If you invoke expiration on the folder that does
5039 not match any of them, nothing will happen. And if either the second or
5040 the third element of the item is @code{nil}, expiration will not take
5043 You can use any one of the following for
5044 @var{specification-of-message-to-be-deleted}:
5047 @item (number @var{n1} [@var{n2}])
5048 deletes messages depending on the number of messages in the folder.
5050 @var{n1} is the number of messages which should survive deletion, for example
5051 if its value is 500, the newest 500 messages survive and the rests are
5054 @var{n2} is the number of messages in the folder on which expiration should
5055 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5056 folders with 510 or more messages are expired.
5057 If you configured automatic expiration, frequently used folders may
5058 expire every time it receive messages, and you may be annoyed with the
5059 long delay in reading mail.
5060 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5061 expiration would not take place until a certain number of messages
5064 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5065 with important/new/unread) are not deleted.
5066 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5067 will expire so as to have 500 messages including such ones.
5068 Otherwise, it will have 500 messages except such ones.
5070 @item (date @var{d1})
5071 deletes messages depending on the dates.
5073 Messages dated @var{d1} or more days ago are deleted, for example if its
5074 value is seven, messages seven days old or more are deleted. Note that
5075 the date is the one in the @samp{Date:} field of the message, not when
5076 the message entered the folder.
5078 Messages with no or invalid @samp{Date:} field does not expire; you
5079 might have to delete them by hand.
5082 You can use any one of the following in the place of @var{destination}:
5086 deletes the messages instantly.
5089 hide the messages from summary (messages are not deleted).
5092 moves the messages to @code{wl-trash-folder}.
5094 @item @var{string}(folder)
5095 moves the messages to the folder specified with @var{string}.
5097 It would be useful for specifying an archiving folder, but because this
5098 does not move important messages, it might be better to use the
5099 standard functions described below.
5101 @item @var{function}
5102 invokes the specified @var{function}.
5104 To the @var{function}, three arguments are passed: a folder name, a list
5105 of messages to be deleted, and msgdb information of the summary. You
5106 can specify function-specific arguments after the name of the
5107 @var{function}. Note that the list contains messages with marks in
5108 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5111 These are four standard functions; three of them move messages to an archive
5112 folder in the specified way. This means old messages can be compressed
5113 and saved in a file, being deleted from the original folder.
5114 The last one divides messages to some MH folders.
5117 @item wl-expire-archive-number1
5118 re-files to archiving folders corresponding to the message numbers of
5119 the messages being deleted. For example, a message numbered 102 will be
5120 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5121 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5122 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5124 The archiving folders to which messages are re-filed are determined by
5125 the name of the folder as follows (in this case, archiving folders are
5126 handled as if @code{elmo-archive-treat-file} were non-nil).
5129 @item If the folder type is localdir:
5130 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5132 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5133 (@file{~/Mail/ml/wl-00100.zip}).
5135 @item The folder type is other than localdir:
5136 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5138 For example, @samp{%#mh/ml/wl} corresponds to
5139 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5142 As you can see, in the case of localdir, the folder type is not included
5143 in the path name, but otherwise it is included.
5144 And you can control the prefix to the archiving folder name by
5145 @code{wl-expire-archive-folder-prefix}.
5146 Refer to @code{wl-expire-archive-folder-prefix} for details.
5148 @item wl-expire-archive-number2
5149 re-files every certain number of messages to archiving folders.
5151 This differs from @samp{wl-expire-archive-number1} in that this re-files
5152 to the folder up to the specified number regardless of message numbers.
5153 The archiving folders to which messages are re-filed are determined in the
5154 same way as @code{wl-expire-archive-number1}.
5156 @item wl-expire-archive-date
5157 re-files messages depending on its date (year and month) to archive
5160 For example, a message dated December 1998 is re-filed to
5161 @code{$folder-199812;zip}. The name of the archiving folders except the
5162 date part are determined in the same way as
5163 @code{wl-expire-archive-number1}.
5166 You can set the first argument to these three standard functions to non-nil
5167 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5168 For example, it can be specified just after the name of the function:
5171 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5174 If you omit the argument, consecutive numbers from 1 are assigned for
5175 each archiving folder.
5177 @item wl-expire-localdir-date
5178 divedes messages depending on its date (year and month) to MH folders
5179 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5183 @subsection Treatment for Important or Unread Messages
5185 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5186 standard function, messages with marks in
5187 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5188 messages} thereafter) are retained.
5190 Per default, this variable include the important, new, and unread marks,
5191 so that messages with these marks are not removed.
5192 Note that you cannot include the temporary mark (i.e. temporary marks
5193 are removed anyway), and be sure to process temporary marks before you
5196 @subsection Auto Expiration
5198 The following setup invokes expiration when you move into the summary
5199 mode. There will be no confirmation, so make sure you made no mistake
5200 in regexp and other settings before you set up this.
5204 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5208 In the folder mode, you can invoke expiration per group as well as per
5209 folder. Therefore, if you specify @samp{Desktop} group, all folders
5210 matching @code{wl-expire-alist} expire.
5214 @subsection Treating archive folders.
5215 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5216 you must set non-nil value to @code{elmo-archive-treat-file}.
5218 @subsection Confirming
5220 If you are to use @code{remove}, try @code{trash} at first and see
5221 messages move to @code{wl-trash-folder} as expected, then replace it
5222 with @code{remove}. It would be dangerous to use @code{remove} from the
5225 If you are to use @code{wl-expire-archive-number1} and the like, try to
5226 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5227 you can append messages to it. Even if settings in
5228 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5229 would not be saved anywhere and disappeared in case the archiver program
5232 After you make sure you can archive to the folder correctly, you can
5233 invoke expiration and utilize the log.
5235 If you set @code{wl-expire-use-log} to @code{t},
5236 @file{~/.elmo/expired-log} should contain the log, for example:
5240 delete +ml/wl (593 594 595 596 597 598 599)
5241 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5245 The first column indicates the operation, i.e. @samp{delete},
5246 @samp{copy}, or @samp{move}. The next is the name of the folder that
5247 expired. In the case of @samp{copy} and @samp{move}, the destination
5248 folder is recorded after @samp{->}. The last is the list of message
5249 numbers that are actually deleted or moved (in the case of @samp{copy}
5250 and @samp{move}, the number is the one in the source folder, rather than
5251 the destination folder).
5253 @subsection Re-filing Reserved Messages
5255 The three standard functions copy reserved messages to the archive
5256 folder, but do not delete them from the source folder. Because
5257 reserved messages and the like always remain, they are recorded in
5258 @file{~/.elmo/expired-alist} so that they are not copied over and over
5259 again. They are not recorded if copied by @code{wl-summary-archive}.
5261 If you enabled logging, usually @samp{move} is recorded for re-filing,
5262 but instead @samp{copy} and @samp{delete} are recorded separately if
5263 reserved messages are involved. This is because it actually copies
5264 messages including reserved, then deletes ones except reserved in that
5267 @section Customizable Variables
5270 @item wl-expire-alist
5271 @vindex wl-expire-alist
5272 The initial setting is @code{nil}.
5273 This variable specifies folders and methods to expire. For details,
5274 refer to @code{wl-expire-alist} settings above.
5276 @item wl-summary-expire-reserve-marks
5277 @vindex wl-summary-expire-reserve-marks
5278 The initial setting is the list below.
5282 (list wl-summary-important-mark
5284 wl-summary-unread-mark
5285 wl-summary-unread-uncached-mark
5286 wl-summary-unread-cached-mark)
5290 Messages with these marks are retained in the folder, even after
5292 Only permanent marks can be listed, not temporary marks.
5294 You can list marks one by one as in the default; you can use the
5295 following settings as well:
5299 All messages with permanent marks are retained,
5300 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5304 All messages are handled as usual ones that are already read, no matter
5305 what marks they have; even important messages are deleted.
5308 @item wl-expire-archive-files
5309 @vindex wl-expire-archive-files
5310 The initial setting is 100.
5311 This variable specifies the number of messages to be retained in one
5314 @item wl-expire-number-with-reserve-marks
5315 @vindex wl-expire-number-with-reserve-marks
5316 The initial setting is @code{nil}.
5317 If non-nil, if expiring messages are specified by @code{number},
5318 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5320 @item wl-expire-archive-get-folder-function
5321 @vindex wl-expire-archive-get-folder-function
5322 The initial setting is @code{wl-expire-archive-get-folder}.
5324 This variable specifies a function that returns the name of an archiving
5325 folder for standard functions in the place of @var{destination}.
5326 You can use the following three variables for simple modification of
5327 folder names; if you want more complex settings, define your own
5328 function in this variable.
5330 @code{wl-expire-archive-get-folder} can be customized by these
5333 @item @code{wl-expire-archive-folder-name-fmt}
5334 @item @code{wl-expire-archive-folder-type}
5335 @item @code{wl-expire-archive-folder-prefix}
5338 @item wl-expire-archive-folder-name-fmt
5339 @vindex wl-expire-archive-folder-name-fmt
5340 The initial setting is @samp{%s-%%05d;%s}.
5341 This is a @code{format} string for archiving folders used in
5342 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5343 Note that you must specify the message number by @samp{%%d}, because it
5344 is parsed twice by @code{format}.
5346 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5349 @item wl-expire-archive-date-folder-name-fmt
5350 @vindex wl-expire-archive-date-folder-name-fmt
5351 The initial setting is @samp{%s-%%04d%%02d;%s}.
5352 This is a @code{format} string for archiving folders used in
5353 @code{wl-expire-archive-date}. Note that you must specify the message
5354 number by @samp{%%d}, because it is parsed twice by @code{format}.
5355 There should be @samp{%%d} twice, one for the year and the other for the
5358 If you modify this, adjust
5359 @code{wl-expire-archive-date-folder-num-regexp} as well.
5361 @item wl-expire-archive-folder-type
5362 @vindex wl-expire-archive-folder-type
5363 The initial setting is @code{zip}.
5364 This variable specifies an archiver type of the archiving folders.
5366 @item wl-expire-archive-folder-prefix
5367 @vindex wl-expire-archive-folder-prefix
5368 The initial setting is @code{nil}.
5369 This variable specifies the prefix (directory structure) to archiving
5371 Exercise extreme caution in using this feature, as it has not been
5373 In the worst case, there is a fear of destructing archiving folders.
5377 There will be no prefix.
5380 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5381 @samp{$ml/wl-00000;zip;wl}.
5384 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5387 @samp{$ml/wl-00000;zip;ml/wl}.
5390 @item wl-expire-archive-folder-num-regexp
5391 @vindex wl-expire-archive-folder-num-regexp
5392 The initial setting is @samp{-\\([-0-9]+\\);}.
5393 This variable specifies the regular expression to be used for getting
5394 message numbers from multiple archiving folders specified by
5395 @code{elmo-list-folders}.
5396 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5398 @item wl-expire-archive-date-folder-num-regexp
5399 @vindex wl-expire-archive-date-folder-num-regexp
5400 The initial setting is @samp{-\\([-0-9]+\\);}.
5401 This is the regular expression to be used for getting message numbers
5402 from multiple archiving folders specified by @code{elmo-list-folders}.
5403 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5405 @item wl-expire-delete-oldmsg-confirm
5406 @vindex wl-expire-delete-oldmsg-confirm
5407 The initial setting is @code{t}.
5408 If non-nil, messages older than the one with the largest number will be
5409 deleted with confirmation.
5410 If @code{nil}, they are deleted without confirmation.
5412 This feature is valid only if non-nil is specified as a argument to the
5413 standard functions so as to retain numbers.
5415 @item wl-expire-use-log
5416 @vindex wl-expire-use-log
5417 The initial setting is @code{nil}.
5418 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5419 They are appended but not truncated or rotated automatically; you might
5420 need to remove it manually.
5422 @item wl-expire-add-seen-list
5423 @vindex wl-expire-add-seen-list
5424 The initial setting is @code{t}.
5426 If non-nil, when messages are re-filed by expiration, read/unread
5427 information is passed to the destination folder.
5429 However if you do not read the destination folder from Wanderlust,
5430 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5431 want to set this to @code{nil} if you are simply saving to some
5432 archiving folders. Even if its value is @code{nil}, messages in the
5433 archiving folders are simply treated as unread; it does not affect
5436 @item wl-expire-folder-update-msgdb
5437 @vindex wl-expire-folder-update-msgdb
5438 The initial setting is @code{t}.
5439 If @code{t}, in the folder mode, expiration is carried out after
5440 updating summary information. If you specified a list of regular
5441 expressions of folder names, summary information is updated for matching
5446 @node Archive, , Expire, Expire and Archive
5447 @section Archiving Messages
5449 @subsection Archiving Messages
5450 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5451 folders. If there are the archiving folders already, only new messages
5454 You can use @code{wl-archive-alist} in order to specify how messages are
5455 archived according to their folder names, as in @code{wl-expire-alist}.
5460 (setq wl-archive-alist
5461 '(("^\\+tmp$" wl-archive-date)
5462 ("^\\+outbox$" wl-archive-number2)
5463 (".*" wl-archive-number1)))
5467 Each item in the list has the following format:
5470 (@var{folders-regexp} @var{deleting-function})
5473 As you can see, you can only use a function after @var{folders-regexp}.
5474 Per default, there are three functions:
5477 @item @code{wl-archive-number1}
5478 @item @code{wl-archive-number2}
5479 @item @code{wl-archive-date}
5482 As inferred from their names, they work similarly to "expire" versions,
5483 other than the following points:
5486 @item No messages are deleted
5487 @item Message numbers are retained even if invoked without arguments
5490 These functions are good to archive all messages in a folder by their
5491 numbers or by their dates.
5492 These are also useful for backup or confirmation purposes before
5494 If you try to re-file them after they are archived, they are deleted but
5497 Per default, the archiving folders to which messages are copied are
5498 determined automatically by @code{wl-expire-archive-get-folder-function}.
5499 You can copy to a specific folder by invoking with a prefix argument,
5500 i.e. @kbd{C-u M-x wl-summary-archive}.
5502 Note that this feature has not been seriously tested, because you can
5503 simply copy to an archiving folder, for example by
5504 @code{wl-summary-copy-region}.
5506 The archiving folders are determined by the same logic as in
5507 @code{wl-summary-expire}; the following customizable variables are
5511 @item @code{wl-expire-archive-files}
5512 @item @code{wl-expire-archive-get-folder-function}
5513 @item @code{wl-expire-archive-folder-name-fmt}
5514 @item @code{wl-expire-archive-folder-type}
5515 @item @code{wl-expire-archive-folder-prefix}
5516 @item @code{wl-expire-archive-folder-num-regexp}
5519 @subsection Customizable Variables
5522 @item wl-archive-alist
5523 @vindex wl-archive-alist
5524 The initial setting is the list shown below:
5528 ((".*" wl-archive-number1))
5533 This variable specifies a function that copies to archiving folders.
5534 To the function, three arguments are passed: a folder name, a list of
5535 messages in the folder, and msgdb information of the summary.
5536 Needless to say, you can use your own function.
5540 @node Scoring, Address Book, Expire and Archive, Top
5541 @chapter Score of the Messages
5543 @c @cindex Kill File
5545 Scoring is the function that associates a score (value) with each
5546 message, and marks as read or deletes from the summary according to it.
5548 You can put target or important marks on essential messages, or read marks
5549 on the ones you do not want to read, for example spam articles.
5551 This scoring function has a capability and a format similar to the one
5552 that Gnus has, although there are some unsupported features and
5553 Wanderlust specifics.
5554 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5557 * Score Commands:: Score Commands
5558 * Score File Format:: Score File Format
5562 @node Score Commands, Score File Format, Scoring, Scoring
5563 @section Score Commands
5564 @cindex Score Commands
5566 @subsection Score File Specification
5568 @code{wl-score-folder-alist} specifies score files or variables in which
5569 scores are defined, corresponding to folder names.
5573 (setq wl-score-folder-alist
5582 If paths to the score files are omitted, the directory specified in the
5583 variable @code{wl-score-files-directory} is assumed.
5585 No matter what you write in @code{wl-score-folder-alist}, the default
5586 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5587 read (it does not have to exist).
5588 Therefore, in the example above, the three score files,
5589 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5590 the folders that matches @samp{^-.*}.
5592 @subsection Scored Messages
5594 Scores are attached to the messages that are specified by
5595 @code{wl-summary-score-marks} temporarily when the summary is updated;
5596 when you exit from the summary, the scores are removed and reverts to
5599 @subsection Creation of Score Files
5601 In the summary buffer, move to an appropriate message and type @kbd{L}.
5602 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5603 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5605 This makes @minus{}1000 are scored for messages with the same
5606 @samp{Subject:} as the string you entered. That is, such a score file
5607 is created automatically.
5609 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5610 The score file you just made appears.
5611 This buffer is called @dfn{score editing buffer} thereafter.
5612 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5613 as you are previously; type @kbd{a}. Then a score entry for "From"
5615 In this way, you can create a score file easily either in the summary
5616 buffer or in the score editing buffer.
5618 By the way, you might be aware the numbers of key strokes are different
5619 between @kbd{s s p} and @kbd{a}.
5620 This is determined by @code{wl-score-header-default-entry}.
5621 This variable specifies the default score entries corresponding to
5623 For example, for "subject" field, a type and a time limit are prompted,
5624 but for "from" field, they are fixed upon automatically as substring and
5625 permanent respectively.
5626 However, score values can be modified by the prefix argument.
5627 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5630 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5631 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5632 erasing contents of the buffer deletes the score file being edited.
5636 @subsubsection Selecting Score Files
5638 You can change score files to which scores are appended by
5639 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5640 @code{wl-score-change-score-file}.
5642 @subsubsection Summing Up the Score
5644 If you add the same entries by @code{wl-summary-increase-score},
5645 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5646 scores for the entry is summed up.
5648 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5649 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5650 @minus{}1200 will be created as a result.
5652 @subsubsection Creating Thread Key
5654 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5655 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5657 @subsubsection Creating Followup Key
5659 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5660 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5661 at the cursor to @samp{References} key.
5662 If @code{wl-score-auto-make-followup-entry} is non-nil,
5663 @samp{Message-ID} of all messages to be followed up within dates
5664 specified by @code{wl-score-expiry-days}.
5666 @subsection Key Bindings
5671 @findex wl-summary-increase-score
5672 Increases the score for the current message.
5673 And the score entry is appended to the score file at the same moment.
5674 You can specify the score value by a prefix argument.
5678 @findex wl-summary-lower-score
5679 Decreases the score for the current message.
5680 And the score entry is appended to the score file at the same moment.
5681 You can specify the score value by a prefix argument.
5684 @kindex h R (Summary)
5685 @findex wl-summary-rescore
5686 Re-applies the scoring.
5687 However, already scored messages are not scored anew.
5690 @kindex h c (Summary)
5691 @findex wl-score-change-score-file
5692 Changes the score file currently selected.
5695 @kindex h e (Summary)
5696 @findex wl-score-edit-current-scores
5697 Edits the score file currently selected.
5698 If there are multiple score files, the previously specified one is
5702 @kindex h f (Summary)
5703 @findex wl-score-edit-file
5704 Edits an arbitrary score file and selects it.
5707 @kindex h F (Summary)
5708 @findex wl-score-flush-cache
5709 Erases caches associated to the score files that are read.
5710 If you modified score files directly (from other than Wanderlust), you
5711 need to re-read them after erasing the cache.
5714 @kindex h m (Summary)
5715 @findex wl-score-set-mark-below
5716 Specifies the criterion for scores to be marked as read.
5717 Messages with scores less than this value are marked as read.
5720 @kindex h x (Summary)
5721 @findex wl-score-set-expunge-below
5722 Specifies the criterion for scores to be deleted from the summary.
5723 Messages with scores less than this value are deleted.
5724 "Deleted" means it is not shown; they are not removed from the summary
5725 information or the folder.
5726 The deleted messages can be shown by rescan-noscore again.
5729 @subsection Key Bindings in the Score Editing Buffer
5733 @kindex C-c C-k (Score Mode)
5734 @findex wl-score-edit-kill
5735 Abandons the file being edited.
5738 @kindex C-c C-c (Score Mode)
5739 @findex wl-score-edit-exit
5740 Saves the file being edited, and quits from the edit mode.
5743 @kindex C-c C-p (Score Mode)
5744 @findex wl-score-pretty-print
5748 @kindex C-c C-d (Score Mode)
5749 @findex wl-score-edit-insert-date
5750 Inserts the number of dates from Dec. 31, 1 B.C.
5751 It is used for creating the third factor of time-limited scores.
5754 @kindex C-c C-s (Score Mode)
5755 @findex wl-score-edit-insert-header
5756 Inserts the header of the message selected in the summary buffer.
5759 @kindex C-c C-e (Score Mode)
5760 @findex wl-score-edit-insert-entry
5761 Inserts the score entry of the message selected in the summary buffer.
5764 @subsection Customizable Variables
5767 @item wl-summary-default-score
5768 @vindex wl-summary-default-score
5769 The initial setting is 0 (zero).
5770 This variable specifies the default value of the score.
5771 The score is increased or decreased based upon this value.
5773 @item wl-summary-important-above
5774 @vindex wl-summary-important-above
5775 The initial setting is @code{nil}.
5776 Messages with scores larger than this value are attached with the
5777 important mark (@samp{$}).
5778 If @code{nil}, no important marks are attached.
5780 @item wl-summary-target-above
5781 @vindex wl-summary-target-above
5782 The initial setting is @code{nil}.
5783 Messages with scores larger than this value are attached with the target
5785 If @code{nil}, no target marks are attached.
5787 @item wl-summary-mark-below
5788 @vindex wl-summary-mark-below
5789 The initial setting is 0 (zero).
5790 Messages with scores smaller than this value are marked as read.
5792 @item wl-summary-expunge-below
5793 @vindex wl-summary-expunge-below
5794 The initial setting is @code{nil}.
5795 Messages with scores smaller than this value are deleted from the
5797 If @code{nil}, they are not deleted.
5799 @item wl-summary-score-marks
5800 @vindex wl-summary-score-marks
5801 The initial setting is the list shown below:
5805 (list wl-summary-new-mark)
5810 Messages with these marks are scored.
5812 @item wl-use-scoring
5813 @vindex wl-use-scoring
5814 The initial setting is t.
5815 If non-nil, scoring is enabled.
5817 @item wl-score-files-directory
5818 @vindex wl-score-files-directory
5819 The initial setting is @file{~/.elmo/}.
5820 The default directory for score files.
5822 @item wl-score-interactive-default-score
5823 @vindex wl-score-interactive-default-score
5824 The initial setting is 1000.
5825 This value is used as a score when a score factor is @code{nil} in the
5826 score file. It is also used in @code{wl-summary-increase-score} and
5827 @code{wl-summary-lower-score}, on condition that the value of
5828 @code{wl-score-header-default-entry} is @code{nil}.
5830 @item wl-score-expiry-days
5831 @vindex wl-score-expiry-days
5832 The initial setting is 7.
5833 This is the number of days before time-limited scores are deleted.
5835 @item wl-score-update-entry-dates
5836 @vindex wl-score-update-entry-dates
5837 The initial setting is @code{t}.
5838 If non-nil, it enables deletion of time-limited scores.
5840 @item wl-score-header-default-entry
5841 @vindex wl-score-header-default-entry
5842 Specifies the default value for each header field for score entries
5843 created by @code{wl-summary-increase-score},
5844 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5846 @item wl-score-simplify-fuzzy-regexp
5847 @vindex wl-score-simplify-fuzzy-regexp
5848 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5849 regular expression to be deleted from the string.
5850 Because this is usually used for Subject, the default is prefixes that
5851 are attached by mailing list programs.
5853 @item wl-summary-rescore-partial-threshold
5854 @vindex wl-summary-rescore-partial-threshold
5855 The initial setting is 200.
5856 When sync-all or rescan is executed, if there are messages more than
5857 this value, only the last same number of messages as this value are
5860 @item wl-summary-auto-sync-marks
5861 @vindex wl-summary-auto-sync-marks
5862 If non-nil, unread/important marks are synchronized when the summary
5864 Unread marks reflect information on the IMAP4 server.
5865 Important marks reflect information on the IMAP4 server (flagged or
5866 not), and contents of @samp{'mark} folder.
5867 The initial setting is @code{t}.
5871 @node Score File Format, , Score Commands, Scoring
5872 @section Score File Format
5873 @cindex Score File Format
5875 The format of score files are the same as Gnus, and basically you can
5876 use Gnus score files as they are. But they are not fully compatible
5877 because some keys are not supported and there are Wanderlust specifics.
5878 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5883 ("for sale" -1000 nil s)
5884 ("profit" -1000 nil s))
5886 ("spam@@spamspamspam" -10000 nil s))
5888 ("my@@address" 3001 nil s))
5890 (1000000 -10 nil >))
5900 If the key is a string, it is the name of the header to be matched.
5901 The following keys are available:
5902 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5903 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5904 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5905 @code{Chars} and @code{Lines} mean the size and the number of lines of
5906 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5907 are described later.
5908 The rest corresponds the field of the same name.
5910 Arbitrary numbers of core entries are specified after the key.
5911 Each score entry consists of these five factors:
5915 A factor that matches header. This should be a number in the cases of
5916 @code{lines} and @code{chars}, otherwise a string.
5919 A score factor. When the first item matches, the score of the message
5920 is increased or decreased by this value.
5923 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5924 of a number, the score is deleted if it does not match for days
5925 (@code{wl-score-expiry-days}) from the date specified by this.
5926 The date is since Dec. 31, 1 B.C.
5929 A type factor. This specifies the way the first factor matches.
5930 Available types depend on keys.
5933 @item From, Subject, References, Message-ID
5934 For these keys in string, @code{r} and @code{R} (regexp),
5935 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5936 as well as @code{f} and @code{F} (fuzzy) can be used.
5937 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5940 For these keys, the following five numerical relative operators can be
5941 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5944 This key matches @code{From} header, and scores all follow-ups to the
5946 For example, it would be useful for increasing scores for follow-ups to
5949 You can use the same types as @code{From} except for @code{f}.
5950 And a @samp{Followup} entry is automatically appended to the score file.
5953 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5954 A @samp{Thread} entry is automatically appended for each article that
5955 has @var{x} in the @code{References} header.
5956 You can make sure the whole thread including messages that does not have
5957 all ancestors @code{Message-ID} in @code{References} is scored.
5959 You can use the same types as @code{References} except for @code{f}.
5960 And a @samp{Thread} entry is automatically appended to the score file.
5964 A factor for extension header. This is meaningful only if the key is
5966 This specifies headers to be matched other than standard headers like
5967 @code{Subject} and @code{From}.
5968 Note that you should specify the header in
5969 @code{elmo-msgdb-extra-fields} also.
5970 Therefore it does not work in folders where extension headers cannot be
5975 The sum of these scores @emph{after all factors are applied} becomes the
5976 score of the message.
5978 @cindex Score File Atoms
5980 Messages with a score less than this value is marked as read.
5981 The default is @code{wl-summary-mark-below}.
5984 Messages with a score less than this value is deleted from the summary.
5985 The default is @code{wl-summary-expunge-below}.
5987 @item mark-and-expunge
5988 Both @code{mark} and @code{expunge} are applied,
5989 i.e. messages with a score less than this value is marked as read and
5990 deleted from the summary.
5993 Messages with a score greater than this value is attached with temp
5995 The default is @code{wl-summary-target-above}.
5998 Messages with a score greater than this value is attached with important
6000 The default is @code{wl-summary-important-above}.
6005 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6006 are used, you need to set @code{elmo-msgdb-extra-fields}.
6009 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6012 There are other restrictions as shown below:
6015 @item Because @samp{References} field in the summary information
6016 contains only the last @samp{Message-ID}, @code{references} key matches
6020 Keys that can be seen by folder of types:
6024 chars lines xref extra
6025 localdir,localnews Y E E E
6026 nntp (supporting xover) Y E E N
6032 N: cannot be seen (ignored)
6033 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6038 @node Address Book, Customization, Scoring, Top
6039 @chapter Address Book
6040 @cindex Address Book
6042 With address book, you can utilize address completion, and you have
6043 summary displayed with nicknames.
6046 * Mail Addresses:: Definition of Address Book
6047 * Address Manager:: Address Manager
6050 @node Mail Addresses, Address Manager, Address Book, Address Book
6051 @section Address book
6052 @cindex Address book Definition
6054 @cindex Alias, Address
6056 The file @file{~/.addresses} is a simple address book for Wanderlust.
6057 Make address file @file{~/.addresses}, and edit to suit your requirement.
6059 The data written in @file{~/.addresses} are used for address completion
6060 under draft editing mode. Furthermore, they are used when showing names
6061 in summary display mode. You can safely skip this section, if you don't
6062 want to customize address completion and summary display.
6063 It is possible to add/change/remove addresses from @file{~/.addresses} in
6064 summary buffer after Wanderlust is invoked. @refill
6066 The format is very simple. Like this. @refill
6071 # @r{Lines begin with @samp{#} are comment.}
6072 # @r{Empty lines are ignored}
6074 # @r{Format of each line:}
6075 # @var{email-address} "@var{nickname} "@var{realname}"
6077 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6078 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6079 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6084 One line defines one persons description.
6086 Actually, in default setup, @var{nickname} is used in summary-mode and
6087 @var{realname} is used in draft preparation mode. This behavior is
6088 better understood if you try it and confirmed the function first. You
6089 can write and try a small definition, so you will know the idea of the
6090 address book before writing a big one.
6092 And, if MH alias file is specified in variable @code{wl-alias-file},
6093 it is used as an address information in the draft preparation mode.
6095 If variable @code{wl-use-ldap} is non-nil (initial setting is
6096 @code{nil}), address completion in draft mode uses LDAP information.
6098 If you use LDAP, you have to set @code{wl-ldap-server},
6099 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6100 not have LDAP feature as built-in feature (Currently only XEmacs can
6101 have built-in LDAP feature), you have to set command exec @env{PATH} to
6102 the program @command{ldapsearch}.
6105 @node Address Manager, , Mail Addresses, Address Book
6106 @section Address Manager
6107 @cindex Address Manager
6109 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6110 the address book and insert address to draft buffer.
6112 @subsection Key Bindings
6116 @kindex t (Address Manager)
6117 @findex wl-addrmgr-set-to
6118 Add @samp{To:} mark.
6121 @kindex c (Address Manager)
6122 @findex wl-addrmgr-set-cc
6123 Add @samp{Cc:} mark.
6126 @kindex b (Address Manager)
6127 @findex wl-addrmgr-set-bcc
6128 Add @samp{Bcc:} mark.
6131 @kindex u (Address Manager)
6132 @findex wl-addrmgr-unmark
6136 @kindex x (Address Manager)
6137 @findex wl-addrmgr-apply
6139 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6140 buffer and quit address manager. When no draft buffer, make new draft
6141 with insert marked addresses.
6143 If no mark, quit address manager.
6147 @kindex q (Address Manager)
6148 @findex wl-addrmgr-quit
6149 Quit address manager.
6152 @kindex a (Address Manager)
6153 @findex wl-addrmgr-add
6157 @kindex d (Address Manager)
6158 @findex wl-addrmgr-delete
6162 @kindex e (Address Manager)
6163 @findex wl-addrmgr-edit
6168 @node Customization, Mailing List, Address Book, Top
6169 @chapter Customizing Wanderlust
6170 @cindex Customization
6173 * Living with other packages:: Cooperating with other packages
6174 * Highlights:: Highlights
6175 * Biff:: Notify Mail arrival
6176 * Advanced Settings:: Advanced Settings
6177 * Customizable Variables:: Customizable Variables
6182 @node Living with other packages, Highlights, Customization, Customization
6183 @section Living with other packages
6185 Examples with other packages.
6188 * imput:: imput (im-wl.el)
6190 * supercite:: supercite.el
6191 * mu-cite:: mu-cite.el
6192 * X-Face:: x-face,bitmap-mule
6193 * dired-dd:: dired-dd.el
6195 * Addrbook:: Addrbook
6196 * mime-w3m:: mime-w3m.el
6200 @node imput, BBDB, Living with other packages, Living with other packages
6205 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6208 If @command{imput} is on the @code{exec-path} at the installation,
6209 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6213 (autoload 'wl-draft-send-with-imput-async "im-wl")
6214 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6219 @node BBDB, supercite, imput, Living with other packages
6223 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6226 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6227 byte-compiled and installed.
6235 ;; @r{enable pop-ups}
6236 (setq bbdb-use-pop-up t)
6237 ;; @r{auto collection}
6238 (setq bbdb/mail-auto-create-p t)
6239 (setq signature-use-bbdb t)
6240 (setq bbdb-north-american-phone-numbers-p nil)
6241 ;; @r{shows the name of bbdb in the summary} :-)
6242 (setq wl-summary-from-function 'bbdb-wl-from-func)
6243 ;; @r{automatically add mailing list fields}
6244 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6245 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6249 You can complete address with BBDB by @kbd{M-@key{TAB}}
6253 @node supercite, mu-cite, BBDB, Living with other packages
6254 @subsection sc.el(supercite), sc-register.el
6258 The same setting as usual mailers should be OK. The following is an
6259 example of settings:
6263 (autoload 'sc-cite-original "supercite" nil t)
6264 (add-hook 'mail-citation-hook 'sc-cite-original)
6269 @node mu-cite, X-Face, supercite, Living with other packages
6270 @subsection mu-cite.el
6273 The same setting as usual mailers should be OK. The following is an
6274 example of settings.
6276 If you use mu-cite version 8.0 or earlier:
6280 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6281 (setq mail-citation-hook 'mu-cite/cite-original)
6285 If you use mu-cite version 8.1 or later:
6289 (autoload 'mu-cite-original "mu-cite" nil t)
6290 (add-hook 'mail-citation-hook (function mu-cite-original))
6294 @node X-Face, dired-dd, mu-cite, Living with other packages
6298 If you have installed one of the following, you can decode
6299 @samp{X-Face:} field in message buffer and you will see face image.
6302 * x-face-xmas:: XEmacs case
6303 * x-face-mule:: Emacs case
6306 If there is an encoded X-Face string in a file @file{~/.xface} (the
6307 value of the variable @code{wl-x-face-file}), it is inserted as a
6308 @samp{X-Face:} field in the draft buffer (if
6309 @code{wl-auto-insert-x-face} is non-nil).
6311 @node x-face-xmas, x-face-mule, X-Face, X-Face
6312 @subsubsection x-face-xmas (for XEmacs)
6315 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6316 1.3.6.13 or later, do the following:
6320 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6321 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6325 @node x-face-mule, , x-face-xmas, X-Face
6326 @subsubsection x-face-mule (for Emacs)
6330 If you use @file{x-face-mule.el} in bitmap-mule
6331 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6335 (autoload 'x-face-decode-message-header "x-face-mule")
6336 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6340 @subsubsection x-face-e21 (for Emacs 21.x)
6343 With Emacs 21.x, you can use @file{x-face-e21.el}
6344 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6345 to display X-Face. In this case, bitmap-mule is not required.
6350 (autoload 'x-face-decode-message-header "x-face-e21")
6351 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6356 @node dired-dd, MHC, X-Face, Living with other packages
6357 @subsection dired-dd(Dired-DragDrop)
6358 @pindex Dired-DragDrop
6360 @cindex Drag and Drop
6362 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6363 compose multi-part by simple Drag-and-Drop from dired to the draft
6364 buffer being edited in GNU Emacs (this feature is not Wanderlust
6365 specific, but general-purpose for SEMI).
6369 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6375 ;; @r{Set dired-x variables here.}
6376 ;; @r{To and flo@dots{}}
6378 (progn (require 'dired-dd)
6379 (require 'dired-dd-mime))))))
6383 @node MHC, Addrbook, dired-dd, Living with other packages
6387 Message Harmonized Calendaring system
6388 (@uref{http://www.quickhack.net/mhc/})
6390 By using MHC, you can make a calendar from the messages.
6396 (setq mhc-mailer-package 'wl)
6397 (autoload 'mhc-mode "mhc" nil t)
6398 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6399 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6407 (autoload 'mhc-wl-setup "mhc-wl")
6408 (add-hook 'wl-init-hook 'mhc-wl-setup)
6412 @node Addrbook, mime-w3m, MHC, Living with other packages
6413 @subsection wl-addrbook.el
6417 (@uref{http://www.mew.org/})
6419 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6420 @code{load-path} and do the following settings.
6424 (require 'wl-addrbook)
6429 @node mime-w3m, , Addrbook, Living with other packages
6430 @subsection mime-w3m.el
6433 You can display html part by using @file{mime-w3m.el}
6434 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6435 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6438 @node Highlights, Biff, Living with other packages, Customization
6441 @subsection Customizable Variables
6444 @item wl-summary-highlight
6445 @vindex wl-summary-highlight
6446 The initial setting is @code{t}.
6447 If non-nil, the summary is highlighted.
6449 @item wl-highlight-max-summary-lines
6450 @vindex wl-highlight-max-summary-lines
6451 The initial setting is 10000.
6452 The summary is not highlighted if it has more lines than this value.
6454 @item wl-summary-highlight-partial-threshold
6455 @vindex wl-summary-highlight-partial-threshold
6456 The initial setting is 1000.
6457 This is a threshold whether the whole summary is highlighted.
6458 If there are more lines of messages in the summary, it is partially
6461 @item wl-summary-partial-highlight-above-lines
6462 @vindex wl-summary-partial-highlight-above-lines
6463 The initial setting is 30. If there are more lines of messages than
6464 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6465 after the point that is the same number of lines as this value above the
6466 cursor line are highlighted partially. (If this value is @code{nil},
6467 the last same number of lines as the value of
6468 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6470 @item wl-highlight-body-too
6471 @vindex wl-highlight-body-too
6472 The initial setting is @code{t}.
6473 If non-nil, bodies of drafts and messages are also highlighted.
6475 @item wl-highlight-message-header-alist
6476 @vindex wl-highlight-message-header-alist
6477 When highlighting headers of drafts and messages, this variable
6478 specifies which faces are allocated to important
6479 (@code{wl-highlight-message-important-header-contents}), secondly
6480 important (@code{wl-highlight-message-important-header-contents2}), and
6481 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6483 Similarly, it can be used for allocating arbitrary faces to arbitrary
6484 regular expressions.
6486 @item wl-highlight-citation-prefix-regexp
6487 @vindex wl-highlight-citation-prefix-regexp
6488 Specifies a regular expression to which quoted lines in bodies of
6489 drafts and messages match.
6490 Bodies matching to this regular expression are highlighted by the faces
6491 specified by (@code{wl-highlight-message-cited-text-*}).
6493 @item wl-highlight-highlight-citation-too
6494 @vindex wl-highlight-highlight-citation-too
6495 The initial setting is @code{nil}.
6496 If non-nil, the quoting regular expression itself given by
6497 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6499 @item wl-highlight-citation-header-regexp
6500 @vindex wl-highlight-citation-header-regexp
6501 Specifies a regular expression that denotes beginning of quotation.
6502 Bodies matching to this regular expression are highlighted by the face
6503 specified by @code{wl-highlight-message-headers}.
6505 @item wl-highlight-max-header-size
6506 @vindex wl-highlight-max-header-size
6507 The initial setting is @code{nil}. If a header size is larger than this
6508 value, it will not be highlighted. If @code{nil}, always highlighted
6509 (ignore header size).
6511 @item wl-highlight-max-message-size
6512 @vindex wl-highlight-max-message-size
6513 The initial setting is 10000.
6514 If a message is larger than this value, it will not be highlighted.
6515 With this variable, highlight is suppressed for uuencode or huge digest
6518 @item wl-highlight-signature-separator
6519 @vindex wl-highlight-signature-separator
6520 Specifies regular expressions that denotes the boundary of a signature.
6521 It can be a regular expression, or a list of ones.
6522 Messages after the place that matches this regular expression are
6523 highlighted by the face specified by
6524 @code{wl-highlight-message-signature}.
6526 @item wl-max-signature-size
6527 @vindex wl-max-signature-size
6528 The initial setting is 400.
6529 This is the largest size for a signature to be highlighted.
6531 @item wl-use-highlight-mouse-line
6532 @vindex wl-use-highlight-mouse-line
6533 The initial setting is @code{t}.
6534 If non-nil, the line pointed by the mouse is highlighted in the folder
6535 mode, summary mode, and the like.
6538 @subsection Setting Colors and Fonts of the Characters
6540 If you want to change colors or fonts of the characters, you need to
6541 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6542 want to change fonts, and @code{set-face-foreground} for colors, and so
6543 on. You cannot write face settings in @file{.emacs}; write in
6546 For example, if you want to change the color for signatures to yellow,
6550 (set-face-foreground 'wl-highlight-message-signature "yellow")
6556 Faces defined in Wanderlust:
6559 @item wl-highlight-message-headers
6560 The face for field names of message headers.
6562 @item wl-highlight-message-header-contents
6563 The face for field bodies of message headers.
6565 @item wl-highlight-message-important-header-contents
6566 The face for important parts of message headers.
6567 Per default, this face is used for a body of @samp{Subject:} field.
6568 You can change its value by editing
6569 @code{wl-highlight-message-header-alist}.
6571 @item wl-highlight-message-important-header-contents2
6572 The face for secondly important parts of message headers.
6573 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6574 fields. You can change its value by editing
6575 @code{wl-highlight-message-header-alist}.
6577 @item wl-highlight-message-unimportant-header-contents
6578 The face for unimportant parts of message headers.
6579 Per default, this face is used for bodies of @samp{X-} fields
6580 @samp{User-Agent:} fields. You can change its value by editing
6581 @code{wl-highlight-message-header-alist}.
6583 @item wl-highlight-message-citation-header
6584 The face for headers of quoted messages.
6586 @item wl-highlight-message-cited-text-*
6587 The face for texts of quoted messages. The last @samp{*} is a
6588 @var{single figure} so that 10 different colors can be used according to
6591 @item wl-highlight-message-signature
6592 The face for signatures of messages. The initial settings are
6593 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6594 dark background colors.
6596 @item wl-highlight-header-separator-face
6597 The face for header separators of draft messages.
6599 @item wl-highlight-summary-important-face
6600 The face for message lines with important marks in the summary.
6602 @item wl-highlight-summary-new-face
6603 The face for message lines with new marks in the summary.
6605 @item wl-highlight-summary-displaying-face
6606 The face for the message line that is currently displayed.
6607 This face is overlaid.
6609 @item wl-highlight-thread-indent-face
6610 The face for the threads that is currently displayed.
6612 @item wl-highlight-summary-unread-face
6613 The face for message lines with unread marks in the summary.
6615 @item wl-highlight-summary-deleted-face
6616 The face for message lines with delete marks in the summary.
6618 @item wl-highlight-summary-refiled-face
6619 The face for message lines with re-file marks in the summary.
6621 @item wl-highlight-refile-destination-face
6622 The face for re-file information part of message lines with re-file
6623 marks in the summary.
6625 @item wl-highlight-summary-copied-face
6626 The face for message lines with copy marks in the summary.
6628 @item wl-highlight-summary-target-face
6629 The face for message lines with target marks @samp{*} in the summary.
6631 @item wl-highlight-summary-thread-top-face
6632 The face for message lines that are on the top of the thread in the
6635 @item wl-highlight-summary-normal-face
6636 The face for message lines that are not on top of the thread in the
6639 @item wl-highlight-folder-unknown-face
6640 The face for folders that are not known to have how many unsync messages
6643 @item wl-highlight-folder-zero-face
6644 The face for folders that have no unsync messages in the folder mode.
6646 @item wl-highlight-folder-few-face
6647 The face for folders that have some unsync messages in the folder mode.
6649 @item wl-highlight-folder-many-face
6650 The face for folders that have many unsync messages in the folder mode.
6651 The boundary between `some' and `many' is specified by the variable
6652 @code{wl-folder-many-unsync-threshold}.
6654 @item wl-highlight-folder-unread-face
6655 The face for folders that have no unsync but unread messages in the
6658 @item wl-highlight-folder-killed-face
6659 The face for folders that are deleted from the access group in the
6662 @item wl-highlight-folder-opened-face
6663 The face for open groups in the folder mode.
6664 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6665 @code{nil} or a @var{number}.
6667 @item wl-highlight-folder-closed-face
6668 The face for close groups in the folder mode.
6669 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6670 @code{nil} or a @var{number}.
6672 @item wl-highlight-folder-path-face
6673 The face for the path to the currently selected folder in the folder
6676 @item wl-highlight-logo-face
6677 The face for logo in the demo.
6679 @item wl-highlight-demo-face
6680 The face for strings (for example, a version number) in the demo.
6684 @node Biff, Advanced Settings, Highlights, Customization
6685 @section Notify Mail arrival
6688 Following setting is to notify mail arrival of @samp{%inbox}
6689 by the indicator on the modeline
6692 (setq wl-biff-check-folder-list '("%inbox"))
6695 @subsection Customizable Variables
6697 @item wl-biff-check-folder-list
6698 @vindex wl-biff-check-folder-list
6699 The initial setting is @code{nil}.
6700 This is the list of folders to check mail arrival.
6701 If @code{nil}, wl doesn't check mail arrival.
6703 @item wl-biff-check-interval
6704 @vindex wl-biff-check-interval
6705 The initial setting is 40 (in seconds).
6706 Check mail arrival in this period.
6708 @item wl-biff-notify-hook
6709 @vindex wl-biff-notify-hook
6710 This hook is run at the arrival of new mail.
6711 To beep with mail arrival(initial setting), set as follows.
6713 (setq wl-biff-notify-hook '(ding))
6715 For silence, set to @code{nil}.
6719 @node Advanced Settings, Customizable Variables, Biff, Customization
6720 @section Advanced Settings
6723 * Draft for Reply:: Draft for Reply
6724 * Thread Format:: Appearance of Thread
6725 * User-Agent Field:: @samp{User-Agent:} Header Field
6729 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6730 @subsection Draft for Replay
6731 @vindex wl-draft-reply-with-argument-list
6732 @vindex wl-draft-reply-without-argument-list
6733 @vindex wl-draft-reply-myself-with-argument-list
6734 @vindex wl-draft-reply-myself-without-argument-list
6736 If you want, when you replying to articles in mailing lists, the address
6737 in Reply-To field of the original message to be prepared to To field of
6738 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6743 (setq wl-draft-reply-without-argument-list
6744 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6745 ("Followup-To" . (nil nil ("Followup-To")))
6746 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6747 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6752 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6753 in the original message, @samp{Reply-To:} field in the original is
6754 copied to @samp{To:} field.)
6756 Moreover, the behavior of @kbd{a} with prefix argument can
6757 be directed by @code{wl-draft-reply-with-argument-list} as well.
6759 Note: To set the behavior when you reply to the message written by yourself, use
6760 @code{wl-draft-reply-myself-without-argument-list} and
6761 @code{wl-draft-reply-myself-with-argument-list}
6764 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6765 @subsection Appearance of Threads
6769 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6770 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6771 391 09/18(Fri)19:24 +-[ Murata-san ]
6772 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6773 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6774 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6775 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6776 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6777 412 09/22(Tue)09:28 | +-[ Teranishi ]
6778 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6779 416 09/22(Tue)12:38 | +-[ Teranishi ]
6780 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6781 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6785 Settings to make appearance of threads like shown above:
6789 (setq wl-thread-indent-level 2)
6790 (setq wl-thread-have-younger-brother-str "+")
6791 (setq wl-thread-youngest-child-str "+")
6792 (setq wl-thread-vertical-str "|")
6793 (setq wl-thread-horizontal-str "-")
6794 (setq wl-thread-space-str " ")
6798 If you do not want to see branches, do the following:
6802 (setq wl-thread-indent-level 2)
6803 (setq wl-thread-have-younger-brother-str " ")
6804 (setq wl-thread-youngest-child-str " ")
6805 (setq wl-thread-vertical-str " ")
6806 (setq wl-thread-horizontal-str " ")
6807 (setq wl-thread-space-str " ")
6812 @node User-Agent Field, , Thread Format, Advanced Settings
6813 @subsection User-Agent Field
6817 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6818 @samp{User-Agent:} fields, define a function that generate appropriate
6819 strings as you like, and set it to variable
6820 @code{wl-generate-mailer-string-function}.
6822 If you do not want verbose @samp{User-Agent:} field, do the following:
6826 (setq wl-generate-mailer-string-function
6829 (concat "User-Agent: "
6830 (wl-generate-user-agent-string-1 nil)))))
6834 The following is a example:
6838 (setq mime-edit-insert-user-agent-field nil)
6839 (setq wl-generate-mailer-string-function
6842 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6847 @node Customizable Variables, Hooks, Advanced Settings, Customization
6848 @section Customizable Variables
6850 Customizable variables that have not been described yet:
6853 @item wl-default-folder
6854 @vindex wl-default-folder
6855 The initial setting is @samp{%inbox}. This is the default value for moving to
6856 a folder and the like.
6858 @item wl-draft-folder
6859 @vindex wl-draft-folder
6860 The initial setting is @samp{+draft}. It is the folder to which drafts are
6861 saved. It must be a localdir folder.
6863 @item wl-trash-folder
6864 @vindex wl-trash-folder
6865 The initial setting is @samp{+trash}. It is the wastebasket folder.
6866 If you changed this variable, you had better restart Wanderlust.
6868 @item wl-interactive-exit
6869 @vindex wl-interactive-exit
6870 The initial setting is @code{t}.
6871 If non-nil, you are asked for confirmation when Wanderlust terminates.
6873 @item wl-interactive-send
6874 @vindex wl-interactive-send
6875 The initial setting is @code{t}.
6876 If non-nil, you are asked for confirmation when mail is sent.
6878 @item wl-folder-sync-range-alist
6879 @vindex wl-folder-sync-range-alist
6880 The initial setting is the alist shown below:
6885 ("^\\+draft$\\|^\\+queue$" . "all"))
6890 This is an associative list of regular expressions of folder names and
6891 update range of the summary. Update range is one of the @samp{all},
6892 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6893 @samp{last}. If a folder do not match, @samp{update} is used.
6896 @vindex wl-ask-range
6897 The initial setting is @code{t}.
6898 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6899 for updating the summary when you changed folders.
6901 @item wl-mime-charset
6902 @vindex wl-mime-charset
6903 The initial setting is @code{x-ctext}.
6904 This is the MIME charset for messages that are not MIME (e.g. without
6905 @samp{Content-Type:}). This value also used as default charset for
6906 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6907 this value as @code{iso-2022-jp}.)
6909 @item wl-highlight-folder-with-icon
6910 @vindex wl-highlight-folder-with-icon
6911 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6912 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6914 @item wl-strict-diff-folders
6915 @vindex wl-strict-diff-folders
6916 This is a list of regular expressions of folders.
6917 Unread messages are checked, for example when you press @kbd{s} in
6918 the folder mode, usually in a brief way (rapidly processed but not
6920 The folders matching this variable are seriously checked.
6921 You may want to set this variable so as to match conditional filter
6922 folders for IMAP4 folders.
6923 The initial setting is @code{nil}.
6925 @item wl-folder-use-server-diff
6926 @vindex wl-folder-use-server-diff
6927 When unread messages are checked, for example when you press @kbd{s} in
6928 the folder mode, usually (the number of messages on the server) @minus{}
6929 (the number of local messages) will be the number of unread messages.
6930 However, if this variable is non-nil, the number of unread messages on
6931 the server is checked. This affects IMAP4 folders only, but IMAP4
6932 folders in mail boxes matching
6933 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6934 the number of unread messages on the server, even if they matches this
6935 variable. The initial setting is @code{t}.
6937 @item wl-auto-check-folder-name
6938 @vindex wl-auto-check-folder-name
6939 The initial setting is @code{nil}.
6940 If non-nil, the folder with the name of the value is checked for unread
6941 messages at the start.
6942 If it is @code{none}, no folders are checked.
6943 If it is a list, all folders in the list are checked at the start.
6945 @item wl-auto-uncheck-folder-list
6946 @vindex wl-auto-uncheck-folder-list
6947 The initial setting is the list shown below:
6956 Folders with the name matching this variable are not checked for unread
6957 messages at the start, even if they are included in the groups in
6958 @code{wl-auto-check-folder-name}.
6960 @item wl-auto-check-folder-list
6961 @vindex wl-auto-check-folder-list
6962 The initial setting is @code{nil}.
6963 Folders with the name matching this variable are always checked for
6964 unread messages at the start, if they are included in the groups in
6965 @code{wl-auto-check-folder-name}.
6966 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6968 @item wl-no-save-folder-list
6969 @vindex wl-no-save-folder-list
6970 The initial setting is the list shown below:
6979 This is a list of regular expressions of folders not to be saved.
6981 @item wl-save-folder-list
6982 @vindex wl-save-folder-list
6983 The initial setting is @code{nil}.
6984 This is a list of regular expressions of folders to be saved.
6985 This takes precedence over @code{wl-no-save-folder-list}.
6987 @item wl-folder-mime-charset-alist
6988 @vindex wl-folder-mime-charset-alist
6989 The initial setting is the alist shown below:
6993 (("^-alt\\.chinese" . big5)
6994 ("^-relcom\\." . koi8-r)
6996 ("^-han\\." . euc-kr))
7001 This is an associative list of regular expressions of folder names and
7003 If a folder do not match, @code{wl-mime-charset} is used.
7005 @item wl-folder-init-load-access-folders
7006 @vindex wl-folder-init-load-access-folders
7007 The initial setting is @code{nil}.
7008 This is a list of access groups to be loaded specifically at the start.
7009 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7011 @item wl-folder-init-no-load-access-folders
7012 @vindex wl-folder-init-no-load-access-folders
7013 The initial setting is @code{nil}.
7014 This is a list of access groups not to be loaded specifically at the
7016 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7018 @item wl-delete-folder-alist
7019 @vindex wl-delete-folder-alist
7020 The initial setting is the alist shown below:
7029 This list determines disposition of messages with delete marks.
7030 Each item in the list is a folder and destination; you can specify any
7031 one of the following in the place of destination:
7034 @code{remove} or @code{null} : deletes the messages instantly.
7035 string : moves the messages to the specific folder.
7036 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7039 @item wl-refile-policy-alist
7040 @vindex wl-refile-policy-alist
7041 The initial setting is the list shown below:
7051 This list determines whether messages with re-file marks are moved or
7052 copied. Each item in the list is a cons cell of a folder and
7053 @code{copy} or @code{move}.
7055 @item wl-x-face-file
7056 @vindex wl-x-face-file
7057 The initial setting is @file{~/.xface}.
7058 The name of the file that contains encoded X-Face strings.
7061 @item wl-demo-display-logo
7062 @vindex wl-demo-display-logo
7063 If non-nil, bitmap image is shown on the opening demo. If you set
7064 @code{xpm} or @code{xbm}, (if possible) display selected image type
7067 @item elmo-use-database
7068 @vindex elmo-use-database
7069 This is meaningful for XEmacs only. The initial setting depends on
7070 XEmacs (@code{t} for XEmacs with dbm).
7071 If non-nil, Message-ID is controlled by dbm.
7073 @item elmo-passwd-alist-file-name
7074 @vindex elmo-passwd-alist-file-name
7075 The initial setting is @file{passwd}.
7076 This is the name of the file in which passwords are saved.
7077 @code{elmo-passwd-alist-save} saves current passwords to the file.
7079 @item elmo-nntp-list-folders-use-cache
7080 @vindex elmo-nntp-list-folders-use-cache
7081 The initial setting is 600 (in seconds).
7082 This is period in seconds during which results of @samp{list} and
7083 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7086 @item elmo-nntp-max-number-precedes-list-active
7087 @vindex elmo-nntp-max-number-precedes-list-active
7088 The initial setting is @code{nil}.
7089 If non-nil, the number of article obtained by @samp{list active} in NNTP
7090 are used as the maximum article number of the folder.
7091 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7092 and if the number of read messages is not correct.
7094 @item elmo-nntp-default-use-listgroup
7095 @vindex elmo-nntp-default-use-listgroup
7096 The initial setting is @code{t}.
7097 If non-nil, @samp{listgroup} is used for checking the total number of
7098 articles. If it is @code{nil}, @samp{group} is used. In the latter
7099 case, the processing will be a little faster at the sacrifice of
7102 @item elmo-pop3-send-command-synchronously
7103 @vindex elmo-pop3-send-command-synchronously
7104 The initial setting is @code{nil}.
7105 If non-nil, POP3 commands are issued synchronously. Some implementation
7106 of POP3 server fails to get summary information without this setting.
7107 You may have to set this variable to @code{t}, if the process hangs
7108 while looking up POP3.
7110 @item elmo-dop-flush-confirm
7111 @vindex elmo-dop-flush-confirm
7112 The initial setting is @code{t}.
7113 If non-nil, you are asked for confirmation if accumulated off-line
7114 operations are executed.
7116 @item elmo-display-progress-threshold
7117 @vindex elmo-display-progress-threshold
7118 The initial setting is 20.
7119 Threshold for display of progress gauge. If number of renewal is more than
7120 this value, display progress gauge.
7124 @node Hooks, , Customizable Variables, Customization
7130 @node Mailing List, Addition, Customization, Top
7131 @chapter Wanderlust Mailing List
7136 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7139 Topics related to Wanderlust are discussed in the mailing list.
7140 The latest version is also announced there (in Japanese, sorry).
7142 A guide can be obtained automatically by sending mail to
7143 @t{wl-ctl@@lists.airs.net} with the body
7148 Please send bug reports or patches to the mailing list. You can post to
7149 the mailing list even though you are not a member of it.
7151 If you send a bug report, please attach Backtrace with it.
7152 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7155 I would like to express my thanks to the members of the mailing list for
7156 valuable advice and many pieces of code they contributed.
7159 @node Addition, Index, Mailing List, Top
7160 @chapter Additional Information
7162 @section Brief History
7165 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7166 3/10 Made a msgdb mechanism by elisp.
7167 3/26 IMAP and NNTP can be displayed in threads.
7168 4/13 Began to assemble thread display modules as elmo.
7169 5/01 Finished 0.1.0, initial version with many defects.
7170 6/12 I made a slip of the tongue and said I was writing elisp
7171 mailer supporting IMAP
7172 6/16 0.1.3 was announced at tm-ja, elisp ML.
7173 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7174 7/01 Support for mm-backend (0.3.0).
7175 8/25 multi folder added (0.5.0).
7176 8/28 filter folder added (0.5.1).
7177 9/10 You can open/close threads (0.6.0).
7178 9/11 fldmgr by Murata-san made editing folders easy.
7179 9/18 lha folders added by Okunishi-san (0.6.3).
7180 9/24 Display of branches of threads (0.6.5).
7181 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7182 10/28 Off-line operations (0.7.4).
7183 12/09 Becomes beta version.
7184 12/21 wl-expire by Murata-san.
7185 1999 2/03 auto-refile by Tsumura-san.
7186 4/28 wl-template by Murata-san.
7187 5/18 Released 1.0.0 stable.
7188 7/05 Scoring by Murata-san (2.1.0).
7189 9/26 New plugged system by Murata-san (2.2.2).
7190 12/20 Support Modified UTF7.
7191 2000 3/24 Released 1.1.0 stable.
7192 4/03 CVS development started.
7193 5/07 Thread restoration & Its speed up with Murata-san.
7194 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7195 7/11 killed message feature.
7196 7/18 Use UIDL in POP3.
7197 9/12 biff feature with Satata-san & Yamaoka-san.
7198 10/17 expire-hide by Okada-san.
7199 11/08 Released 2.4.0 stable.
7200 2001 7/04 Released 2.6.0 stable.
7201 8/21 wl-addrmgr by Kitamoto-san.
7204 See @file{ChangeLog} for details.
7208 According to a dictionary, Wanderlust has the meaning:
7212 n eager longing for or impulse towards travelling in distant lands
7213 [Ger, fr wandern to wander + lust desire, pleasure]
7217 but I had no profound intention. (if farfetched, IMAP @result{} you can
7218 read mail anywhere @result{} desire to wander ?)
7220 Elmo is the abbreviation of @samp{Elisp Library for Message
7221 Orchestration}. At first I meant the red puppet in the Sesame Street,
7222 but you may associate it with Wandering @result{} Drifting @result{}
7223 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7227 Each versions has code names (they are almost jokes).
7228 Currently they are picked up alphabetically from the top 40 hits of
7229 U.S. Billboard magazines in 1980s.
7231 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7234 @node Index, , Addition, Top
7238 * Concept Index:: Concept Index
7239 * Key Index:: Key Index
7240 * Variable Index:: Variable Index
7241 * Function Index:: Function Index
7244 @node Concept Index, Key Index, Index, Index
7245 @unnumberedsec Concept Index
7248 @node Key Index, Variable Index, Concept Index, Index
7249 @unnumberedsec Key Index
7252 @node Variable Index, Function Index, Key Index, Index
7253 @unnumberedsec Variable Index
7256 @node Function Index, , Variable Index, Index
7257 @unnumberedsec Function Index