1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
25 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
27 This edition is for Wanderlust version @value{VERSION}.
29 Permission is granted to make and distribute verbatim copies of this
30 manual provided the copyright notice and this permission notice are
31 preserved on all copies.
34 Permission is granted to process this file through TeX and print the
35 results, provided the printed document carries copying permission notice
36 identical to this one except for the removal of this paragraph (this
37 paragraph not being relevant to the printed manual).
40 Permission is granted to copy and distribute modified versions of this
41 manual under the conditions for verbatim copying, provided that the
42 entire resulting derived work is distributed under the terms of a
43 permission notice identical to this one.
45 Permission is granted to copy and distribute translations of this manual
46 into another language, under the above conditions for modified versions.
52 @title Wanderlust User's Manual
53 @subtitle Yet another message interface on Emacsen
54 @subtitle for Wanderlust version @value{VERSION}
55 @author Yuuichi Teranishi
56 @author Fujikazu Okunishi
57 @author Masahiro Murata
59 @author Kaoru Takahashi
61 @author Masayuki Osada
62 @author Katsumi Yamaoka
64 @author Yoichi Nakayama
67 @vskip 0pt plus 1filll
68 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
69 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
70 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
71 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
73 This manual is for Wanderlust version @value{VERSION}.
75 Permission is granted to make and distribute verbatim copies of this
76 manual provided the copyright notice and this permission notice are
77 preserved on all copies.
79 Permission is granted to copy and distribute modified versions of this
80 manual under the conditions for verbatim copying, provided that the
81 entire resulting derived work is distributed under the terms of a
82 permission notice identical to this one.
84 Permission is granted to copy and distribute translations of this manual
85 into another language, under the above conditions for modified versions.
91 @node Top, Introduction, (dir), (dir)
92 @top Wanderlust User's Manual
107 This manual is for Wanderlust @value{VERSION}.
112 * Introduction:: Read this first
113 * Start Me Up:: Invoking Wanderlust
114 * Folders:: How to specify folders
115 * Folder:: Selecting and editing folders
116 * Summary:: Reading and refiling messages
117 * Message:: Saving and playing MIME multipart entities
118 * Draft:: Draft buffer, sending mail and news
119 * Disconnected Operations:: Off-Line management
120 * Expire and Archive:: Automatic expiration and archiving of messages
121 * Scoring:: Score of the messages
122 * Address Book:: Management of Address Book
123 * Customization:: Customizing Wanderlust
124 * Terminology:: Terminologies
125 * Mailing List:: Wanderlust mailing list
126 * Addition:: Additional Information
131 @node Introduction, Start Me Up, Top, Top
132 @chapter Introduction of Wanderlust
135 Wanderlust is an mail/news management system on Emacsen.
136 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
138 The main features of Wanderlust:
141 @item Pure elisp implementation.
142 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
143 @item Unified access method to messages based on Mew-like Folder Specification.
144 @item Mew-like Key-bind and mark handling.
145 @item Manages unread messages.
146 @item Interactive thread display.
147 @item Folder Mode shows the list of subscribed folders.
148 @item Message Cache, Disconnected Operation (Read Only).
149 @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
150 @item MIME compliant (by SEMI).
151 @item Transmission of news and mail are unified by Message transmitting draft.
152 @item Graphical list of folders (XEmacs and Emacs 21).
153 @item View a part of message without retrieving the whole message (IMAP4).
154 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
155 @item Virtual Folders.
156 @item Supports compressed folder using common archiving utilities.
157 @item Old articles in folders are automatically removed/archived (Expiration).
158 @item Automatic re-file.
159 @item Template function makes it convenient to send fixed form messages.
165 We confirm Wanderlust works on following Emacsen:
168 @item Mule 2.3 based on Emacs 19.34
169 @item Emacs 20.2 or later
170 @item XEmacs 20.4 or later
171 @item Meadow 1.00 or later
172 @item NTEmacs 20.4 or later
176 IMAP4 connectivity with following imapd are confirmed to work with
180 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
181 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
182 @item Courier-IMAP 1.3.2 or later
183 @item AIR MAIL (AIRC imapd release 2.00)
185 @item Microsoft Exchange Server 5.5
186 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
189 LDAP connectivity with following LDAPd are confirmed to work with
193 @item OpenLDAP 2.0.6 or later
197 @node Start Me Up, Folders, Introduction, Top
198 @chapter Start up Wanderlust
201 The necessary procedure for starting Wanderlust is explained in steps
204 (Of course, you need a mail/news readable environment in advance)
207 * MIME Modules:: Installing the MIME modules
208 * Download:: Download and extract the packages
209 * Install:: Byte-compile and install
210 * Minimal Settings:: @file{.emacs} setup
211 * Folder Definition:: Folder definition
212 * Start Wanderlust:: Starting Wanderlust
216 @node MIME Modules, Download, Start Me Up, Start Me Up
217 @section Installing MIME modules
223 You must install SEMI beforehand to use Wanderlust.
225 SEMI can be downloaded from following site:
229 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
233 You need packages named APEL and FLIM to use SEMI.
234 You can download APEL and FLIM from following URLs:
238 APEL: ftp://ftp.m17n.org/pub/mule/apel/
239 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
243 You have to install APEL, FLIM and SEMI in this order. Generally,
244 @samp{make install} will do the job. (In XEmacs 21, @samp{make
247 Refer to the documents of each package for detailed installation
248 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
249 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
253 Recommended combination of APEL, FLIM and SEMI are following:
256 @item APEL 10.3, FLIM 1.14.3 and SEMI 1.14.3
259 You can also use many other FLIM/SEMI variants. Combination of the
260 latest versions should work. For example, the following combination are
264 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
265 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
268 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
271 @node Download, Install, MIME Modules, Start Me Up
272 @section Download and Extract the Package
275 You can download Wanderlust package from following sites:
279 ftp://ftp.gohome.org/wl/
282 Mirrored ftp/http sites:
286 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
287 http://www.jpl.org/elips/wl/
288 http://www.ring.gr.jp/archives/text/elisp/wl/
289 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
290 ftp://opaopa.org/pub/mirror/elisp/wl/
291 @c ftp://roguelife.org/pub/tsumura/wl/
295 Extract the obtained package to your working directory:
300 % tar zxvf wl-@var{version}.tar.gz
301 % cd wl-@var{version}
305 @subsection To use SSL (Secure Socket Layer)
310 SSL (Secure Socket Layer) can be used for
311 SMTP, IMAP, NNTP and POP connections in Wanderlust.
313 There are two ways to use SSL. One is to start SSL negotiation just
314 after the connection establishment (generic way). The other one is to
315 start SSL negotiation by invoking STARTTLS command in the each session.
317 To use the formal SSL (generic SSL), you must set @env{PATH} to the
318 directory that OpenSSL commands are installed.
320 To use the latter SSL(STARTTLS), you must install starttls package in
322 You can download starttls package from the following site.
325 ftp://opaopa.org/pub/elisp/
328 @node Install, Minimal Settings, Download, Start Me Up
329 @section Byte-compile and install
336 @subsection Installation
338 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
339 Set the Emacs's command name to @code{EMACS}.
340 Set package installation directory to @code{LISPDIR}.
341 Then, please execute following commands.
350 Destination directory is auto-probed if you leave @code{LISPDIR}
351 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
353 If you are using an Emacs variant which does not merge specified directory
354 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
355 then you will see the error message:
358 Cannot open load file: mime-setup
362 In this case, either add destination directories of custom, APEL, FLIM
363 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
364 @code{load-path} in @file{WL-CFG} in extracted directory.
366 If you want to use BBDB, then the necessary modules are byte-compiled
367 and installed when BBDB directory is added to @code{load-path}.
370 @subsection @file{WL-CFG}
372 Contents of the file @file{WL-CFG} is loaded under installation if a file
373 with that name exists in extracted directory. You can use @file{WL-CFG} to
374 configure @code{load-path} to extra packages such as SEMI if needed.
376 If you want to specify the install directory of Wanderlust related
377 files, then set following variables in @file{WL-CFG}
381 A directory to install WL modules.
382 This directory is relative directory from @code{LISPDIR}.
383 WL modules include @file{wl*.el}, @file{wl*.elc} files.
384 @c Modules under the directory @file{util/} are also installed if
385 @c it detected as necessary.
388 A directory to install ELMO modules.
389 This directory is relative directory from @code{LISPDIR}.
390 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
391 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
395 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
397 If you want to install ELMO related files under a sub-directory
398 such as "elmo" then add following to @file{WL-CFG}:
401 (setq ELMO_PREFIX "elmo")
404 @subsection Install as a XEmacs package
405 @cindex XEmacs package
406 @cindex XEmacs package install
407 @cindex Package, XEmacs
408 @cindex Package install, XEmacs
409 @c @cindex install-package
411 It is possible to install Wanderlust as one of packages of XEmacs (21.0
412 or later). Configuration for autoload and icon-path in local
413 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
416 Follow the next example to install Wanderlust as an XEmacs package.
422 % make install-package
426 package directory is auto-probed, if SEMI is installed.
427 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
429 @subsection Run in place
431 If wl and elmo directories are defined in @code{load-path}, then
432 byte-compilation and installation are not necessary to start Wanderlust.
433 For example, if package is extracted in @file{~/work}, Wanderlust can be
434 invoked with following setting in @file{~/.emacs}.
438 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
439 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
445 Manual is described in Info format. Please do following.
454 If you install Wanderlust as a XEmacs package, Info file is already
455 installed too, so there are no need of these commands.
457 Manual directory is automatically detected. Of course, it can be
458 configured by @code{INFODIR} in @file{Makefile}.
460 You can read manual at the following URL:
463 http://www.gohome.org/wl/doc/wl_toc.html
466 @node Minimal Settings, Folder Definition, Install, Start Me Up
467 @section Set up .emacs
468 @cindex Minimal Settings
470 @cindex Configuration
474 The Wanderlust package contains two module groups.
477 @item ELMO (elmo-*.el)
478 These modules show everything as folders. This is the back-end for WL.
480 These modules controls the behavior of main body of Wanderlust.
481 They are also the front-end for ELMO.
484 You can customize the behavior of Wanderlust by changing the value
485 of environmental variables which begins with @code{elmo-} and @code{wl-}.
487 The minimal requirement for settings is as the following.
491 ;; @r{The setting to use SEMI}
492 (require 'mime-setup)
494 ;; @r{autoload configuration}
495 ;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
496 (autoload 'wl "wl" "Wanderlust" t)
497 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
498 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
500 ;; @r{Directory where icons are placed.}
501 ;; @r{Default: the peculiar value to the running version of Emacs.}
502 ;; @r{(Not required if the default value points properly)}
503 (setq wl-icon-directory "~/work/wl/etc")
505 ;; @r{SMTP server for mail posting. Default: @code{nil}}
506 (setq wl-smtp-posting-server "your.smtp.example.com")
507 ;; @r{NNTP server for news posting. Default: @code{nil}}
508 (setq wl-nntp-posting-server "your.nntp.example.com")
512 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
513 file exists). So it is convenient to gather Wanderlust specific settings
514 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
515 because you can't write them in @file{.emacs}
516 (if you write it to @file{.emacs}, you'll get an error).
519 All above described settings except @samp{(require 'mime-setup)} and autoload
520 configuration can be written in
523 @subsection @code{mail-user-agent}
524 @cindex Default Mailer
525 @cindex Mailer, Default
526 @vindex mail-user-agent
529 If you write following setting in you @file{.emacs}, you can
530 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
531 This means it enables you to run Wanderlust as a default mail composer
534 It is effective only when your Emacs can define @code{mail-user-agent}.
535 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
539 (autoload 'wl-user-agent-compose "wl-draft" nil t)
540 (if (boundp 'mail-user-agent)
541 (setq mail-user-agent 'wl-user-agent))
542 (if (fboundp 'define-mail-user-agent)
543 (define-mail-user-agent
545 'wl-user-agent-compose
554 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
555 @section Folder Definition
556 @cindex Folder Definition
559 You can skip this section because it is possible to add/edit the
560 subscribe folders from the buffer for list of folders.
561 @xref{Folder Manager}.
563 Define the folders you want to subscribe in file @file{~/.folders}. The
564 contents written in @file{~/.folders} become the folders which you
565 subscribe to as it is.
567 Format for @file{~/.folders} is very simple. Here is an example:
572 # @r{Lines begin with @samp{#} are comment.}
573 # @r{Empty lines are ignored}
575 # @var{folder name} "@var{folder nickname}"
576 # @r{(nicknames are not necessary)}
581 %#mh/Backup@@my.imap.example.com "Sent"
584 %#mh/spool/wl "Wanderlust ML"
585 %#mh/spool/elips "ELIPS ML"
586 %#mh/spool/apel-ja "APEL Japanese ML"
587 %#mh/spool/xemacs-beta "XEmacs beta"
588 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
589 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
592 # @r{If folder name ends with @samp{/}, that means an `access group',}
593 # @r{all subfolders automatically included in one folder group.}
595 %#mh/expire@@localhost /
596 # @r{All MH folders are included in one folder group.}
601 Each line contains one folder you want to read. The definition of
602 folders will be explained in detail in the next section.
604 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
605 become one folder group. One folder group is treated as a directory
606 which can be opened and closed in folder mode. It is convenient for
607 collecting some folders and putting them in order.
609 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
610 line and you have to write it that way (It is because the parser sucks).
612 There are two types of groups. One is like @samp{Emacsen} from above
613 example which the user chooses his favorite folders as a group.
615 The other one is @dfn{access group} like @samp{+ /} from above example.
616 It makes all the sub-folders in a folder to a group. (It differs from
617 the type of the folder. For example, @samp{+} followed by @samp{/}
618 makes entire MH sub-directories to one group)
620 This behavior is better understood if you try it and confirmed the
621 function first. You can write and try a small folder definition, so you
622 will know the idea of the folder function before writing the real one.
624 @node Start Wanderlust, , Folder Definition, Start Me Up
625 @section Start Wanderlust
626 @cindex Start Wanderlust
628 If installation and configuration worked well, you can invoke Wanderlust by
629 typing following command in Emacs.
636 After initialization, Folder Mode which shows the list of folders will appear.
637 That means the folders you defined in the @file{~/.folders} are listed
638 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
639 can skip folder checking.
641 Basically, you will handle messages in wanderlust while you come and go
642 from/to each of the following buffers.
646 You can see the list of folders. You can select some folder and go into the summary
647 of it. You can subscribe new folder or edit subscription list.
649 You can see the list of messages in the folder. You can select message and view its
650 contents, and reply to some message. You can delete ones or move ones to another
653 You can see the contents of the message. You can save part to disk or open in external
656 You can edit message.
659 Details of each ones are explained later.
662 @node Folders, Folder, Start Me Up, Top
663 @chapter Wanderlust's folders
666 This chapter describes the folder types which Wanderlust is able to handle.
668 Wanderlust uses ELMO as it's interface, so you can use every folder types
671 As of version @value{VERSION}, 11 types of folders are predefined. These are
672 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
673 Pipe and Internal folder types.
676 * IMAP Folder:: @samp{%} -- IMAP folder
677 * NNTP Folder:: @samp{-} -- NNTP folder
678 * MH Folder:: @samp{+} -- MH folder
679 * Maildir Folder:: @samp{.} -- Maildir folder
680 * News Spool Folder:: @samp{=} -- News spool folder
681 * Archive Folder:: @samp{$} -- Archive folder
682 * POP Folder:: @samp{&} -- POP folder
683 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
684 * Namazu Folder:: @samp{[} -- Namazu Folder
685 * Multi Folder:: @samp{*} -- Multi folder
686 * Filter Folder:: @samp{/} -- Filter folder
687 * Pipe Folder:: @samp{|} -- Pipe folder
688 * Internal Folder:: @samp{'} -- Internal folder
692 @node IMAP Folder, NNTP Folder, Folders, Folders
700 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
706 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
710 You can specify @code{login} (encoded password transmission),
711 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
712 authentication) or @code{clear} (or @code{nil}, plain password
713 transmission) as @var{authenticate-type}.
718 @var{username} -> The value of @code{elmo-imap4-default-user}.
719 Initial setting is @env{USER} environment variable or
720 @env{LOGNAME} environment variable or return value of
721 @code{(user-login-name)}.
722 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
723 Initial setting is "auth".
724 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
725 Initial setting is "localhost".
726 @var{port} -> The value of @code{elmo-imap4-default-port}.
727 Initial setting is 143.
730 You can omit the @var{hostname} from folder names if you set
731 @code{elmo-imap4-default-server} as your main IMAP server.
732 For example, you can specify a folder as @samp{foo%imap@@gateway} even
733 if you have to go through a firewall.
737 ;; @r{Example: imap4.exaple.org as main IMAP server}
738 (setq elmo-imap4-default-server "imap4.example.org")
742 SSL (Secure Socket Layer) connection will be used if a folder name ends
743 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
744 is @code{ssl}, SSL will be the default connection. If a folder name
745 ends with @samp{!!}, STARTTLS connection will be established. If the
746 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
747 STARTTLS will be the default connection.
751 ;; @r{Example: Use SSL connection}
752 (setq elmo-imap4-default-stream-type 'ssl)
756 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
757 authentication method, the password is sent in encoded form. But, if
758 your server is unable to receive an encoded password, authentication
759 will fall back to @code{clear} (that is, sending password in raw format)
760 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
761 authentication will fall back to @code{clear} without confirmation
762 (default value is @code{nil}).
766 ;; @r{Example: password in raw format}
767 (setq elmo-imap4-default-authenticate-type 'clear)
775 %inbox -> IMAP mailbox "inbox"
776 %#mh/inbox -> IMAP mailbox "#mh/inbox"
778 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
779 %inbox:hoge/clear@@server1
780 -> server1's IMAP mailbox "inbox"
781 of user "hoge", with plain password authentication
786 @subsection International mailbox names (Modified UTF7)
787 @cindex Modified UTF7
794 You can use international mailbox names in @var{mailbox} part, if you
795 are using Emacs which can treat unicode and
796 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
797 value is @code{nil}).
799 Currently, following Emacsen can treat unicode.
802 @item Emacs 20.3 or later + Mule-UCS
804 If you installed Mule-UCS package, Emacs can treat unicode.
805 You can obtain Mule-UCS package from following URL.
808 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
811 @item XEmacs 21.2.13 or later + ucs-conv package
813 By default, XEmacs 21 cannot treat unicodes, but if you installed
814 ucs-conv package, it can.
815 You can obtain ucs-conv package from following anonymous CVS.
819 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
820 Password: @var{NULL} (Just enter return key)
821 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
825 You also need utf7 conversion programs, @command{u7tou8} and
826 @command{u8tou7} to use international mailbox name in the current
827 XEmacs. These programs are included in the UTF7 package which can be
828 obtained from following URL.
831 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
836 @node NNTP Folder, MH Folder, IMAP Folder, Folders
847 A folder to access USENET news via NNTP protocol (RFC 977).
848 One newsgroup is treated as a folder.
854 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
860 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
861 Initial setting is @samp{localhost}.
862 @var{username} -> The value of @code{elmo-nntp-default-user}.
863 Initial setting is @code{nil}.
864 @var{port} -> The value of @code{elmo-nntp-default-port}.
865 Initial setting is 119.
868 AUTHINFO is used as authentication method if the @var{username} is
869 non-nil. SSL will be default method if
870 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
871 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
872 STARTTLS connection will be established. if the value of
873 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
874 be the default connection.
880 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
881 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
886 @node MH Folder, Maildir Folder, NNTP Folder, Folders
893 A folder to access MH format mail (1 file is 1 mail).
898 @samp{+} @var{directory-name}
901 Normally, @var{directory-name} is an relative path to the variable
902 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
903 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
904 (this is also true for drive-letters).
906 Message number is used for the name of the message file.
912 +inbox -> @file{~/Mail/inbox}
913 +from/teranisi -> @file{~/Mail/from/teranisi}
914 +~/test -> @file{~/test}
919 @node Maildir Folder, News Spool Folder, MH Folder, Folders
920 @section Maildir Folder
922 @cindex Maildir Folder
926 A folder to access Maildir format (1 file is 1 mail).
931 @samp{.} [@var{directory-name}]
934 Normally, @var{directory-name} is a relative path to the variable
935 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
936 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
937 (this is also true for drive-letters).
939 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
940 Messages are contained in the @file{cur} directory. All message files
941 in the @file{new} directory are moved to @file{cur} directory when you
942 access the folder. All message files contained in the @file{tmp}
943 directory and not accessed for 36 hours are deleted.
945 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
951 . -> @file{~/Maildir}
952 .inbox -> @file{~/Maildir/inbox}
953 .from/teranisi -> @file{~/Maildir/from/teranisi}
954 .~/test -> @file{~/test}
959 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
960 @section News Spool Folder
962 @cindex News spool Folder
965 This folder handles locally saved news articles which are proposed by
966 Mew/IM. You can also read articles directly from a spool-file which is
967 retrieved by an utility like @command{gnspool}.
972 @samp{=} @var{directory-name}
975 @var{directory-name} is a sub-directory to the directory defined by
976 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
977 You can use @samp{.} as directory delimiter as well as @samp{/}.
983 =fj/os/os2 -> @file{~/News/fj/os/os2}
984 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
989 @node Archive Folder, POP Folder, News Spool Folder, Folders
990 @section Archive Folder
992 @cindex Archive Folder
995 This method can handle archive files, which are compressed by utilities
996 such as Info-ZIP or LHA, as one folder.
1002 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1006 @var{path-name} is the relative path from
1007 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1008 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1009 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1010 also permitted under the environment of ange-ftp, efs.
1012 The actual file name of the archive folder is
1013 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1014 under the @var{path-name}. If a file named @var{path-name} exists, it is
1015 treated as folder. The suffix is automatically decided for
1016 @var{archiver-type}.
1018 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1019 (Initial setting is @code{zip}) is referred.
1021 @var{prefix} specifies the internal directory structure of the archive.
1022 For example, if the ML server is fml, @file{msend.tar.gz} has a
1023 structure like @file{spool/1}, so you have to specify @samp{spool} as
1030 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1031 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1032 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1033 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1034 $ml;zip/ -> Access group consists of archive folders
1035 under @file{~/Mail/ml}
1040 * Archiver:: Supported Archivers
1041 * Archive Tips:: TIPS
1042 * Archive Vars:: Customization
1046 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1047 @subsection Supported Archives
1057 By default, following archives are supported.
1061 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1062 GNU TAR('tgz, 'tar) ;; read-only
1066 If your archiver can include multiple files in one archive, you have a
1067 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1068 of the candidate. TAR is supported read-only because it cannot delete
1069 file in the archive (@code{mv})).
1071 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1072 archiver of Wanderlust because they cannot include multiple
1073 files. Archivers that cannot extract files to standard output are also
1076 @subsection OS specific information about archiver.
1078 Behaviors of the following archivers are confirmed by further experiences.
1079 (@samp{*} mark means recommended archiver).
1082 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1083 LHA OS/2 version Rel.2.06b Feb 18, 1998
1084 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1085 *Zip 2.2 (November 3rd 1997).
1086 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1087 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1088 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1090 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1091 LHa for UNIX V 1.14c
1092 UnZip 5.32 of 3 November 1997
1093 Zip 2.2 (November 3rd 1997)
1094 GNU tar 1.12 (1.11.x is no good)
1095 gzip 1.2.4 (18 Aug 93)
1097 [Win32] Win.98/Meadow
1101 GNU tar 1.11.8 + 1.5(WIN32)
1108 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1109 Hiramatsu version of LHA is only supported.
1110 In Win32, LHa32 is only supported (DOS version is no good).
1112 * Caution about GNU tar
1114 You have to take care about GNU tar's version because many version has
1115 problem on deleting file from archive.
1117 Please test @option{--delete} @option{-f} options work. Otherwise, your
1118 archive will be destroyed. No problem is reported on above versions of
1122 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1124 @cindex Archive Tips
1126 For comfortable migration, usage of @code{wl-summary-archive}
1127 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1128 archive folders created by expiration, you must set non-nil value to
1129 @code{elmo-archive-treat-file}.
1131 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1132 in processing speed. For comfortable use, Emacs20 is recommended.
1133 (If re-search's performance is the problem, 19.3x or later may be okay.)
1135 If many files are included in one archive,
1136 it takes long time to access the archive folder because
1137 archiver starting overhead is increased (especially LHA).
1138 150-200 messages in one archive is recommended.
1140 Of course, following is possible @t{:-)}
1141 (meanings of these variables are described later.)
1145 (setq wl-fcc "$backup")
1146 (setq wl-trash-folder "$trash;lha")
1150 @node Archive Vars, , Archive Tips, Archive Folder
1151 @subsection Variables About Archive Folder
1152 @cindex Archive variables
1155 @item elmo-archive-default-type
1156 @vindex elmo-archive-default-type
1157 The initial setting is @code{zip}.
1158 Set archiver type by symbol.
1160 @item elmo-archive-@var{type}-method-alist
1161 @vindex elmo-archive-TYPE-method-alist
1162 Define archiver @var{type}'s methods.
1163 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1164 Each element of the alist is following.
1168 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1169 (@var{action} . @var{function}) ;; function
1173 Currently available actions are following.
1177 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1178 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1185 actions enclosed with braces are optional (They are used for better
1188 @item elmo-archive-suffix-alist
1189 @vindex elmo-archive-suffix-alist
1190 An alist of archiver-type (symbol) and suffix.
1192 @item elmo-archive-file-regexp-alist
1193 @vindex elmo-archive-file-regexp-alist
1194 An alist of a regexp to get file number from list output of archiver
1195 and archiver-type (symbol).
1197 @item elmo-archive-method-list
1198 @vindex elmo-archive-method-list
1199 A list of elmo-archive-@var{type}-method-alist
1200 (@var{type} is a symbol of archiver-type).
1202 @item elmo-archive-lha-dos-compatible
1203 @vindex elmo-archive-lha-dos-compatible
1204 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1205 DOS (Mr. Yoshizaki original) compatible.
1207 @item elmo-archive-cmdstr-max-length
1208 @vindex elmo-archive-cmdstr-max-length
1209 The initial setting is 8000.
1211 Max length of command line argument for external archiver program.
1212 Emacs does not have a limit of command line byte length, but some OS
1213 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1214 this limit because it calls external archiver program directly (not
1215 called via shell). For example, you cannot delete messages if archiver
1216 program must receive larger bytes of arguments to delete. OS/2 have a
1217 command line argument limit of 8190 bytes, so we defined default as 8000
1220 However, you don't have an influence of command line argument limit
1221 if the archiver has `actions' to receive target file information from
1222 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1226 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1234 A folder to access e-mails via POP3 protocol (RFC 1939).
1240 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1245 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1246 as @var{authenticate-type}.
1248 You can specify @samp{uidl} (use UIDL command for message numbering) or
1249 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1253 @var{username} -> The value of @code{elmo-pop3-default-user}.
1254 Initial setting is @env{USER} environment variable or
1255 @env{LOGNAME} environment variable or return value of
1256 @code{(user-login-name)}.
1257 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1258 Initial setting is @samp{user}.
1259 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1260 If t, use UIDL for numbering. Initial setting is t.
1261 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1262 Initial setting is @samp{localhost}.
1263 @var{port} -> The value of @code{elmo-pop3-default-port}.
1264 Initial setting is 110.
1271 &hoge@@localhost -> access localhost as user @samp{hoge}.
1272 &hoge@@popserver:109 -> access the server "popserver" on port 109
1273 as user @samp{hoge}.
1277 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1278 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1279 @file{utils/sasl/lisp/} or Emacs/W3 package
1280 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1283 If the last character of the folder name is @samp{!}, Wanderlust
1284 connects to the POP server via SSL (Secure Socket Layer). If you set
1285 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1286 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1287 with @samp{!!}, STARTTLS connection will be established. if the value
1288 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1292 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1293 @section Shimbun Folder
1295 @cindex Shimbun Folder
1296 @cindex Folder, Shimbun
1301 A folder for watching "shimbun" (means "newspaper" in Japanese),
1302 news site and mailing list archives on WWW by using emacs-w3m
1303 (@uref{http://emacs-w3m.namazu.org/}).
1305 You should possess w3m and emacs-w3m to use this.
1311 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1315 Admissible values of @var{module-name} and @var{folder-name} are
1316 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1322 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1323 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1327 @subsection Variables About Shimbun Folder
1330 @item elmo-shimbun-update-overview-folder-list
1331 @vindex elmo-shimbun-update-overview-folder-list
1332 The initial setting is @code{nil}. You can specify a list of regular
1333 expressions of shimbun folder names. The overview of matched shimbun
1334 folder is updated when messages are fetched.
1335 You should @kbd{s rescan} after fetching to update summary.
1339 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1340 @section Namazu Folder
1342 @cindex Namazu Folder
1343 @cindex Folder, Namazu
1344 @cindex Folder, Text Search
1347 A folder to access messages found in namazu-index with some condition.
1348 It uses namazu (@uref{http://www.namazu.org/}) for search.
1354 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1358 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1364 [wanderlust] -> search messages matched with
1365 "wanderlust" from the default index
1366 [semi flim]~/Mail/semi -> search "semi flim" from the index
1367 in the directory "~/Mail/semi"
1373 @subsubsection Enter space to separate keywords
1375 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1377 @subsubsection Alias name for index
1379 You can define an alias name for index.
1384 (setq elmo-nmz-index-alias-alist
1385 '(("cache" . "~/.elmo/cache")
1386 ("docs" . "~/documents")))
1389 Above definition defines two index aliases.
1396 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1397 directory @file{~/.elmo/cache}.
1399 @subsubsection Multiple indices
1401 You can specify a list for @code{elmo-nmz-default-index-path} and
1402 @code{elmo-nmz-index-alias-alist}.
1403 When list is specified, all index contained in the list is used as the
1409 (setq elmo-nmz-index-alias-alist
1410 '(("all" . ("~/.elmo/cache" "~/documents"))
1411 ("cache" . "~/.elmo/cache")))
1414 Using above alias setting, you can specify
1420 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1421 directory @file{~/.elmo/cache} and @file{~/documents}.
1423 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1424 @section Multi Folder
1426 @cindex Multi Folder
1427 @cindex Folder, Multiple
1428 @cindex Folder, Marge
1430 A folder to access virtual folder which collects messages from
1437 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1441 After @samp{*} character, specify multiple folders you want to collect
1442 separated by @samp{,} like
1443 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1449 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1450 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1451 treated as one folder.
1453 *+inbox,-fj.rec.tv,%inbox
1454 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1459 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1460 @section Filter Folder
1462 @cindex Filter Folder
1463 @cindex Folder, Filtering
1464 @cindex Folder, Virtual
1465 @cindex Folder, Conditional
1467 A folder to access virtual folder which collects all messages that
1468 satisfy a condition.
1473 @samp{/} @var{condition} @samp{/} @var{target-folder}
1476 In the @var{condition} part, you can specify following.
1480 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1482 first: @var{number} messages are picked from top of folder.
1483 last: @var{number} messages are picked from bottom of folder.
1489 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1490 /first:20/%inbox -> First 20 messages from %inbox are picked.
1495 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1497 since: only messages arrived since @var{date} are picked.
1498 before: only messages arrived before @var{date} are picked.
1500 You can specify following as @var{date}.
1504 yesterday -> a day before today.
1505 lastweek -> same day of last week.
1506 lastmonth -> same day of last month.
1507 lastyear -> same day of last year.
1508 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1509 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1517 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1519 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1525 Field filter: @samp{@var{field}:@var{value}}
1527 All messages that have @var{field} and its value is @var{value} are picked.
1528 @var{field} and @var{value} are case insensitive.
1534 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1535 and its value includes "teranisi" string are picked.
1536 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1544 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1545 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1547 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1548 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1554 /from:teranisi&!to:teranisi/+inbox
1555 -> In +inbox, messages are picked if the message's
1556 From: field includes "teranisi" and
1557 To: field doesn't include "teranisi".
1559 /tocc:"Yuuichi Teranishi"/+inbox
1560 -> In +inbox, messages are picked if the
1561 message's To: field or Cc: field includes
1562 "Yuuichi Teranishi".
1564 /(from:yt|from:teranisi)&subject:report/+inbox
1565 -> In +inbox, messages are picked if the message's
1566 From: field includes "yt" or "teranisi", and
1567 Subject includes "report".
1573 Tip for string description:
1575 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1576 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1577 should be escaped with @samp{\} in it). You can enclose the string with
1578 @samp{"} even it does not contain these characters.
1584 *%inbox,/from:teranisi/%inbox@@server
1585 -> Messages in %inbox or
1586 message is in the %inbox@@server folder and it's From field
1587 includes "teranisi" are collected.
1589 /last:100//to:teranisi/*+inbox,%inbox
1590 -> Latest 100 messages which is in the +inbox or %inbox folder
1591 and To: field matches "teranisi".
1593 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1594 -> Pick messages which have From: field and it includes "hogehoge"
1595 from latest 20 messages in the %#mh/inbox@@localhost
1596 and To: or Cc: field includes "teranisi".
1599 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1600 @section Pipe Folder
1604 @cindex Download Message
1605 @cindex Incorporate Message
1607 In the pipe folder, messages are automatically transferred from the source
1608 folder to destination folder.
1613 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1616 When you access the pipe folder, messages are automatically transferred
1617 from @var{source-folder} to @var{destination-folder}.
1618 It is convenient if you want to download messages to local disk via POP.
1619 For example, if you specify following
1622 |&username@@popserver|+inbox
1626 and access it, Wanderlust downloads messages from
1627 @samp{&username@@popserver} to @samp{+inbox} automatically.
1629 On the other hand, if you put @samp{|:} instead of second @samp{|},
1630 then messages are copied to the destination folder (not deleted from
1631 source-folder). At the next time you access that folder, copies new
1635 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1638 If you want to copy messages from POP server and view them, specify the
1642 |&username@@popserver|:+inbox
1645 where messages will be kept on the server.
1651 |%inbox|%myinbox -> Download %inbox to %myinbox.
1652 |*&user@@popserver1,&user@@popserver2|+inbox
1653 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1654 |-gnu.emacs.sources|:+sources
1655 -> Copy messages from -gnu.emacs.sources to +sources.
1659 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1661 @node Internal Folder, , Pipe Folder, Folders
1662 @section Internal folder
1664 @cindex Internal Folder
1665 @cindex Folder, @samp{$} mark
1667 @c @cindex Folder, Null
1669 A folder to access internal messages of Wanderlust.
1681 A folder named @samp{'mark} is a special virtual folder which collects
1682 messages which have important mark @samp{$}.
1684 You can review important messages at once after you put important marks
1685 on the messages in the different folders.
1687 In this folder, if you delete message, important mark @samp{$} put on
1688 the message is removed. If you append messages to this folder, the
1689 message will have @samp{$} mark.
1691 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1692 folder. If you want IMAP folder's message remove from @samp{'mark}
1693 folder, remove important mark at IMAP Folder.)
1696 A folder named @samp{'sendlog} is a virtual folder which collects
1697 cached messages which are recoded on @file{~/.elmo/sendlog}.
1698 It might be useful when you forgot to add cc for yourself.
1699 To use this, you should set @code{wl-draft-use-cache} to non-nil
1700 so that sent messages are cached.
1703 You can access cached messages fetched via network by accessing
1704 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1705 the name of the subdirectories of the cache directory
1706 (@file{~/.elmo/cache}).
1709 @node Folder, Summary, Folders, Top
1710 @chapter Folder mode
1713 After you start Wanderlust, folder mode is appeared firstly.
1714 It contains folder list you subscribed.
1715 You can select and edit folders in this mode.
1718 * Selecting Folder:: Select folder you want to read
1719 * Folder Manager:: Editing folders
1723 @node Selecting Folder, Folder Manager, Folder, Folder
1724 @section Selecting Folder
1725 @cindex Selecting Folder
1727 @subsection Usage (TIPS)
1729 @subsubsection Check new, unread number
1731 Folder mode looks like this.
1732 (In XEmacs, it looks much nicer @t{;-)})
1736 [-]Desktop:14186/35580/67263
1741 [-]Emacsen:0/34/4837
1742 Wanderlust ML:0/0/558
1745 XEmacs Beta:0/29/255
1756 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1760 @kbd{s} key on the folder line updates these numbers.
1761 It changes its color if it has many new messages.
1763 The whole folder mode is a folder group named @samp{Desktop}.
1764 Folder group open/close by return key.
1765 A operation to a folder group is treated as operations on the
1767 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1768 six children folders update its unread number status.
1770 @subsubsection Select Folder
1772 To enter summary mode of the folder, type return (or space) key on
1774 If the variable @code{wl-stay-folder-window} has non-nil value,
1775 summary window appears on the right of the folder mode window.
1777 @subsection Key bindings
1779 Folder mode's key binding (related to selecting folders) is following.
1784 @kindex @key{SPC} (Folder)
1785 @kindex @key{RET} (Folder)
1786 @findex wl-folder-jump-to-current-entity
1787 Enter to the summary mode of the folder at the current cursor point.
1788 With prefix argument, enter the sticky summary.
1789 If the cursor is on the top of folder group line,
1790 the folder group is opened or closed.
1791 When the cursor is on the access group and this command is called
1792 with prefix argument, folder children list is updated to the newest one.
1793 (Children list is updated recursively if the access folder has hierarchical
1795 (@code{wl-folder-jump-to-current-entity})
1798 @kindex M-@key{RET} (Folder)
1799 @findex wl-folder-update-recursive-current-entity
1800 Folder children list of the access group at the current cursor point
1801 is updated to the newest one.
1802 (Children list is updated recursively if the access folder has hierarchical
1804 (@code{wl-folder-update-recursive-current-entity})
1809 Create a new draft message.
1814 @findex wl-folder-write-current-folder
1815 If the current cursor point is on the NNTP folder, create a new draft
1816 message which already has @samp{Newsgroups:} field. If the current
1817 cursor point is on the folder for mailing list (refile destination),
1818 create a new draft message which already has @samp{To:} field with
1819 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1821 (@code{wl-folder-write-current-folder})
1824 @kindex C-c C-o (Folder)
1825 @findex wl-jump-to-draft-buffer
1826 Move to the draft buffer if available. If multiple draft buffer exists,
1827 moved to one after another. If prefix argument is specified, load draft
1828 folder's message to the draft buffer and jump to it.
1829 (@code{wl-jump-to-draft-buffer})
1833 @findex wl-folder-check-current-entity
1834 Update new and unread number information of the folder at the current
1836 (@code{wl-folder-check-current-entity})
1840 @findex wl-folder-sync-current-entity
1841 Update summary information of the folder at the current cursor point.
1842 (@code{wl-folder-sync-current-entity})
1845 @kindex r s (Folder)
1846 @findex wl-folder-check-region
1847 Update new and unread number information of the folders in the currently
1849 (@code{wl-folder-check-region})
1852 @kindex r S (Folder)
1853 @findex wl-folder-sync-region
1854 Update summary information of the folders in the currently selected region.
1855 (@code{wl-folder-sync-region})
1859 @findex wl-status-update
1860 Sync up address book status with @file{~/.addresses}'s content.
1861 (@code{wl-status-update})
1865 @findex wl-folder-prev-unread
1866 Jump cursor to the folder which have unread messages on the upward from
1867 current cursor point.
1868 (@code{wl-folder-prev-unread})
1872 Jump cursor to the folder which have unread messages on the downward
1873 from current cursor point.
1874 (@code{wl-folder-next-unread})
1878 Move cursor to the folder on the previous line.
1879 (@code{wl-folder-prev-entity})
1883 Move cursor to the folder on the next line.
1884 (@code{wl-folder-next-entity})
1888 Jump to the folder specified by the user input.
1889 (@code{wl-folder-jump-folder})
1893 @findex wl-folder-prefetch-current-entity
1894 Prefetch new messages of the folder at the current cursor point by
1895 @code{wl-summary-incorporate}.
1896 If the cursor is on the folder group, it is executed recursively.
1897 (@code{wl-folder-prefetch-current-entity})
1901 @findex wl-folder-mark-as-read-all-current-entity
1902 Mark all unread messages of the folder at the current cursor point as read.
1903 If the cursor is on the folder group, it is executed recursively.
1904 (@code{wl-folder-mark-as-read-all-current-entity})
1908 @findex wl-folder-goto-first-unread-folder
1909 Enter summary mode of the first unread folder.
1910 (@code{wl-folder-goto-first-unread-folder})
1914 @findex wl-folder-empty-trash
1916 (@code{wl-folder-empty-trash})
1920 @findex wl-folder-flush-queue
1922 (@code{wl-folder-flush-queue})
1926 @findex wl-folder-virtual
1927 Move to the virtual folder with the condition specified.
1928 (@code{wl-folder-virtual})
1932 @findex wl-folder-pick
1933 Search the folders with the condition specified.
1934 (@code{wl-folder-pick})
1938 @findex wl-folder-open-all-unread-folder
1939 All unread folder is opened.
1940 (@code{wl-folder-open-all-unread-folder})
1944 @findex wl-folder-open-close
1945 Folder group is opened/closed.
1946 (@code{wl-thread-open-close})
1950 All folder group is opened.
1951 (@code{wl-folder-open-all})
1955 All folder group is closed.
1956 (@code{wl-folder-close-all})
1966 (@code{wl-folder-suspend})
1969 @kindex M-s (Folder)
1970 Save current folder status.
1974 @kindex M-t (Folder)
1975 Toggle Wanderlust's offline/online status.
1976 (@code{wl-toggle-plugged})
1979 @kindex C-t (Folder)
1980 Start Wanderlust's plug-status manager.
1981 (@code{wl-plugged-change})
1984 @subsection Customize variables
1987 @item wl-folders-file
1988 @vindex wl-folders-file
1989 The initial setting is @file{~/.folders}.
1990 Subscribed folders are described (saved) in this file.
1992 @item wl-folder-info-save
1993 @vindex wl-folder-info-save
1994 The initial setting is @code{t}. If non-nil, unread information is
1995 saved and used in the next Wanderlust session.
1997 @item wl-stay-folder-window
1998 @vindex wl-stay-folder-window
1999 The initial setting is @code{nil}.
2000 If non-nil, summary window is appeared on the right side of the folder buffer.
2002 @item wl-folder-window-width
2003 @vindex wl-folder-window-width
2004 The initial setting is 20.
2005 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2007 @item wl-folder-use-frame
2008 @vindex wl-folder-use-frame
2009 The initial setting is @code{nil}.
2010 If non-nil, use new frame for the folder window.
2012 @item wl-folder-many-unsync-threshold
2013 @vindex wl-folder-many-unsync-threshold
2014 The initial setting is 70.
2015 If the number of unread messages is more than this value,
2016 folder color is changed.
2018 @item wl-highlight-folder-by-numbers
2019 @vindex wl-highlight-folder-by-numbers
2020 This option controls how to highlight each line in the folder buffer.
2021 The default value is @code{t}, highlighting with various colors based on
2022 the message numbers. If it is @code{nil}, highlighting with various
2023 colors based on the folder status. In addition, if it is a number
2024 (e.g. 1), highlighting will be done based on both the message numbers
2025 and the folder status.
2027 @item wl-folder-desktop-name
2028 @vindex wl-folder-desktop-name
2029 The initial setting is @samp{Desktop}.
2030 The name of top folder group.
2032 @item wl-folder-petname-alist
2033 @vindex wl-folder-petname-alist
2034 The initial setting is @code{nil}.
2035 An alist of folder's realname and its nickname.
2037 @item wl-folder-access-subscribe-alist
2038 @vindex wl-folder-access-subscribe-alist
2039 The initial setting is @code{nil}.
2041 Control automatic subscribing and unsubscribing of the children list
2047 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2051 If @var{subscribe-flag} is non-nil, folders which have name matched to
2052 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2053 already unsubscribed folder is not displayed even when the
2054 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2061 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2062 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2063 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2064 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2068 @item wl-folder-hierarchy-access-folders
2069 @vindex wl-folder-hierarchy-access-folders
2070 The initial setting is the list shown below:
2079 A list of regular expressions for access groups which creates children
2080 folder list hierarchically.
2082 For example, if you specify
2083 @code{wl-folder-hierarchy-access-folders} like following,
2087 (setq wl-folder-hierarchy-access-folders
2088 '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
2093 you obtain the access group hierarchy as follows.
2099 -fj.comp.announce:0/0/2
2100 -fj.comp.dev.cdrom:0/0/0
2102 [+]-japan:238/238/1688
2105 -comp.unix.admin:0/0/0
2106 -comp.unix.dos-under-unix:0/0/0
2107 -comp.unix.programmer:0/0/0
2108 [-]-comp.unix.bsd:0/0/23
2109 -comp.unix.bsd.freebsd.announce:0/0/0
2114 If you opened @samp{-} in this example, only the direct children is created
2115 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2116 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2117 is not created until the children access group is opened.
2121 @node Folder Manager, , Selecting Folder, Folder
2122 @section Editing Folders
2123 @cindex Folder Manager
2124 @cindex Folder, Edit
2125 @cindex Folder, Subscribe
2126 @cindex Folder, Unsubscribe
2128 As described before, subscribed folder list is saved in @file{~/.folders} file.
2129 But you don't have to edit @file{~/.folders} directly.
2130 You can append, delete, edit folders from folder mode.
2132 @subsection Usage (Tips)
2134 @subsubsection Append Folder
2136 @kbd{m a} appends new folder to the folder mode.
2137 @kbd{m g} appends new folder group.
2138 To append new folder to this group, firstly open it,
2139 then execute append command in the next line.
2141 @subsubsection Edit Folder
2143 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2144 Thus, you can change folder position as if you were editing a normal file.
2146 @subsubsection Create Multi Folder.
2150 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2152 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2154 Type @kbd{m m}, then you can create multi folder.
2157 @subsubsection Delete Nickname, Filter
2159 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2160 minibuffer while appending.
2162 @subsubsection Append Folder to Empty Group
2164 To append new folder to the empty folder group
2165 (after you create folder group by typing @kbd{m g}),
2166 firstly open it, then execute append command in the next line.
2167 If it is closed, folder is appended on the same level with
2168 the folder group above. It is difficult to explain by words so try it.
2169 In other words, appended position depends on the
2170 open/close status of the upper one.
2172 @subsubsection Charset of the Folders File.
2174 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2176 @subsubsection Create Filter
2178 @kbd{m f} adds filter to the folder at the current cursor point. To
2179 create new filter folder and leave the current folder unchanged, copy it
2180 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2181 filter can be specified while appending filter. If you put
2182 ``''(@var{NULL}), filter is deleted.
2184 @subsubsection Sort Folders
2186 Sorting of the folders is executed by the function specified by
2187 @code{wl-fldmgr-sort-function}.
2188 The initial setting is @code{wl-fldmgr-sort-standard},
2189 which sorts alphabetically.
2190 Sorting affects only on the current folder group. It does not
2191 affect on the child groups.
2193 @subsubsection Hiding Folders in the Access Group
2195 Usually, access group displays all children folders, but you can set
2196 some folders hidden. Following operations are only available on access
2199 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2200 (subscribe/unsubscribe) of the folder at current cursor point. Against
2201 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2204 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2205 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2206 argument and if the argument has positive number, the unsubscribe it.
2207 If the prefix argument has negative value, folder becomes visible and if
2208 zero, folder visibility is toggled.
2210 The other commands, @code{wl-fldmgr-subscribe} and
2211 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2214 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2215 executed in the access group, they have a same effect with
2216 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2217 The difference is that cut commands deletes folders from the current
2220 @subsubsection Operations in the Access Group
2222 You can insert and delete folders in the access group like usual folder
2223 group. But insert and delete commands can be only available for the
2224 children folders of the access group and they only sets the subscribe
2225 status. In other words, insertion of the folder means subscribing,
2226 deletion means unsubscribing.
2227 @footnote{In the current implementation,
2228 it is faster to delete region than to unsubscribe region.}
2230 To update the access group when children folders are inserted or deleted
2231 by other way (other than Wanderlust),
2232 open the access group by typing @kbd{C-u @key{RET}}.
2233 @xref{Selecting Folder}.
2235 The order of children folders of access group is saved after
2236 insertion/deletion/sorting.
2237 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2238 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2239 newly created folders are inserted on the top of the access group.
2241 @subsection Key bindings
2242 @cindex Keybind, Folder Mode
2243 @cindex Keybind, Folder Buffer
2245 Key bindings on the folder mode related to folder editing are shown below.
2246 All bindings starts with @kbd{m}, and primary commands are binded to
2247 one stroke key binding.
2251 @kindex m a (Folder)
2252 @findex wl-fldmgr-add
2254 (@code{wl-fldmgr-add})
2259 @kindex m g (Folder)
2260 @findex wl-fldmgr-make-group
2261 Create a folder group.
2262 (@code{wl-fldmgr-make-group})
2265 @kindex m A (Folder)
2266 @findex wl-fldmgr-make-access-group
2267 Create an access group.
2268 (@code{wl-fldmgr-make-access-group})
2271 @kindex m d (Folder)
2272 @findex wl-fldmgr-delete
2273 Delete folder itself and msgdb.
2274 If the folder itself cannot be deleted like NNTP folder,
2275 only msgdb is deleted.
2276 (@code{wl-fldmgr-delete})
2281 @kindex m R (Folder)
2282 @findex wl-fldmgr-rename
2283 Change the name of folder or folder group.
2284 msgdb's path is also changed.
2285 (@code{wl-fldmgr-rename})
2291 @findex wl-fldmgr-make-multi
2292 Create a multi folders in the cutlist (cut, copied folders).
2293 (@code{wl-fldmgr-make-multi})
2298 @kindex m f (Folder)
2299 @findex wl-fldmgr-make-filter
2300 Create a filter folder. (Put a filter on the folder).
2301 (@code{wl-fldmgr-make-filter})
2305 @kindex M-c (Folder)
2306 @kindex m c (Folder)
2307 @findex wl-fldmgr-copy
2308 Copy folder (it is not available on folder group).
2309 (@code{wl-fldmgr-copy})
2313 @kindex M-w (Folder)
2314 @kindex m W (Folder)
2315 @findex wl-fldmgr-copy-region
2316 Copy folders in the specified region.
2317 (@code{wl-fldmgr-copy-region})
2321 @kindex C-k (Folder)
2322 @kindex m k (Folder)
2323 @findex wl-fldmgr-cut
2324 Cut folder. Folder itself is not deleted.
2325 (@code{wl-fldmgr-cut})
2329 @kindex C-w (Folder)
2330 @kindex m C-w (Folder)
2331 @findex wl-fldmgr-cut-region
2332 Cut folders in the specified region.
2333 (@code{wl-fldmgr-cut-region})
2337 @kindex C-y (Folder)
2338 @kindex m y (Folder)
2339 @findex wl-fldmgr-yank
2340 Paste folders that are copied or cut (folders in the cut-list).
2341 (@code{wl-fldmgr-yank})
2344 @kindex m p (Folder)
2345 @findex wl-fldmgr-set-petname
2346 Put nickname on the folder.
2347 (@code{wl-fldmgr-set-petname})
2350 @kindex m q (Folder)
2351 @findex wl-fldmgr-clear-cut-entity-list
2352 Clear the cut-list. (cut, copied folder information is cleared,
2353 you cannot paste after this)
2354 (@code{wl-fldmgr-clear-cut-entity-list})
2357 @kindex m s (Folder)
2358 @findex wl-fldmgr-sort
2359 Sort folders in the current folder group.
2360 (@code{wl-fldmgr-sort})
2363 @kindex m C-s (Folder)
2364 @findex wl-fldmgr-save
2365 Save current folder view to the @file{wl-folders-file}.
2366 (@code{wl-fldmgr-save})
2369 [Following commands are only available on the access groups]
2375 @kindex m u (Folder)
2376 @findex wl-fldmgr-unsubscribe
2377 Set the visibility of folder (subscribe/unsubscribe).
2378 (@code{wl-fldmgr-unsubscribe})
2383 @kindex r u (Folder)
2384 @findex wl-fldmgr-unsubscribe-region
2385 Set the visibility of the folders (subscribe/unsubscribe) in the
2387 (@code{wl-fldmgr-unsubscribe-region})
2392 @kindex m l (Folder)
2393 @findex wl-fldmgr-access-display-normal
2394 List folders that are currently available.
2395 (@code{wl-fldmgr-access-display-normal})
2400 @kindex m L (Folder)
2401 @findex wl-fldmgr-access-display-all
2402 List all folders regardless of the subscription status.
2403 (@code{wl-fldmgr-access-display-all})
2407 @subsection Customize variables
2410 @item wl-interactive-save-folders
2411 @vindex wl-interactive-save-folders
2412 The initial setting is @code{t}. If non-nil and folder view is
2413 modified, confirm saving it before Wanderlust or Emacs exits. If
2414 @code{nil}, save without confirmation.
2416 @item wl-fldmgr-make-backup
2417 @vindex wl-fldmgr-make-backup
2418 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2419 created before saving the folder status.
2421 @item wl-fldmgr-sort-function
2422 @vindex wl-fldmgr-sort-function
2423 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2424 sort folders. By default function, folders are sorted alphabetically
2425 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2428 @item wl-fldmgr-sort-group-first
2429 @vindex wl-fldmgr-sort-group-first
2430 The initial setting is @code{t}. If non-nil,
2431 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2432 does not care whether it is folder group or not.
2434 @item wl-folder-check-async
2435 @vindex wl-folder-check-async
2436 The initial setting is @code{t}. If non-nil, check folder's unread
2437 status asynchronously. It boosts newsgroup checking.
2439 @item wl-folder-check-fast
2440 @vindex wl-folder-check-fast
2441 The initial setting is @code{nil}.
2442 If non-nil, it does not update folder status while checking.
2444 @item wl-folder-notify-deleted
2445 @vindex wl-folder-notify-deleted
2446 The initial setting is @code{nil}.
2448 If non-nil, negative value is displayed when the message is deleted. If
2449 @code{sync}, folder is synchronized when the message is deleted. If
2450 @code{nil}, message deletion is ignored.
2452 @item wl-fldmgr-add-complete-with-current-folder-list
2453 @vindex wl-fldmgr-add-complete-with-current-folder-list
2454 The initial setting is @code{nil}.
2455 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2456 candidate for @code{wl-fldmgr-add}.
2459 @subsection Miscellanea
2461 Following is a note for folder editing.
2465 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2466 paste(yank) command pastes the folders on one cut or copy command
2467 (If copy command is executed by region, folders in the region are pasted
2468 by one paste command)
2471 You cannot cut @samp{Desktop} group.
2472 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2475 You cannot copy folder group.
2478 Operations on the access group are only available for the folders
2479 in the same access group.
2482 You cannot create a folder which has same name with the folders already exist.
2485 You cannot insert folders which have same name in one group.
2486 You can insert them in the different groups.
2487 You cannot put same nickname to the different folders.
2491 @node Summary, Message, Folder, Top
2492 @chapter Summary Mode
2494 After you select the folder via folder mode, you enter to the summary
2498 * Usage of Summary Mode:: TIPS
2499 * Thread Operations:: Thread operations
2500 * Cache:: File cache, Buffer cache, and Prefetch
2501 * Auto Refile:: Auto refile settings
2502 * Sticky Summary:: Summary make sticky
2503 * Summary View:: Format of summary lines
2504 * Key Bindings of Summary:: Key bindings
2505 * Variables of Summary:: Customize Summary Mode
2509 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2510 @section Usage (Tips)
2512 @subsection Summary Content
2514 In the summary mode, messages are displayed like following.
2518 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2519 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2520 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2521 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2528 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2532 You cannot change this in the current version.
2534 @var{Message number} is the message's unique number in the folder. In
2535 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2536 in the MH folder, it is the filename of the message.
2538 @var{Temporal mark} and @var{Persistent mark} are described later.
2540 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2541 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2542 Japanese, but if you want to display it in English, set the value of
2543 @code{wl-summary-weekday-name-lang} as @samp{en}.
2545 @var{Sender}'s indentation corresponds to the depth of the thread.
2546 Sender name is displayed as nickname if it is defined in the address
2547 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2548 displaying with nickname.
2550 If number is printed at the head of @var{Sender} part like @samp{+2},
2551 that means the message have 2 follow messages.
2553 @var{Subject} is the @samp{Subject:} header field of the message. If
2554 the message have same @samp{Subject:} with the parent message, it is not
2555 displayed. Some mailing list puts its sequence number in the
2556 @samp{Subject:} field, but it is
2557 ignored. @code{wl-summary-no-subject-message} is displayed when the
2558 message has empty subject field.
2560 @subsection Temporary Marks
2561 @cindex Mark, Temporary
2563 There are four temporary marks,
2564 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2565 Temporary marks indicates message operations.
2570 You can execute a command on the all messages that have @samp{*} mark,
2571 with the key bindings which begins with @kbd{m}.
2574 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2578 After you type @kbd{o} key, prompt appears to input refile destination.
2579 Your answer is printed in the summary line.
2583 You can put this mark by typing @kbd{O} key.
2584 The difference between this mark and refile mark is,
2585 this mark does not delete the message while latter does.
2588 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2590 @subsection Persistent Marks
2592 There are five persistent marks,
2593 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2595 The persistent mark indicates the message's status and it is saved.
2596 Each persistent mark indicates:
2602 It is unread message.
2604 It is unread but cached message.
2606 It is read but it is not cached.
2608 It is important message. You can put @samp{$} mark by typing @kbd{$}
2609 key (if already exists, the mark is deleted). It is convenient to put
2610 this mark on the messages to remember (If you want to remember to write
2611 a reply for the message, for example) because this mark remains after
2612 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2613 @samp{'mark} folder even the message itself is deleted in the actual folder.
2616 If the message is read and cached (or local message),there are no
2620 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2621 cache. Messages with the marks other than these, you can read them in
2622 the offline status even they are in the IMAP folder or netnews folder.
2624 Among messages with persistent marks, ones with marks specified by
2625 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2626 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2628 @subsection How To Read
2630 Basically, you can read messages only typing space key again and again.
2632 To update summary status to the newest status (synchronize),
2635 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2636 moves cursor to the next message.
2637 Enter message buffer by typing @kbd{j} key.
2638 To operate multipart, you have to enter to the message buffer.
2641 @subsection Pack the Message Numbers
2642 You can pack the message numbers in Summary by
2643 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2644 News Spool Folder and Maildir Folder are supported folder types.
2647 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2648 @section Thread Operations
2650 For example, the following line indicates one thread (a context of a topic).
2653 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2657 If you type @kbd{/} on this line, the thread is opened and it changes
2658 the appearance like following.
2662 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2663 388 09/17(Thu)22:34 +-[ Murata san ]
2667 (Message 388 is the replied message to the message 384.)
2668 If you type @kbd{/} key once again, the thread is closed.
2669 With prefix argument, @kbd{/} opens all children threads.
2671 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2674 Commands with the key binding that begins with @kbd{t} executes commands
2675 on the messages in the thread.
2676 @xref{Key Bindings of Summary}.
2678 @subsection reconstruct thread by hand
2680 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2681 (@code{wl-summary-save-current-message}) at the corresponding message,
2682 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2683 message then you have the reconstructed thread.
2686 @node Cache, Auto Refile, Thread Operations, Summary
2689 @subsection Cache File
2691 The messages which have to access via network (e.x. IMAP, NNTP folder)
2692 are cached as a local file. The cache file is saved under the directory
2693 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2694 elmo-cache-expire-by-size}. The command deletes cache files to the
2695 specified size by the order of last accessed time.
2697 @subsection Buffer Cache and Prefetching
2699 The messages that are read are kept in the cache buffer. It is called
2700 `buffer cache'. The number of cache buffer is specified by
2701 @code{wl-message-buffer-cache-size}.
2703 There are message prefetching mechanism in the Wanderlust that
2704 prefetches next message while you are reading.
2706 You can control the message prefetching mechanism by these two
2710 @item wl-message-buffer-prefetch-folder-type-list
2711 @vindex wl-message-buffer-prefetch-folder-type-list
2712 The initial setting is @code{t}. In this case, prefetch messages in all
2714 If it is a list of folder types, it specifies the folder types in which
2715 message prefetching is enabled.
2716 Following is an example (prefetch messages in nntp and imap4 folders)
2720 (setq wl-message-buffer-prefetch-folder-type-list
2725 In this case, multi folder that contains localdir and imap4 prefetches
2726 only imap4 messages. This variable precedes the value of
2727 @code{wl-message-buffer-prefetch-folder-list}.
2729 @item wl-message-buffer-prefetch-folder-list
2730 @vindex wl-message-buffer-prefetch-folder-list
2731 The initial setting is @code{nil}.
2732 A list of regexp of folders to enable message prefetching.
2734 @item wl-message-buffer-prefetch-depth
2735 @vindex wl-message-buffer-prefetch-depth
2736 The initial setting is 3. The number of messages for automatical prefetch.
2738 @item wl-message-buffer-prefetch-idle-time
2739 @vindex wl-message-buffer-prefetch-idle-time
2740 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2742 @item wl-message-buffer-prefetch-threshold
2743 @vindex wl-message-buffer-prefetch-threshold
2744 The initial setting is 30000 (bytes). If prefetching message has larger
2745 size than this value, Wanderlust does not prefetch automatically.
2746 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2747 the message is not checked for the size.
2749 @item wl-auto-prefetch-first
2750 @vindex wl-auto-prefetch-first
2751 The initial setting is @code{nil}.
2752 If non-nil, first message is automatically prefetched to the buffer
2753 when you enter the folder.
2757 @node Auto Refile, Sticky Summary, Cache, Summary
2758 @section Auto Refile
2759 @vindex elmo-msgdb-extra-fields
2760 @vindex wl-refile-rule-alist
2761 @findex wl-summary-auto-refile
2763 You can refile messages automatically, by typing @kbd{C-o}
2764 (@code{wl-summary-auto-refile}). It decides destination of refile by
2765 the content of the message header information (information in the msgdb).
2767 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2768 available. If you want to decide destination by other header fields,
2769 set the variable @code{elmo-msgdb-extra-fields} like following.
2773 (setq elmo-msgdb-extra-fields
2783 By this setting, Wanderlust saves extra fields in the msgdb. You have
2784 to type @kbd{s all} to get extra fields for the messages that are
2785 already exists in the summary.
2787 Then, specify the refile rule. The refile target folder of auto
2788 refiling is decided by the value of @code{wl-refile-rule-alist}.
2789 @code{wl-refile-rule-alist} is a list of a rule:
2793 (@var{field} (@var{regexp} . @var{target})
2794 (@var{regexp} . @var{target})
2799 Each rule means `if @var{field} value matches @var{regexp},
2800 then refile to @var{target} folder'.
2801 The rule matched first is applied.
2803 @var{field} is a string of field name. You can specify a list of field name
2804 string, too. In this case, if one of these fields is matched, then the
2805 rule is fired (i.e. OR condition).
2807 @var{regexp} is a regular expression for field value. @var{target} is a target
2808 folder string. You can specify a rule at @var{target} part, too. In this
2809 case, If the field value of the rule and the current rule is matched,
2810 then the current rule is fired (i.e. AND condition).
2812 You can refer matched substring of @var{regexp} to specify @var{target} part.
2813 To refer substring, use following keys:
2817 means substitute original matched text.
2820 means substitute what matched the @var{N}th `\(@dots{}\)'.
2821 (@var{N} is a number.)
2824 Following is an example of @code{wl-refile-rule-alist}.
2828 (setq wl-refile-rule-alist
2830 ("^Wanderlust" . "+wl")
2831 ("^Elisp" . "+elisp"))
2833 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2835 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2836 "+from-me-to-you"))))))
2840 After these settings, refile marks are automatically put on the condition
2841 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2843 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2845 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2846 with these persistent marks are not automatically refiled.
2847 It means Wanderlust does not execute auto refile on unread messages by
2848 the default setting.
2849 To execute auto refile on all messages, set following.
2852 (setq wl-summary-auto-refile-skip-marks nil)
2856 @node Sticky Summary, Summary View, Auto Refile, Summary
2857 @section Sticky Summary
2858 @cindex Summary, Sticky
2859 @cindex Sticky Summary
2861 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2863 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2864 @kbd{G} in some suummary sticky summary buffer is created.
2865 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2866 makes current one sticky.
2868 The buffer name of the sticky summary becomes like
2869 @samp{Summary:@var{folder-name}}.
2870 You can visit the sticky summary at any time by @kbd{C-x b}
2871 (@code{switch-to-buffer}), or you can go round summary buffers by
2872 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2873 (@code{wl-summary-next-buffer}) in summary mode.
2875 In sticky summary, the summary buffer is preserved after @kbd{g} or
2876 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2877 another summary by @kbd{C-u g}. Other operations in the sticky summary
2878 are same as normal summary.
2880 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2881 are automatically stuck.
2884 @node Summary View, Key Bindings of Summary, Sticky Summary, Summary
2885 @section Format of summary lines
2886 @cindex Format of summary lines
2887 You can alter the format of lines in Summary mode.
2889 Summary line format is specified by @code{wl-summary-line-format}.
2890 You can use control strings defined by
2891 @code{wl-summary-line-format-spec-alist}.
2897 ;; @r{number temporary-mark persistent-mark date branch}
2898 ;; @r{[ (number-of-children) sender ] subject}
2899 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2903 Where the number set the column number of the field (for negative value,
2906 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2907 are displayed in the following list.
2918 %t branch of the thread
2919 %[ [ (< for re-connected child)
2920 %] ] (> for re-connected child)
2924 %c +number-of-children: (display only for opened thread)
2925 %C [+number-of-children] (display only for opened thread)
2926 %T temporary mark (mandatory)
2927 %P persistent mark (mandatory)
2931 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
2932 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
2933 the constant column. For example, if you specify @samp{%T} or
2934 @samp{%P} after the @samp{%t}, which changes its length by thread
2935 position, marks are not treated correctly.
2937 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
2938 column of the enclosed region is justified to the `number'. Multiple
2939 level @samp{%number(} parenthesis can be defined. It is useful to
2940 justify the column of the multiple control strings. For example, in the
2941 above @code{wl-summary-line-format},
2947 means ``Adjust number-of-children and sender string to the 17 column''.
2949 You can specify the format by each folders with
2950 @code{wl-folder-summary-line-format-alist}. Please set regular
2951 expression for folder names and summary line format as the following
2956 (setq wl-folder-summary-line-format-alist
2957 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
2958 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
2963 @node Key Bindings of Summary, Variables of Summary, Summary View, Summary
2964 @section Key bindings
2965 @cindex Keybind, Summary Mode
2966 @cindex Keybind, Summary Buffer
2968 Key bindings of the summary mode are shown below.
2972 @kindex @key{SPC} (Summary)
2973 @findex wl-summary-read
2974 Proceed reading a message at the current cursor point.
2975 (@code{wl-summary-read})
2979 @findex wl-summary-redisplay
2980 Redisplay a message at the current cursor point.
2981 If this command is called with prefix argument,
2982 Redisplay message regardless of the message cache (message is re-loaded
2984 (@code{wl-summary-redisplay})
2988 @findex wl-summary-display-top
2989 Display the top message in the folder.
2990 (@code{wl-summary-display-top})
2994 @findex wl-summary-display-bottom
2995 Display the bottom message in the folder.
2996 (@code{wl-summary-display-bottom})
3000 @kindex @key{BS} (Summary)
3001 @kindex @key{DEL} (Summary)
3002 Display the previous page of the message at the current cursor point.
3003 @findex wl-summary-prev-page
3004 (@code{wl-summary-prev-page})
3007 @kindex @key{RET} (Summary)
3008 @findex wl-summary-next-line-content
3009 Display the next line of the message at the current cursor point.
3010 Display the message at the current cursor point if it is not displayed yet.
3011 (@code{wl-summary-next-line-content})
3016 @kindex M-@key{RET} (Summary)
3017 @findex wl-summary-prev-line-content
3018 Display the previous line of the message at the current cursor point.
3019 Display the message at the current cursor point if it is not displayed yet.
3020 (@code{wl-summary-prev-line-content})
3024 @findex wl-thread-open-close
3025 Toggle open or close the thread at the current cursor point.
3026 (@code{wl-thread-open-close})
3031 @findex wl-thread-open-all
3032 (@code{wl-thread-open-all})
3037 @findex wl-thread-close-all
3038 (@code{wl-thread-close-all})
3042 @findex wl-summary-goto-folder
3044 (@code{wl-summary-goto-folder})
3048 Mark all messages in the folder as read.
3049 @findex wl-summary-mark-as-read-all
3050 (@code{wl-summary-mark-as-read-all})
3054 @findex wl-summary-reply
3055 Prepare a draft for reply the message at the current cursor point.
3056 (@code{wl-summary-reply})
3060 @findex wl-summary-reply-with-citation
3061 Prepare a draft for reply the message at the current cursor point.
3062 (@code{wl-summary-reply-with-citation})
3066 @findex wl-summary-cancel-message
3067 If the message at current cursor point is your own netnews article,
3069 (@code{wl-summary-cancel-message})
3073 @findex wl-summary-reedit
3074 Prepare a draft for re-editing the message at current cursor point.
3075 If the message at current cursor point is your own netnews article,
3076 a draft for `supersedes message' for the message is prepared.
3077 (@code{wl-summary-reedit})
3080 @kindex M-e (Summary)
3081 @findex wl-summary-resend-bounced-mail
3082 If the message at current cursor point is a bounced message,
3083 a draft for re-sending original message is prepared.
3084 (@code{wl-summary-resend-bounced-mail})
3088 @findex wl-summary-forward
3089 A draft for forwarding the message at current cursor point is prepared.
3090 (@code{wl-summary-forward})
3094 @findex wl-summary-mark-as-important
3095 Put @samp{$} mark on the message at current cursor point.
3096 If already marked as @samp{$}, delete it.
3097 (@code{wl-summary-mark-as-important})
3103 Save the message at current cursor point.
3104 @findex wl-summary-save
3105 (@code{wl-summary-save})
3109 @findex wl-summary-next
3110 Move cursor to the next message.
3111 If message is marked with a temporal mark in
3112 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3113 In the offline mode, cursor is not moved to the messages which are not cached
3115 (@code{wl-summary-next})
3119 @findex wl-summary-prev
3120 Move cursor to the previous message.
3121 If message is marked with a temporal mark in
3122 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3123 In the offline mode, cursor is not moved to the messages which are not cached
3125 (@code{wl-summary-prev})
3129 @findex wl-summary-down
3130 Move cursor to the downward message which is unread or marked
3132 In the offline mode, cursor is not moved to the messages which are not cached
3134 If there are messages which have target mark @samp{*} in the summary,
3135 cursor is moved to the downward message which have a target mark.
3136 This behavior is changed according to the value of @code{wl-summary-move-order}.
3137 (@code{wl-summary-down})
3141 @findex wl-summary-up
3142 Move cursor to the upward message which is unread or marked
3144 In the offline mode, cursor is not moved to the messages which are not cached
3146 If there are messages which have target mark @samp{*} in the summary,
3147 cursor is moved to the downward message which have a target mark.
3148 This behavior is changed according to the value of @code{wl-summary-move-order}.
3149 (@code{wl-summary-up})
3153 @findex wl-summary-write
3154 Prepare a new draft.
3155 (@code{wl-summary-write})
3159 @findex wl-summary-write-current-folder
3160 Prepare a new draft. If the current folder is NNTP folder,
3161 @samp{Newsgroups:} field is completed. If the current folder is mailing
3162 list folder (refile destination), guess @samp{To:} field and completed
3163 (If @code{wl-subscribed-mailing-list} is valid list)
3164 (@code{wl-summary-write-current-folder})
3168 @findex wl-summary-redisplay-all-header
3169 Redisplay the message at current cursor point with all header fields.
3170 (@code{wl-summary-redisplay-all-header})
3174 @findex wl-summary-redisplay-no-mime
3175 Redisplay the message at current cursor point without MIME analysis.
3176 (@code{wl-summary-redisplay-no-mime})
3180 @findex wl-summary-burst
3181 If the message at current cursor point has
3182 encapsulates multiple messages using MIME,
3183 de-capsulate and extract them on the current folder.
3184 (@code{wl-summary-burst})
3187 @kindex @@ (Summary)
3188 @findex wl-summary-edit-addresses
3189 Append/change/delete the message's sender information to the address
3190 book @file{~/.addresses} interactively. If this command is called with
3191 prefix argument, arbitrary address can be edited.
3192 (@code{wl-summary-edit-petname})
3196 @findex wl-status-update
3197 Sync up address book status with @file{~/.addresses}'s content.
3198 (@code{wl-status-update})
3202 @findex wl-summary-pipe-message
3203 Pipe current message's content to the external process.
3204 (@code{wl-summary-pipe-message})
3208 @findex wl-summary-print-message
3209 Print out current message's content.
3210 It uses @code{ps-print} module in Emacs 20.x.
3211 If you don't use color printer, you might want to set
3212 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3215 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3218 (@code{wl-summary-print-message})
3222 @findex wl-summary-exit
3223 Exit current folder.
3224 (@code{wl-summary-exit})
3228 @findex wl-summary-jump-to-current-message
3229 Jump cursor to the currently displayed message's window.
3230 (@code{wl-summary-jump-to-current-message})
3234 Jump cursor to the other message.
3235 @findex wl-summary-jump-to-msg
3236 (@code{wl-summary-jump-to-msg})
3240 Update summary status and
3241 prefetch all messages which have marks included in the
3242 @code{wl-summary-incorporate-marks}.
3243 @findex wl-summary-incorporate
3244 (@code{wl-summary-incorporate})
3247 @kindex M-j (Summary)
3248 @findex wl-summary-jump-to-msg-by-message-id
3249 Jump cursor to the message which have specified @samp{Message-Id:}. If
3250 @code{elmo-use-database} is non-nil, other folder is also searched.
3251 (@code{wl-summary-jump-to-msg-by-message-id})
3255 Jump to parent message.
3256 @findex wl-summary-jump-to-parent-message
3257 (@code{wl-summary-jump-to-parent-message})
3261 @findex wl-summary-mark-as-unread
3262 Mark as unread the message at current cursor point.
3263 (@code{wl-summary-mark-as-unread})
3267 @findex wl-summary-sync
3268 Synchronize summary view after prompting the update range
3269 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3273 all ...Discard current summary and update all message.
3274 all-visible ...Discard current summary and update all visible message.
3275 update ...Update the difference between summary and the folder itself.
3276 rescan ...Rescan the msgdb and display again.
3277 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3278 cache-status ...Sync the all marks with the real status of cache.
3279 first, last ...Move to the filter folder(partial filter).
3284 (@code{wl-summary-sync})
3288 @findex wl-summary-sort
3290 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3291 (@code{wl-summary-sort})
3295 @findex wl-summary-toggle-thread
3296 Toggle the threading.
3297 Threading status is displayed on the modeline.
3298 @samp{@{S@}} means threading is off (Sequence) and
3299 @samp{@{T@}} means threading is on (Thread).
3300 (@code{wl-summary-toggle-thread})
3304 @findex wl-summary-toggle-disp-folder
3305 Toggle displaying of folder window.
3306 (@code{wl-summary-toggle-disp-folder})
3310 Toggle displaying of message window.
3311 @findex wl-summary-toggle-disp-msg
3312 (@code{wl-summary-toggle-disp-msg})
3316 Move to the virtual folder with the condition specified.
3317 If called with prefix argument and current folder is virtual, exit it.
3318 @findex wl-summary-virtual
3319 (@code{wl-summary-virtual})
3322 @kindex @key{TAB} (Summary)
3323 @findex wl-summary-goto-last-displayed-msg
3324 Jump to the message which is displayed last.
3325 (@code{wl-summary-goto-last-displayed-msg})
3329 Put @samp{*} mark on the messages that satisfies the specified condition.
3330 @findex wl-summary-pick
3331 (@code{wl-summary-pick})
3335 @findex wl-summary-mark-as-read
3336 Mark as read the message at the current cursor point.
3337 (@code{wl-summary-mark-as-read})
3341 Prefetch the message at the current cursor point.
3342 With prefix argument, prefetch the message even if it is cached.
3343 @findex wl-summary-prefetch
3344 (@code{wl-summary-prefetch})
3348 Execute @samp{D}, @samp{o} and @samp{O} marks.
3349 @findex wl-summary-exec
3350 (@code{wl-summary-exec})
3354 @findex wl-summary-target-mark-line
3355 Put target mark on the message at the current cursor point.
3356 (@code{wl-summary-target-mark-line})
3360 Put refile mark on the message at the current cursor point.
3361 @findex wl-summary-refile
3362 (@code{wl-summary-refile})
3365 @kindex C-o (Summary)
3366 Execute auto refile.
3367 @findex wl-summary-auto-refile
3368 (@code{wl-summary-auto-refile})
3372 Put copy mark on the message at the current cursor point.
3373 @findex wl-summary-copy
3374 (@code{wl-summary-copy})
3377 @kindex M-o (Summary)
3378 Put refile mark on the message at the current cursor point with the destination
3379 previously specified.
3380 @findex wl-summary-refile-prev-destination
3381 (@code{wl-summary-refile-prev-destination})
3385 @findex wl-summary-delete
3386 Put delete mark on the message at the current cursor point.
3387 (@code{wl-summary-delete})
3391 @findex wl-summary-unmark
3392 Unmark the temporal mark on the message at the current cursor point.
3393 (@code{wl-summary-unmark})
3397 Unmark all the temporal marks.
3398 @findex wl-summary-unmark-all
3399 (@code{wl-summary-unmark-all})
3402 @kindex r R (Summary)
3403 @findex wl-summary-mark-as-read-region
3404 Mark as read messages in the specified region.
3405 (@code{wl-summary-mark-as-read-region})
3408 @kindex r $ (Summary)
3409 @findex wl-summary-mark-as-important-region
3410 Mark as important @samp{$} messages in the specified region.
3411 If @samp{$} already exists, it is deleted.
3412 (@code{wl-summary-mark-as-important-region})
3415 @kindex r ! (Summary)
3416 @findex wl-summary-mark-as-unread-region
3417 Mark as unread messages in the specified region.
3418 (@code{wl-summary-mark-as-unread-region})
3421 @kindex r i (Summary)
3422 @findex wl-summary-prefetch-region
3423 Prefetch messages in the specified region.
3424 (@code{wl-summary-prefetch-region})
3427 @kindex r x (Summary)
3428 @findex wl-summary-exec-region
3429 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3431 (@code{wl-summary-exec-region})
3434 @kindex r * (Summary)
3435 @findex wl-summary-target-mark-region
3436 Put target mark on the messages in the specified region.
3437 (@code{wl-summary-target-mark-region})
3440 @kindex r o (Summary)
3441 @findex wl-summary-refile-region
3442 Put refile mark on the messages in the specified region.
3443 (@code{wl-summary-refile-region})
3446 @kindex r O (Summary)
3447 @findex wl-summary-copy-region
3448 Put copy mark on the messages in the specified region.
3449 (@code{wl-summary-copy-region})
3452 @kindex r d (Summary)
3453 @findex wl-summary-delete-region
3454 Put delete mark on the messages in the specified region.
3455 (@code{wl-summary-delete-region})
3458 @kindex r u (Summary)
3459 @findex wl-summary-unmark-region
3460 Delete temporal mark on the messages in the specified region.
3461 (@code{wl-summary-unmark-region})
3464 @kindex r y (Summary)
3465 Save messages in the specified region.
3466 @findex wl-summary-save-region
3467 (@code{wl-summary-save-region})
3470 @kindex t R (Summary)
3471 @findex wl-thread-mark-as-read
3472 Mark as read messages which are the descendant of the current thread.
3473 With prefix argument, it affects on the all messages in the thread tree.
3474 (@code{wl-thread-mark-as-read})
3477 @kindex t $ (Summary)
3478 @findex wl-thread-mark-as-important
3479 Put important mark @samp{$} on the messages which are the
3480 descendant of the current thread.
3481 If @samp{$} mark exists, it is deleted.
3482 With prefix argument, it affects on the all messages in the thread tree.
3483 (@code{wl-thread-mark-as-important})
3486 @kindex t ! (Summary)
3487 @findex wl-thread-mark-as-unread
3488 Mark as unread messages which are the descendant of the current thread.
3489 With prefix argument, it affects on the all messages in the thread tree.
3490 (@code{wl-thread-mark-as-unread})
3493 @kindex t i (Summary)
3494 @findex wl-thread-prefetch
3495 Prefetch messages which are the descendant of the current thread.
3496 With prefix argument, it affects on the all messages in the thread tree.
3497 (@code{wl-thread-prefetch})
3500 @kindex t x (Summary)
3501 @findex wl-thread-exec
3502 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3503 the descendant of the current thread. With prefix argument, it affects
3504 on the all messages in the thread tree.
3505 (@code{wl-thread-exec})
3508 @kindex t * (Summary)
3509 @findex wl-thread-target-mark
3510 Put target mark @samp{*} on the messages which are the descendant of the
3511 current thread. With prefix argument, it affects on the all messages in
3513 (@code{wl-thread-target-mark})
3516 @kindex t o (Summary)
3517 @findex wl-thread-refile
3518 Put refile mark on the messages which are the descendant of the current thread.
3519 With prefix argument, it affects on the all messages in the thread tree.
3520 (@code{wl-thread-refile})
3523 @kindex t O (Summary)
3524 @findex wl-thread-copy
3525 Put copy mark on the messages which are the descendant of the current thread.
3526 With prefix argument, it affects on the all messages in the thread tree.
3527 (@code{wl-thread-copy})
3530 @kindex t d (Summary)
3531 @findex wl-thread-delete
3532 Put delete mar on the messages which are the descendant of the current thread.
3533 With prefix argument, it affects on the all messages in the thread tree.
3534 (@code{wl-thread-delete})
3537 @kindex t u (Summary)
3538 @findex wl-thread-unmark
3539 Unmark temporal mark on the messages which are the descendant of the
3540 current thread. With prefix argument, it affects on the all messages in
3542 (@code{wl-thread-unmark})
3545 @kindex t y (Summary)
3546 @findex wl-thread-save
3547 Save messages which are the descendant of the current thread.
3548 With prefix argument, it affects on the all messages in the thread tree.
3549 (@code{wl-thread-save})
3552 @kindex m i (Summary)
3553 @findex wl-summary-target-mark-prefetch
3554 Prefetch all messages which have target mark @samp{*}.
3555 With prefix argument, prefetch all targets even if some of them are cached.
3556 (@code{wl-summary-target-mark-prefetch})
3559 @kindex m R (Summary)
3560 @findex wl-summary-target-mark-mark-as-read
3561 Mark as read all messages which have target mark @samp{*}.
3562 (@code{wl-summary-target-mark-mark-as-read})
3565 @kindex m $ (Summary)
3566 @findex wl-summary-target-mark-mark-as-important
3567 Mark as important all messages which have target mark @samp{*}.
3568 If already marked as @samp{$}, it is deleted.
3569 (@code{wl-summary-target-mark-mark-as-important})
3572 @kindex m ! (Summary)
3573 @findex wl-summary-target-mark-mark-as-unread
3574 Mark as unread all messages which have target mark @samp{*}.
3575 (@code{wl-summary-target-mark-mark-as-unread})
3578 @kindex m o (Summary)
3579 @findex wl-summary-target-mark-refile
3580 Put refile mark on the messages which have target mark @samp{*}.
3581 (@code{wl-summary-target-mark-refile})
3584 @kindex m O (Summary)
3585 @findex wl-summary-target-mark-copy
3586 Put copy mark on the messages which have target mark @samp{*}.
3587 (@code{wl-summary-target-mark-copy})
3590 @kindex m d (Summary)
3591 @findex wl-summary-target-mark-delete
3592 Put delete mark on the messages which have target mark @samp{*}.
3593 (@code{wl-summary-target-mark-delete})
3596 @kindex m y (Summary)
3597 @findex wl-summary-target-mark-save
3598 Save messages which have target mark @samp{*}.
3599 (@code{wl-summary-target-mark-save})
3602 @kindex m u (Summary)
3603 Unmark all temporal marks.
3604 (@code{wl-summary-delete-all-temp-marks})
3605 @findex wl-summary-delete-all-temp-marks
3608 @kindex m a (Summary)
3609 Put target mark @samp{*} on the all messages.
3610 (@code{wl-summary-target-mark-all})
3611 @findex wl-summary-target-mark-all
3614 @kindex m t (Summary)
3615 Put target mark @samp{*} on the messages in the current thread.
3616 @findex wl-summary-target-mark-thread
3617 (@code{wl-summary-target-mark-thread})
3620 @kindex m r (Summary)
3621 @findex wl-summary-target-mark-region
3622 Put target mark @samp{*} on the messages in the specified region.
3623 (@code{wl-summary-target-mark-region})
3626 @kindex m A (Summary)
3627 @findex wl-summary-target-mark-reply-with-citation
3628 Prepare a draft which cites all messages which have target mark @samp{*}.
3629 (@code{wl-summary-target-mark-reply-with-citation})
3632 @kindex m f (Summary)
3633 @findex wl-summary-target-mark-forward
3634 Prepare a draft which forwards all messages which have target mark @samp{*}.
3635 (@code{wl-summary-target-mark-forward})
3638 @kindex m U (Summary)
3639 @findex wl-summary-target-mark-uudecode
3640 Uudecode the messages which have target mark @samp{*}.
3641 (@code{wl-summary-target-mark-uudecode})
3644 @kindex m ? (Summary)
3645 @findex wl-summary-target-mark-pick
3646 Pick messages from the @samp{*} marked messages.
3647 That is, @samp{*} marks on the messages are remained
3648 if the specified condition is satisfied.
3649 (@code{wl-summary-target-mark-pick})
3652 @kindex m # (Summary)
3653 @findex wl-summary-target-mark-print
3654 Print out all messages which have target mark @samp{*}.
3655 (@code{wl-summary-target-mark-print})
3658 @kindex m | (Summary)
3659 @findex wl-summary-target-mark-pipe
3660 Pipe content of each message with target mark @samp{*} to some specified
3662 (@code{wl-summary-target-mark-pipe})
3665 @kindex M-t (Summary)
3666 @findex wl-toggle-plugged
3667 Toggle offline/online status of Wanderlust.
3668 (@code{wl-toggle-plugged})
3671 @kindex C-t (Summary)
3672 Start Wanderlust's plug-status manager.
3673 (@code{wl-plugged-change})
3676 @kindex C-c C-o (Summary)
3677 @findex wl-jump-to-draft-buffer
3678 Move to the draft buffer if available. If multiple draft buffer exists,
3679 moved to one after another. If prefix argument is specified, load draft
3680 folder's message to the draft buffer and jump to it.
3681 (@code{wl-jump-to-draft-buffer})
3684 @kindex M-w (Summary)
3685 @findex wl-summary-save-current-message
3686 Save the message at the current cursor point.
3687 (@code{wl-summary-save-current-message})
3690 @kindex C-y (Summary)
3691 @findex wl-summary-yank-saved-message
3692 Regard the message at the current cursor point as
3693 parent, connect the message saved by
3694 @code{wl-summary-save-current-message}
3696 (@code{wl-summary-yank-saved-message})
3699 @kindex C-x C-s (Summary)
3700 @findex wl-summary-save-status
3701 Save the current summary.
3702 (@code{wl-summary-save-status})
3706 @node Variables of Summary, , Key Bindings of Summary, Summary
3707 @section Customiziable variables
3710 @item wl-summary-move-order
3711 @vindex wl-summary-move-order
3712 The initial setting is @code{unread}. Specify cursor moving policy. If
3713 you want to precede new messages, set @code{new}. If you want to
3714 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3717 @item wl-auto-select-first
3718 @vindex wl-auto-select-first
3719 The initial setting is @code{nil}.
3720 If non-nil, first message is automatically displayed when you enter
3723 @item wl-auto-select-next
3724 @vindex wl-auto-select-next
3725 The initial setting is @code{nil}. This controls behavior when there is
3726 no unread message in current summary.
3729 nil: asks whether you want to go back to folder mode
3730 'unread: asks whether you want to go to next unread folder
3731 If the next one comes to be possessing no unread message
3732 by treatment of cross-posted messages or Scoring, then
3733 asks whether you want to go to next to next folder.
3734 'skip-no-unread: similar as unread
3735 But does not ask before going to next to next folder.
3736 otherwise: asks whether you want to go to next unread folder
3739 It might be useful to set @code{'skip-no-unread} for people who
3740 want to continue reading by just pressing and pressing space key.
3742 @item wl-thread-insert-opened
3743 @vindex wl-thread-insert-opened
3744 The initial setting is @code{nil}.
3745 If non-nil, thread is inserted as opened.
3747 @item wl-thread-open-reading-thread
3748 @vindex wl-thread-open-reading-thread
3749 The initial setting is @code{t}. If non-nil, reading thread is
3750 automatically opened though it is closed thread.
3752 @item wl-summary-exit-next-move
3753 @vindex wl-summary-exit-next-move
3754 The initial setting is @code{t}. If non-nil, move to next folder at
3757 @item wl-folder-move-cur-folder
3758 @vindex wl-folder-move-cur-folder
3759 The initial setting is @code{nil}. If non-nil, cursor position on the
3762 @item wl-summary-weekday-name-lang
3763 @vindex wl-summary-weekday-name-lang
3764 The initial setting is @samp{ja}. Specify language of the weekday.
3765 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3766 displays Deutsch. You should rescan summary view after changing this value.
3768 @item wl-summary-fix-timezone
3769 @vindex wl-summary-fix-timezone
3770 The initial setting is @code{nil}.
3771 Time zone of the date string in summary mode is adjusted using this value.
3772 If @code{nil}, it is adjust to the default time zone information
3773 (system's default time zone or environment variable @samp{TZ}).
3775 @item wl-use-petname
3776 @vindex wl-use-petname
3777 The initial setting is @code{t}.
3778 If non-nil, sender part displays nickname.
3780 @item wl-break-pages
3781 @vindex wl-break-pages
3782 The initial setting is @code{t}.
3783 If non-nil, message is split as pages by @samp{^L}.
3785 @item wl-message-window-size
3786 @vindex wl-message-window-size
3787 The initial setting is '(1 . 4).
3788 A cons cell to specify the rate of summary and message window.
3789 car:cdr corresponds summary:message.
3791 @item wl-summary-no-from-message
3792 @vindex wl-summary-no-from-message
3793 The initial setting is @samp{nobody@@nowhere?}. A string which is
3794 displayed when there's no @samp{From:} field in the message.
3796 @item wl-summary-no-subject-message
3797 @vindex wl-summary-no-subject-message
3798 The initial setting is @samp{(WL:No Subject in original.)}. A string
3799 which is displayed when there's no @samp{Subject:} field in the message.
3801 @item wl-summary-use-frame
3802 @vindex wl-summary-use-frame
3803 The initial setting is @code{nil}.
3804 If non-nil, use new frame for the summary.
3806 @item wl-use-folder-petname
3807 @vindex wl-use-folder-petname
3808 The initial setting is the list shown below:
3817 A list of display policy (symbol) of folder nickname. Available symbols
3822 Display folder petname on modeline.
3824 Destination folder is notified as nickname if
3825 @code{wl-auto-select-next} is non-nil.
3827 You can input folder name by nickname in the function
3828 @code{wl-summary-read-folder}.
3831 @item wl-summary-move-direction-toggle
3832 @vindex wl-summary-move-direction-toggle
3833 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3834 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3835 want to aware of reading direction, set this to @code{t}.
3837 @item wl-summary-width
3838 @vindex wl-summary-width
3839 The initial setting is 80.
3840 Width of summary line. If @code{nil}, summary line's width is as is.
3842 @item wl-summary-from-width
3843 @vindex wl-summary-from-width
3844 The initial setting is 17.
3845 Width of sender part of summary line.
3847 @item wl-summary-subject-length-limit
3848 @vindex wl-summary-subject-length-limit
3849 The initial setting is @code{nil}. Specify the limit for the length of
3850 subject parts in summary. @code{nil} means unlimited.
3852 @item wl-summary-indent-length-limit
3853 @vindex wl-summary-indent-length-limit
3854 The initial setting is 46.
3855 Specify the limit of thread indent level. @code{nil} means unlimited
3857 If you set this to @code{nil} you should set @code{wl-summary-width}
3860 @item wl-summary-recenter
3861 @vindex wl-summary-recenter
3862 The initial setting is t.
3863 If non-nil, cursor point is moved to the center of the summary window.
3865 @item wl-summary-divide-thread-when-subject-changed
3866 @vindex wl-summary-divide-thread-when-subject-changed
3867 The initial setting is @code{nil}. If non-nil, thread is split if
3868 the subject is changed.
3870 @item wl-summary-search-via-nntp
3871 @vindex wl-summary-search-via-nntp
3872 The initial setting is @code{confirm}.
3874 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3875 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3876 from the NNTP server @code{elmo-nntp-default-server}. The value of
3877 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3878 @code{elmo-nntp-default-stream-type} are used.
3880 If @code{confirm}, server name can be specified. You can specify NNTP
3881 folder format like @samp{-:username@@servername:119!}.
3883 @item wl-summary-keep-cursor-command
3884 @vindex wl-summary-keep-cursor-command
3885 The initial setting is the list shown below:
3889 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3894 When you entered to summary by these commands and the target summary
3895 buffer already exists, summary status is not automatically updated and
3896 cursor position is saved.
3898 @item elmo-folder-update-threshold
3899 @vindex elmo-folder-update-threshold
3900 The initial setting is 500. If updated message number is larger than
3901 this value, confirm whether drop them or not (in the case where the value
3902 of @code{elmo-folder-update-confirm} is non-nil).
3904 @item elmo-folder-update-confirm
3905 @vindex elmo-folder-update-confirm
3906 The initial setting is @code{t}. If the value is non-nil, do check with
3907 @code{elmo-folder-update-threshold}.
3909 @item wl-summary-always-sticky-folder-list
3910 @vindex wl-summary-always-sticky-folder-list
3911 The initial setting is @code{nil}.
3912 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3913 are automatically stuck. Each element is regexp of folder name.
3915 @item wl-summary-reserve-mark-list
3916 @vindex wl-summary-reserve-mark-list
3917 The initial setting is the list shown below:
3926 If a message is already marked as temporal marks in this list, the
3927 message is not marked by any mark command.
3929 @item wl-summary-skip-mark-list
3930 @vindex wl-summary-skip-mark-list
3931 The initial setting is the list shown below:
3940 If a message is already marked as temporal marks in this list, the
3941 message is skipped at cursor move.
3943 @item elmo-message-fetch-threshold
3944 @vindex elmo-message-fetch-threshold
3945 The initial setting is 30000 (bytes). If displaying message has larger
3946 size than this value, Wanderlust confirms whether fetch the message or
3947 not (in the case where the value of @code{elmo-message-fetch-confirm}
3950 @item elmo-message-fetch-confirm
3951 @vindex elmo-message-fetch-confirm
3952 The initial setting is @code{t}. If the value is non-nil, do check with
3953 @code{elmo-message-fetch-threshold}.
3955 @item wl-prefetch-threshold
3956 @vindex wl-prefetch-threshold
3957 The initial setting is 30000 (bytes). If prefetching message has larger
3958 size than this value and @code{wl-prefetch-confirm} is non-nil,
3959 Wanderlust confirms whether prefetch the message or not. If
3960 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3961 without confirmation.
3963 @item wl-prefetch-confirm
3964 @vindex wl-prefetch-confirm
3965 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3966 prefetch the message or not if the message has larger size than
3967 @code{wl-prefetch-threshold}.
3969 @item elmo-imap4-use-cache
3970 @vindex elmo-imap4-use-cache
3971 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3974 @item elmo-nntp-use-cache
3975 @vindex elmo-nntp-use-cache
3976 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3979 @item elmo-pop3-use-cache
3980 @vindex elmo-pop3-use-cache
3981 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3984 @item elmo-shimbun-use-cache
3985 @vindex elmo-shimbun-use-cache
3986 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3989 @item wl-folder-process-duplicates-alist
3990 @vindex wl-folder-process-duplicates-alist
3991 The initial setting is @code{nil}.
3992 This list determines how to deal with duplicated messages in the same folder.
3993 Each item in the list is regexp of folder name and action; you can specify any
3994 one of the following in the place of action:
3997 @code{nil} : do nothing for duplicated messages.
3998 @code{hide} : hide duplicated messages from the summary.
3999 @code{read} : set duplicated messages as read.
4003 Following is an example (hide duplicated messages in multi folders)
4007 (setq wl-folder-process-duplicates-alist
4008 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4009 ("^\\*.*" . hide) (".*" . read)))
4015 @node Message, Draft, Summary, Top
4016 @chapter Message Buffer
4018 Message Buffers utilize MIME-View mode of SEMI. For operational
4019 procedures and key bindings, refer to respective documents.
4020 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4021 You can also see help by @kbd{?} in message buffer.
4023 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4024 brings you back to Summary mode. @kbd{l} toggles display of Summary
4027 @section Key Bindings
4033 @findex wl-message-toggle-disp-summary
4034 Toggles display of Summary mode buffer.
4035 (@code{wl-message-toggle-disp-summary})
4038 @findex wl-message-refer-article-or-url
4039 @kindex Button-2 (Message)
4040 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4041 corresponding message if found.
4042 (@code{wl-message-refer-article-or-url})
4044 @item Button-4 (upward movement of a wheel)
4045 @kindex Button-4 (Message)
4046 @findex wl-message-wheel-down
4047 Scrolls the message backwards. When the top of the message is hit,
4048 moves to the previous message.
4049 (@code{wl-message-wheel-down})
4051 @item Button-5 (downward movement of a wheel)
4052 @kindex Button-5 (Message)
4053 @findex wl-message-wheel-up
4054 Scrolls the message forward. When the bottom of the message is hit,
4055 moves to the next message.
4056 (@code{wl-message-wheel-up})
4059 @section Customizable Variables
4062 @item wl-message-window-size
4063 @vindex wl-message-window-size
4064 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4065 its car and cdr value corresponds to the ratio of Summary and Message
4068 @item wl-message-ignored-field-list
4069 @vindex wl-message-ignored-field-list
4070 (SEMI only) Initial setting is @code{nil}.
4071 All fields that match this list will be hidden in message buffer.
4072 Each elements are regexp of field-name.
4073 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4075 @item wl-message-visible-field-list
4076 @vindex wl-message-visible-field-list
4077 (SEMI only) Initial setting is @code{nil}.
4078 All fields that match this list will be display in message buffer.
4079 Each elements are regexp of field-name. This value precedes
4080 @code{wl-message-ignored-field-list}.
4081 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4083 @item wl-message-sort-field-list
4084 @vindex wl-message-sort-field-list
4085 (SEMI only) Initial setting is
4086 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4087 Header fields in message buffer are ordered by this value.
4088 Each elements are regexp of field-name.
4090 @item wl-message-truncate-lines
4091 @vindex wl-message-truncate-lines
4092 The initial value is the value of @code{default-truncate-lines}.
4093 If it is non-nil, truncate long lines in message buffer.
4096 @node Draft, Disconnected Operations, Message, Top
4097 @chapter Draft Buffer
4099 At Summary mode, pressing @kbd{w} and the like creates a new draft
4100 buffer. You can edit and send mail and news articles in this buffer.
4102 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4103 with those if possible.
4106 * Usage of Draft Mode:: TIPS
4107 * Key Bindings of Draft:: Key bindings
4108 * Variables of Draft Mode:: Customize Draft Mode
4111 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4114 Basically it is Emacs-standard mail mode.
4118 * Editing Message Body::
4119 * Dynamical Message Re-arrangement::
4124 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4125 @subsection Editing Message Header
4127 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4128 addresses. @kbd{@key{TAB}} completes them.
4130 You can use following headers to specify recipients. Add some of them
4131 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4134 @item @samp{Newsgroups:}
4135 Specify newsgroups to which you post the news article.
4138 Specify addresses to send a copy (Carbon Copy) of the message.
4141 Following ones are removed from the header contents before sending.
4145 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4148 Specify folders in which a copy of the message is saved.
4151 Specify recipients to send encapsulated copy of the message.
4154 You can add initial headers by following variables.
4160 The initial setting is @code{nil}.
4161 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4162 the draft when it is prepared. If function is specified, its return
4167 The initial setting is @code{nil}.
4168 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4169 the draft when it is prepared.
4172 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4173 @subsection Editing Messages
4175 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4176 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4177 a MIME user interface for GNU Emacs}.
4178 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4180 If you save the draft buffer you are editing, it is appended to the
4181 folder specified by @code{wl-draft-folder}.
4183 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4184 @subsection Dynamic Modification of Messages
4185 @vindex wl-draft-config-alist
4186 @c @cindex Change Message
4187 @c @cindex Message, Change Dynamic
4189 You can set @code{wl-draft-config-alist} so that header and body of the
4190 message will automatically modified depending on information of header
4193 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4195 In the example below, the header is modified when
4196 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4197 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4198 before sending the message.
4202 (setq wl-draft-config-alist
4203 '(((string-match "aaa\\.example\\.com$" (system-name))
4204 ;; @r{applied if the expression is non-nil}
4205 (wl-smtp-posting-server . "mailserver-B")
4206 (wl-nntp-posting-server . "newsserver-B")
4207 ;; @r{settings of temporary variables}
4209 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4210 ;; @r{applied if it matches the header of the draft buffer}
4211 ("Organization" . (format "Go %s" my-webpage)))
4212 ;; @r{you can write elisp expressions here (eval only)}
4213 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4214 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4219 The format of @code{wl-draft-config-alist} is:
4223 '(("@var{regexp of the header}" or @var{elisp expression}
4224 ("@var{Field}" . value(@var{elisp expression}))
4225 (@var{variable} . value(@var{elisp expression}))
4226 (@var{sub-function} . value(@var{elisp expression}))
4229 ("@var{regexp of the header}" or @var{elisp expression}
4230 ("@var{Field}" . value(@var{elisp expression}))
4235 Per default, there are 10 following sub-functions.
4238 'header: Inserts the specified string at the bottom of the header.
4239 'header-top: Inserts the specified string at the top of the header.
4240 'header-file: Inserts the specified file at the bottom of the header.
4241 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4242 'top: Inserts the specified string at the top of the body.
4243 'top-file: Inserts the specified file at the top of the body.
4244 'body: Replaces the body with the specified string.
4245 Specifying @code{nil} deletes the entire body string.
4246 'body-file: Replaces the body with the content of the specified file.
4247 'bottom: Inserts the specified string at the bottom of the body.
4248 'bottom-file: Inserts the specified file at the top of the body.
4249 'part-top: Inserts the specified string at the top of the current part.
4250 'part-bottom: Inserts the specified string at the bottom of the current part.
4251 'template: Applies the specified template.
4252 (refer to the next subsection)
4255 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4256 change them or add your own functions. If you read the code, you can
4257 easily find how to write the functions.
4259 At the first of each item, @var{a regular expression of the header} or
4260 an @var{elisp expression} should be specified. In the case of an elisp
4261 expression, the item is applied when the expression is evaluated
4264 Per default, when multiple items match or are evaluated non-nil, all
4265 such items are applied, but if you set a variable
4266 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4269 At the second of the item, a cons or a list of functions should be
4270 specified. The car part of the cons should be a header field, a
4271 variable, or a sub-function. When a header field is specified, the
4272 field will be modified. If a variable is specified, the value of the
4273 variable will be modified temporarily.
4275 In the cdr part of a cons, not only a variable but also an elisp
4276 expression can be specified as is. If the car part is a header field
4277 and the cdr part is @code{nil}, the field will be deleted.
4279 If you want to use name of parent folder, you can refer the buffer local
4280 variable @code{wl-draft-parent-folder}.
4282 See the next example as well:
4286 (setq wl-draft-config-alist
4288 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4289 ;; @r{applied if it matches the header of the buffer being replied}
4290 (body . " Hello.\n")
4291 (template . "default")
4296 As in the (1) above, if a header regexp is prepended with @code{reply},
4297 it is applied when the draft is prepared by @code{wl-summary-reply} for
4298 example, and when it matches the header being replied. It is ignored
4299 when there is no buffer being replied, like after @code{wl-draft} was
4302 Note that @code{wl-draft-config-alist} is applied only once when
4303 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4304 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4305 aborting transmission, execute @kbd{C-c C-e}
4306 (@code{wl-draft-config-exec}) explicitly.
4308 If you don't want to apply @code{wl-draft-config-alist} when
4309 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4313 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4316 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4317 prepared, do the following:
4320 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4323 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4324 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4328 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4331 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4332 @subsection Inserting Templates
4334 @cindex Apply Template
4336 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4337 @kbd{M-x wl-template-select} in the draft buffer.
4339 The format of @code{wl-template-alist} is almost the same as
4340 @code{wl-draft-config-alist}.
4344 (setq wl-template-alist
4347 ("Organization" . "Example Co.Ltd.")
4348 (body . "Hello.\n"))
4350 (template . "default") ;; @r{(a)}
4351 ("To" . "boss@@example.com")
4352 ("Subject" . "Report")
4353 (body-file . "~/work/report.txt")
4359 As you can see, the only difference is item (template) names such as
4360 @samp{default} and @samp{report}, instead of a regexp of header.
4361 Because definition of each item is the same as
4362 @code{wl-draft-config-alist}, you can call another template, like (a).
4364 Executing the command @code{wl-template-select} results in template
4365 selection, but the result differs depending on variable
4366 @code{wl-template-visible-select}.
4368 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4369 window is shown below the draft buffer. You can select a template by
4370 @kbd{n} and @kbd{p} seeing the buffer window.
4372 Press the @key{RET} key and the template is actually applied to the draft
4373 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4374 adjust the window size by @code{wl-template-buffer-lines}.
4376 If @code{wl-template-visible-select} is @code{nil}, you should type the
4377 name of the template in the mini buffer.
4379 As shown in the example in @code{wl-draft-config-alist}, you can select
4380 @samp{default} template by writing:
4383 (template . "default")
4386 @node POP-before-SMTP, , Template, Usage of Draft Mode
4387 @subsection Sending mail by POP-before-SMTP
4388 @cindex POP-before-SMTP
4390 You can send mail by POP-before-SMTP with this single line:
4393 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4397 Configure the following variables if you need.
4400 @item wl-pop-before-smtp-user
4401 The POP user name for POP-before-SMTP authentication.
4402 If unset, @code{elmo-pop3-default-user} is used.
4404 @item wl-pop-before-smtp-server
4405 The POP server name for POP-before-SMTP authentication.
4406 If unset, @code{elmo-pop3-default-server} is used.
4408 @item wl-pop-before-smtp-authenticate-type
4409 The POP authentication method for POP-before-SMTP authentication.
4410 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4412 @item wl-pop-before-smtp-port
4413 The POP port number for POP-before-SMTP authentication.
4414 If unset, @code{elmo-pop3-default-port} is used.
4416 @item wl-pop-before-smtp-stream-type
4417 If non-nil, POP connection is established using SSL. If
4418 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4419 unset, @code{elmo-pop3-default-stream-type} is used.
4422 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4423 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4425 Therefore, if SMTP server and POP server are actually the same, and if
4426 POP folder per default (such as @samp{&}) is available, no settings are
4429 Refer to the following URL about POP-before-SMTP.
4433 http://spam.ayamura.org/tools/smPbS.html
4434 http://www.iecc.com/pop-before-smtp.html
4439 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4440 @section Key Bindings
4441 @cindex Keybind, Draft Mode
4442 @cindex Keybind, Draft Buffer
4447 @kindex C-c C-y (Draft)
4448 @findex wl-draft-yank-original
4449 Cites the content of the current message buffer.
4450 (@code{wl-draft-yank-original})
4453 @kindex C-c C-p (Draft)
4454 @findex wl-draft-preview-message
4455 Previews the content of the current draft.
4456 This is useful for previewing MIME multi-part messages.
4457 (@code{wl-draft-preview-message})
4460 @kindex C-c C-s (Draft)
4461 @findex wl-draft-send
4462 Sends the content of the current draft. Does not erase the draft buffer.
4463 This is useful for sending multiple messages, which are a little different
4465 (@code{wl-draft-send})
4468 @kindex C-c C-c (Draft)
4469 @findex wl-draft-send-and-exit
4470 Sends the content of the current draft and erases the draft buffer.
4471 (@code{wl-draft-send-and-exit})
4474 @kindex C-x C-s (Draft)
4475 @findex wl-draft-save
4476 Save the current draft.
4477 (@code{wl-draft-save})
4480 @kindex C-c C-k (Draft)
4481 @findex wl-draft-kill
4482 Kills the current draft.
4483 (@code{wl-draft-kill})
4486 @kindex C-x k (Draft)
4487 @findex wl-draft-mimic-kill-buffer
4488 Kills the current draft.
4489 (@code{wl-draft-mimic-kill-buffer})
4492 @kindex C-c C-z (Draft)
4493 @findex wl-draft-save-and-exit
4494 Saves the current draft, and erases the draft buffer.
4495 This is useful if you want to suspend editing of the draft.
4496 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4497 the @samp{+draft} folder.
4498 (@code{wl-draft-save-and-exit})
4501 @kindex C-c C-r (Draft)
4502 @findex wl-caesar-region
4503 Encodes or decodes the specified region in Caesar cipher.
4504 (@code{wl-caesar-region})
4508 @findex wl-draft-highlight-and-recenter
4509 Recenter and rehighlight current draft.
4510 (@code{wl-draft-highlight-and-recenter})
4514 @findex wl-toggle-plugged
4515 Toggles off-line/on-line states of Wanderlust.
4516 (@code{wl-toggle-plugged})
4519 @kindex C-c C-o (Draft)
4520 @findex wl-jump-to-draft-buffer
4521 Jumps to the other draft buffer, if exists.
4522 With prefix argument, reads a file (if any) from the draft folder when
4523 there is no such buffer.
4524 (@code{wl-jump-to-draft-buffer})
4527 @kindex C-c C-e (Draft)
4528 @findex wl-draft-config-exec
4529 Applies @code{wl-draft-config-alist}.
4530 (@code{wl-draft-config-exec})
4533 @kindex C-c C-j (Draft)
4534 @findex wl-template-select
4536 (@code{wl-template-select})
4539 @kindex C-c C-a (Draft)
4541 Enter Address Manager.
4542 @xref{Address Manager}.
4546 @kindex C-c C-d (Draft)
4547 @findex wl-draft-elide-region
4548 Elide the text between point and mark (@code{wl-draft-elide-region}).
4549 The text is killed and replaced with the contents of the variable
4550 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4554 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4555 @section Customizable Variables
4558 @item wl-subscribed-mailing-list
4559 @vindex wl-subscribed-mailing-list
4560 The initial setting is @code{nil}. Mailing lists to which you
4561 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4562 field of a reply draft, removes your own address from
4563 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4564 contained in @samp{To:} or @samp{Cc:} field of a message to be
4565 automatically re-filed, the destination folder will be leaned in
4566 connection with the address.
4572 (setq wl-subscribed-mailing-list
4573 '("wl@@lists.airs.net"
4575 "emacs-mime-ja@@m17n.org"))
4579 @item wl-insert-mail-followup-to
4580 @vindex wl-insert-mail-followup-to
4581 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4582 field is automatically inserted in the draft buffer.
4584 @item wl-insert-mail-reply-to
4585 @vindex wl-insert-mail-reply-to
4586 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4587 field is automatically inserted in the draft buffer.
4589 @item wl-auto-insert-x-face
4590 @vindex wl-auto-insert-x-face
4591 The initial setting is @code{t}. If non-nil and there is an encoded
4592 X-Face string in a file @file{~/.xface} (the value of the variable
4593 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4594 draft buffer. If @code{nil}, it is not automatically inserted.
4596 @item wl-insert-message-id
4597 @vindex wl-insert-message-id
4598 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4599 is automatically inserted on the transmission.
4601 @item wl-message-id-use-wl-from
4602 @vindex wl-message-id-use-wl-from
4603 The initial setting is @code{nil}. If non-nil, the value of
4604 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4606 @item wl-local-domain
4607 @vindex wl-local-domain
4608 The initial setting is @code{nil}. If @code{nil}, the return value of
4609 the function @code{system-name} will be used as the domain part of
4612 If @code{system-name} does not return FQDN (i.e. the full name of the
4613 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4614 to the string of the local domain name without hostname (like
4615 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4616 @samp{.} @code{wl-local-domain} is used as domain part of the
4619 If your terminal does not have global IP, set the value of
4620 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4621 you use invalid @samp{Message-ID:}.)
4623 Moreover, concatenation of @code{system-name} @samp{.}
4624 @code{wl-local-domain} will be used as an argument to the HELO command
4627 @item wl-message-id-domain
4628 @vindex wl-message-id-domain
4629 The initial setting is @code{nil}. If non-nil, this value is used as a
4630 domain part of the @samp{Message-ID:}. If your terminal does not have
4631 global IP address, set unique string to this value (e.x. your e-mail
4634 @item wl-unique-id-suffix
4635 @vindex wl-unique-id-suffix
4636 The initial setting is @samp{.wl}. You can specify the string in generated
4637 Message-ID which appear just before @samp{@@}.
4639 @item wl-draft-config-alist
4640 @vindex wl-draft-config-alist
4641 The initial setting is @code{nil}. Modifies the draft message just
4642 before the transmission. The content of @code{wl-draft-config-alist}
4643 will be automatically applied only once on the transmission. If you
4644 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4647 @item wl-template-alist
4648 @vindex wl-template-alist
4649 The initial setting is @code{nil}.
4650 This variable specifies the template to be applied in the draft buffer.
4652 @item wl-draft-config-matchone
4653 @vindex wl-draft-config-matchone
4654 The initial setting is @code{nil}. If non-nil, only the first matching
4655 item is used when @code{wl-draft-config-alist} is applied. If
4656 @code{nil}, all matching items are used.
4658 @item wl-template-visible-select
4659 @vindex wl-template-visible-select
4660 The initial setting is @code{t}.
4661 If non-nil, you can preview the result of the template selection in
4664 @item wl-template-confirm
4665 @vindex wl-template-confirm
4666 The initial setting is @code{nil}.
4667 If non-nil, asks for confirmation when you press the enter key to select
4668 template while previewing.
4670 @item wl-template-buffer-lines
4671 @vindex wl-template-buffer-lines
4672 The initial setting is 7.
4673 If @code{wl-template-visible-select} is non-nil, this variable specifies
4674 the size of the preview window.
4676 @item wl-draft-reply-buffer-style
4677 @vindex wl-draft-reply-buffer-style
4678 The initial setting is @code{split}. @code{split} or @code{full} can be
4679 specified. In the case of @code{full}, the whole frame will be used for
4680 a reply draft buffer when it is prepared.
4682 @item wl-draft-use-frame
4683 @vindex wl-draft-use-frame
4684 The initial setting is @code{nil}.
4685 If non-nil, use new frame for the draft.
4687 @item wl-draft-truncate-lines
4688 @vindex wl-draft-truncate-lines
4689 The initial value is the value of @code{default-truncate-lines}.
4690 If it is non-nil, truncate long lines in draft buffer.
4694 The initial setting is the value of the variable
4695 @code{user-mail-address}. The value of this variable is inserted as a
4696 @samp{From:} field of the draft when it is prepared.
4698 @item wl-envelope-from
4699 @vindex wl-envelope-from
4700 The initial setting is @code{nil}.
4701 The value of this variable is used for envelope from (MAIL FROM).
4702 If @code{nil}, the address part of @code{wl-from} is used.
4704 @item wl-user-mail-address-list
4705 @vindex wl-user-mail-address-list
4706 The initial setting is @code{nil}.
4707 This is the User's address list. If you have multiple addresses,
4710 @item wl-reply-subject-prefix
4711 @vindex wl-reply-subject-prefix
4712 The initial setting is @samp{Re: }.
4713 In the @samp{Subject:} of the reply draft, this string is prepended to
4714 the @samp{Subject:} of being replied.
4716 @item wl-forward-subject-prefix
4717 @vindex wl-forward-subject-prefix
4718 The initial setting is @samp{Forward: }.
4719 In the @samp{Subject:} of the forwarding draft, this string is prepended
4720 to the @samp{Subject:} of being forwarded.
4722 @item wl-draft-reply-use-address-with-full-name
4723 @vindex wl-draft-reply-use-address-with-full-name
4724 The initial setting is @code{t}.
4725 If non-nil, insert her full name with address when prepare a draft for
4726 reply a message. If it is @code{nil}, insert her address only.
4728 @item wl-draft-enable-queuing
4729 @vindex wl-draft-enable-queuing
4730 The initial setting is @code{t}.
4731 This flag controls off-line transmission. If non-nil, the draft is
4734 @item wl-draft-use-cache
4735 @vindex wl-draft-use-cache
4736 The initial setting is @code{nil}. If the value is non-nil and
4737 @code{wl-insert-message-id} is nil, cache the message which is sent.
4739 @item wl-fcc-force-as-read
4740 @vindex wl-fcc-force-as-read
4741 The initial setting is @code{nil}. If the value is non-nil,
4742 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4744 @item wl-auto-flush-queue
4745 @vindex wl-auto-flush-queue
4746 The initial setting is t.
4747 This flag controls automatic transmission of the queue when Wanderlust
4748 becomes on-line. If non-nil, the queue is automatically transmitted
4749 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4750 manually, press @kbd{F} in the folder mode.
4752 @item wl-ignored-forwarded-headers
4753 @vindex wl-ignored-forwarded-headers
4754 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4755 All headers that match this regexp will be deleted when forwarding a message.
4757 @item wl-ignored-resent-headers
4758 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4759 All headers that match this regexp will be deleted when resending a message.
4761 @item wl-draft-always-delete-myself
4762 @vindex wl-draft-always-delete-myself
4763 If non-nil, always removes your own address from @samp{To:} and
4764 @samp{Cc:} when you are replying to the mail addressed to you.
4766 @item wl-draft-delete-myself-from-bcc-fcc
4767 @vindex wl-draft-delete-myself-from-bcc-fcc
4768 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4769 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4771 @item wl-smtp-posting-server
4772 @vindex wl-smtp-posting-server
4773 The initial setting is @code{nil}.
4774 This is the SMTP server name for mail transmission.
4776 @item wl-smtp-posting-user
4777 @vindex wl-smtp-posting-user
4778 The initial setting is @code{nil}.
4779 This is the user name for SMTP AUTH authentication. If @code{nil},
4780 @code{smtp-authenticate-user} is used.
4782 @item wl-smtp-authenticate-type
4783 @vindex wl-smtp-authenticate-type
4784 The initial setting is @code{nil}.
4785 This is the authentication method for SMTP AUTH authentication. If
4786 @code{nil}, @code{smtp-authenticate-type} is used. If
4787 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4790 @item wl-smtp-connection-type
4791 @vindex wl-smtp-connection-type
4792 The initial setting is @code{nil}.
4793 This variable specifies how to establish SMTP connections.
4794 If @code{nil}, @code{smtp-connection-type} is used.
4795 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4797 @item wl-nntp-posting-server
4798 @vindex wl-nntp-posting-server
4799 The initial setting is @code{nil}.
4800 This is the NNTP server name used for news submission.
4801 If @code{nil}, @code{elmo-nntp-default-server} is used.
4803 @item wl-nntp-posting-user
4804 @vindex wl-nntp-posting-user
4805 The initial setting is @code{nil}.
4806 This is the user name for AUTHINFO authentication on news submission.
4807 If @code{nil}, @code{elmo-nntp-default-user} is used.
4808 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4810 @item wl-nntp-posting-port
4811 @vindex wl-nntp-posting-port
4812 The initial setting is @code{nil}.
4813 This is the port number of the NNTP server used for news submission.
4814 If @code{nil}, @code{elmo-nntp-default-server} is used.
4816 @item wl-nntp-posting-stream-type
4817 @vindex wl-nntp-posting-stream-type
4818 The initial setting is @code{nil}.
4819 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4820 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4821 connection will be established.
4823 @item wl-nntp-posting-function
4824 @vindex wl-nntp-posting-function
4825 The initial setting is @code{elmo-nntp-post}.
4826 This is the function to post NNTP message.
4828 @item wl-nntp-posting-config-alist
4829 @vindex wl-nntp-posting-config-alist
4830 The initial setting is @code{nil}.
4831 The value takes an alist to define NNTP server like following example.
4832 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
4836 (setq wl-nntp-posting-config-alist
4837 '((",?gmane\\." . "news.gmane.org")
4839 ((server . "news-server")
4840 (user . "newsmaster")
4842 (function . elmo-nntp-post)))
4843 (".*" . "default-news-server")))
4847 @item wl-pop-before-smtp-user
4848 @vindex wl-pop-before-smtp-user
4849 The initial setting is @code{nil}.
4850 This is the POP user name for POP-before-SMTP.
4851 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4853 @item wl-pop-before-smtp-server
4854 @vindex wl-pop-before-smtp-server
4855 The initial setting is @code{nil}.
4856 This is the POP server name for POP-before-SMTP.
4857 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4859 @item wl-pop-before-smtp-authenticate-type
4860 @vindex wl-pop-before-smtp-authenticate-type
4861 The initial setting is @code{nil}.
4862 This is the authentication method for POP-before-SMTP authentication.
4863 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4865 @item wl-pop-before-smtp-port
4866 @vindex wl-pop-before-smtp-port
4867 The initial setting is @code{nil}.
4868 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4869 @code{elmo-pop3-default-port} is used.
4871 @item wl-pop-before-smtp-stream-type
4872 @vindex wl-pop-before-smtp-stream-type
4873 The initial setting is @code{nil}.
4874 This flag controls the use of SSL for POP-before-SMTP. If it is
4875 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4876 STARTTLS (RFC2595) connection will be established.
4878 @item wl-draft-queue-save-variables
4879 @vindex wl-draft-queue-save-variables
4880 Specifies a list of variable to which queued messages are saved on the
4881 off-line transmission.
4883 @item wl-draft-sendlog
4884 @vindex wl-draft-sendlog
4885 The initial setting is @code{t}.
4886 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4890 @item drafts are sent by smtp or qmail
4891 @item saved into folders by fcc
4892 @item saved into folders by queuing
4895 (it is written even if the transmission fails).
4896 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4897 and left to the logging function of @command{imput}.
4900 @item wl-draft-sendlog-max-size
4901 @vindex wl-draft-sendlog-max-size
4902 The initial setting is 20000 (in bytes).
4903 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4904 beyond the size specified by this variable.
4908 The initial setting is @code{nil}.
4909 If non-nil, address completion uses LDAP.
4911 @item wl-ldap-server
4912 @vindex wl-ldap-server
4913 The initial setting is @samp{localhost}.
4914 LDAP server name for address completion.
4917 @vindex wl-ldap-port
4918 The initial setting is @code{nil}.
4919 If non-nil, the value is used as port number.
4922 @vindex wl-ldap-base
4923 The initial setting is @samp{c=US}.
4924 LDAP search starting point (base) for address completion.
4926 @item wl-draft-remove-group-list-contents
4927 @vindex wl-draft-remove-group-list-contents
4928 The initial setting is @code{t}.
4929 If non-nil, remove the group-lists' members in the recipients when
4930 sending the message (group-list means the description such as
4931 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4934 @node Disconnected Operations, Expire and Archive, Draft, Top
4935 @chapter Off-line Management
4936 @cindex Disconnected Operations
4938 Wanderlust has on-line and off-line states.
4941 * Off-line State:: Wanderlust has on-line and off-line states
4942 * Enable Operations:: Enable Disconnected Operations
4943 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4944 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4945 * Variables of Plugged Mode:: Customize Plugged Mode
4949 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4950 @section Off-line State
4952 Wanderlust has on-line and off-line states. In the off-line state, you
4953 cannot access messages via network, unless they are cached.
4955 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4956 in the mode line indicates the off-line state. In folder or summary
4957 modes, press @kbd{M-t} to switch between off- and on-line.
4959 You can invoke Wanderlust in the off-line state by setting
4960 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4962 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4963 ignores uncached messages.
4966 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4967 @section Enable Disconeected Operations
4969 Even in the off-line state, provided that relevant messages are cached,
4970 and the variable @code{elmo-enable-disconnected-operation} (described
4971 later) is non-nil, you can following operations:
4972 @xref{Plugged Mode}, @xref{Off-line State settings}.
4975 * Send Messages off-line:: Transmit Messages
4976 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4977 * Creation of Folders:: Create Folders off-line (IMAP4)
4978 * Marking:: Mark (IMAP4)
4979 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4982 As soon as Wanderlust becomes on-line, such operations invoked off-line
4983 are reflected in the servers via network.
4986 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4987 @subsection Transmission of Messages
4989 You can send mail/news messages off-line (if you are using
4990 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4991 accumulated in the queue folder, @samp{+queue}. These messages are
4992 transmitted at once when Wanderlust becomes on-line.
4994 You can visit @samp{+queue} in the off-line state and confirm content of
4995 messages in the queue. You can also remove messages. Removed messages
4996 are not transmitted even in the on-line state.
4999 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5000 @subsection Re-file and Copy (IMAP4)
5002 Re-file and copy operations to IMAP folders invoked during the off-line
5003 state are accumulated in the queue, and reflected in the server side
5004 when Wanderlust becomes on-line. If you visit destination folders after
5005 off-line re-file or copy, it looks as if messages were appended even in
5008 For the safety reasons, messages re-filed off-line are removed from
5009 source folders only if their @samp{Message-ID:} match messages on the
5010 servers. While the queue is processed, messages that failed to be
5011 re-filed or copied to the specified folders are appended to the folder
5015 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5016 @subsection Creation of Folders (IMAP4)
5018 You can create IMAP folders off-line. The creation of folders are
5019 reflected in the servers when Wanderlust becomes on-line. If the creation
5020 of those folders fails at that time for some reasons, messages
5021 to be re-filed into those are appended to the folder @samp{+lost+found}
5025 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5026 @subsection Marking (IMAP4)
5028 Off-line changes in unread/read and importance mark @samp{$} information
5029 are also reflected in the servers when Wanderlust becomes on-line.
5032 @node Pre-fetching Reservations, , Marking, Enable Operations
5033 @subsection Pre-fetching (IMAP4, NNTP)
5035 You can make reservations for pre-fetching messages in IMAP or NNTP
5036 folders. Reserved messages are marked with @samp{!} but not cached
5037 yet. When Wanderlust becomes on-line, they are pre-fetched from
5040 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5041 these off-line operations for IMAP4 and NNTP do not take place, and
5042 off-line re-file, copy or suchlike simply results in error.
5044 Because off-line operations use cache files, it is a bad idea to erase
5045 them by hand; it may cause Wanderlust to malfunction.
5047 If you want to remove caches, be sure to execute @kbd{M-x
5048 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5049 remove caches for messages relevant to off-line operations.
5052 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5053 @section Switching On-line/Off-line per Server/Port
5055 @kbd{M-t} described above switches networking states as a whole, but you
5056 can switch on-line/off-line per server/port.
5058 Pressing @kbd{C-t} in the folder or summary modes brings you in
5059 wl-plugged-mode shown below, in which you can change the plugged state
5064 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5067 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5068 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5070 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5071 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5077 The first line indicates status of the following three variables, and
5078 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5079 column modifies the values of these variables.
5083 "Queuing" @code{wl-draft-enable-queuing}
5084 "AutoFlushQueue" @code{wl-auto-flush-queue}
5085 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5089 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5092 The second and after lines indicate on-line/off-line states of servers
5093 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5094 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5095 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5097 @dfn{sending queue} means messages accumulated in the folder
5098 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5099 off-line operations when @code{elmo-enable-disconnected-operation} is
5101 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5102 @c off-line operations are enabled.
5104 They are displayed if there are any of them. In the example above, in
5105 the sending queue there are two messages (the first and the second in
5106 the queue folder) for smtp to hosta and one (the third) for nntp to
5107 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5110 If you change @samp{(wl-plugged)} in the second line, the variable
5111 @code{wl-plugged} is changed, so that the mode line indicator and
5112 plugged states of all ports are affected. If you change plugged states
5113 of any servers or ports, @samp{(wl-plugged)} in the second line is
5114 affected depending on @code{elmo-plugged-condition} settings and the
5115 plugged state of each port.
5118 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5119 @section Invoking Wanderlust in the Off-line State
5121 As described before, if you set @code{wl-plugged} to @code{nil} in
5122 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5123 off-line state. You can specify off-line state on a per server or port
5124 basis. Refer to @code{wl-reset-plugged-alist} also.
5126 Usually, when Wanderlust starts up, the plugged state of each port is
5127 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5128 @code{wl-nntp-posting-server} and so on. If you want to change the
5129 plugged state of these ports or to add other ports, configure
5130 @code{wl-make-plugged-hook} with a function.
5134 (add-hook 'wl-make-plugged-hook
5136 (elmo-set-plugged plugged-value(t/nil) server port)
5137 ;; @r{add or change plugged states of the port of the server}
5138 (elmo-set-plugged plugged-value(t/nil) server)
5139 ;; @r{if the port is omitted, all ports are affected}
5140 ;; @r{(you cannot omit the port if you newly add the server)}
5146 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5147 @section Customizable Variables
5152 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5153 mode from the beginning.
5155 @item wl-queue-folder
5156 @vindex wl-queue-folder
5157 The initial setting is @samp{+queue}.
5158 This is the folder in which messages in the transmission queue are
5161 @item wl-auto-flush-queue
5162 @vindex wl-auto-flush-queue
5163 The initial setting is @code{t}.
5164 This flag controls automatic transmission of the queue when Wanderlust
5165 becomes on-line. If non-nil, the queue is automatically transmitted
5166 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5167 manually, press @kbd{F} in the folder mode.
5169 @item elmo-enable-disconnected-operation
5170 @vindex elmo-enable-disconnected-operation
5171 The initial setting is @code{nil}. Controls off-line operations
5172 regarding IMAP4. If non-nil, off-line operations are carried out.
5174 @item elmo-lost+found-folder
5175 @vindex elmo-lost+found-folder
5176 The initial setting is @samp{+lost+found}.
5177 This is the folder to which messages are saved when they fails to be
5178 appended while the off-line re-file/copy queue is processed.
5180 @item elmo-plugged-condition
5181 @vindex elmo-plugged-condition
5182 The initial setting is @code{one}.
5183 The value of @code{wl-plugged} reflects the return value of the function
5184 @code{elmo-plugged-p} (without arguments).
5185 This variable @code{elmo-plugged-condition} specifies the condition on
5186 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5187 plugged state of each port.
5190 'one : plugged if one or more ports are plugged.
5191 'all : plugged if all ports are plugged.
5192 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5193 states of the ports.
5194 @var{function} : reflects the return value of the @var{function}
5195 functions available per default
5196 'elmo-plug-on-by-servers
5197 : reflects the plugged state of the servers specified by the
5198 variable elmo-plug-on-servers.
5199 'elmo-plug-on-by-exclude-servers
5200 : reflects the plugged state of the servers that are not
5201 in elmo-plug-on-exclude-servers.
5202 elmo-plug-on-exclude-servers defaults to
5205 (system-name)without the domain part)
5211 (setq elmo-plugged-condition 'all)
5213 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5214 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5216 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5217 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5221 @item wl-reset-plugged-alist
5222 @vindex wl-reset-plugged-alist
5223 The initial setting is @code{t}. If non-nil, plugged states are
5224 initialized on a per server or port basis when Wanderlust starts up.
5226 If @code{nil}, plugged states are retained while Emacs is running. In
5227 other words, they are initialized when Emacs is restarted even if the
5228 value is @code{nil}.
5232 @node Expire and Archive, Scoring, Disconnected Operations, Top
5233 @chapter Automatic Expiration and Archiving of Messages
5234 @cindex Expire and Archive
5237 * Expire:: Expiration and Archiving
5238 * Archive:: Archiving All Messages
5242 @node Expire, Archive, Expire and Archive, Expire and Archive
5244 @cindex Expire Message
5246 Expiration means deletion of old messages which have outlasted a
5247 certain period of time.
5249 @code{wl-expire} supports not only simple deletion, but also moving to
5250 specified archiving folders.
5254 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5255 or @kbd{M-e} in the summary mode.
5257 @subsection Configuring @code{wl-expire-alist}
5259 An example configuration of @code{wl-expire-alist} is shown below.
5260 Everything in this @code{wl-expire-alist} makes a great difference in
5261 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5262 to @code{t}, especially in the initial stage.
5266 (setq wl-expire-alist
5267 '(("^\\+trash$" (date 14) remove)
5269 ("^\\+tmp$" (date 7) trash)
5270 ;; @r{re-file to @code{wl-trash-folder}}
5271 ("^\\+outbox$" (number 300) "$outbox;lha")
5272 ;; @r{re-file to the specific folder}
5274 ;; @r{do not expire}
5275 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5276 ;; @r{archive by message number (retaining numbers)}
5277 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5278 ;; @r{archive by a fixed number (retaining numbers)}
5279 ("^\\+diary$" (date 30) wl-expire-archive-date)
5280 ;; @r{archive by year and month (numbers discarded)}
5285 Items in the list has the format of:
5288 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5292 The folder is examined if it matches @var{regexp-for-folders} from the
5293 beginning of the list. If you invoke expiration on the folder that does
5294 not match any of them, nothing will happen. And if either the second or
5295 the third element of the item is @code{nil}, expiration will not take
5298 You can use any one of the following for
5299 @var{specification-of-message-to-be-deleted}:
5302 @item (number @var{n1} [@var{n2}])
5303 deletes messages depending on the number of messages in the folder.
5305 @var{n1} is the number of messages which should survive deletion, for example
5306 if its value is 500, the newest 500 messages survive and the rests are
5309 @var{n2} is the number of messages in the folder on which expiration should
5310 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5311 folders with 510 or more messages are expired.
5312 If you configured automatic expiration, frequently used folders may
5313 expire every time it receive messages, and you may be annoyed with the
5314 long delay in reading mail.
5315 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5316 expiration would not take place until a certain number of messages
5319 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5320 with important/new/unread) are not deleted.
5321 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5322 will expire so as to have 500 messages including such ones.
5323 Otherwise, it will have 500 messages except such ones.
5325 @item (date @var{d1})
5326 deletes messages depending on the dates.
5328 Messages dated @var{d1} or more days ago are deleted, for example if its
5329 value is seven, messages seven days old or more are deleted. Note that
5330 the date is the one in the @samp{Date:} field of the message, not when
5331 the message entered the folder.
5333 Messages with no or invalid @samp{Date:} field does not expire; you
5334 might have to delete them by hand.
5337 You can use any one of the following in the place of @var{destination}:
5341 deletes the messages instantly.
5344 hide the messages from summary (messages are not deleted).
5347 moves the messages to @code{wl-trash-folder}.
5349 @item @var{string}(folder)
5350 moves the messages to the folder specified with @var{string}.
5352 It would be useful for specifying an archiving folder, but because this
5353 does not move important messages, it might be better to use the
5354 standard functions described below.
5356 @item @var{function}
5357 invokes the specified @var{function}.
5359 To the @var{function}, three arguments are passed: a folder name, a list
5360 of messages to be deleted, and msgdb information of the summary. You
5361 can specify function-specific arguments after the name of the
5362 @var{function}. Note that the list contains messages with marks in
5363 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5366 These are four standard functions; three of them move messages to an archive
5367 folder in the specified way. This means old messages can be compressed
5368 and saved in a file, being deleted from the original folder.
5369 The last one divides messages to some MH folders.
5372 @item wl-expire-archive-number1
5373 re-files to archiving folders corresponding to the message numbers of
5374 the messages being deleted. For example, a message numbered 102 will be
5375 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5376 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5377 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5379 The archiving folders to which messages are re-filed are determined by
5380 the name of the folder as follows (in this case, archiving folders are
5381 handled as if @code{elmo-archive-treat-file} were non-nil).
5384 @item If the folder type is localdir:
5385 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5387 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5388 (@file{~/Mail/ml/wl-00100.zip}).
5390 @item The folder type is other than localdir:
5391 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5393 For example, @samp{%#mh/ml/wl} corresponds to
5394 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5397 As you can see, in the case of localdir, the folder type is not included
5398 in the path name, but otherwise it is included.
5399 And you can control the prefix to the archiving folder name by
5400 @code{wl-expire-archive-folder-prefix}.
5401 Refer to @code{wl-expire-archive-folder-prefix} for details.
5403 @item wl-expire-archive-number2
5404 re-files every certain number of messages to archiving folders.
5406 This differs from @samp{wl-expire-archive-number1} in that this re-files
5407 to the folder up to the specified number regardless of message numbers.
5408 The archiving folders to which messages are re-filed are determined in the
5409 same way as @code{wl-expire-archive-number1}.
5411 @item wl-expire-archive-date
5412 re-files messages depending on its date (year and month) to archive
5415 For example, a message dated December 1998 is re-filed to
5416 @code{$folder-199812;zip}. The name of the archiving folders except the
5417 date part are determined in the same way as
5418 @code{wl-expire-archive-number1}.
5421 You can set the first argument to these three standard functions to non-nil
5422 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5423 For example, it can be specified just after the name of the function:
5426 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5429 If you omit the argument, consecutive numbers from 1 are assigned for
5430 each archiving folder.
5432 @item wl-expire-localdir-date
5433 divedes messages depending on its date (year and month) to MH folders
5434 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5438 @subsection Treatment for Important or Unread Messages
5440 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5441 standard function, messages with marks in
5442 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5443 messages} thereafter) are retained.
5445 Per default, this variable include the important, new, and unread marks,
5446 so that messages with these marks are not removed.
5447 Note that you cannot include the temporary mark (i.e. temporary marks
5448 are removed anyway), and be sure to process temporary marks before you
5451 @subsection Auto Expiration
5453 The following setup invokes expiration when you move into the summary
5454 mode. There will be no confirmation, so make sure you made no mistake
5455 in regexp and other settings before you set up this.
5459 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5463 In the folder mode, you can invoke expiration per group as well as per
5464 folder. Therefore, if you specify @samp{Desktop} group, all folders
5465 matching @code{wl-expire-alist} expire.
5469 @subsection Treating archive folders.
5470 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5471 you must set non-nil value to @code{elmo-archive-treat-file}.
5473 @subsection Confirming
5475 If you are to use @code{remove}, try @code{trash} at first and see
5476 messages move to @code{wl-trash-folder} as expected, then replace it
5477 with @code{remove}. It would be dangerous to use @code{remove} from the
5480 If you are to use @code{wl-expire-archive-number1} and the like, try to
5481 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5482 you can append messages to it. Even if settings in
5483 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5484 would not be saved anywhere and disappeared in case the archiver program
5487 After you make sure you can archive to the folder correctly, you can
5488 invoke expiration and utilize the log.
5490 If you set @code{wl-expire-use-log} to @code{t},
5491 @file{~/.elmo/expired-log} should contain the log, for example:
5495 delete +ml/wl (593 594 595 596 597 598 599)
5496 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5500 The first column indicates the operation, i.e. @samp{delete},
5501 @samp{copy}, or @samp{move}. The next is the name of the folder that
5502 expired. In the case of @samp{copy} and @samp{move}, the destination
5503 folder is recorded after @samp{->}. The last is the list of message
5504 numbers that are actually deleted or moved (in the case of @samp{copy}
5505 and @samp{move}, the number is the one in the source folder, rather than
5506 the destination folder).
5508 @subsection Re-filing Reserved Messages
5510 The three standard functions copy reserved messages to the archive
5511 folder, but do not delete them from the source folder. Because
5512 reserved messages and the like always remain, they are recorded in
5513 @file{~/.elmo/expired-alist} so that they are not copied over and over
5514 again. They are not recorded if copied by @code{wl-summary-archive}.
5516 If you enabled logging, usually @samp{move} is recorded for re-filing,
5517 but instead @samp{copy} and @samp{delete} are recorded separately if
5518 reserved messages are involved. This is because it actually copies
5519 messages including reserved, then deletes ones except reserved in that
5522 @section Customizable Variables
5525 @item wl-expire-alist
5526 @vindex wl-expire-alist
5527 The initial setting is @code{nil}.
5528 This variable specifies folders and methods to expire. For details,
5529 refer to @code{wl-expire-alist} settings above.
5531 @item wl-summary-expire-reserve-marks
5532 @vindex wl-summary-expire-reserve-marks
5533 The initial setting is the list below.
5537 (list wl-summary-important-mark
5539 wl-summary-unread-mark
5540 wl-summary-unread-uncached-mark
5541 wl-summary-unread-cached-mark)
5545 Messages with these marks are retained in the folder, even after
5547 Only permanent marks can be listed, not temporary marks.
5549 You can list marks one by one as in the default; you can use the
5550 following settings as well:
5554 All messages with permanent marks are retained,
5555 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5559 All messages are handled as usual ones that are already read, no matter
5560 what marks they have; even important messages are deleted.
5563 @item wl-expire-archive-files
5564 @vindex wl-expire-archive-files
5565 The initial setting is 100.
5566 This variable specifies the number of messages to be retained in one
5569 @item wl-expire-number-with-reserve-marks
5570 @vindex wl-expire-number-with-reserve-marks
5571 The initial setting is @code{nil}.
5572 If non-nil, if expiring messages are specified by @code{number},
5573 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5575 @item wl-expire-archive-get-folder-function
5576 @vindex wl-expire-archive-get-folder-function
5577 The initial setting is @code{wl-expire-archive-get-folder}.
5579 This variable specifies a function that returns the name of an archiving
5580 folder for standard functions in the place of @var{destination}.
5581 You can use the following three variables for simple modification of
5582 folder names; if you want more complex settings, define your own
5583 function in this variable.
5585 @code{wl-expire-archive-get-folder} can be customized by these
5588 @item @code{wl-expire-archive-folder-name-fmt}
5589 @item @code{wl-expire-archive-folder-type}
5590 @item @code{wl-expire-archive-folder-prefix}
5593 @item wl-expire-archive-folder-name-fmt
5594 @vindex wl-expire-archive-folder-name-fmt
5595 The initial setting is @samp{%s-%%05d;%s}.
5596 This is a @code{format} string for archiving folders used in
5597 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5598 Note that you must specify the message number by @samp{%%d}, because it
5599 is parsed twice by @code{format}.
5601 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5604 @item wl-expire-archive-date-folder-name-fmt
5605 @vindex wl-expire-archive-date-folder-name-fmt
5606 The initial setting is @samp{%s-%%04d%%02d;%s}.
5607 This is a @code{format} string for archiving folders used in
5608 @code{wl-expire-archive-date}. Note that you must specify the message
5609 number by @samp{%%d}, because it is parsed twice by @code{format}.
5610 There should be @samp{%%d} twice, one for the year and the other for the
5613 If you modify this, adjust
5614 @code{wl-expire-archive-date-folder-num-regexp} as well.
5616 @item wl-expire-archive-folder-type
5617 @vindex wl-expire-archive-folder-type
5618 The initial setting is @code{zip}.
5619 This variable specifies an archiver type of the archiving folders.
5621 @item wl-expire-archive-folder-prefix
5622 @vindex wl-expire-archive-folder-prefix
5623 The initial setting is @code{nil}.
5624 This variable specifies the prefix (directory structure) to archiving
5626 Exercise extreme caution in using this feature, as it has not been
5628 In the worst case, there is a fear of destructing archiving folders.
5632 There will be no prefix.
5635 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5636 @samp{$ml/wl-00000;zip;wl}.
5639 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5642 @samp{$ml/wl-00000;zip;ml/wl}.
5645 @item wl-expire-archive-folder-num-regexp
5646 @vindex wl-expire-archive-folder-num-regexp
5647 The initial setting is @samp{-\\([-0-9]+\\);}.
5648 This variable specifies the regular expression to be used for getting
5649 message numbers from multiple archiving folders specified by
5650 @code{elmo-list-folders}.
5651 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5653 @item wl-expire-archive-date-folder-num-regexp
5654 @vindex wl-expire-archive-date-folder-num-regexp
5655 The initial setting is @samp{-\\([-0-9]+\\);}.
5656 This is the regular expression to be used for getting message numbers
5657 from multiple archiving folders specified by @code{elmo-list-folders}.
5658 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5660 @item wl-expire-delete-oldmsg-confirm
5661 @vindex wl-expire-delete-oldmsg-confirm
5662 The initial setting is @code{t}.
5663 If non-nil, messages older than the one with the largest number will be
5664 deleted with confirmation.
5665 If @code{nil}, they are deleted without confirmation.
5667 This feature is valid only if non-nil is specified as a argument to the
5668 standard functions so as to retain numbers.
5670 @item wl-expire-use-log
5671 @vindex wl-expire-use-log
5672 The initial setting is @code{nil}.
5673 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5674 They are appended but not truncated or rotated automatically; you might
5675 need to remove it manually.
5677 @item wl-expire-add-seen-list
5678 @vindex wl-expire-add-seen-list
5679 The initial setting is @code{t}.
5681 If non-nil, when messages are re-filed by expiration, read/unread
5682 information is passed to the destination folder.
5684 However if you do not read the destination folder from Wanderlust,
5685 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5686 want to set this to @code{nil} if you are simply saving to some
5687 archiving folders. Even if its value is @code{nil}, messages in the
5688 archiving folders are simply treated as unread; it does not affect
5691 @item wl-expire-folder-update-msgdb
5692 @vindex wl-expire-folder-update-msgdb
5693 The initial setting is @code{t}.
5694 If @code{t}, in the folder mode, expiration is carried out after
5695 updating summary information. If you specified a list of regular
5696 expressions of folder names, summary information is updated for matching
5701 @node Archive, , Expire, Expire and Archive
5702 @section Archiving Messages
5704 @subsection Archiving Messages
5705 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5706 folders. If there are the archiving folders already, only new messages
5709 You can use @code{wl-archive-alist} in order to specify how messages are
5710 archived according to their folder names, as in @code{wl-expire-alist}.
5715 (setq wl-archive-alist
5716 '(("^\\+tmp$" wl-archive-date)
5717 ("^\\+outbox$" wl-archive-number2)
5718 (".*" wl-archive-number1)))
5722 Each item in the list has the following format:
5725 (@var{folders-regexp} @var{deleting-function})
5728 As you can see, you can only use a function after @var{folders-regexp}.
5729 Per default, there are three functions:
5732 @item @code{wl-archive-number1}
5733 @item @code{wl-archive-number2}
5734 @item @code{wl-archive-date}
5737 As inferred from their names, they work similarly to "expire" versions,
5738 other than the following points:
5741 @item No messages are deleted
5742 @item Message numbers are retained even if invoked without arguments
5745 These functions are good to archive all messages in a folder by their
5746 numbers or by their dates.
5747 These are also useful for backup or confirmation purposes before
5749 If you try to re-file them after they are archived, they are deleted but
5752 Per default, the archiving folders to which messages are copied are
5753 determined automatically by @code{wl-expire-archive-get-folder-function}.
5754 You can copy to a specific folder by invoking with a prefix argument,
5755 i.e. @kbd{C-u M-x wl-summary-archive}.
5757 Note that this feature has not been seriously tested, because you can
5758 simply copy to an archiving folder, for example by
5759 @code{wl-summary-copy-region}.
5761 The archiving folders are determined by the same logic as in
5762 @code{wl-summary-expire}; the following customizable variables are
5766 @item @code{wl-expire-archive-files}
5767 @item @code{wl-expire-archive-get-folder-function}
5768 @item @code{wl-expire-archive-folder-name-fmt}
5769 @item @code{wl-expire-archive-folder-type}
5770 @item @code{wl-expire-archive-folder-prefix}
5771 @item @code{wl-expire-archive-folder-num-regexp}
5774 @subsection Customizable Variables
5777 @item wl-archive-alist
5778 @vindex wl-archive-alist
5779 The initial setting is the list shown below:
5783 ((".*" wl-archive-number1))
5788 This variable specifies a function that copies to archiving folders.
5789 To the function, three arguments are passed: a folder name, a list of
5790 messages in the folder, and msgdb information of the summary.
5791 Needless to say, you can use your own function.
5795 @node Scoring, Address Book, Expire and Archive, Top
5796 @chapter Score of the Messages
5798 @c @cindex Kill File
5800 Scoring is the function that associates a score (value) with each
5801 message, and marks as read or deletes from the summary according to it.
5803 You can put target or important marks on essential messages, or read marks
5804 on the ones you do not want to read, for example spam articles.
5806 This scoring function has a capability and a format similar to the one
5807 that Gnus has, although there are some unsupported features and
5808 Wanderlust specifics.
5809 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5812 * Score Commands:: Score Commands
5813 * Score File Format:: Score File Format
5817 @node Score Commands, Score File Format, Scoring, Scoring
5818 @section Score Commands
5819 @cindex Score Commands
5821 @subsection Score File Specification
5823 @code{wl-score-folder-alist} specifies score files or variables in which
5824 scores are defined, corresponding to folder names.
5828 (setq wl-score-folder-alist
5837 If paths to the score files are omitted, the directory specified in the
5838 variable @code{wl-score-files-directory} is assumed.
5840 No matter what you write in @code{wl-score-folder-alist}, the default
5841 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5842 read (it does not have to exist).
5843 Therefore, in the example above, the three score files,
5844 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5845 the folders that matches @samp{^-.*}.
5847 @subsection Scored Messages
5849 Scores are attached to the messages that are specified by
5850 @code{wl-summary-score-marks} temporarily when the summary is updated;
5851 when you exit from the summary, the scores are removed and reverts to
5854 @subsection Creation of Score Files
5856 In the summary buffer, move to an appropriate message and type @kbd{L}.
5857 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5858 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5860 This makes @minus{}1000 are scored for messages with the same
5861 @samp{Subject:} as the string you entered. That is, such a score file
5862 is created automatically.
5864 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5865 The score file you just made appears.
5866 This buffer is called @dfn{score editing buffer} thereafter.
5867 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5868 as you are previously; type @kbd{a}. Then a score entry for "From"
5870 In this way, you can create a score file easily either in the summary
5871 buffer or in the score editing buffer.
5873 By the way, you might be aware the numbers of key strokes are different
5874 between @kbd{s s p} and @kbd{a}.
5875 This is determined by @code{wl-score-header-default-entry}.
5876 This variable specifies the default score entries corresponding to
5878 For example, for "subject" field, a type and a time limit are prompted,
5879 but for "from" field, they are fixed upon automatically as substring and
5880 permanent respectively.
5881 However, score values can be modified by the prefix argument.
5882 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5885 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5886 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5887 erasing contents of the buffer deletes the score file being edited.
5891 @subsubsection Selecting Score Files
5893 You can change score files to which scores are appended by
5894 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5895 @code{wl-score-change-score-file}.
5897 @subsubsection Summing Up the Score
5899 If you add the same entries by @code{wl-summary-increase-score},
5900 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5901 scores for the entry is summed up.
5903 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5904 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5905 @minus{}1200 will be created as a result.
5907 @subsubsection Creating Thread Key
5909 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5910 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5912 @subsubsection Creating Followup Key
5914 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5915 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5916 at the cursor to @samp{References} key.
5917 If @code{wl-score-auto-make-followup-entry} is non-nil,
5918 @samp{Message-ID} of all messages to be followed up within dates
5919 specified by @code{wl-score-expiry-days}.
5921 @subsection Key Bindings
5926 @findex wl-summary-increase-score
5927 Increases the score for the current message.
5928 And the score entry is appended to the score file at the same moment.
5929 You can specify the score value by a prefix argument.
5933 @findex wl-summary-lower-score
5934 Decreases the score for the current message.
5935 And the score entry is appended to the score file at the same moment.
5936 You can specify the score value by a prefix argument.
5939 @kindex h R (Summary)
5940 @findex wl-summary-rescore
5941 Re-applies the scoring.
5942 However, already scored messages are not scored anew.
5945 @kindex h c (Summary)
5946 @findex wl-score-change-score-file
5947 Changes the score file currently selected.
5950 @kindex h e (Summary)
5951 @findex wl-score-edit-current-scores
5952 Edits the score file currently selected.
5953 If there are multiple score files, the previously specified one is
5957 @kindex h f (Summary)
5958 @findex wl-score-edit-file
5959 Edits an arbitrary score file and selects it.
5962 @kindex h F (Summary)
5963 @findex wl-score-flush-cache
5964 Erases caches associated to the score files that are read.
5965 If you modified score files directly (from other than Wanderlust), you
5966 need to re-read them after erasing the cache.
5969 @kindex h m (Summary)
5970 @findex wl-score-set-mark-below
5971 Specifies the criterion for scores to be marked as read.
5972 Messages with scores less than this value are marked as read.
5975 @kindex h x (Summary)
5976 @findex wl-score-set-expunge-below
5977 Specifies the criterion for scores to be deleted from the summary.
5978 Messages with scores less than this value are deleted.
5979 "Deleted" means it is not shown; they are not removed from the summary
5980 information or the folder.
5981 The deleted messages can be shown by rescan-noscore again.
5984 @subsection Key Bindings in the Score Editing Buffer
5988 @kindex C-c C-k (Score Mode)
5989 @findex wl-score-edit-kill
5990 Abandons the file being edited.
5993 @kindex C-c C-c (Score Mode)
5994 @findex wl-score-edit-exit
5995 Saves the file being edited, and quits from the edit mode.
5998 @kindex C-c C-p (Score Mode)
5999 @findex wl-score-pretty-print
6003 @kindex C-c C-d (Score Mode)
6004 @findex wl-score-edit-insert-date
6005 Inserts the number of dates from Dec. 31, 1 B.C.
6006 It is used for creating the third factor of time-limited scores.
6009 @kindex C-c C-s (Score Mode)
6010 @findex wl-score-edit-insert-header
6011 Inserts the header of the message selected in the summary buffer.
6014 @kindex C-c C-e (Score Mode)
6015 @findex wl-score-edit-insert-entry
6016 Inserts the score entry of the message selected in the summary buffer.
6019 @subsection Customizable Variables
6022 @item wl-summary-default-score
6023 @vindex wl-summary-default-score
6024 The initial setting is 0 (zero).
6025 This variable specifies the default value of the score.
6026 The score is increased or decreased based upon this value.
6028 @item wl-summary-important-above
6029 @vindex wl-summary-important-above
6030 The initial setting is @code{nil}.
6031 Messages with scores larger than this value are attached with the
6032 important mark (@samp{$}).
6033 If @code{nil}, no important marks are attached.
6035 @item wl-summary-target-above
6036 @vindex wl-summary-target-above
6037 The initial setting is @code{nil}.
6038 Messages with scores larger than this value are attached with the target
6040 If @code{nil}, no target marks are attached.
6042 @item wl-summary-mark-below
6043 @vindex wl-summary-mark-below
6044 The initial setting is 0 (zero).
6045 Messages with scores smaller than this value are marked as read.
6047 @item wl-summary-expunge-below
6048 @vindex wl-summary-expunge-below
6049 The initial setting is @code{nil}.
6050 Messages with scores smaller than this value are deleted from the
6052 If @code{nil}, they are not deleted.
6054 @item wl-summary-score-marks
6055 @vindex wl-summary-score-marks
6056 The initial setting is the list shown below:
6060 (list wl-summary-new-mark)
6065 Messages with these marks are scored.
6067 @item wl-use-scoring
6068 @vindex wl-use-scoring
6069 The initial setting is t.
6070 If non-nil, scoring is enabled.
6072 @item wl-score-files-directory
6073 @vindex wl-score-files-directory
6074 The initial setting is @file{~/.elmo/}.
6075 The default directory for score files.
6077 @item wl-score-interactive-default-score
6078 @vindex wl-score-interactive-default-score
6079 The initial setting is 1000.
6080 This value is used as a score when a score factor is @code{nil} in the
6081 score file. It is also used in @code{wl-summary-increase-score} and
6082 @code{wl-summary-lower-score}, on condition that the value of
6083 @code{wl-score-header-default-entry} is @code{nil}.
6085 @item wl-score-expiry-days
6086 @vindex wl-score-expiry-days
6087 The initial setting is 7.
6088 This is the number of days before time-limited scores are deleted.
6090 @item wl-score-update-entry-dates
6091 @vindex wl-score-update-entry-dates
6092 The initial setting is @code{t}.
6093 If non-nil, it enables deletion of time-limited scores.
6095 @item wl-score-header-default-entry
6096 @vindex wl-score-header-default-entry
6097 Specifies the default value for each header field for score entries
6098 created by @code{wl-summary-increase-score},
6099 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6101 @item wl-score-simplify-fuzzy-regexp
6102 @vindex wl-score-simplify-fuzzy-regexp
6103 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6104 regular expression to be deleted from the string.
6105 Because this is usually used for Subject, the default is prefixes that
6106 are attached by mailing list programs.
6108 @item wl-summary-rescore-partial-threshold
6109 @vindex wl-summary-rescore-partial-threshold
6110 The initial setting is 200.
6111 When sync-all or rescan is executed, if there are messages more than
6112 this value, only the last same number of messages as this value are
6115 @item wl-summary-auto-sync-marks
6116 @vindex wl-summary-auto-sync-marks
6117 If non-nil, unread/important marks are synchronized when the summary
6119 Unread marks reflect information on the IMAP4 server.
6120 Important marks reflect information on the IMAP4 server (flagged or
6121 not), and contents of @samp{'mark} folder.
6122 The initial setting is @code{t}.
6126 @node Score File Format, , Score Commands, Scoring
6127 @section Score File Format
6128 @cindex Score File Format
6130 The format of score files are the same as Gnus, and basically you can
6131 use Gnus score files as they are. But they are not fully compatible
6132 because some keys are not supported and there are Wanderlust specifics.
6133 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6138 ("for sale" -1000 nil s)
6139 ("profit" -1000 nil s))
6141 ("spam@@spamspamspam" -10000 nil s))
6143 ("my@@address" 3001 nil s))
6145 (1000000 -10 nil >))
6155 If the key is a string, it is the name of the header to be matched.
6156 The following keys are available:
6157 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6158 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6159 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6160 @code{Chars} and @code{Lines} mean the size and the number of lines of
6161 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6162 are described later.
6163 The rest corresponds the field of the same name.
6165 Arbitrary numbers of core entries are specified after the key.
6166 Each score entry consists of these five factors:
6170 A factor that matches header. This should be a number in the cases of
6171 @code{lines} and @code{chars}, otherwise a string.
6174 A score factor. When the first item matches, the score of the message
6175 is increased or decreased by this value.
6178 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6179 of a number, the score is deleted if it does not match for days
6180 (@code{wl-score-expiry-days}) from the date specified by this.
6181 The date is since Dec. 31, 1 B.C.
6184 A type factor. This specifies the way the first factor matches.
6185 Available types depend on keys.
6188 @item From, Subject, References, Message-ID
6189 For these keys in string, @code{r} and @code{R} (regexp),
6190 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6191 as well as @code{f} and @code{F} (fuzzy) can be used.
6192 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6195 For these keys, the following five numerical relative operators can be
6196 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6199 This key matches @code{From} header, and scores all follow-ups to the
6201 For example, it would be useful for increasing scores for follow-ups to
6204 You can use the same types as @code{From} except for @code{f}.
6205 And a @samp{Followup} entry is automatically appended to the score file.
6208 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6209 A @samp{Thread} entry is automatically appended for each article that
6210 has @var{x} in the @code{References} header.
6211 You can make sure the whole thread including messages that does not have
6212 all ancestors @code{Message-ID} in @code{References} is scored.
6214 You can use the same types as @code{References} except for @code{f}.
6215 And a @samp{Thread} entry is automatically appended to the score file.
6219 A factor for extension header. This is meaningful only if the key is
6221 This specifies headers to be matched other than standard headers like
6222 @code{Subject} and @code{From}.
6223 Note that you should specify the header in
6224 @code{elmo-msgdb-extra-fields} also.
6225 Therefore it does not work in folders where extension headers cannot be
6230 The sum of these scores @emph{after all factors are applied} becomes the
6231 score of the message.
6233 @cindex Score File Atoms
6235 Messages with a score less than this value is marked as read.
6236 The default is @code{wl-summary-mark-below}.
6239 Messages with a score less than this value is deleted from the summary.
6240 The default is @code{wl-summary-expunge-below}.
6242 @item mark-and-expunge
6243 Both @code{mark} and @code{expunge} are applied,
6244 i.e. messages with a score less than this value is marked as read and
6245 deleted from the summary.
6248 Messages with a score greater than this value is attached with temp
6250 The default is @code{wl-summary-target-above}.
6253 Messages with a score greater than this value is attached with important
6255 The default is @code{wl-summary-important-above}.
6260 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6261 are used, you need to set @code{elmo-msgdb-extra-fields}.
6264 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6267 There are other restrictions as shown below:
6270 @item Because @samp{References} field in the summary information
6271 contains only the last @samp{Message-ID}, @code{references} key matches
6275 Keys that can be seen by folder of types:
6279 chars lines xref extra
6280 localdir,localnews Y E E E
6281 nntp (supporting xover) Y E E N
6287 N: cannot be seen (ignored)
6288 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6293 @node Address Book, Customization, Scoring, Top
6294 @chapter Address Book
6295 @cindex Address Book
6297 With address book, you can utilize address completion, and you have
6298 summary displayed with nicknames.
6301 * Mail Addresses:: Definition of Address Book
6302 * Address Manager:: Address Manager
6305 @node Mail Addresses, Address Manager, Address Book, Address Book
6306 @section Address book
6307 @cindex Address book Definition
6309 @cindex Alias, Address
6311 The file @file{~/.addresses} is a simple address book for Wanderlust.
6312 Make address file @file{~/.addresses}, and edit to suit your requirement.
6314 The data written in @file{~/.addresses} are used for address completion
6315 under draft editing mode. Furthermore, they are used when showing names
6316 in summary display mode. You can safely skip this section, if you don't
6317 want to customize address completion and summary display.
6318 It is possible to add/change/remove addresses from @file{~/.addresses} in
6319 summary buffer after Wanderlust is invoked. @refill
6321 The format is very simple. Like this. @refill
6326 # @r{Lines begin with @samp{#} are comment.}
6327 # @r{Empty lines are ignored}
6329 # @r{Format of each line:}
6330 # @var{email-address} "@var{nickname} "@var{realname}"
6332 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6333 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6334 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6339 One line defines one persons description.
6341 Actually, in default setup, @var{nickname} is used in summary-mode and
6342 @var{realname} is used in draft preparation mode. This behavior is
6343 better understood if you try it and confirmed the function first. You
6344 can write and try a small definition, so you will know the idea of the
6345 address book before writing a big one.
6347 And, if MH alias file is specified in variable @code{wl-alias-file},
6348 it is used as an address information in the draft preparation mode.
6350 If variable @code{wl-use-ldap} is non-nil (initial setting is
6351 @code{nil}), address completion in draft mode uses LDAP information.
6353 If you use LDAP, you have to set @code{wl-ldap-server},
6354 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6355 not have LDAP feature as built-in feature (Currently only XEmacs can
6356 have built-in LDAP feature), you have to set command exec @env{PATH} to
6357 the program @command{ldapsearch}.
6360 @node Address Manager, , Mail Addresses, Address Book
6361 @section Address Manager
6362 @cindex Address Manager
6364 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6365 the address book and insert address to draft buffer.
6367 @subsection Key Bindings
6371 @kindex t (Address Manager)
6372 @findex wl-addrmgr-set-to
6373 Add @samp{To:} mark.
6376 @kindex c (Address Manager)
6377 @findex wl-addrmgr-set-cc
6378 Add @samp{Cc:} mark.
6381 @kindex b (Address Manager)
6382 @findex wl-addrmgr-set-bcc
6383 Add @samp{Bcc:} mark.
6386 @kindex u (Address Manager)
6387 @findex wl-addrmgr-unmark
6391 @kindex x (Address Manager)
6392 @findex wl-addrmgr-apply
6394 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6395 buffer and quit address manager. When no draft buffer, make new draft
6396 with insert marked addresses.
6398 If no mark, quit address manager.
6402 @kindex q (Address Manager)
6403 @findex wl-addrmgr-quit
6404 Quit address manager.
6407 @kindex a (Address Manager)
6408 @findex wl-addrmgr-add
6412 @kindex d (Address Manager)
6413 @findex wl-addrmgr-delete
6417 @kindex e (Address Manager)
6418 @findex wl-addrmgr-edit
6423 @node Customization, Terminology, Address Book, Top
6424 @chapter Customizing Wanderlust
6425 @cindex Customization
6428 * Living with other packages:: Cooperating with other packages
6429 * Highlights:: Highlights
6430 * Biff:: Notify Mail arrival
6431 * Advanced Settings:: Advanced Settings
6432 * Customizable Variables:: Customizable Variables
6437 @node Living with other packages, Highlights, Customization, Customization
6438 @section Living with other packages
6440 Examples with other packages.
6443 * imput:: imput (im-wl.el)
6444 * BBDB:: The Insidious Big Brother Database
6445 * LSDB:: The Lovely Sister Database
6446 * supercite:: supercite.el
6447 * mu-cite:: mu-cite.el
6448 * X-Face:: x-face,bitmap-mule
6449 * dired-dd:: dired-dd.el
6451 * Addrbook:: Addrbook
6452 * mime-w3m:: mime-w3m.el
6456 @node imput, BBDB, Living with other packages, Living with other packages
6461 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6464 If @command{imput} is on the @code{exec-path} at the installation,
6465 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6469 (autoload 'wl-draft-send-with-imput-async "im-wl")
6470 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6475 @node BBDB, LSDB, imput, Living with other packages
6479 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6482 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6483 byte-compiled and installed.
6491 ;; @r{enable pop-ups}
6492 (setq bbdb-use-pop-up t)
6493 ;; @r{auto collection}
6494 (setq bbdb/mail-auto-create-p t)
6495 ;; @r{exceptional folders against auto collection}
6496 (setq bbdb-wl-ignore-folder-regexp "^@@")
6497 (setq signature-use-bbdb t)
6498 (setq bbdb-north-american-phone-numbers-p nil)
6499 ;; @r{shows the name of bbdb in the summary} :-)
6500 (setq wl-summary-from-function 'bbdb-wl-from-func)
6501 ;; @r{automatically add mailing list fields}
6502 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6503 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6507 You can complete address with BBDB by @kbd{M-@key{TAB}}
6511 @node LSDB, supercite, BBDB, Living with other packages
6515 The following is an example of settings:
6521 (add-hook 'wl-draft-mode-hook
6523 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
6527 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
6528 (complete address with LSDB).
6531 @node supercite, mu-cite, LSDB, Living with other packages
6532 @subsection sc.el(supercite), sc-register.el
6536 The same setting as usual mailers should be OK. The following is an
6537 example of settings:
6541 (autoload 'sc-cite-original "supercite" nil t)
6542 (add-hook 'mail-citation-hook 'sc-cite-original)
6547 @node mu-cite, X-Face, supercite, Living with other packages
6548 @subsection mu-cite.el
6551 The same setting as usual mailers should be OK. The following is an
6552 example of settings.
6554 If you use mu-cite version 8.0 or earlier:
6558 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6559 (setq mail-citation-hook 'mu-cite/cite-original)
6563 If you use mu-cite version 8.1 or later:
6567 (autoload 'mu-cite-original "mu-cite" nil t)
6568 (add-hook 'mail-citation-hook (function mu-cite-original))
6572 @node X-Face, dired-dd, mu-cite, Living with other packages
6576 If you have installed one of the following, you can decode
6577 @samp{X-Face:} field in message buffer and you will see face image.
6580 * x-face-xmas:: XEmacs case
6581 * x-face-mule:: Emacs case
6584 If there is an encoded X-Face string in a file @file{~/.xface} (the
6585 value of the variable @code{wl-x-face-file}), it is inserted as a
6586 @samp{X-Face:} field in the draft buffer (if
6587 @code{wl-auto-insert-x-face} is non-nil).
6589 @node x-face-xmas, x-face-mule, X-Face, X-Face
6590 @subsubsection x-face-xmas (for XEmacs)
6593 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6594 1.3.6.13 or later, do the following:
6598 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6599 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6603 @node x-face-mule, , x-face-xmas, X-Face
6604 @subsubsection x-face-mule (for Emacs)
6608 If you use @file{x-face-mule.el} in bitmap-mule
6609 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6613 (autoload 'x-face-decode-message-header "x-face-mule")
6614 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6618 @subsubsection x-face-e21 (for Emacs 21.x)
6621 With Emacs 21.x, you can use @file{x-face-e21.el}
6622 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6623 to display X-Face. In this case, bitmap-mule is not required.
6628 (autoload 'x-face-decode-message-header "x-face-e21")
6629 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6634 @node dired-dd, MHC, X-Face, Living with other packages
6635 @subsection dired-dd(Dired-DragDrop)
6636 @pindex Dired-DragDrop
6638 @cindex Drag and Drop
6640 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6641 compose multi-part by simple Drag-and-Drop from dired to the draft
6642 buffer being edited in GNU Emacs (this feature is not Wanderlust
6643 specific, but general-purpose for SEMI).
6647 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6653 ;; @r{Set dired-x variables here.}
6654 ;; @r{To and flo@dots{}}
6656 (progn (require 'dired-dd)
6657 (require 'dired-dd-mime))))))
6661 @node MHC, Addrbook, dired-dd, Living with other packages
6665 Message Harmonized Calendaring system
6666 (@uref{http://www.quickhack.net/mhc/})
6668 By using MHC, you can make a calendar from the messages.
6674 (setq mhc-mailer-package 'wl)
6675 (autoload 'mhc-mode "mhc" nil t)
6676 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6677 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6685 (autoload 'mhc-wl-setup "mhc-wl")
6686 (add-hook 'wl-init-hook 'mhc-wl-setup)
6690 @node Addrbook, mime-w3m, MHC, Living with other packages
6691 @subsection wl-addrbook.el
6695 (@uref{http://www.mew.org/})
6697 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6698 @code{load-path} and do the following settings.
6702 (require 'wl-addrbook)
6707 @node mime-w3m, , Addrbook, Living with other packages
6708 @subsection mime-w3m.el
6711 You can display html part by using @file{mime-w3m.el}
6712 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6713 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6716 @node Highlights, Biff, Living with other packages, Customization
6719 @subsection Customizable Variables
6722 @item wl-summary-highlight
6723 @vindex wl-summary-highlight
6724 The initial setting is @code{t}.
6725 If non-nil, the summary is highlighted.
6727 @item wl-highlight-max-summary-lines
6728 @vindex wl-highlight-max-summary-lines
6729 The initial setting is 10000.
6730 The summary is not highlighted if it has more lines than this value.
6732 @item wl-summary-highlight-partial-threshold
6733 @vindex wl-summary-highlight-partial-threshold
6734 The initial setting is 1000.
6735 This is a threshold whether the whole summary is highlighted.
6736 If there are more lines of messages in the summary, it is partially
6739 @item wl-summary-partial-highlight-above-lines
6740 @vindex wl-summary-partial-highlight-above-lines
6741 The initial setting is 30. If there are more lines of messages than
6742 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6743 after the point that is the same number of lines as this value above the
6744 cursor line are highlighted partially. (If this value is @code{nil},
6745 the last same number of lines as the value of
6746 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6748 @item wl-highlight-body-too
6749 @vindex wl-highlight-body-too
6750 The initial setting is @code{t}.
6751 If non-nil, bodies of drafts and messages are also highlighted.
6753 @item wl-highlight-message-header-alist
6754 @vindex wl-highlight-message-header-alist
6755 When highlighting headers of drafts and messages, this variable
6756 specifies which faces are allocated to important
6757 (@code{wl-highlight-message-important-header-contents}), secondly
6758 important (@code{wl-highlight-message-important-header-contents2}), and
6759 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6761 Similarly, it can be used for allocating arbitrary faces to arbitrary
6762 regular expressions.
6764 @item wl-highlight-citation-prefix-regexp
6765 @vindex wl-highlight-citation-prefix-regexp
6766 Specifies a regular expression to which quoted lines in bodies of
6767 drafts and messages match.
6768 Bodies matching to this regular expression are highlighted by the faces
6769 specified by (@code{wl-highlight-message-cited-text-*}).
6771 @item wl-highlight-highlight-citation-too
6772 @vindex wl-highlight-highlight-citation-too
6773 The initial setting is @code{nil}.
6774 If non-nil, the quoting regular expression itself given by
6775 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6777 @item wl-highlight-citation-header-regexp
6778 @vindex wl-highlight-citation-header-regexp
6779 Specifies a regular expression that denotes beginning of quotation.
6780 Bodies matching to this regular expression are highlighted by the face
6781 specified by @code{wl-highlight-message-headers}.
6783 @item wl-highlight-max-header-size
6784 @vindex wl-highlight-max-header-size
6785 The initial setting is @code{nil}. If a header size is larger than this
6786 value, it will not be highlighted. If @code{nil}, always highlighted
6787 (ignore header size).
6789 @item wl-highlight-max-message-size
6790 @vindex wl-highlight-max-message-size
6791 The initial setting is 10000.
6792 If a message is larger than this value, it will not be highlighted.
6793 With this variable, highlight is suppressed for uuencode or huge digest
6796 @item wl-highlight-signature-separator
6797 @vindex wl-highlight-signature-separator
6798 Specifies regular expressions that denotes the boundary of a signature.
6799 It can be a regular expression, or a list of ones.
6800 Messages after the place that matches this regular expression are
6801 highlighted by the face specified by
6802 @code{wl-highlight-message-signature}.
6804 @item wl-max-signature-size
6805 @vindex wl-max-signature-size
6806 The initial setting is 400.
6807 This is the largest size for a signature to be highlighted.
6809 @item wl-use-highlight-mouse-line
6810 @vindex wl-use-highlight-mouse-line
6811 The initial setting is @code{t}.
6812 If non-nil, the line pointed by the mouse is highlighted in the folder
6813 mode, summary mode, and the like.
6816 @subsection Setting Colors and Fonts of the Characters
6818 If you want to change colors or fonts of the characters, you need to
6819 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6820 want to change fonts, and @code{set-face-foreground} for colors, and so
6821 on. You cannot write face settings in @file{.emacs}; write in
6824 For example, if you want to change the color for signatures to yellow,
6828 (set-face-foreground 'wl-highlight-message-signature "yellow")
6834 Faces defined in Wanderlust:
6837 @item wl-highlight-message-headers
6838 The face for field names of message headers.
6840 @item wl-highlight-message-header-contents
6841 The face for field bodies of message headers.
6843 @item wl-highlight-message-important-header-contents
6844 The face for important parts of message headers.
6845 Per default, this face is used for a body of @samp{Subject:} field.
6846 You can change its value by editing
6847 @code{wl-highlight-message-header-alist}.
6849 @item wl-highlight-message-important-header-contents2
6850 The face for secondly important parts of message headers.
6851 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6852 fields. You can change its value by editing
6853 @code{wl-highlight-message-header-alist}.
6855 @item wl-highlight-message-unimportant-header-contents
6856 The face for unimportant parts of message headers.
6857 Per default, this face is used for bodies of @samp{X-} fields
6858 @samp{User-Agent:} fields. You can change its value by editing
6859 @code{wl-highlight-message-header-alist}.
6861 @item wl-highlight-message-citation-header
6862 The face for headers of quoted messages.
6864 @item wl-highlight-message-cited-text-*
6865 The face for texts of quoted messages. The last @samp{*} is a
6866 @var{single figure} so that 10 different colors can be used according to
6869 @item wl-highlight-message-signature
6870 The face for signatures of messages. The initial settings are
6871 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6872 dark background colors.
6874 @item wl-highlight-header-separator-face
6875 The face for header separators of draft messages.
6877 @item wl-highlight-summary-important-face
6878 The face for message lines with important marks in the summary.
6880 @item wl-highlight-summary-new-face
6881 The face for message lines with new marks in the summary.
6883 @item wl-highlight-summary-displaying-face
6884 The face for the message line that is currently displayed.
6885 This face is overlaid.
6887 @item wl-highlight-thread-indent-face
6888 The face for the threads that is currently displayed.
6890 @item wl-highlight-summary-unread-face
6891 The face for message lines with unread marks in the summary.
6893 @item wl-highlight-summary-deleted-face
6894 The face for message lines with delete marks in the summary.
6896 @item wl-highlight-summary-refiled-face
6897 The face for message lines with re-file marks in the summary.
6899 @item wl-highlight-refile-destination-face
6900 The face for re-file information part of message lines with re-file
6901 marks in the summary.
6903 @item wl-highlight-summary-copied-face
6904 The face for message lines with copy marks in the summary.
6906 @item wl-highlight-summary-target-face
6907 The face for message lines with target marks @samp{*} in the summary.
6909 @item wl-highlight-summary-thread-top-face
6910 The face for message lines that are on the top of the thread in the
6913 @item wl-highlight-summary-normal-face
6914 The face for message lines that are not on top of the thread in the
6917 @item wl-highlight-folder-unknown-face
6918 The face for folders that are not known to have how many unsync messages
6921 @item wl-highlight-folder-zero-face
6922 The face for folders that have no unsync messages in the folder mode.
6924 @item wl-highlight-folder-few-face
6925 The face for folders that have some unsync messages in the folder mode.
6927 @item wl-highlight-folder-many-face
6928 The face for folders that have many unsync messages in the folder mode.
6929 The boundary between `some' and `many' is specified by the variable
6930 @code{wl-folder-many-unsync-threshold}.
6932 @item wl-highlight-folder-unread-face
6933 The face for folders that have no unsync but unread messages in the
6936 @item wl-highlight-folder-killed-face
6937 The face for folders that are deleted from the access group in the
6940 @item wl-highlight-folder-opened-face
6941 The face for open groups in the folder mode.
6942 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6943 @code{nil} or a @var{number}.
6945 @item wl-highlight-folder-closed-face
6946 The face for close groups in the folder mode.
6947 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6948 @code{nil} or a @var{number}.
6950 @item wl-highlight-folder-path-face
6951 The face for the path to the currently selected folder in the folder
6954 @item wl-highlight-logo-face
6955 The face for logo in the demo.
6957 @item wl-highlight-demo-face
6958 The face for strings (for example, a version number) in the demo.
6962 @node Biff, Advanced Settings, Highlights, Customization
6963 @section Notify Mail arrival
6966 Following setting is to notify mail arrival of @samp{%inbox}
6967 by the indicator on the modeline
6970 (setq wl-biff-check-folder-list '("%inbox"))
6973 @subsection Customizable Variables
6975 @item wl-biff-check-folder-list
6976 @vindex wl-biff-check-folder-list
6977 The initial setting is @code{nil}.
6978 This is the list of folders to check mail arrival.
6979 If @code{nil}, wl doesn't check mail arrival.
6981 @item wl-biff-check-interval
6982 @vindex wl-biff-check-interval
6983 The initial setting is 40 (in seconds).
6984 Check mail arrival in this period.
6986 @item wl-biff-notify-hook
6987 @vindex wl-biff-notify-hook
6988 This hook is run at the arrival of new mail.
6989 To beep with mail arrival(initial setting), set as follows.
6991 (setq wl-biff-notify-hook '(ding))
6993 For silence, set to @code{nil}.
6997 @node Advanced Settings, Customizable Variables, Biff, Customization
6998 @section Advanced Settings
7001 * Draft for Reply:: Draft for Reply
7002 * Thread Format:: Appearance of Thread
7003 * User-Agent Field:: @samp{User-Agent:} Header Field
7007 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7008 @subsection Draft for Replay
7009 @vindex wl-draft-reply-with-argument-list
7010 @vindex wl-draft-reply-without-argument-list
7011 @vindex wl-draft-reply-myself-with-argument-list
7012 @vindex wl-draft-reply-myself-without-argument-list
7014 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7015 The addressee for the draft is decided by following rules.
7017 For example, you can set as follows:
7021 (setq wl-draft-reply-without-argument-list
7022 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7023 ("Followup-To" . (nil nil ("Followup-To")))
7024 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7025 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7029 Where each element of the list @code{wl-draft-reply-without-argument-list}
7033 (key . (to-list cc-list newsgroup-list))
7036 and if the field designated by @samp{key} exist in the parent message,
7037 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7038 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7039 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7040 the draft respectively.
7045 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7048 Match if the parent has @samp{Mail-Followup-To} field.
7049 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7050 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7054 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7057 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7058 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7061 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7064 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7065 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7068 These are evaluated in order and first matched one is used.
7070 Moreover, the behavior of @kbd{a} with prefix argument can
7071 be directed by @code{wl-draft-reply-with-argument-list} as well.
7073 By the way, you can use some function (will be evaluated in the parent
7074 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7075 For example, if you only want to reply to mailing lists in
7076 @code{wl-subscribed-mailing-list} if the parent has some of them,
7081 (defun wl-mailing-list-addresses ()
7085 (nth 1 (std11-extract-address-components addr)))
7088 (elmo-multiple-fields-body-list (list "To" "Cc"))
7090 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
7091 (setq list-addrs (cons to list-addrs))))
7092 (nreverse list-addrs)))
7094 (setq wl-draft-reply-with-argument-list
7095 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
7096 ("Reply-To" . (("Reply-To") nil nil))
7097 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
7098 ("From" . (("From") nil nil))))
7103 Note: To set the behavior when you reply to the message written by yourself,
7104 use @code{wl-draft-reply-myself-without-argument-list} and
7105 @code{wl-draft-reply-myself-with-argument-list} instead of them.
7107 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
7108 @subsection Appearance of Threads
7112 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
7113 390 09/18(Fri)07:25 +-[ Tsumura-san ]
7114 391 09/18(Fri)19:24 +-[ Murata-san ]
7115 392 09/20(Sun)21:49 +-[ Okunishi-san ]
7116 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
7117 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
7118 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
7119 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
7120 412 09/22(Tue)09:28 | +-[ Teranishi ]
7121 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
7122 416 09/22(Tue)12:38 | +-[ Teranishi ]
7123 395 09/20(Sun)21:49 +-[ Okunishi-san ]
7124 397 09/21(Mon)00:15 +-[ Okunishi-san ]
7128 Settings to make appearance of threads like shown above:
7132 (setq wl-thread-indent-level 2)
7133 (setq wl-thread-have-younger-brother-str "+")
7134 (setq wl-thread-youngest-child-str "+")
7135 (setq wl-thread-vertical-str "|")
7136 (setq wl-thread-horizontal-str "-")
7137 (setq wl-thread-space-str " ")
7141 If you do not want to see branches, do the following:
7145 (setq wl-thread-indent-level 2)
7146 (setq wl-thread-have-younger-brother-str " ")
7147 (setq wl-thread-youngest-child-str " ")
7148 (setq wl-thread-vertical-str " ")
7149 (setq wl-thread-horizontal-str " ")
7150 (setq wl-thread-space-str " ")
7155 @node User-Agent Field, , Thread Format, Advanced Settings
7156 @subsection User-Agent Field
7160 If you are eccentric enough to elaborate @samp{X-Mailer:} or
7161 @samp{User-Agent:} fields, define a function that generate appropriate
7162 strings as you like, and set it to variable
7163 @code{wl-generate-mailer-string-function}.
7165 If you do not want verbose @samp{User-Agent:} field, do the following:
7169 (setq wl-generate-mailer-string-function
7170 'wl-generate-user-agent-string-1)
7174 The following is a example:
7178 (setq wl-generate-mailer-string-function nil)
7179 (setq wl-draft-additional-header-alist
7181 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7186 @node Customizable Variables, Hooks, Advanced Settings, Customization
7187 @section Customizable Variables
7189 Customizable variables that have not been described yet:
7192 @item wl-default-folder
7193 @vindex wl-default-folder
7194 The initial setting is @samp{%inbox}. This is the default value for moving to
7195 a folder and the like.
7197 @item wl-draft-folder
7198 @vindex wl-draft-folder
7199 The initial setting is @samp{+draft}. It is the folder to which drafts are
7200 saved. It must be a localdir folder.
7202 @item wl-trash-folder
7203 @vindex wl-trash-folder
7204 The initial setting is @samp{+trash}. It is the wastebasket folder.
7205 If you changed this variable, you had better restart Wanderlust.
7207 @item wl-interactive-exit
7208 @vindex wl-interactive-exit
7209 The initial setting is @code{t}.
7210 If non-nil, you are asked for confirmation when Wanderlust terminates.
7212 @item wl-interactive-send
7213 @vindex wl-interactive-send
7214 The initial setting is @code{t}.
7215 If non-nil, you are asked for confirmation when mail is sent.
7217 @item wl-folder-sync-range-alist
7218 @vindex wl-folder-sync-range-alist
7219 The initial setting is the alist shown below:
7224 ("^\\+draft$\\|^\\+queue$" . "all"))
7229 This is an associative list of regular expressions of folder names and
7230 update range of the summary. Update range is one of the @samp{all},
7231 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
7232 @samp{last}. If a folder do not match, @samp{update} is used.
7235 @vindex wl-ask-range
7236 The initial setting is @code{t}.
7237 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7238 for updating the summary when you changed folders.
7240 @item wl-mime-charset
7241 @vindex wl-mime-charset
7242 The initial setting is @code{x-ctext}.
7243 This is the MIME charset for messages that are not MIME (e.g. without
7244 @samp{Content-Type:}). This value also used as default charset for
7245 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7246 this value as @code{iso-2022-jp}.)
7248 @item wl-highlight-folder-with-icon
7249 @vindex wl-highlight-folder-with-icon
7250 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7251 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7253 @item wl-strict-diff-folders
7254 @vindex wl-strict-diff-folders
7255 This is a list of regular expressions of folders.
7256 Unread messages are checked, for example when you press @kbd{s} in
7257 the folder mode, usually in a brief way (rapidly processed but not
7259 The folders matching this variable are seriously checked.
7260 You may want to set this variable so as to match conditional filter
7261 folders for IMAP4 folders.
7262 The initial setting is @code{nil}.
7264 @item wl-folder-use-server-diff
7265 @vindex wl-folder-use-server-diff
7266 When unread messages are checked, for example when you press @kbd{s} in
7267 the folder mode, usually (the number of messages on the server) @minus{}
7268 (the number of local messages) will be the number of unread messages.
7269 However, if this variable is non-nil, the number of unread messages on
7270 the server is checked. This affects IMAP4 folders only, but IMAP4
7271 folders in mail boxes matching
7272 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7273 the number of unread messages on the server, even if they matches this
7274 variable. The initial setting is @code{t}.
7276 @item wl-auto-check-folder-name
7277 @vindex wl-auto-check-folder-name
7278 The initial setting is @code{nil}.
7279 You can specify a folder or a group which is checked for unread message
7280 at the start. You can also specify a list of folders (groups) to be checked.
7281 If the value is @code{nil}, whole Desktop is checked at the start.
7282 If it is @code{none}, no folders are checked.
7284 @item wl-auto-uncheck-folder-list
7285 @vindex wl-auto-uncheck-folder-list
7286 The initial setting is the list shown below:
7295 You can set a list of regular expressions to specify folders
7296 which are not automatically checked even if they are included
7297 in some groups assigned by @code{wl-auto-check-folder-name}.
7299 @item wl-auto-check-folder-list
7300 @vindex wl-auto-check-folder-list
7301 The initial setting is @code{nil}.
7302 You can set a list of regular expressions to specify exceptions
7303 for @code{wl-auto-uncheck-folder-list}.
7305 @item wl-no-save-folder-list
7306 @vindex wl-no-save-folder-list
7307 The initial setting is the list shown below:
7316 This is a list of regular expressions of folders not to be saved.
7318 @item wl-save-folder-list
7319 @vindex wl-save-folder-list
7320 The initial setting is @code{nil}.
7321 This is a list of regular expressions of folders to be saved.
7322 This takes precedence over @code{wl-no-save-folder-list}.
7324 @item wl-folder-mime-charset-alist
7325 @vindex wl-folder-mime-charset-alist
7326 The initial setting is the alist shown below:
7330 (("^-alt\\.chinese" . big5)
7331 ("^-relcom\\." . koi8-r)
7333 ("^-han\\." . euc-kr))
7338 This is an associative list of regular expressions of folder names and
7340 If a folder do not match, @code{wl-mime-charset} is used.
7342 @item wl-folder-init-load-access-folders
7343 @vindex wl-folder-init-load-access-folders
7344 The initial setting is @code{nil}.
7345 This is a list of access groups to be loaded specifically at the start.
7346 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7348 @item wl-folder-init-no-load-access-folders
7349 @vindex wl-folder-init-no-load-access-folders
7350 The initial setting is @code{nil}.
7351 This is a list of access groups not to be loaded specifically at the
7353 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7355 @item wl-delete-folder-alist
7356 @vindex wl-delete-folder-alist
7357 The initial setting is the alist shown below:
7366 This list determines disposition of messages with delete marks.
7367 Each item in the list is a folder and destination; you can specify any
7368 one of the following in the place of destination:
7371 @code{remove} or @code{null} : deletes the messages instantly.
7372 string : moves the messages to the specific folder.
7373 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7376 @item wl-refile-policy-alist
7377 @vindex wl-refile-policy-alist
7378 The initial setting is the list shown below:
7388 This list determines whether messages with re-file marks are moved or
7389 copied. Each item in the list is a cons cell of a folder and
7390 @code{copy} or @code{move}.
7392 @item wl-x-face-file
7393 @vindex wl-x-face-file
7394 The initial setting is @file{~/.xface}.
7395 The name of the file that contains encoded X-Face strings.
7398 @item wl-demo-display-logo
7399 @vindex wl-demo-display-logo
7400 If non-nil, bitmap image is shown on the opening demo. If you set
7401 @code{xpm} or @code{xbm}, (if possible) display selected image type
7404 @item elmo-use-database
7405 @vindex elmo-use-database
7406 This is meaningful for XEmacs only. The initial setting depends on
7407 XEmacs (@code{t} for XEmacs with dbm).
7408 If non-nil, Message-ID is controlled by dbm.
7410 @item elmo-passwd-alist-file-name
7411 @vindex elmo-passwd-alist-file-name
7412 The initial setting is @file{passwd}.
7413 This is the name of the file in which passwords are saved.
7414 @code{elmo-passwd-alist-save} saves current passwords to the file.
7416 @item elmo-nntp-list-folders-use-cache
7417 @vindex elmo-nntp-list-folders-use-cache
7418 The initial setting is 600 (in seconds).
7419 This is period in seconds during which results of @samp{list} and
7420 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7423 @item elmo-nntp-max-number-precedes-list-active
7424 @vindex elmo-nntp-max-number-precedes-list-active
7425 The initial setting is @code{nil}.
7426 If non-nil, the number of article obtained by @samp{list active} in NNTP
7427 are used as the maximum article number of the folder.
7428 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7429 and if the number of read messages is not correct.
7431 @item elmo-nntp-default-use-listgroup
7432 @vindex elmo-nntp-default-use-listgroup
7433 The initial setting is @code{t}.
7434 If non-nil, @samp{listgroup} is used for checking the total number of
7435 articles. If it is @code{nil}, @samp{group} is used. In the latter
7436 case, the processing will be a little faster at the sacrifice of
7439 @item elmo-pop3-send-command-synchronously
7440 @vindex elmo-pop3-send-command-synchronously
7441 The initial setting is @code{nil}.
7442 If non-nil, POP3 commands are issued synchronously. Some implementation
7443 of POP3 server fails to get summary information without this setting.
7444 You may have to set this variable to @code{t}, if the process hangs
7445 while looking up POP3.
7447 @item elmo-dop-flush-confirm
7448 @vindex elmo-dop-flush-confirm
7449 The initial setting is @code{t}.
7450 If non-nil, you are asked for confirmation if accumulated off-line
7451 operations are executed.
7453 @item elmo-display-progress-threshold
7454 @vindex elmo-display-progress-threshold
7455 The initial setting is 20.
7456 Threshold for display of progress gauge. If number of renewal is more than
7457 this value, display progress gauge.
7461 @node Hooks, , Customizable Variables, Customization
7466 @node Terminology, Mailing List, Customization, Top
7467 @chapter Terminology around Wanderlust
7470 Here we explain terminologies used in this manual.
7474 A container in which messages are stored.
7477 A set consists of some folders.
7480 A special group consists of automatically collected folders under
7481 some specified path.
7482 @xref{Folder Definition}.
7484 @item summary buffer
7485 A buffer for displaying list of messages in some folder.
7487 @item sticky summary
7488 Compared with ordinary summary buffer which will be destroyed after
7489 exiting from it, this type of summary will be remain even after exiting
7490 by @kbd{q} or @kbd{g}.
7491 @xref{Sticky Summary}.
7494 To delete or put into the archive expired messages.
7501 To cache messages beforehand in order to read messages after you will be
7502 disconnected from the server.
7506 @node Mailing List, Addition, Terminology, Top
7507 @chapter Wanderlust Mailing List
7511 Topics related to Wanderlust are discussed in following mailing lists.
7512 The latest version is also announced there.
7515 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7518 In this list Japanese is mainly used for discussion. We also have a list
7519 for discussion in English:
7522 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7524 (Messages posted to this list are also forwarded to the former one.)
7526 A guide can be obtained automatically by sending mail to
7527 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7528 the English one) with the body
7534 Please send bug reports or patches to one of those lists. You can post to
7535 the mailing list even though you are not a member of it.
7537 If you send a bug report, please attach Backtrace with it.
7538 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7541 I would like to express my thanks to the members of the mailing list for
7542 valuable advice and many pieces of code they contributed.
7545 @node Addition, Index, Mailing List, Top
7546 @chapter Additional Information
7548 @section Brief History
7551 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7552 3/10 Made a msgdb mechanism by elisp.
7553 3/26 IMAP and NNTP can be displayed in threads.
7554 4/13 Began to assemble thread display modules as elmo.
7555 5/01 Finished 0.1.0, initial version with many defects.
7556 6/12 I made a slip of the tongue and said I was writing elisp
7557 mailer supporting IMAP
7558 6/16 0.1.3 was announced at tm-ja, elisp ML.
7559 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7560 7/01 Support for mm-backend (0.3.0).
7561 8/25 multi folder added (0.5.0).
7562 8/28 filter folder added (0.5.1).
7563 9/10 You can open/close threads (0.6.0).
7564 9/11 fldmgr by Murata-san made editing folders easy.
7565 9/18 lha folders added by Okunishi-san (0.6.3).
7566 9/24 Display of branches of threads (0.6.5).
7567 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7568 10/28 Off-line operations (0.7.4).
7569 12/09 Becomes beta version.
7570 12/21 wl-expire by Murata-san.
7571 1999 2/03 auto-refile by Tsumura-san.
7572 4/28 wl-template by Murata-san.
7573 5/18 Released 1.0.0 stable.
7574 7/05 Scoring by Murata-san (2.1.0).
7575 9/26 New plugged system by Murata-san (2.2.2).
7576 12/20 Support Modified UTF7.
7577 2000 3/24 Released 1.1.0 stable.
7578 4/03 CVS development started.
7579 5/07 Thread restoration & Its speed up with Murata-san.
7580 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7581 7/11 killed message feature.
7582 7/18 Use UIDL in POP3.
7583 9/12 biff feature with Satata-san & Yamaoka-san.
7584 10/17 expire-hide by Okada-san.
7585 11/08 Released 2.4.0 stable.
7586 2001 7/04 Released 2.6.0 stable.
7587 8/21 wl-addrmgr by Kitamoto-san.
7588 12/27 Released 2.8.1 stable.
7591 See @file{ChangeLog} for details.
7595 According to a dictionary, Wanderlust has the meaning:
7599 n eager longing for or impulse towards travelling in distant lands
7600 [Ger, fr wandern to wander + lust desire, pleasure]
7604 but I had no profound intention. (if farfetched, IMAP @result{} you can
7605 read mail anywhere @result{} desire to wander ?)
7607 Elmo is the abbreviation of @samp{Elisp Library for Message
7608 Orchestration}. At first I meant the red puppet in the Sesame Street,
7609 but you may associate it with Wandering @result{} Drifting @result{}
7610 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7614 Each versions has code names (they are almost jokes).
7615 Currently they are picked up alphabetically from the top 40 hits of
7616 U.S. Billboard magazines in 1980s.
7618 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7621 @node Index, , Addition, Top
7625 * Concept Index:: Concept Index
7626 * Key Index:: Key Index
7627 * Variable Index:: Variable Index
7628 * Function Index:: Function Index
7631 @node Concept Index, Key Index, Index, Index
7632 @unnumberedsec Concept Index
7635 @node Key Index, Variable Index, Concept Index, Index
7636 @unnumberedsec Key Index
7639 @node Variable Index, Function Index, Key Index, Index
7640 @unnumberedsec Variable Index
7643 @node Function Index, , Variable Index, Index
7644 @unnumberedsec Function Index