1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
25 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
27 This edition is for Wanderlust version @value{VERSION}.
29 Permission is granted to make and distribute verbatim copies of this
30 manual provided the copyright notice and this permission notice are
31 preserved on all copies.
34 Permission is granted to process this file through TeX and print the
35 results, provided the printed document carries copying permission notice
36 identical to this one except for the removal of this paragraph (this
37 paragraph not being relevant to the printed manual).
40 Permission is granted to copy and distribute modified versions of this
41 manual under the conditions for verbatim copying, provided that the
42 entire resulting derived work is distributed under the terms of a
43 permission notice identical to this one.
45 Permission is granted to copy and distribute translations of this manual
46 into another language, under the above conditions for modified versions.
52 @title Wanderlust User's Manual
53 @subtitle Yet another message interface on Emacsen
54 @subtitle for Wanderlust version @value{VERSION}
55 @author Yuuichi Teranishi
56 @author Fujikazu Okunishi
57 @author Masahiro Murata
59 @author Kaoru Takahashi
61 @author Masayuki Osada
62 @author Katsumi Yamaoka
64 @author Yoichi Nakayama
67 @vskip 0pt plus 1filll
68 Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
69 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
70 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
71 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
73 This manual is for Wanderlust version @value{VERSION}.
75 Permission is granted to make and distribute verbatim copies of this
76 manual provided the copyright notice and this permission notice are
77 preserved on all copies.
79 Permission is granted to copy and distribute modified versions of this
80 manual under the conditions for verbatim copying, provided that the
81 entire resulting derived work is distributed under the terms of a
82 permission notice identical to this one.
84 Permission is granted to copy and distribute translations of this manual
85 into another language, under the above conditions for modified versions.
91 @node Top, Introduction, (dir), (dir)
92 @top Wanderlust User's Manual
107 This manual is for Wanderlust @value{VERSION}.
112 * Introduction:: Read this first
113 * Start Me Up:: Invoking Wanderlust
114 * Folders:: How to specify folders
115 * Folder:: Selecting and editing folders
116 * Summary:: Reading and refiling messages
117 * Message:: Saving and playing MIME multipart entities
118 * Draft:: Draft buffer, sending mail and news
119 * Disconnected Operations:: Off-Line management
120 * Expire and Archive:: Automatic expiration and archiving of messages
121 * Scoring:: Score of the messages
122 * Address Book:: Management of Address Book
123 * Customization:: Customizing Wanderlust
124 * Mailing List:: Wanderlust mailing list
125 * Addition:: Additional Information
130 @node Introduction, Start Me Up, Top, Top
131 @chapter Introduction of Wanderlust
134 Wanderlust is an mail/news management system on Emacsen.
135 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
137 The main features of Wanderlust:
140 @item Pure elisp implementation.
141 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
142 @item Unified access method to messages based on Mew-like Folder Specification.
143 @item Mew-like Key-bind and mark handling.
144 @item Manages unread messages.
145 @item Interactive thread display.
146 @item Folder Mode shows the list of subscribed folders.
147 @item Message Cache, Disconnected Operation (Read Only).
148 @item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
149 @item MIME compliant (by SEMI).
150 @item Transmission of news and mail are unified by Message transmitting draft.
151 @item Graphical list of folders (XEmacs and Emacs 21).
152 @item View a part of message without retrieving the whole message (IMAP4).
153 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
154 @item Virtual Folders.
155 @item Supports compressed folder using common archiving utilities.
156 @item Old articles in folders are automatically removed/archived (Expiration).
157 @item Automatic re-file.
158 @item Template function makes it convenient to send fixed form messages.
164 Wanderlust is supposed to run on following Emacsen:
167 @item Mule 2.3 based on Emacs 19.34
168 @item Emacs 20.2 or later
169 @item XEmacs 20.4 or later
170 @item Meadow 1.00 or later
171 @item NTEmacs 20.4 or later
175 IMAP4 connectivity with following imapd are confirmed to work with
179 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
180 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
181 @item Courier-IMAP 1.3.2 or later
182 @item AIR MAIL (AIRC imapd release 2.00)
184 @item Microsoft Exchange Server 5.5
185 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
188 LDAP connectivity with following LDAPd are confirmed to work with
192 @item OpenLDAP 2.0.6 or later
196 @node Start Me Up, Folders, Introduction, Top
197 @chapter Start up Wanderlust
200 The necessary procedure for starting Wanderlust is explained in steps
203 (Of course, you need a mail/news readable environment in advance)
206 * MIME Modules:: Installing the MIME modules
207 * Download:: Download and extract the packages
208 * Install:: Byte-compile and install
209 * Minimal Settings:: @file{.emacs} setup
210 * Folder Definition:: Folder definition
211 * Start Wanderlust:: Starting Wanderlust
215 @node MIME Modules, Download, Start Me Up, Start Me Up
216 @section Installing MIME modules
223 SEMI or tm must be installed to make Wanderlust work correctly.
225 SEMI does not run on Emacs 19.28 or earlier
226 @footnote{SEMI runs on Emacs 19.34. @*
227 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
228 so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
231 However, SEMI is recommended because of its wider functionality.
233 Refer to the documents of each package for detailed installation procedure.
235 SEMI and tm can be downloaded from these sites:
239 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
240 tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
244 You need packages named APEL and FLIM to use SEMI.
245 You can download APEL and FLIM from following URLs:
249 APEL: ftp://ftp.m17n.org/pub/mule/apel/
250 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
254 You have to install APEL, FLIM and SEMI in this order. Generally,
255 @samp{make install} will do the job. (In XEmacs 21, @samp{make
258 Recommended combination of APEL, FLIM and SEMI are following:
261 @item APEL 10.3, FLIM 1.14.2 and SEMI 1.14.3
264 You can also use many other FLIM/SEMI variants. Combination of the
265 latest versions should work. For example, the following combination are
269 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
270 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
273 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
277 @node Download, Install, MIME Modules, Start Me Up
278 @section Download and Extract the Package
281 You can download Wanderlust package from following sites:
285 ftp://ftp.gohome.org/wl/
288 Mirrored ftp/http sites:
292 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
293 http://www.jpl.org/elips/wl/
294 http://www.ring.gr.jp/archives/text/elisp/wl/
295 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
296 ftp://opaopa.org/pub/mirror/elisp/wl/
297 @c ftp://roguelife.org/pub/tsumura/wl/
301 Extract the obtained package to your working directory:
306 % tar zxvf wl-@var{version}.tar.gz
307 % cd wl-@var{version}
311 @subsection To use SSL (Secure Socket Layer)
316 SSL (Secure Socket Layer) can be used for
317 SMTP, IMAP, NNTP and POP connections in Wanderlust.
319 There are two ways to use SSL. One is to start SSL negotiation just
320 after the connection establishment (generic way). The other one is to
321 start SSL negotiation by invoking STARTTLS command in the each session.
323 To use the formal SSL (generic SSL), you must set @env{PATH} to the
324 directory that OpenSSL commands are installed.
326 To use the latter SSL(STARTTLS), you must install starttls package in
328 You can download starttls package from the following site.
331 ftp://opaopa.org/pub/elisp/
334 @node Install, Minimal Settings, Download, Start Me Up
335 @section Byte-compile and install
342 @subsection Installation
344 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
345 Set the Emacs's command name to @code{EMACS}.
346 Set package installation directory to @code{LISPDIR}.
347 Then, please execute following commands.
356 Destination directory is auto-probed if you leave @code{LISPDIR}
357 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
359 If you are using an Emacs variant which does not merge specified directory
360 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
361 then you will see the error message:
364 Cannot open load file: mime-setup
368 In this case, either add destination directories of custom, APEL, FLIM
369 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
370 @code{load-path} in @file{WL-CFG} in extracted directory.
372 If you want to use BBDB, then the necessary modules are byte-compiled
373 and installed when BBDB directory is added to @code{load-path}.
376 @subsection @file{WL-CFG}
378 Contents of the file @file{WL-CFG} is loaded under installation if a file
379 with that name exists in extracted directory. You can use @file{WL-CFG} to
380 configure @code{load-path} to extra packages such as SEMI if needed.
382 If you want to specify the install directory of Wanderlust related
383 files, then set following variables in @file{WL-CFG}
387 A directory to install WL modules.
388 This directory is relative directory from @code{LISPDIR}.
389 WL modules include @file{wl*.el}, @file{wl*.elc} files.
390 @c Modules under the directory @file{util/} are also installed if
391 @c it detected as necessary.
394 A directory to install ELMO modules.
395 This directory is relative directory from @code{LISPDIR}.
396 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
397 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
401 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
403 If you want to install ELMO related files under a sub-directory
404 such as "elmo" then add following to @file{WL-CFG}:
407 (setq ELMO_PREFIX "elmo")
410 @subsection Install as a XEmacs package
411 @cindex XEmacs package
412 @cindex XEmacs package install
413 @cindex Package, XEmacs
414 @cindex Package install, XEmacs
415 @c @cindex install-package
417 It is possible to install Wanderlust as one of packages of XEmacs (21.0
418 or later). Configuration for autoload and icon-path in local
419 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
422 Follow the next example to install Wanderlust as an XEmacs package.
428 % make install-package
432 package directory is auto-probed, if SEMI is installed.
433 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
435 @subsection Run in place
437 If wl and elmo directories are defined in @code{load-path}, then
438 byte-compilation and installation are not necessary to start Wanderlust.
439 For example, if package is extracted in @file{~/work}, Wanderlust can be
440 invoked with following setting in @file{~/.emacs}.
444 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
445 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
451 Manual is described in Info format. Please do following.
460 If you install Wanderlust as a XEmacs package, Info file is already
461 installed too, so there are no need of these commands.
463 Manual directory is automatically detected. Of course, it can be
464 configured by @code{INFODIR} in @file{Makefile}.
466 You can read manual at the following URL:
469 http://www.gohome.org/wl/doc/wl-euc_toc.html
472 @node Minimal Settings, Folder Definition, Install, Start Me Up
473 @section Set up .emacs
474 @cindex Minimal Settings
476 @cindex Configuration
480 The Wanderlust package contains two module groups.
483 @item ELMO (elmo-*.el)
484 These modules show everything as folders. This is the back-end for WL.
486 These modules controls the behavior of main body of Wanderlust.
487 They are also the front-end for ELMO.
490 You can customize the behavior of Wanderlust by changing the value
491 of environmental variables which begins with @code{elmo-} and @code{wl-}.
493 The minimal requirement for settings is as the following.
497 ;; @r{The setting to use SEMI}
500 ;; @r{autoload configuration}
501 ;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
502 (autoload 'wl "wl" "Wanderlust" t)
503 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
505 ;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
506 ;; @r{Default: @code{nil}.}
507 ;; @r{(This is not required if Wanderlust is installed as XEmacs package)}
508 (setq wl-icon-dir "~/work/wl/etc")
510 ;; @r{SMTP server for mail posting. Default: @code{nil}}
511 (setq wl-smtp-posting-server "your.smtp.example.com")
512 ;; @r{NNTP server for news posting. Default: @code{nil}}
513 (setq wl-nntp-posting-server "your.nntp.example.com")
517 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
518 file exists). So it is convenient to gather Wanderlust specific settings
519 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
520 because you can't write them in @file{.emacs}
521 (if you write it to @file{.emacs}, you'll get an error).
524 All above described settings except (load "mime-setup") and autoload
525 configuration can be written in
528 @subsection @code{mail-user-agent}
529 @cindex Default Mailer
530 @cindex Mailer, Default
531 @vindex mail-user-agent
534 If you write following setting in you @file{.emacs}, you can
535 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
536 This means it enables you to run Wanderlust as a default mail composer
539 It is effective only when your Emacs can define @code{mail-user-agent}.
540 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
544 (autoload 'wl-user-agent-compose "wl-draft" nil t)
545 (if (boundp 'mail-user-agent)
546 (setq mail-user-agent 'wl-user-agent))
547 (if (fboundp 'define-mail-user-agent)
548 (define-mail-user-agent
550 'wl-user-agent-compose
559 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
560 @section Folder Definition
561 @cindex Folder Definition
564 You can skip this section because it is possible to add/edit the
565 subscribe folders from the buffer for list of folders.
566 @xref{Folder Manager}.
568 Define the folders you want to subscribe in file @file{~/.folders}. The
569 contents written in @file{~/.folders} become the folders which you
570 subscribe to as it is.
572 Format for @file{~/.folders} is very simple. Here is an example:
577 # @r{Lines begin with @samp{#} are comment.}
578 # @r{Empty lines are ignored}
580 # @var{folder name} "@var{folder nickname}"
581 # @r{(nicknames are not necessary)}
586 %#mh/Backup@@my.imap.example.com "Sent"
589 %#mh/spool/wl "Wanderlust ML"
590 %#mh/spool/elips "ELIPS ML"
591 %#mh/spool/apel-ja "APEL Japanese ML"
592 %#mh/spool/xemacs-beta "XEmacs beta"
593 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
594 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
597 # @r{If folder name ends with @samp{/}, that means an `access group',}
598 # @r{all subfolders automatically included in one folder group.}
600 %#mh/expire@@localhost /
601 # @r{All MH folders are included in one folder group.}
606 Each line contains one folder you want to read. The definition of
607 folders will be explained in detail in the next section.
609 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
610 become one folder group. One folder group is treated as a directory
611 which can be opened and closed in folder mode. It is convenient for
612 collecting some folders and putting them in order.
614 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
615 line and you have to write it that way (It is because the parser sucks).
617 There are two types of groups. One is like @samp{Emacsen} from above
618 example which the user chooses his favorite folders as a group.
620 The other one is @dfn{access group} like @samp{+ /} from above example.
621 It makes all the sub-folders in a folder to a group. (It differs from
622 the type of the folder. For example, @samp{+} followed by @samp{/}
623 makes entire MH sub-directories to one group)
625 This behavior is better understood if you try it and confirmed the
626 function first. You can write and try a small folder definition, so you
627 will know the idea of the folder function before writing the real one.
629 @node Start Wanderlust, , Folder Definition, Start Me Up
630 @section Start Wanderlust
631 @cindex Start Wanderlust
633 If installation and configuration worked well, you can invoke Wanderlust by
634 typing following command in Emacs.
641 After initialization, Folder Mode which shows the list of folders will appear.
642 That means the folders you defined in the @file{~/.folders} are listed
643 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
644 can skip folder checking.
647 @node Folders, Folder, Start Me Up, Top
648 @chapter Wanderlust's folders
651 This chapter describes the folder types which Wanderlust is able to handle.
653 Wanderlust uses ELMO as it's interface, so every folder types supported
654 by ELMO is usable in Wanderlust.
656 As of version @value{VERSION}, 11 types of folders are predefined. These are
657 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
658 Pipe and Internal folder types.
661 * IMAP Folder:: @samp{%} -- IMAP folder
662 * NNTP Folder:: @samp{-} -- NNTP folder
663 * MH Folder:: @samp{+} -- MH folder
664 * Maildir Folder:: @samp{.} -- Maildir folder
665 * News Spool Folder:: @samp{=} -- News spool folder
666 * Archive Folder:: @samp{$} -- Archive folder
667 * POP Folder:: @samp{&} -- POP folder
668 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
669 * Namazu Folder:: @samp{[} -- Namazu Folder
670 * Multi Folder:: @samp{*} -- Multi folder
671 * Filter Folder:: @samp{/} -- Filter folder
672 * Pipe Folder:: @samp{|} -- Pipe folder
673 * Internal Folder:: @samp{'} -- Internal folder
677 @node IMAP Folder, NNTP Folder, Folders, Folders
685 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
691 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
695 You can specify @code{login} (encoded password transmission),
696 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
697 authentication) or @code{clear} (or @code{nil}, plain password
698 transmission) as @var{authenticate-type}.
703 @var{username} -> The value of @code{elmo-imap4-default-user}.
704 Initial setting is @env{USER} environment variable or
705 @env{LOGNAME} environment variable or return value of
706 @code{(user-login-name)}.
707 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
708 Initial setting is "auth".
709 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
710 Initial setting is "localhost".
711 @var{port} -> The value of @code{elmo-imap4-default-port}.
712 Initial setting is 143.
715 You can omit the @var{hostname} from folder names if you set
716 @code{elmo-imap4-default-server} as your main IMAP server.
717 For example, you can specify a folder as @samp{foo%imap@@gateway} even
718 if you have to go through a firewall.
722 ;; @r{Example: imap4.exaple.org as main IMAP server}
723 (setq elmo-imap4-default-server "imap4.example.org")
727 SSL (Secure Socket Layer) connection will be used if a folder name ends
728 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
729 is @code{ssl}, SSL will be the default connection. If a folder name
730 ends with @samp{!!}, STARTTLS connection will be established. If the
731 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
732 STARTTLS will be the default connection.
736 ;; @r{Example: Use SSL connection}
737 (setq elmo-imap4-default-stream-type 'ssl)
741 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
742 authentication method, the password is sent in encoded form. But, if
743 your server is unable to receive an encoded password, authentication
744 will fall back to @code{clear} (that is, sending password in raw format)
745 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
746 authentication will fall back to @code{clear} without confirmation
747 (default value is @code{nil}).
751 ;; @r{Example: password in raw format}
752 (setq elmo-imap4-default-authenticate-type 'clear)
760 %inbox -> IMAP mailbox "inbox"
761 %#mh/inbox -> IMAP mailbox "#mh/inbox"
763 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
764 %inbox:hoge/clear@@server1
765 -> server1's IMAP mailbox "inbox"
766 of user "hoge", with plain password authentication
771 @subsection International mailbox names (Modified UTF7)
772 @cindex Modified UTF7
779 You can use international mailbox names in @var{mailbox} part, if you
780 are using Emacs which can treat unicode and
781 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
782 value is @code{nil}).
784 Currently, following Emacsen can treat unicode.
787 @item Emacs 20.3 or later + Mule-UCS
789 If you installed Mule-UCS package, Emacs can treat unicode.
790 You can obtain Mule-UCS package from following URL.
793 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
796 @item XEmacs 21.2.13 or later + ucs-conv package
798 By default, XEmacs 21 cannot treat unicodes, but if you installed
799 ucs-conv package, it can.
800 You can obtain ucs-conv package from following anonymous CVS.
804 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
805 Password: @var{NULL} (Just enter return key)
806 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
810 You also need utf7 conversion programs, @command{u7tou8} and
811 @command{u8tou7} to use international mailbox name in the current
812 XEmacs. These programs are included in the UTF7 package which can be
813 obtained from following URL.
816 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
821 @node NNTP Folder, MH Folder, IMAP Folder, Folders
832 A folder to access USENET news via NNTP protocol (RFC 977).
833 One newsgroup is treated as a folder.
839 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
845 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
846 Initial setting is @samp{localhost}.
847 @var{username} -> The value of @code{elmo-nntp-default-user}.
848 Initial setting is @code{nil}.
849 @var{port} -> The value of @code{elmo-nntp-default-port}.
850 Initial setting is 119.
853 AUTHINFO is used as authentication method if the @var{username} is
854 non-nil. SSL will be default method if
855 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
856 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
857 STARTTLS connection will be established. if the value of
858 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
859 be the default connection.
865 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
866 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
871 @node MH Folder, Maildir Folder, NNTP Folder, Folders
878 A folder to access MH format mail (1 file is 1 mail).
883 @samp{+} @var{directory-name}
886 Normally, @var{directory-name} is an relative path to the variable
887 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
888 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
889 (this is also true for drive-letters).
891 Message number is used for the name of the message file.
897 +inbox -> @file{~/Mail/inbox}
898 +from/teranisi -> @file{~/Mail/from/teranisi}
899 +~/test -> @file{~/test}
904 @node Maildir Folder, News Spool Folder, MH Folder, Folders
905 @section Maildir Folder
907 @cindex Maildir Folder
911 A folder to access Maildir format (1 file is 1 mail).
916 @samp{.} [@var{directory-name}]
919 Normally, @var{directory-name} is a relative path to the variable
920 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
921 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
922 (this is also true for drive-letters).
924 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
925 Messages are contained in the @file{cur} directory. All message files
926 in the @file{new} directory are moved to @file{cur} directory when you
927 access the folder. All message files contained in the @file{tmp}
928 directory and not accessed for 36 hours are deleted.
930 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
936 . -> @file{~/Maildir}
937 .inbox -> @file{~/Maildir/inbox}
938 .from/teranisi -> @file{~/Maildir/from/teranisi}
939 .~/test -> @file{~/test}
944 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
945 @section News Spool Folder
947 @cindex News spool Folder
950 This folder handles locally saved news articles which are proposed by
951 Mew/IM. You can also read articles directly from a spool-file which is
952 retrieved by an utility like @command{gnspool}.
957 @samp{=} @var{directory-name}
960 @var{directory-name} is a sub-directory to the directory defined by
961 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
962 You can use @samp{.} as directory delimiter as well as @samp{/}.
968 =fj/os/os2 -> @file{~/News/fj/os/os2}
969 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
974 @node Archive Folder, POP Folder, News Spool Folder, Folders
975 @section Archive Folder
977 @cindex Archive Folder
980 This method can handle archive files, which are compressed by utilities
981 such as Info-ZIP or LHA, as one folder.
987 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
991 @var{path-name} is the relative path from
992 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
993 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
994 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
995 also permitted under the environment of ange-ftp, efs.
997 The actual file name of the archive folder is
998 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
999 under the @var{path-name}. If a file named @var{path-name} exists, it is
1000 treated as folder. The suffix is automatically decided for
1001 @var{archiver-type}.
1003 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1004 (Initial setting is @code{zip}) is referred.
1006 @var{prefix} specifies the internal directory structure of the archive.
1007 For example, if the ML server is fml, @file{msend.tar.gz} has a
1008 structure like @file{spool/1}, so you have to specify @samp{spool} as
1015 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1016 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1017 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1018 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1023 * Archiver:: Supported Archivers
1024 * Archive Tips:: TIPS
1025 * Archive Vars:: Customization
1029 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1030 @subsection Supported Archives
1040 By default, following archives are supported.
1044 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1045 GNU TAR('tgz, 'tar) ;; read-only
1049 If your archiver can include multiple files in one archive, you have a
1050 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1051 of the candidate. TAR is supported read-only because it cannot delete
1052 file in the archive (@code{mv})).
1054 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1055 archiver of Wanderlust because they cannot include multiple
1056 files. Archivers that cannot extract files to standard output are also
1059 @subsection OS specific information about archiver.
1061 Behaviors of the following archivers are confirmed by further experiences.
1062 (@samp{*} mark means recommended archiver).
1065 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1066 LHA OS/2 version Rel.2.06b Feb 18, 1998
1067 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1068 *Zip 2.2 (November 3rd 1997).
1069 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1070 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1071 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1073 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1074 LHa for UNIX V 1.14c
1075 UnZip 5.32 of 3 November 1997
1076 Zip 2.2 (November 3rd 1997)
1077 GNU tar 1.12 (1.11.x is no good)
1078 gzip 1.2.4 (18 Aug 93)
1080 [Win32] Win.98/Meadow
1084 GNU tar 1.11.8 + 1.5(WIN32)
1091 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1092 Hiramatsu version of LHA is only supported.
1093 In Win32, LHa32 is only supported (DOS version is no good).
1095 * Caution about GNU tar
1097 You have to take care about GNU tar's version because many version has
1098 problem on deleting file from archive.
1100 Please test @option{--delete} @option{-f} options work. Otherwise, your
1101 archive will be destroyed. No problem is reported on above versions of
1105 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1107 @cindex Archive Tips
1109 For comfortable migration, usage of @code{wl-summary-archive}
1110 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1111 archive folders created by expiration, you must set non-nil value to
1112 @code{elmo-archive-treat-file}.
1114 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1115 in processing speed. For comfortable use, Emacs20 is recommended.
1116 (If re-search's performance is the problem, 19.3x or later may be okay.)
1118 If many files are included in one archive,
1119 it takes long time to access the archive folder because
1120 archiver starting overhead is increased (especially LHA).
1121 150-200 messages in one archive is recommended.
1123 Of course, following is possible @t{:-)}
1124 (meanings of these variables are described later.)
1128 (setq wl-fcc "$backup")
1129 (setq wl-trash-folder "$trash;lha")
1133 @node Archive Vars, , Archive Tips, Archive Folder
1134 @subsection Variables About Archive Folder
1135 @cindex Archive variables
1138 @item elmo-archive-default-type
1139 @vindex elmo-archive-default-type
1140 The initial setting is @code{zip}.
1141 Set archiver type by symbol.
1143 @item elmo-archive-@var{type}-method-alist
1144 @vindex elmo-archive-TYPE-method-alist
1145 Define archiver @var{type}'s methods.
1146 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1147 Each element of the alist is following.
1151 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1152 (@var{action} . @var{function}) ;; function
1156 Currently available actions are following.
1160 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1161 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1168 actions enclosed with braces are optional (They are used for better
1171 @item elmo-archive-suffix-alist
1172 @vindex elmo-archive-suffix-alist
1173 An alist of archiver-type (symbol) and suffix.
1175 @item elmo-archive-file-regexp-alist
1176 @vindex elmo-archive-file-regexp-alist
1177 An alist of a regexp to get file number from list output of archiver
1178 and archiver-type (symbol).
1180 @item elmo-archive-method-list
1181 @vindex elmo-archive-method-list
1182 A list of elmo-archive-@var{type}-method-alist
1183 (@var{type} is a symbol of archiver-type).
1185 @item elmo-archive-lha-dos-compatible
1186 @vindex elmo-archive-lha-dos-compatible
1187 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1188 DOS (Mr. Yoshizaki original) compatible.
1190 @item elmo-archive-cmdstr-max-length
1191 @vindex elmo-archive-cmdstr-max-length
1192 The initial setting is 8000.
1194 Max length of command line argument for external archiver program.
1195 Emacs does not have a limit of command line byte length, but some OS
1196 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1197 this limit because it calls external archiver program directly (not
1198 called via shell). For example, you cannot delete messages if archiver
1199 program must receive larger bytes of arguments to delete. OS/2 have a
1200 command line argument limit of 8190 bytes, so we defined default as 8000
1203 However, you don't have an influence of command line argument limit
1204 if the archiver has `actions' to receive target file information from
1205 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1209 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1217 A folder to access e-mails via POP3 protocol (RFC 1939).
1223 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1228 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1229 as @var{authenticate-type}.
1233 @var{username} -> The value of @code{elmo-pop3-default-user}.
1234 Initial setting is @env{USER} environment variable or
1235 @env{LOGNAME} environment variable or return value of
1236 @code{(user-login-name)}.
1237 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1238 Initial setting is @samp{user}.
1239 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1240 Initial setting is @samp{localhost}.
1241 @var{port} -> The value of @code{elmo-pop3-default-port}.
1242 Initial setting is 110.
1249 &hoge@@localhost -> access localhost as user @samp{hoge}.
1250 &hoge@@popserver:109 -> access the server "popserver" on port 109
1251 as user @samp{hoge}.
1255 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1256 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1257 @file{utils/sasl/lisp/} or Emacs/W3 package
1258 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1261 If the last character of the folder name is @samp{!}, Wanderlust
1262 connects to the POP server via SSL (Secure Socket Layer). If you set
1263 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1264 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1265 with @samp{!!}, STARTTLS connection will be established. if the value
1266 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1270 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1271 @section Shimbun Folder
1273 @cindex Shimbun Folder
1274 @cindex Folder, Shimbun
1279 A folder for watching "shimbun" (means "newspaper" in Japanese),
1280 news site and mailing list archives on WWW by using emacs-w3m
1281 (@uref{http://emacs-w3m.namazu.org/}).
1283 You should possess w3m and emacs-w3m to use this.
1289 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1293 Admissible values of @var{module-name} and @var{folder-name} are
1294 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1300 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1301 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1306 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1307 @section Namazu Folder
1309 @cindex Namazu Folder
1310 @cindex Folder, Namazu
1311 @cindex Folder, Text Search
1314 A folder to access messages found in namazu-index with some condition.
1315 It uses namazu (@uref{http://www.namazu.org/}) for search.
1321 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1326 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1327 @section Multi Folder
1329 @cindex Multi Folder
1330 @cindex Folder, Multiple
1331 @cindex Folder, Marge
1333 A folder to access virtual folder which collects messages from
1340 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1344 After @samp{*} character, specify multiple folders you want to collect
1345 separated by @samp{,} like
1346 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1352 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1353 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1354 treated as one folder.
1356 *+inbox,-fj.rec.tv,%inbox
1357 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1362 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1363 @section Filter Folder
1365 @cindex Filter Folder
1366 @cindex Folder, Filtering
1367 @cindex Folder, Virtual
1368 @cindex Folder, Conditional
1370 A folder to access virtual folder which collects all messages that
1371 satisfy a condition.
1376 @samp{/} @var{condition} @samp{/} @var{target-folder}
1379 In the @var{condition} part, you can specify following.
1383 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1385 first: @var{number} messages are picked from top of folder.
1386 last: @var{number} messages are picked from bottom of folder.
1392 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1393 /first:20/%inbox -> First 20 messages from %inbox are picked.
1398 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1400 since: only messages arrived since @var{date} are picked.
1401 before: only messages arrived before @var{date} are picked.
1403 You can specify following as @var{date}.
1407 yesterday -> a day before today.
1408 lastweek -> same day of last week.
1409 lastmonth -> same day of last month.
1410 lastyear -> same day of last year.
1411 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1412 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1420 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1422 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1428 Field filter: @samp{@var{field}:@var{value}}
1430 All messages that have @var{field} and its value is @var{value} are picked.
1431 @var{field} and @var{value} are case insensitive.
1437 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1438 and its value includes "teranisi" string are picked.
1439 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1447 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1448 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1450 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1451 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1457 /from:teranisi&!to:teranisi/+inbox
1458 -> In +inbox, messages are picked if the message's
1459 From: field includes "teranisi" and
1460 To: field doesn't include "teranisi".
1462 /tocc:"Yuuichi Teranishi"/+inbox
1463 -> In +inbox, messages are picked if the
1464 message's To: field or Cc: field includes
1465 "Yuuichi Teranishi".
1467 /(from:yt|from:teranisi)&subject:report/+inbox
1468 -> In +inbox, messages are picked if the message's
1469 From: field includes "yt" or "teranisi", and
1470 Subject includes "report".
1476 Tip for string description:
1478 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1479 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1480 should be escaped with @samp{\} in it). You can enclose the string with
1481 @samp{"} even it does not contain these characters.
1487 *%inbox,/from:teranisi/%inbox@@server
1488 -> Messages in %inbox or
1489 message is in the %inbox@@server folder and it's From field
1490 includes "teranisi" are collected.
1492 /last:100//to:teranisi/*+inbox,%inbox
1493 -> Latest 100 messages which is in the +inbox or %inbox folder
1494 and To: field matches "teranisi".
1496 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1497 -> Pick messages which have From: field and it includes "hogehoge"
1498 from latest 20 messages in the %#mh/inbox@@localhost
1499 and To: or Cc: field includes "teranisi".
1502 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1503 @section Pipe Folder
1507 @cindex Download Message
1508 @cindex Incorporate Message
1510 In the pipe folder, messages are automatically transferred from the source
1511 folder to destination folder.
1516 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1519 When you access the pipe folder, messages are automatically transferred
1520 from @var{source-folder} to @var{destination-folder}.
1521 It is convenient if you want to download messages to local disk via POP.
1522 For example, if you specify following
1525 |&username@@popserver|+inbox
1529 and access it, messages are downloaded automatically from
1530 @samp{&username@@popserver} to @samp{+inbox}.
1536 %inbox|%myinbox -> Download %inbox to %myinbox.
1537 *&user@@popserver1,&user@@popserver2|+inbox
1538 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1542 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1544 @node Internal Folder, , Pipe Folder, Folders
1545 @section Internal folder
1547 @cindex Internal Folder
1548 @cindex Folder, @samp{$} mark
1550 @c @cindex Folder, Null
1552 A folder to access internal messages of Wanderlust.
1564 A folder named @samp{'mark} is a special virtual folder which collects
1565 messages which have important mark @samp{$}.
1567 You can review important messages at once after you put important marks
1568 on the messages in the different folders.
1570 In this folder, if you delete message, important mark @samp{$} put on
1571 the message is removed. If you append messages to this folder, the
1572 message will have @samp{$} mark.
1574 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1575 folder. If you want IMAP folder's message remove from @samp{'mark}
1576 folder, remove important mark at IMAP Folder.)
1578 You can access cached messages fetched via network by accessing
1579 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1580 the name of the subdirectories of the cache directory
1581 (@file{~/.elmo/cache}).
1584 @node Folder, Summary, Folders, Top
1585 @chapter Folder mode
1588 After you start Wanderlust, folder mode is appeared firstly.
1589 It contains folder list you subscribed.
1590 You can select and edit folders in this mode.
1593 * Selecting Folder:: Select folder you want to read
1594 * Folder Manager:: Editing folders
1598 @node Selecting Folder, Folder Manager, Folder, Folder
1599 @section Selecting Folder
1600 @cindex Selecting Folder
1602 @subsection Usage (TIPS)
1604 @subsubsection Check new, unread number
1606 Folder mode looks like this.
1607 (In XEmacs, it looks much nicer @t{;-)})
1611 [-]Desktop:14186/35580/67263
1616 [-]Emacsen:0/34/4837
1617 Wanderlust ML:0/0/558
1620 XEmacs Beta:0/29/255
1631 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1635 @kbd{s} key on the folder line updates these numbers.
1636 It changes its color if it has many new messages.
1638 The whole folder mode is a folder group named @samp{Desktop}.
1639 Folder group open/close by return key.
1640 A operation to a folder group is treated as operations on the
1642 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1643 six children folders update its unread number status.
1645 @subsubsection Select Folder
1647 To enter summary mode of the folder, type return (or space) key on
1649 If the variable @code{wl-stay-folder-window} has non-nil value,
1650 summary window appears on the right of the folder mode window.
1652 @subsection Key bindings
1654 Folder mode's key binding (related to selecting folders) is following.
1659 @kindex @key{SPC} (Folder)
1660 @kindex @key{RET} (Folder)
1661 @findex wl-folder-jump-to-current-entity
1662 Enter to the summary mode of the folder at the current cursor point.
1663 If the cursor is on the top of folder group line,
1664 the folder group is opened or closed.
1665 When the cursor is on the access group and this command is called
1666 with prefix argument, folder children list is updated to the newest one.
1667 (Children list is updated recursively if the access folder has hierarchical
1669 (@code{wl-folder-jump-to-current-entity})
1672 @kindex M-@key{RET} (Folder)
1673 @findex wl-folder-update-recursive-current-entity
1674 Folder children list of the access group at the current cursor point
1675 is updated to the newest one.
1676 (Children list is updated recursively if the access folder has hierarchical
1678 (@code{wl-folder-update-recursive-current-entity})
1683 Create a new draft message.
1688 @findex wl-folder-write-current-folder
1689 If the current cursor point is on the NNTP folder, create a new draft
1690 message which already has @samp{Newsgroups:} field. If the current
1691 cursor point is on the folder for mailing list (refile destination),
1692 create a new draft message which already has @samp{To:} field with
1693 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1695 (@code{wl-folder-write-current-folder})
1698 @kindex C-c C-o (Folder)
1699 @findex wl-jump-to-draft-buffer
1700 Move to the draft buffer if available. If multiple draft buffer exists,
1701 moved to one after another. If prefix argument is specified, load draft
1702 folder's message to the draft buffer and jump to it.
1703 (@code{wl-jump-to-draft-buffer})
1707 @findex wl-folder-check-current-entity
1708 Update new and unread number information of the folder at the current
1710 (@code{wl-folder-check-current-entity})
1714 @findex wl-folder-sync-current-entity
1715 Update summary information of the folder at the current cursor point.
1716 (@code{wl-folder-sync-current-entity})
1719 @kindex r s (Folder)
1720 @findex wl-folder-check-region
1721 Update new and unread number information of the folders in the currently
1723 (@code{wl-folder-check-region})
1726 @kindex r S (Folder)
1727 @findex wl-folder-sync-region
1728 Update summary information of the folders in the currently selected region.
1729 (@code{wl-folder-sync-region})
1733 @findex wl-status-update
1734 Sync up address book status with @file{~/.addresses}'s content.
1735 (@code{wl-status-update})
1739 @findex wl-folder-prev-unread
1740 Jump cursor to the folder which have unread messages on the upward from
1741 current cursor point.
1742 (@code{wl-folder-prev-unread})
1746 Jump cursor to the folder which have unread messages on the downward
1747 from current cursor point.
1748 (@code{wl-folder-next-unread})
1752 Move cursor to the folder on the previous line.
1753 (@code{wl-folder-prev-entity})
1757 Move cursor to the folder on the next line.
1758 (@code{wl-folder-next-entity})
1762 Jump to the folder specified by the user input.
1763 (@code{wl-folder-jump-folder})
1767 @findex wl-folder-prefetch-current-entity
1768 Prefetch new messages of the folder at the current cursor point by
1769 @code{wl-summary-incorporate}.
1770 If the cursor is on the folder group, it is executed recursively.
1771 (@code{wl-folder-prefetch-current-entity})
1775 @findex wl-folder-mark-as-read-all-current-entity
1776 Mark all unread messages of the folder at the current cursor point as read.
1777 If the cursor is on the folder group, it is executed recursively.
1778 (@code{wl-folder-mark-as-read-all-current-entity})
1782 @findex wl-folder-goto-first-unread-folder
1783 Enter summary mode of the first unread folder.
1784 (@code{wl-folder-goto-first-unread-folder})
1788 @findex wl-folder-empty-trash
1790 (@code{wl-folder-empty-trash})
1794 @findex wl-folder-open-all-unread-folder
1795 All unread folder is opened.
1796 (@code{wl-folder-open-all-unread-folder})
1800 @findex wl-folder-open-close
1801 Folder group is opened/closed.
1802 (@code{wl-thread-open-close})
1806 All folder group is opened.
1807 (@code{wl-folder-open-all})
1811 All folder group is closed.
1812 (@code{wl-folder-close-all})
1822 (@code{wl-folder-suspend})
1825 @kindex M-s (Folder)
1826 Save current folder status.
1830 @kindex M-t (Folder)
1831 Toggle Wanderlust's offline/online status.
1832 (@code{wl-toggle-plugged})
1835 @kindex C-t (Folder)
1836 Start Wanderlust's plug-status manager.
1837 (@code{wl-plugged-change})
1840 @subsection Customize variables
1843 @item wl-folders-file
1844 @vindex wl-folders-file
1845 The initial setting is @file{~/.folders}.
1846 Subscribed folders are described (saved) in this file.
1848 @item wl-folder-info-save
1849 @vindex wl-folder-info-save
1850 The initial setting is @code{t}. If non-nil, unread information is
1851 saved and used in the next Wanderlust session.
1853 @item wl-stay-folder-window
1854 @vindex wl-stay-folder-window
1855 The initial setting is @code{nil}.
1856 If non-nil, summary window is appeared on the right side of the folder buffer.
1858 @item wl-folder-window-width
1859 @vindex wl-folder-window-width
1860 The initial setting is 20.
1861 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
1863 @item wl-folder-many-unsync-threshold
1864 @vindex wl-folder-many-unsync-threshold
1865 The initial setting is 70.
1866 If the number of unread messages is more than this value,
1867 folder color is changed.
1869 @item wl-highlight-folder-by-numbers
1870 @vindex wl-highlight-folder-by-numbers
1871 This option controls how to highlight each line in the folder buffer.
1872 The default value is @code{t}, highlighting with various colors based on
1873 the message numbers. If it is @code{nil}, highlighting with various
1874 colors based on the folder status. In addition, if it is a number
1875 (e.g. 1), highlighting will be done based on both the message numbers
1876 and the folder status.
1878 @item wl-folder-desktop-name
1879 @vindex wl-folder-desktop-name
1880 The initial setting is @samp{Desktop}.
1881 The name of top folder group.
1883 @item wl-folder-petname-alist
1884 @vindex wl-folder-petname-alist
1885 The initial setting is @code{nil}.
1886 An alist of folder's realname and its nickname.
1888 @item wl-folder-access-subscribe-alist
1889 @vindex wl-folder-access-subscribe-alist
1890 The initial setting is @code{nil}.
1892 Control automatic subscribing and unsubscribing of the children list
1898 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
1902 If @var{subscribe-flag} is non-nil, folders which have name matched to
1903 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
1904 already unsubscribed folder is not displayed even when the
1905 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
1912 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
1913 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
1914 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
1915 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
1919 @item wl-folder-hierarchy-access-folders
1920 @vindex wl-folder-hierarchy-access-folders
1921 The initial setting is the list shown below:
1930 A list of access groups which creates children folder list hierarchically.
1932 For example, if you specify
1933 @code{wl-folder-hierarchy-access-folders} like following,
1937 (setq wl-folder-hierarchy-access-folders
1938 '("-" "-alt" "-japan" "-comp" "-comp.unix"))
1943 such access group hierarchy is obtained.
1949 -fj.comp.announce:0/0/2
1950 -fj.comp.dev.cdrom:0/0/0
1952 [+]-japan:238/238/1688
1955 -comp.unix.admin:0/0/0
1956 -comp.unix.dos-under-unix:0/0/0
1957 -comp.unix.programmer:0/0/0
1958 [-]-comp.unix.bsd:0/0/23
1959 -comp.unix.bsd.freebsd.announce:0/0/0
1964 If you opened @samp{-} in this example, only the direct children is created
1965 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
1966 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
1967 is not created until the children access group is opened.
1971 @node Folder Manager, , Selecting Folder, Folder
1972 @section Editing Folders
1973 @cindex Folder Manager
1974 @cindex Folder, Edit
1975 @cindex Folder, Subscribe
1976 @cindex Folder, Unsubscribe
1978 As described before, subscribed folder list is saved in @file{~/.folders} file.
1979 But you don't have to edit @file{~/.folders} directly.
1980 You can append, delete, edit folders from folder mode.
1982 @subsection Usage (Tips)
1984 @subsubsection Append Folder
1986 @kbd{m a} appends new folder to the folder mode.
1987 @kbd{m g} appends new folder group.
1988 To append new folder to this group, firstly open it,
1989 then execute append command in the next line.
1991 @subsubsection Edit Folder
1993 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
1994 Thus, you can change folder position as if you were editing a normal file.
1996 @subsubsection Create Multi Folder.
2000 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2002 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2004 Type @kbd{m m}, then you can create multi folder.
2007 @subsubsection Delete Nickname, Filter
2009 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2010 minibuffer while appending.
2012 @subsubsection Append Folder to Empty Group
2014 To append new folder to the empty folder group
2015 (after you create folder group by typing @kbd{m g}),
2016 firstly open it, then execute append command in the next line.
2017 If it is closed, folder is appended on the same level with
2018 the above folder group. It is difficult to explain by words so try it.
2019 In other words, appended position depends on the
2020 above folder group's open/close status.
2022 @subsubsection Charset of the Folders File.
2024 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2026 @subsubsection Create Filter
2028 @kbd{m f} adds filter to the folder at the current cursor point. To
2029 create new filter folder and leave the current folder unchanged, copy it
2030 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2031 filter can be specified while appending filter. If you put
2032 ``''(@var{NULL}), filter is deleted.
2034 @subsubsection Sort Folders
2036 Sorting of the folders is executed by the function specified by
2037 @code{wl-fldmgr-sort-function}.
2038 The initial setting is @code{wl-fldmgr-sort-standard},
2039 which sorts alphabetically.
2040 Sorting affects only on the current folder group. It does not
2041 affect on the child groups.
2043 @subsubsection Hiding Folders in the Access Group
2045 Usually, access group displays all children folders, but you can set
2046 some folders hidden. Following operations are only available on access
2049 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2050 (subscribe/unsubscribe) of the folder at current cursor point. Against
2051 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2054 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2055 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2056 argument and if the argument has positive number, the unsubscribe it.
2057 If the prefix argument has negative value, folder becomes visible and if
2058 zero, folder visibility is toggled.
2060 The other commands, @code{wl-fldmgr-subscribe} and
2061 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2064 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2065 executed in the access group, they have a same effect with
2066 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2067 The difference is that cut commands deletes folders from the current
2070 @subsubsection Operations in the Access Group
2072 You can insert and delete folders in the access group like usual folder
2073 group. But insert and delete commands can be only available for the
2074 children folders of the access group and they only sets the subscribe
2075 status. In other words, insertion of the folder means subscribing,
2076 deletion means unsubscribing.
2077 @footnote{In the current implementation,
2078 it is faster to delete region than to unsubscribe region.}
2080 To update the access group when children folders are inserted or deleted
2081 by other way (other than Wanderlust),
2082 open the access group by typing @kbd{C-u @key{RET}}.
2083 @xref{Selecting Folder}.
2085 The order of children folders of access group is saved after
2086 insertion/deletion/sorting.
2087 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2088 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2089 newly created folders are inserted on the top of the access group.
2091 @subsection Key bindings
2092 @cindex Keybind, Folder Mode
2093 @cindex Keybind, Folder Buffer
2095 Key bindings on the folder mode related to folder editing are shown below.
2096 All bindings starts with @kbd{m}, and primary commands are binded to
2097 one stroke key binding.
2101 @kindex m a (Folder)
2102 @findex wl-fldmgr-add
2104 (@code{wl-fldmgr-add})
2109 @kindex m g (Folder)
2110 @findex wl-fldmgr-make-group
2111 Create a folder group.
2112 (@code{wl-fldmgr-make-group})
2115 @kindex m A (Folder)
2116 @findex wl-fldmgr-make-access-group
2117 Create an access group.
2118 (@code{wl-fldmgr-make-access-group})
2121 @kindex m d (Folder)
2122 @findex wl-fldmgr-delete
2123 Delete folder itself and msgdb.
2124 If the folder itself cannot be deleted like NNTP folder,
2125 only msgdb is deleted.
2126 (@code{wl-fldmgr-delete})
2131 @kindex m R (Folder)
2132 @findex wl-fldmgr-rename
2133 Change the name of folder or folder group.
2134 msgdb's path is also changed.
2135 (@code{wl-fldmgr-rename})
2141 @findex wl-fldmgr-make-multi
2142 Create a multi folders in the cutlist (cut, copied folders).
2143 (@code{wl-fldmgr-make-multi})
2148 @kindex m f (Folder)
2149 @findex wl-fldmgr-make-filter
2150 Create a filter folder. (Put a filter on the folder).
2151 (@code{wl-fldmgr-make-filter})
2155 @kindex M-c (Folder)
2156 @kindex m c (Folder)
2157 @findex wl-fldmgr-copy
2158 Copy folder (it is not available on folder group).
2159 (@code{wl-fldmgr-copy})
2163 @kindex M-w (Folder)
2164 @kindex m W (Folder)
2165 @findex wl-fldmgr-copy-region
2166 Copy folders in the specified region.
2167 (@code{wl-fldmgr-copy-region})
2171 @kindex C-k (Folder)
2172 @kindex m k (Folder)
2173 @findex wl-fldmgr-cut
2174 Cut folder. Folder itself is not deleted.
2175 (@code{wl-fldmgr-cut})
2179 @kindex C-w (Folder)
2180 @kindex m C-w (Folder)
2181 @findex wl-fldmgr-cut-region
2182 Cut folders in the specified region.
2183 (@code{wl-fldmgr-cut-region})
2187 @kindex C-y (Folder)
2188 @kindex m y (Folder)
2189 @findex wl-fldmgr-yank
2190 Paste folders that are copied or cut (folders in the cut-list).
2191 (@code{wl-fldmgr-yank})
2194 @kindex m p (Folder)
2195 @findex wl-fldmgr-set-petname
2196 Put nickname on the folder.
2197 (@code{wl-fldmgr-set-petname})
2200 @kindex m q (Folder)
2201 @findex wl-fldmgr-clear-cut-entity-list
2202 Clear the cut-list. (cut, copied folder information is cleared,
2203 you cannot paste after this)
2204 (@code{wl-fldmgr-clear-cut-entity-list})
2207 @kindex m s (Folder)
2208 @findex wl-fldmgr-sort
2209 Sort folders in the current folder group.
2210 (@code{wl-fldmgr-sort})
2213 @kindex m C-s (Folder)
2214 @findex wl-fldmgr-save
2215 Save current folder view to the @file{wl-folders-file}.
2216 (@code{wl-fldmgr-save})
2219 [Following commands are only available on the access groups]
2225 @kindex m u (Folder)
2226 @findex wl-fldmgr-unsubscribe
2227 Set the visibility of folder (subscribe/unsubscribe).
2228 (@code{wl-fldmgr-unsubscribe})
2233 @kindex r u (Folder)
2234 @findex wl-fldmgr-unsubscribe-region
2235 Set the visibility of the folders (subscribe/unsubscribe) in the
2237 (@code{wl-fldmgr-unsubscribe-region})
2242 @kindex m l (Folder)
2243 @findex wl-fldmgr-access-display-normal
2244 List folders that are currently available.
2245 (@code{wl-fldmgr-access-display-normal})
2250 @kindex m L (Folder)
2251 @findex wl-fldmgr-access-display-all
2252 List all folders regardless of the subscription status.
2253 (@code{wl-fldmgr-access-display-all})
2257 @subsection Customize variables
2260 @item wl-interactive-save-folders
2261 @vindex wl-interactive-save-folders
2262 The initial setting is @code{t}. If non-nil and folder view is
2263 modified, confirm saving it before Wanderlust or Emacs exits. If
2264 @code{nil}, save without confirmation.
2266 @item wl-fldmgr-make-backup
2267 @vindex wl-fldmgr-make-backup
2268 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2269 created before saving the folder status.
2271 @item wl-fldmgr-sort-function
2272 @vindex wl-fldmgr-sort-function
2273 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2274 sort folders. By default function, folders are sorted alphabetically
2275 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2278 @item wl-fldmgr-sort-group-first
2279 @vindex wl-fldmgr-sort-group-first
2280 The initial setting is @code{t}. If non-nil,
2281 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2282 does not care whether it is folder group or not.
2284 @item wl-folder-check-async
2285 @vindex wl-folder-check-async
2286 The initial setting is @code{t}. If non-nil, check folder's unread
2287 status asynchronously. It boosts newsgroup checking.
2289 @item wl-folder-check-fast
2290 @vindex wl-folder-check-fast
2291 The initial setting is @code{nil}.
2292 If non-nil, it does not update folder status while checking.
2294 @item wl-folder-notify-deleted
2295 @vindex wl-folder-notify-deleted
2296 The initial setting is @code{nil}.
2298 If non-nil, negative value is displayed when the message is deleted. If
2299 @code{sync}, folder is synchronized when the message is deleted. If
2300 @code{nil}, message deletion is ignored.
2303 @subsection Miscellanea
2305 Following is a note for folder editing.
2309 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2310 paste(yank) command pastes the folders on one cut or copy command
2311 (If copy command is executed by region, folders in the region are pasted
2312 by one paste command)
2315 You cannot cut @samp{Desktop} group.
2316 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2319 You cannot copy folder group.
2322 Operations on the access group are only available for the folders
2323 in the same access group.
2326 You cannot create a folder which has same name with the folders already exist.
2329 You cannot insert folders which have same name in one group.
2330 You can insert them in the different groups.
2331 You cannot put same nickname to the different folders.
2335 @node Summary, Message, Folder, Top
2336 @chapter Summary Mode
2338 After you select the folder via folder mode, you enter to the summary
2342 * Usage of Summary Mode:: TIPS
2343 * Thread Operations:: Thread operations
2344 * Cache:: File cache, Buffer cache, and Prefetch
2345 * Auto Refile:: Auto refile settings
2346 * Sticky Summary:: Summary make sticky
2347 * Key Bindings of Summary:: Key bindings
2348 * Variables of Summary:: Customize Summary Mode
2352 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2353 @section Usage (Tips)
2355 @subsection Summary Content
2357 In the summary mode, messages are displayed like following.
2361 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2362 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2363 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2364 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2371 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2375 You cannot change this in the current version.
2377 @var{Message number} is the message's unique number in the folder. In
2378 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2379 in the MH folder, it is the filename of the message.
2381 @var{Temporal mark} and @var{Persistent mark} are described later.
2383 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2384 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2385 Japanese, but if you want to display it in English, set the value of
2386 @code{wl-summary-weekday-name-lang} as @samp{en}.
2388 @var{Sender}'s indentation corresponds to the depth of the thread.
2389 Sender name is displayed as nickname if it is defined in the address
2390 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2391 displaying with nickname.
2393 If number is printed at the head of @var{Sender} part like @samp{+2},
2394 that means the message have 2 follow messages.
2396 @var{Subject} is the @samp{Subject:} header field of the message. If
2397 the message have same @samp{Subject:} with the parent message, it is not
2398 displayed. Some mailing list puts its sequence number in the
2399 @samp{Subject:} field, but it is
2400 ignored. @code{wl-summary-no-subject-message} is displayed when the
2401 message has empty subject field.
2403 @subsection Temporary Marks
2404 @cindex Mark, Temporary
2406 There are four temporary marks,
2407 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2408 Temporary marks indicates message operations.
2413 You can execute a command on the all messages that have @samp{*} mark,
2414 with the key bindings which begins with @kbd{m}.
2417 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2421 After you type @kbd{o} key, prompt appears to input refile destination.
2422 Your answer is printed in the summary line.
2426 You can put this mark by typing @kbd{O} key.
2427 The difference between this mark and refile mark is,
2428 this mark does not delete the message while latter does.
2431 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2433 @subsection Persistent Marks
2435 There are five persistent marks,
2436 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2438 The persistent mark indicates the message's status and it is saved.
2439 Each persistent mark indicates:
2445 It is unread message.
2447 It is unread but cached message.
2449 It is read but it is not cached.
2451 It is important message. You can put @samp{$} mark by typing @kbd{$}
2452 key (if already exists, the mark is deleted). It is convenient to put
2453 this mark on the messages to remember (If you want to remember to write
2454 a reply for the message, for example) because this mark remains after
2455 you exited Emacs. Messages with the @samp{$} mark remains in the folder
2456 even the message itself is deleted in the actual folder.
2459 If the message is read and cached (or local message),there are no
2463 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2464 cache. Messages with the marks other than these, you can read them in
2465 the offline status even they are in the IMAP folder or netnews folder.
2467 @subsection How To Read
2469 Basically, you can read messages only typing space key again and again.
2471 To update summary status to the newest status (synchronize),
2474 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2475 moves cursor to the next message.
2476 Enter message buffer by typing @kbd{j} key.
2477 To operate multipart, you have to enter to the message buffer.
2480 @subsection Pack the Message Numbers
2481 You can pack the message numbers in Summary by
2482 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2483 News Spool Folder and Maildir Folder are supported folder types.
2486 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2487 @section Thread Operations
2489 For example, the following line indicates one thread (a context of a topic).
2492 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2496 If you type @kbd{/} on this line, the thread is opened and it changes
2497 the appearance like following.
2501 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2502 388 09/17(Thu)22:34 +-[ Murata san ]
2506 (Message 388 is the replied message to the message 384.)
2507 If you type @kbd{/} key once again, the thread is closed.
2508 With prefix argument, @kbd{/} opens all children threads.
2510 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2513 Commands with the key binding that begins with @kbd{t} executes commands
2514 on the messages in the thread.
2515 @xref{Key Bindings of Summary}.
2517 @subsection reconstruct thread by hand
2519 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2520 (@code{wl-summary-save-current-message}) at the corresponding message,
2521 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2522 message then you have the reconstructed thread.
2525 @node Cache, Auto Refile, Thread Operations, Summary
2528 @subsection Cache File
2530 The messages which have to access via network (e.x. IMAP, NNTP folder)
2531 are cached as a local file. The cache file is saved under the directory
2532 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2533 elmo-cache-expire-by-size}. The command deletes cache files to the
2534 specified size by the order of last accessed time.
2536 @subsection Buffer Cache and Prefetching
2538 If the value of @code{elmo-use-buffer-cache} is non-nil, the messages
2539 that are read are kept in the cache buffer. It is called `buffer
2540 cache'. The number of cache buffer is specified by
2541 @code{elmo-buffer-cache-size}.
2543 There are message prefetching mechanism in the Wanderlust that
2544 prefetches next message while you are reading. This function requires
2545 that the value of @code{elmo-use-buffer-cache} is non-nil.
2547 You can control the message prefetching mechanism by these two
2551 @item wl-cache-prefetch-folder-type-list
2552 @vindex wl-cache-prefetch-folder-type-list
2553 The initial setting is the list shown below:
2561 It specifies the folder types in which message prefetching is enabled.
2562 In the initial setting, multi folder that contains localdir and imap4
2563 prefetches only imap4 messages. This variable precedes the value of
2564 @code{wl-cache-prefetch-folder-list}.
2566 If you want to prefetch localdir and localnews also, following setting
2571 (setq wl-cache-prefetch-folder-type-list
2572 '(nntp imap4 localdir localnews))
2576 @item wl-cache-prefetch-folder-list
2577 @vindex wl-cache-prefetch-folder-list
2578 The initial setting is @code{nil}.
2579 A list of regexp of folders to enable message prefetching.
2583 @node Auto Refile, Sticky Summary, Cache, Summary
2584 @section Auto Refile
2585 @vindex elmo-msgdb-extra-fields
2586 @vindex wl-refile-rule-alist
2587 @findex wl-summary-auto-refile
2589 You can refile messages automatically, by typing @kbd{C-o}
2590 (@code{wl-summary-auto-refile}). It decides destination of refile by
2591 the content of the message header information (information in the msgdb).
2593 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2594 available. If you want to decide destination by other header fields,
2595 set the variable @code{elmo-msgdb-extra-fields} like following.
2599 (setq elmo-msgdb-extra-fields
2609 By this setting, Wanderlust saves extra fields in the msgdb. You have
2610 to type @kbd{s all} to get extra fields for the messages that are
2611 already exists in the summary.
2613 Then, specify the refile rule. The refile target folder of auto
2614 refiling is decided by the value of @code{wl-refile-rule-alist}.
2615 @code{wl-refile-rule-alist} is a list of a rule:
2619 (@var{field} (@var{regexp} . @var{target})
2620 (@var{regexp} . @var{target})
2625 Each rule means `if @var{field} value matches @var{regexp},
2626 then refile to @var{target} folder'.
2627 The rule matched first is applied.
2629 @var{field} is a string of field name. You can specify a list of field name
2630 string, too. In this case, if one of these fields is matched, then the
2631 rule is fired (i.e. OR condition).
2633 @var{regexp} is a regular expression for field value. @var{target} is a target
2634 folder string. You can specify a rule at @var{target} part, too. In this
2635 case, If the field value of the rule and the current rule is matched,
2636 then the current rule is fired (i.e. AND condition).
2638 In @var{target} part, you can refer matched substring of @var{regexp}.
2639 To refer substring, specify following in @var{target}:
2643 means substitute original matched text.
2646 means substitute what matched the @var{N}th `\(@dots{}\)'.
2647 (@var{N} is a number.)
2650 Following is an example of @code{wl-refile-rule-alist}.
2654 (setq wl-refile-rule-alist
2656 ("^Wanderlust" . "+wl")
2657 ("^Elisp" . "+elisp"))
2659 ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
2661 ("me@@gohome.org" . ("To" ("you@@gohome.org" .
2662 "+from-me-to-you"))))))
2666 After these settings, refile marks are automatically put on the condition
2667 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2669 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2671 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2672 with these persistent marks are not automatically refiled.
2673 It means Wanderlust does not execute auto refile on unread messages by
2674 the default setting.
2675 To execute auto refile on all messages, set following.
2678 (setq wl-summary-auto-refile-skip-marks nil)
2682 @node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
2683 @section Sticky Summary
2684 @cindex Summary, Sticky
2685 @cindex Sticky Summary
2687 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2689 Sticky buffer is created by entering the summary by typing @kbd{C-u g}
2690 or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
2692 The buffer name of the sticky summary becomes like
2693 @samp{Summary:@var{folder-name}}.
2695 You can visit the sticky summary at any time by @kbd{C-x b}
2696 (@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
2697 q}. Other operations in the sticky summary are same as normal summary.
2699 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2700 are automatically stuck.
2703 @node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
2704 @section Key bindings
2705 @cindex Keybind, Summary Mode
2706 @cindex Keybind, Summary Buffer
2708 Key bindings of the summary mode are shown below.
2712 @kindex @key{SPC} (Summary)
2713 @findex wl-summary-read
2714 Proceed reading a message at the current cursor point.
2715 (@code{wl-summary-read})
2719 @findex wl-summary-redisplay
2720 Redisplay a message at the current cursor point.
2721 If this command is called with prefix argument,
2722 Redisplay message regardless of the message cache (message is re-loaded
2724 (@code{wl-summary-redisplay})
2728 @findex wl-summary-display-top
2729 Display the top message in the folder.
2730 (@code{wl-summary-display-top})
2734 @findex wl-summary-display-bottom
2735 Display the bottom message in the folder.
2736 (@code{wl-summary-display-bottom})
2740 @kindex @key{BS} (Summary)
2741 @kindex @key{DEL} (Summary)
2742 Display the previous page of the message at the current cursor point.
2743 @findex wl-summary-prev-page
2744 (@code{wl-summary-prev-page})
2747 @kindex @key{RET} (Summary)
2748 @findex wl-summary-next-line-content
2749 Display the next line of the message at the current cursor point.
2750 Display the message at the current cursor point if it is not displayed yet.
2751 (@code{wl-summary-next-line-content})
2756 @kindex M-@key{RET} (Summary)
2757 @findex wl-summary-prev-line-content
2758 Display the previous line of the message at the current cursor point.
2759 Display the message at the current cursor point if it is not displayed yet.
2760 (@code{wl-summary-prev-line-content})
2764 @findex wl-thread-open-close
2765 Toggle open or close the thread at the current cursor point.
2766 (@code{wl-thread-open-close})
2771 @findex wl-thread-open-all
2772 (@code{wl-thread-open-all})
2777 @findex wl-thread-close-all
2778 (@code{wl-thread-close-all})
2782 @findex wl-summary-goto-folder
2784 (@code{wl-summary-goto-folder})
2788 Mark all messages in the folder as read.
2789 @findex wl-summary-mark-as-read-all
2790 (@code{wl-summary-mark-as-read-all})
2794 @findex wl-summary-reply
2795 Prepare a draft for reply the message at the current cursor point.
2796 (@code{wl-summary-reply})
2800 @findex wl-summary-reply-with-citation
2801 Prepare a draft for reply the message at the current cursor point.
2802 (@code{wl-summary-reply-with-citation})
2806 @findex wl-summary-cancel-message
2807 If the message at current cursor point is your own netnews article,
2809 (@code{wl-summary-cancel-message})
2813 @findex wl-summary-reedit
2814 Prepare a draft for re-editing the message at current cursor point.
2815 If the message at current cursor point is your own netnews article,
2816 a draft for `supersedes message' for the message is prepared.
2817 (@code{wl-summary-reedit})
2820 @kindex M-e (Summary)
2821 @findex wl-summary-resend-bounced-mail
2822 If the message at current cursor point is a bounced message,
2823 a draft for re-sending original message is prepared.
2824 (@code{wl-summary-resend-bounced-mail})
2828 @findex wl-summary-forward
2829 A draft for forwarding the message at current cursor point is prepared.
2830 (@code{wl-summary-forward})
2834 @findex wl-summary-mark-as-important
2835 Put @samp{$} mark on the message at current cursor point.
2836 If already marked as @samp{$}, delete it.
2837 (@code{wl-summary-mark-as-important})
2843 Save the message at current cursor point.
2844 @findex wl-summary-save
2845 (@code{wl-summary-save})
2849 @findex wl-summary-next
2850 Move cursor to the next message.
2851 If message is marked with a temporal mark in
2852 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2853 In the offline mode, cursor is not moved to the messages which are not cached
2855 (@code{wl-summary-next})
2859 @findex wl-summary-prev
2860 Move cursor to the previous message.
2861 If message is marked with a temporal mark in
2862 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
2863 In the offline mode, cursor is not moved to the messages which are not cached
2865 (@code{wl-summary-prev})
2869 @findex wl-summary-down
2870 Move cursor to the downward message which is unread or marked
2872 In the offline mode, cursor is not moved to the messages which are not cached
2874 If there are messages which have target mark @samp{*} in the summary,
2875 cursor is moved to the downward message which have a target mark.
2876 This behavior is changed according to the value of @code{wl-summary-move-order}.
2877 (@code{wl-summary-down})
2881 @findex wl-summary-up
2882 Move cursor to the upward message which is unread or marked
2884 In the offline mode, cursor is not moved to the messages which are not cached
2886 If there are messages which have target mark @samp{*} in the summary,
2887 cursor is moved to the downward message which have a target mark.
2888 This behavior is changed according to the value of @code{wl-summary-move-order}.
2889 (@code{wl-summary-up})
2893 @findex wl-summary-write
2894 Prepare a new draft.
2895 (@code{wl-summary-write})
2899 @findex wl-summary-write-current-folder
2900 Prepare a new draft. If the current folder is NNTP folder,
2901 @samp{Newsgroups:} field is completed. If the current folder is mailing
2902 list folder (refile destination), guess @samp{To:} field and completed
2903 (If @code{wl-subscribed-mailing-list} is valid list)
2904 (@code{wl-summary-write-current-folder})
2908 @findex wl-summary-redisplay-all-header
2909 Redisplay the message at current cursor point with all header fields.
2910 (@code{wl-summary-redisplay-all-header})
2914 @findex wl-summary-redisplay-no-mime
2915 Redisplay the message at current cursor point without MIME analysis.
2916 (@code{wl-summary-redisplay-no-mime})
2920 @findex wl-summary-burst
2921 If the message at current cursor point has
2922 encapsulates multiple messages using MIME,
2923 de-capsulate and extract them on the current folder.
2924 (@code{wl-summary-burst})
2927 @kindex @@ (Summary)
2928 @findex wl-summary-edit-addresses
2929 Append/change/delete the message's sender information to the address
2930 book @file{~/.addresses} interactively. If this command is called with
2931 prefix argument, arbitrary address can be edited.
2932 (@code{wl-summary-edit-petname})
2936 @findex wl-status-update
2937 Sync up address book status with @file{~/.addresses}'s content.
2938 (@code{wl-status-update})
2942 @findex wl-summary-pipe-message
2943 Pipe current message's content to the external process.
2944 (@code{wl-summary-pipe-message})
2948 @findex wl-summary-print-message
2949 Print out current message's content.
2950 It uses @code{ps-print} module in Emacs 20.x.
2951 If you don't use color printer, you might want to set
2952 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
2955 (setq wl-ps-print-buffer-function 'ps-print-buffer)
2958 (@code{wl-summary-print-message})
2962 @findex wl-summary-exit
2963 Exit current folder.
2964 (@code{wl-summary-exit})
2968 @findex wl-summary-jump-to-current-message
2969 Jump cursor to the currently displayed message's window.
2970 (@code{wl-summary-jump-to-current-message})
2974 Jump cursor to the other message.
2975 @findex wl-summary-jump-to-msg
2976 (@code{wl-summary-jump-to-msg})
2980 Update summary status and
2981 prefetch all messages which have marks included in the
2982 @code{wl-summary-incorporate-marks}.
2983 @findex wl-summary-incorporate
2984 (@code{wl-summary-incorporate})
2987 @kindex M-j (Summary)
2988 @findex wl-summary-jump-to-msg-by-message-id
2989 Jump cursor to the message which have specified @samp{Message-Id:}. If
2990 @code{elmo-use-database} is non-nil, other folder is also searched.
2991 (@code{wl-summary-jump-to-msg-by-message-id})
2995 Jump to parent message.
2996 @findex wl-summary-jump-to-parent-message
2997 (@code{wl-summary-jump-to-parent-message})
3001 @findex wl-summary-mark-as-unread
3002 Mark as unread the message at current cursor point.
3003 (@code{wl-summary-mark-as-unread})
3007 @findex wl-summary-sync
3008 Synchronize summary view after prompting the update range
3009 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3013 all ...Discard current summary and update all message.
3014 update ...Update the difference between summary and the folder itself.
3015 rescan ...Rescan the msgdb and display again.
3016 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3017 first, last ...Move to the filter folder(partial filter).
3022 (@code{wl-summary-sync})
3026 @findex wl-summary-sort
3028 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3029 (@code{wl-summary-sort})
3033 @findex wl-summary-toggle-thread
3034 Toggle the threading.
3035 Threading status is displayed on the modeline.
3036 @samp{@{S@}} means threading is off (Sequence) and
3037 @samp{@{T@}} means threading is on (Thread).
3038 (@code{wl-summary-toggle-thread})
3042 @findex wl-summary-toggle-disp-folder
3043 Toggle displaying of folder window.
3044 (@code{wl-summary-toggle-disp-folder})
3048 Toggle displaying of message window.
3049 @findex wl-summary-toggle-disp-msg
3050 (@code{wl-summary-toggle-disp-msg})
3054 Move to the virtual folder with the condition specified.
3055 If called with prefix argument and current folder is virtual, exit it.
3056 @findex wl-summary-virtual
3057 (@code{wl-summary-virtual})
3060 @kindex @key{TAB} (Summary)
3061 @findex wl-summary-goto-last-displayed-msg
3062 Jump to the message which is displayed last.
3063 (@code{wl-summary-goto-last-displayed-msg})
3067 Put @samp{*} mark on the messages that satisfies the specified condition.
3068 @findex wl-summary-pick
3069 (@code{wl-summary-pick})
3073 @findex wl-summary-mark-as-read
3074 Mark as read the message at the current cursor point.
3075 (@code{wl-summary-mark-as-read})
3079 Prefetch the message at the current cursor point.
3080 With prefix argument, prefetch the message even if it is cached.
3081 @findex wl-summary-prefetch
3082 (@code{wl-summary-prefetch})
3086 Execute @samp{D}, @samp{o} and @samp{O} marks.
3087 @findex wl-summary-exec
3088 (@code{wl-summary-exec})
3092 @findex wl-summary-target-mark-line
3093 Put target mark on the message at the current cursor point.
3094 (@code{wl-summary-target-mark-line})
3098 Put refile mark on the message at the current cursor point.
3099 @findex wl-summary-refile
3100 (@code{wl-summary-refile})
3103 @kindex C-o (Summary)
3104 Execute auto refile.
3105 @findex wl-summary-auto-refile
3106 (@code{wl-summary-auto-refile})
3110 Put copy mark on the message at the current cursor point.
3111 @findex wl-summary-copy
3112 (@code{wl-summary-copy})
3115 @kindex M-o (Summary)
3116 Put refile mark on the message at the current cursor point with the destination
3117 previously specified.
3118 @findex wl-summary-refile-prev-destination
3119 (@code{wl-summary-refile-prev-destination})
3123 @findex wl-summary-delete
3124 Put delete mark on the message at the current cursor point.
3125 (@code{wl-summary-delete})
3129 @findex wl-summary-unmark
3130 Unmark the temporal mark on the message at the current cursor point.
3131 (@code{wl-summary-unmark})
3135 Unmark all the temporal marks.
3136 @findex wl-summary-unmark-all
3137 (@code{wl-summary-unmark-all})
3140 @kindex r R (Summary)
3141 @findex wl-summary-mark-as-read-region
3142 Mark as read messages in the specified region.
3143 (@code{wl-summary-mark-as-read-region})
3146 @kindex r $ (Summary)
3147 @findex wl-summary-mark-as-important-region
3148 Mark as important @samp{$} messages in the specified region.
3149 If @samp{$} already exists, it is deleted.
3150 (@code{wl-summary-mark-as-important-region})
3153 @kindex r ! (Summary)
3154 @findex wl-summary-mark-as-unread-region
3155 Mark as unread messages in the specified region.
3156 (@code{wl-summary-mark-as-unread-region})
3159 @kindex r i (Summary)
3160 @findex wl-summary-prefetch-region
3161 Prefetch messages in the specified region.
3162 (@code{wl-summary-prefetch-region})
3165 @kindex r x (Summary)
3166 @findex wl-summary-exec-region
3167 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3169 (@code{wl-summary-exec-region})
3172 @kindex r * (Summary)
3173 @findex wl-summary-target-mark-region
3174 Put target mark on the messages in the specified region.
3175 (@code{wl-summary-target-mark-region})
3178 @kindex r o (Summary)
3179 @findex wl-summary-refile-region
3180 Put refile mark on the messages in the specified region.
3181 (@code{wl-summary-refile-region})
3184 @kindex r O (Summary)
3185 @findex wl-summary-copy-region
3186 Put copy mark on the messages in the specified region.
3187 (@code{wl-summary-copy-region})
3190 @kindex r d (Summary)
3191 @findex wl-summary-delete-region
3192 Put delete mark on the messages in the specified region.
3193 (@code{wl-summary-delete-region})
3196 @kindex r u (Summary)
3197 @findex wl-summary-unmark-region
3198 Delete temporal mark on the messages in the specified region.
3199 (@code{wl-summary-unmark-region})
3202 @kindex r y (Summary)
3203 Save messages in the specified region.
3204 @findex wl-summary-save-region
3205 (@code{wl-summary-save-region})
3208 @kindex t R (Summary)
3209 @findex wl-thread-mark-as-read
3210 Mark as read messages which are the descendant of the current thread.
3211 With prefix argument, it affects on the all messages in the thread tree.
3212 (@code{wl-thread-mark-as-read})
3215 @kindex t $ (Summary)
3216 @findex wl-thread-mark-as-important
3217 Put important mark @samp{$} on the messages which are the
3218 descendant of the current thread.
3219 If @samp{$} mark exists, it is deleted.
3220 With prefix argument, it affects on the all messages in the thread tree.
3221 (@code{wl-thread-mark-as-important})
3224 @kindex t ! (Summary)
3225 @findex wl-thread-mark-as-unread
3226 Mark as unread messages which are the descendant of the current thread.
3227 With prefix argument, it affects on the all messages in the thread tree.
3228 (@code{wl-thread-mark-as-unread})
3231 @kindex t i (Summary)
3232 @findex wl-thread-prefetch
3233 Prefetch messages which are the descendant of the current thread.
3234 With prefix argument, it affects on the all messages in the thread tree.
3235 (@code{wl-thread-prefetch})
3238 @kindex t x (Summary)
3239 @findex wl-thread-exec
3240 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3241 the descendant of the current thread. With prefix argument, it affects
3242 on the all messages in the thread tree.
3243 (@code{wl-thread-exec})
3246 @kindex t * (Summary)
3247 @findex wl-thread-target-mark
3248 Put target mark @samp{*} on the messages which are the descendant of the
3249 current thread. With prefix argument, it affects on the all messages in
3251 (@code{wl-thread-target-mark})
3254 @kindex t o (Summary)
3255 @findex wl-thread-refile
3256 Put refile mark on the messages which are the descendant of the current thread.
3257 With prefix argument, it affects on the all messages in the thread tree.
3258 (@code{wl-thread-refile})
3261 @kindex t O (Summary)
3262 @findex wl-thread-copy
3263 Put copy mark on the messages which are the descendant of the current thread.
3264 With prefix argument, it affects on the all messages in the thread tree.
3265 (@code{wl-thread-copy})
3268 @kindex t d (Summary)
3269 @findex wl-thread-delete
3270 Put delete mar on the messages which are the descendant of the current thread.
3271 With prefix argument, it affects on the all messages in the thread tree.
3272 (@code{wl-thread-delete})
3275 @kindex t u (Summary)
3276 @findex wl-thread-unmark
3277 Unmark temporal mark on the messages which are the descendant of the
3278 current thread. With prefix argument, it affects on the all messages in
3280 (@code{wl-thread-unmark})
3283 @kindex t y (Summary)
3284 @findex wl-thread-save
3285 Save messages which are the descendant of the current thread.
3286 With prefix argument, it affects on the all messages in the thread tree.
3287 (@code{wl-thread-save})
3290 @kindex m i (Summary)
3291 @findex wl-summary-target-mark-prefetch
3292 Prefetch all messages which have target mark @samp{*}.
3293 (@code{wl-summary-target-mark-prefetch})
3296 @kindex m R (Summary)
3297 @findex wl-summary-target-mark-mark-as-read
3298 Mark as read all messages which have target mark @samp{*}.
3299 (@code{wl-summary-target-mark-mark-as-read})
3302 @kindex m $ (Summary)
3303 @findex wl-summary-target-mark-mark-as-important
3304 Mark as important all messages which have target mark @samp{*}.
3305 If already marked as @samp{$}, it is deleted.
3306 (@code{wl-summary-target-mark-mark-as-important})
3309 @kindex m ! (Summary)
3310 @findex wl-summary-target-mark-mark-as-unread
3311 Mark as unread all messages which have target mark @samp{*}.
3312 (@code{wl-summary-target-mark-mark-as-unread})
3315 @kindex m o (Summary)
3316 @findex wl-summary-target-mark-refile
3317 Put refile mark on the messages which have target mark @samp{*}.
3318 (@code{wl-summary-target-mark-refile})
3321 @kindex m O (Summary)
3322 @findex wl-summary-target-mark-copy
3323 Put copy mark on the messages which have target mark @samp{*}.
3324 (@code{wl-summary-target-mark-copy})
3327 @kindex m d (Summary)
3328 @findex wl-summary-target-mark-delete
3329 Put delete mark on the messages which have target mark @samp{*}.
3330 (@code{wl-summary-target-mark-delete})
3333 @kindex m y (Summary)
3334 @findex wl-summary-target-mark-save
3335 Save messages which have target mark @samp{*}.
3336 (@code{wl-summary-target-mark-save})
3339 @kindex m u (Summary)
3340 Unmark all temporal marks.
3341 (@code{wl-summary-delete-all-temp-marks})
3342 @findex wl-summary-delete-all-temp-marks
3345 @kindex m a (Summary)
3346 Put target mark @samp{*} on the all messages.
3347 (@code{wl-summary-target-mark-all})
3348 @findex wl-summary-target-mark-all
3351 @kindex m t (Summary)
3352 Put target mark @samp{*} on the messages in the current thread.
3353 @findex wl-summary-target-mark-thread
3354 (@code{wl-summary-target-mark-thread})
3357 @kindex m r (Summary)
3358 @findex wl-summary-target-mark-region
3359 Put target mark @samp{*} on the messages in the specified region.
3360 (@code{wl-summary-target-mark-region})
3363 @kindex m A (Summary)
3364 @findex wl-summary-target-mark-reply-with-citation
3365 Prepare a draft which cites all messages which have target mark @samp{*}.
3366 (@code{wl-summary-target-mark-reply-with-citation})
3369 @kindex m f (Summary)
3370 @findex wl-summary-target-mark-forward
3371 Prepare a draft which forwards all messages which have target mark @samp{*}.
3372 (@code{wl-summary-target-mark-forward})
3375 @kindex m U (Summary)
3376 @findex wl-summary-target-mark-uudecode
3377 Uudecode the messages which have target mark @samp{*}.
3378 (@code{wl-summary-target-mark-uudecode})
3381 @kindex m ? (Summary)
3382 @findex wl-summary-target-mark-pick
3383 Pick messages from the @samp{*} marked messages.
3384 That is, @samp{*} marks on the messages are remained
3385 if the specified condition is satisfied.
3386 (@code{wl-summary-target-mark-pick})
3389 @kindex M-t (Summary)
3390 @findex wl-toggle-plugged
3391 Toggle offline/online status of Wanderlust.
3392 (@code{wl-toggle-plugged})
3395 @kindex C-t (Summary)
3396 Start Wanderlust's plug-status manager.
3397 (@code{wl-plugged-change})
3400 @kindex C-c C-o (Summary)
3401 @findex wl-jump-to-draft-buffer
3402 Move to the draft buffer if available. If multiple draft buffer exists,
3403 moved to one after another. If prefix argument is specified, load draft
3404 folder's message to the draft buffer and jump to it.
3405 (@code{wl-jump-to-draft-buffer})
3408 @kindex M-w (Summary)
3409 @findex wl-summary-save-current-message
3410 Save the message at the current cursor point.
3411 (@code{wl-summary-save-current-message})
3414 @kindex C-y (Summary)
3415 @findex wl-summary-yank-saved-message
3416 Regard the message at the current cursor point as
3417 parent, connect the message saved by
3418 @code{wl-summary-save-current-message}
3420 (@code{wl-summary-yank-saved-message})
3424 @node Variables of Summary, , Key Bindings of Summary, Summary
3425 @section Customiziable variables
3428 @item wl-summary-move-order
3429 @vindex wl-summary-move-order
3430 The initial setting is @code{unread}. Specify cursor moving policy. If
3431 you want to precede new messages, set @code{new}. If you want to
3432 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3435 @item wl-auto-select-first
3436 @vindex wl-auto-select-first
3437 The initial setting is @code{nil}.
3438 If non-nil, first message is automatically displayed.
3440 @item wl-auto-select-next
3441 @vindex wl-auto-select-next
3442 The initial setting is @code{nil}. If non-nil, jump to next summary
3443 automatically. If @code{unread}, jump to next unread folder's summary
3444 after confirmation. If @code{skip-no-unread}, unread folders are
3445 automatically skipped.
3447 @item wl-thread-insert-opened
3448 @vindex wl-thread-insert-opened
3449 The initial setting is @code{nil}.
3450 If non-nil, thread is inserted as opened.
3452 @item wl-thread-open-reading-thread
3453 @vindex wl-thread-open-reading-thread
3454 The initial setting is @code{t}. If non-nil, reading thread is
3455 automatically opened though it is closed thread.
3457 @item wl-summary-exit-next-move
3458 @vindex wl-summary-exit-next-move
3459 The initial setting is @code{t}. If non-nil, move to next folder at
3462 @item wl-folder-move-cur-folder
3463 @vindex wl-folder-move-cur-folder
3464 The initial setting is @code{nil}. If non-nil, cursor position on the
3467 @item wl-summary-weekday-name-lang
3468 @vindex wl-summary-weekday-name-lang
3469 The initial setting is @samp{ja}. Specify language of the weekday.
3470 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3473 @item wl-summary-fix-timezone
3474 @vindex wl-summary-fix-timezone
3475 The initial setting is @code{nil}.
3476 Time zone of the date string in summary mode is adjusted using this value.
3477 If @code{nil}, it is adjust to the default time zone information
3478 (system's default time zone or environment variable @samp{TZ}).
3480 @item wl-use-petname
3481 @vindex wl-use-petname
3482 The initial setting is @code{t}.
3483 If non-nil, sender part displays nickname.
3485 @item wl-break-pages
3486 @vindex wl-break-pages
3487 The initial setting is @code{t}.
3488 If non-nil, message is split as pages by @samp{^L}.
3490 @item wl-message-window-size
3491 @vindex wl-message-window-size
3492 The initial setting is '(1 . 4).
3493 A cons cell to specify the rate of summary and message window.
3494 car:cdr corresponds summary:message.
3496 @item wl-summary-recenter
3497 @vindex wl-summary-recenter
3498 The initial setting is t.
3499 If non-nil, cursor point is moved to the center of the summary window.
3501 @item wl-summary-indent-length-limit
3502 @vindex wl-summary-indent-length-limit
3503 The initial setting is 46.
3504 Specify the limit of thread indent level.
3505 If nil, max indent level is unlimited.
3507 @item wl-summary-no-from-message
3508 @vindex wl-summary-no-from-message
3509 The initial setting is @samp{nobody@@nowhere?}. A string which is
3510 displayed when there's no @samp{From:} field in the message.
3512 @item wl-summary-no-subject-message
3513 @vindex wl-summary-no-subject-message
3514 The initial setting is @samp{(WL:No Subject in original.)}. A string
3515 which is displayed when there's no @samp{Subject:} field in the message.
3517 @item wl-summary-width
3518 @vindex wl-summary-width
3519 The initial setting is 80.
3520 Width of summary line. If @code{nil}, summary line's width is as is.
3522 @item wl-use-folder-petname
3523 @vindex wl-use-folder-petname
3524 The initial setting is the list shown below:
3533 A list of display policy (symbol) of folder nickname. Available symbols
3538 Display folder petname on modeline.
3540 Destination folder is notified as nickname if
3541 @code{wl-auto-select-next} is non-nil.
3543 You can input folder name by nickname in the function
3544 @code{wl-summary-read-folder}.
3547 @item wl-summary-move-direction-toggle
3548 @vindex wl-summary-move-direction-toggle
3549 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3550 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3551 want to aware of reading direction, set this to @code{t}.
3554 @vindex wl-from-width
3555 The initial setting is 17.
3556 Width of sender part of summary line.
3558 @item wl-summary-divide-thread-when-subject-changed
3559 @vindex wl-summary-divide-thread-when-subject-changed
3560 The initial setting is @code{nil}. If non-nil, thread is split if
3561 the subject is changed.
3563 @item wl-summary-search-via-nntp
3564 @vindex wl-summary-search-via-nntp
3565 The initial setting is @code{confirm}.
3567 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3568 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3569 from the NNTP server @code{elmo-nntp-default-server}. The value of
3570 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3571 @code{elmo-nntp-default-stream-type} are used.
3573 If @code{confirm}, server name can be specified. You can specify NNTP
3574 folder format like @samp{-:username@@servername:119!}.
3576 @item wl-summary-keep-cursor-command
3577 @vindex wl-summary-keep-cursor-command
3578 The initial setting is the list shown below:
3582 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3587 When you entered to summary by these commands and the target summary
3588 buffer already exists, summary status is not automatically updated and
3589 cursor position is saved.
3591 @item wl-summary-update-confirm-threshold
3592 @vindex wl-summary-update-confirm-threshold
3593 The initial setting is 500. If updated message number is larger than
3594 this value, confirm whether drop them or not.
3596 @item wl-summary-always-sticky-folder-list
3597 @vindex wl-summary-always-sticky-folder-list
3598 The initial setting is @code{nil}.
3599 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3600 are automatically stuck. Each element is regexp of folder name.
3602 @item wl-summary-reserve-mark-list
3603 @vindex wl-summary-reserve-mark-list
3604 The initial setting is the list shown below:
3613 If a message is already marked as temporal marks in this list, the
3614 message is not marked by any mark command.
3616 @item wl-summary-skip-mark-list
3617 @vindex wl-summary-skip-mark-list
3618 The initial setting is the list shown below:
3627 If a message is already marked as temporal marks in this list, the
3628 message is skipped at cursor move.
3630 @item wl-fetch-confirm-threshold
3631 @vindex wl-fetch-confirm-threshold
3632 The initial setting is 30000 (bytes). If displaying message has larger
3633 size than this value, Wanderlust confirms whether fetch the message or
3634 not. If @code{nil}, the message is fetched without confirmation.
3636 @item wl-prefetch-threshold
3637 @vindex wl-prefetch-threshold
3638 The initial setting is 30000 (bytes). If prefetching message has larger
3639 size than this value and @code{wl-prefetch-confirm} is non-nil,
3640 Wanderlust confirms whether prefetch the message or not. If
3641 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3642 without confirmation.
3644 @item wl-prefetch-confirm
3645 @vindex wl-prefetch-confirm
3646 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3647 prefetch the message or not if the message has larger size than
3648 @code{wl-prefetch-threshold}.
3650 @item wl-cache-fetch-threshold
3651 @vindex wl-cache-fetch-threshold
3652 The initial setting is 30000 (bytes). The messages which have larger
3653 size than @code{wl-fetch-confirm-threshold} are skipped buffer caching
3654 mechanism. If @code{nil}, any messages are prefetched by buffer caching
3657 @item elmo-imap4-use-cache
3658 @vindex elmo-imap4-use-cache
3659 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3662 @item elmo-nntp-use-cache
3663 @vindex elmo-nntp-use-cache
3664 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3667 @item elmo-pop3-use-cache
3668 @vindex elmo-pop3-use-cache
3669 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3672 @item wl-folder-process-duplicates-alist
3673 @vindex wl-folder-process-duplicates-alist
3674 The initial setting is @code{nil}.
3675 This list determines how to deal with duplicated messages in the same folder.
3676 Each item in the list is regexp of folder name and action; you can specify any
3677 one of the following in the place of action:
3680 @code{nil} : do nothing for duplicated messages.
3681 @code{hide} : hide duplicated messages from the summary.
3682 @code{read} : set duplicated messages as read.
3686 Following is an example (hide duplicated messages in multi folders)
3690 (setq wl-folder-process-duplicates-alist
3691 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
3692 ("^\\*.*" . hide) (".*" . read)))
3698 @node Message, Draft, Summary, Top
3699 @chapter Message Buffer
3701 Message Buffers utilize MIME-View mode of SEMI. For operational
3702 procedures and key bindings, refer to respective documents.
3703 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
3705 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
3706 brings you back to Summary mode. @kbd{l} toggles display of Summary
3709 @section Key Bindings
3715 @findex wl-message-toggle-disp-summary
3716 Toggles display of Summary mode buffer.
3717 (@code{wl-message-toggle-disp-summary})
3720 @findex wl-message-refer-article-or-url
3721 @kindex Button-2 (Message)
3722 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
3723 corresponding message if found.
3724 (@code{wl-message-refer-article-or-url})
3726 @item Button-4 (upward movement of a wheel)
3727 @kindex Button-4 (Message)
3728 @findex wl-message-wheel-down
3729 Scrolls the message backwards. When the top of the message is hit,
3730 moves to the previous message.
3731 (@code{wl-message-wheel-down})
3733 @item Button-5 (downward movement of a wheel)
3734 @kindex Button-5 (Message)
3735 @findex wl-message-wheel-up
3736 Scrolls the message forward. When the bottom of the message is hit,
3737 moves to the next message.
3738 (@code{wl-message-wheel-up})
3741 @section Customizable Variables
3744 @item wl-message-window-size
3745 @vindex wl-message-window-size
3746 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
3747 its car and cdr value corresponds to the ratio of Summary and Message
3750 @item wl-message-ignored-field-list
3751 @vindex wl-message-ignored-field-list
3752 (SEMI only) Initial setting is @code{nil}.
3753 All fields that match this list will be hidden in message buffer.
3754 Each elements are regexp of field-name.
3755 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
3757 @item wl-message-visible-field-list
3758 @vindex wl-message-visible-field-list
3759 (SEMI only) Initial setting is @code{nil}.
3760 All fields that match this list will be display in message buffer.
3761 Each elements are regexp of field-name. This value precedes
3762 @code{wl-message-ignored-field-list}.
3763 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
3765 @item wl-message-sort-field-list
3766 @vindex wl-message-sort-field-list
3767 (SEMI only) Initial setting is
3768 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
3769 Header fields in message buffer are ordered by this value.
3770 Each elements are regexp of field-name.
3772 @item wl-message-truncate-lines
3773 @vindex wl-message-truncate-lines
3774 The initial value is the value of @code{default-truncate-lines}.
3775 If it is non-nil, truncate long lines in message buffer.
3778 @node Draft, Disconnected Operations, Message, Top
3779 @chapter Draft Buffer
3781 At Summary mode, pressing @kbd{w} and the like creates a new draft
3782 buffer. You can edit and send mail and news articles in this buffer.
3786 Basically it is Emacs-standard mail mode.
3788 @subsection Address Completion
3790 Initially, the cursor is at the @samp{To:} field. Fill in recipients
3791 addresses. @kbd{@key{TAB}} completes them.
3793 If you want to submit a news article, add @samp{Newsgroups:} field by
3794 yourself. Field names can be completed by @kbd{@key{TAB}}.
3796 If you save the draft buffer you are editing, it is appended to the
3797 folder specified by @code{wl-draft-folder}.
3799 Using @samp{FCC:} field, you can specify the folder to which a copy of
3800 the message is saved when it is sent.
3802 @subsection Editing Messages
3804 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
3805 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
3806 a MIME user interface for GNU Emacs}.
3808 @subsection Dynamic Modification of Messages
3809 @vindex wl-draft-config-alist
3810 @c @cindex Change Message
3811 @c @cindex Message, Change Dynamic
3813 You can set @code{wl-draft-config-alist} so that header and body of the
3814 message will automatically modified depending on information of header
3817 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
3819 In the example below, the header is modified when
3820 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
3821 can set @code{wl-interactive-send} to non-nil so as to confirm changes
3822 before sending the message.
3826 (setq wl-draft-config-alist
3827 '(((string-match "aaa.example.com$" (system-name))
3828 ;; @r{applied if the expression is non-nil}
3829 (wl-smtp-posting-server . "mailserver-B")
3830 (wl-nntp-posting-server . "newsserver-B")
3831 ;; @r{settings of temporary variables}
3833 ("^To: .*user@@aaa.bbb.example.com"
3834 ;; @r{applied if it matches the header of the draft buffer}
3835 ("Organization" . (format "Go %s" my-webpage)))
3836 ;; @r{you can write elisp expressions here (eval only)}
3837 (top . "Hello.\n") ;; @r{inserted at the top of the body}
3838 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
3843 The format of @code{wl-draft-config-alist} is:
3847 '(("@var{regexp of the header}" or @var{elisp expression}
3848 ("@var{Field}" . value(@var{elisp expression}))
3849 (@var{variable} . value(@var{elisp expression}))
3850 (@var{sub-function} . value(@var{elisp expression}))
3853 ("@var{regexp of the header}" or @var{elisp expression}
3854 ("@var{Field}" . value(@var{elisp expression}))
3859 Per default, there are 10 following sub-functions.
3862 'header: Inserts the specified string at the bottom of the header.
3863 'header-file: Inserts the specified file at the bottom of the header.
3864 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
3865 'top: Inserts the specified string at the top of the body.
3866 'top-file: Inserts the specified file at the top of the body.
3867 'body: Replaces the body with the specified string.
3868 Specifying @code{nil} deletes the entire body string.
3869 'body-file: Replaces the body with the content of the specified file.
3870 'bottom: Inserts the specified string at the bottom of the body.
3871 'bottom-file: Inserts the specified file at the top of the body.
3872 'template: Applies the specified template.
3873 (refer to the next subsection)
3876 These are defined in @code{wl-draft-config-sub-func-alist} and you can
3877 change them or add your own functions. If you read the code, you can
3878 easily find how to write the functions.
3880 At the first of each item, @var{a regular expression of the header} or
3881 an @var{elisp expression} should be specified. In the case of an elisp
3882 expression, the item is applied when the expression is evaluated
3885 Per default, when multiple items match or are evaluated non-nil, all
3886 such items are applied, but if you set a variable
3887 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
3890 At the second of the item, a cons or a list of functions should be
3891 specified. The car part of the cons should be a header field, a
3892 variable, or a sub-function. When a header field is specified, the
3893 field will be modified. If a variable is specified, the value of the
3894 variable will be modified temporarily.
3896 In the cdr part of a cons, not only a variable but also an elisp
3897 expression can be specified as is. If the car part is a header field
3898 and the cdr part is @code{nil}, the field will be deleted.
3900 See the next example as well:
3904 (setq wl-draft-config-alist
3906 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
3907 ;; @r{applied if it matches the header of the buffer being replied}
3908 (body . " Hello.\n")
3909 (template . "default")
3914 As in the (1) above, if a header regexp is prepended with @code{reply},
3915 it is applied when the draft is prepared by @code{wl-summary-reply} for
3916 example, and when it matches the header being replied. It is ignored
3917 when there is no buffer being replied, like after @code{wl-draft} was
3920 Note that @code{wl-draft-config-alist} is applied only once when
3921 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
3922 Therefore, if you want to apply @code{wl-draft-config-alist} again after
3923 aborting transmission, execute @kbd{C-c C-e}
3924 (@code{wl-draft-config-exec}) explicitly.
3926 If you don't want to apply @code{wl-draft-config-alist} when
3927 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
3931 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
3934 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
3935 prepared, do the following:
3938 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
3941 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
3942 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
3946 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
3949 @subsection Inserting Templates
3951 @cindex Apply Template
3953 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
3954 @kbd{M-x wl-template-select} in the draft buffer.
3956 The format of @code{wl-template-alist} is almost the same as
3957 @code{wl-draft-config-alist}.
3961 (setq wl-template-alist
3964 ("Organization" . "~/.wl sample")
3965 (body . "Hello.\n"))
3967 (template . "default") ;; @r{(a)}
3968 ("To" . "boss@@example.com")
3969 ("Subject" . "Report")
3970 (body-file . "~/work/report.txt")
3976 As you can see, the only difference is item (template) names such as
3977 @samp{default} and @samp{report}, instead of a regexp of header.
3978 Because definition of each item is the same as
3979 @code{wl-draft-config-alist}, you can call another template, like (a).
3981 Executing the command @code{wl-template-select} results in template
3982 selection, but the result differs depending on variable
3983 @code{wl-template-visible-select}.
3985 If @code{wl-template-visible-select} is @code{t} (default), a buffer
3986 window is shown below the draft buffer. You can select a template by
3987 @kbd{n} and @kbd{p} seeing the buffer window.
3989 Press the @key{RET} key and the template is actually applied to the draft
3990 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
3991 adjust the window size by @code{wl-template-buffer-lines}.
3993 If @code{wl-template-visible-select} is @code{nil}, you should type the
3994 name of the template in the mini buffer.
3996 As shown in the example in @code{wl-draft-config-alist}, you can select
3997 @samp{default} template by writing:
4000 (template . "default")
4003 @subsection Sending mail by POP-before-SMTP
4004 @cindex POP-before-SMTP
4006 You can send mail by POP-before-SMTP with this single line:
4009 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4013 Configure the following variables if you need.
4016 @item wl-pop-before-smtp-user
4017 The POP user name for POP-before-SMTP authentication.
4018 If unset, @code{elmo-pop3-default-user} is used.
4020 @item wl-pop-before-smtp-server
4021 The POP server name for POP-before-SMTP authentication.
4022 If unset, @code{elmo-pop3-default-server} is used.
4024 @item wl-pop-before-smtp-authenticate-type
4025 The POP authentication method for POP-before-SMTP authentication.
4026 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4028 @item wl-pop-before-smtp-port
4029 The POP port number for POP-before-SMTP authentication.
4030 If unset, @code{elmo-pop3-default-port} is used.
4032 @item wl-pop-before-smtp-stream-type
4033 If non-nil, POP connection is established using SSL. If
4034 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4035 unset, @code{elmo-pop3-default-stream-type} is used.
4038 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4039 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4041 Therefore, if SMTP server and POP server are actually the same, and if
4042 POP folder per default (such as @samp{&}) is available, no settings are
4045 Refer to the following URL about POP-before-SMTP.
4049 http://spam.ayamura.org/tools/smPbS.html
4050 http://www.iecc.com/pop-before-smtp.html
4054 @section Key Bindings
4055 @cindex Keybind, Draft Mode
4056 @cindex Keybind, Draft Buffer
4061 @kindex C-c C-y (Draft)
4062 @findex wl-draft-yank-original
4063 Cites the content of the current message buffer.
4064 (@code{wl-draft-yank-original})
4067 @kindex C-c C-p (Draft)
4068 @findex wl-draft-preview-message
4069 Previews the content of the current draft.
4070 This is useful for previewing MIME multi-part messages.
4071 (@code{wl-draft-preview-message})
4074 @kindex C-c C-s (Draft)
4075 @findex wl-draft-send
4076 Sends the content of the current draft. Does not erase the draft buffer.
4077 This is useful for sending multiple messages, which are a little different
4079 (@code{wl-draft-send})
4082 @kindex C-c C-c (Draft)
4083 @findex wl-draft-send-and-exit
4084 Sends the content of the current draft and erases the draft buffer.
4085 (@code{wl-draft-send-and-exit})
4088 @kindex C-x C-s (Draft)
4089 @findex wl-draft-save
4090 Save the current draft.
4091 (@code{wl-draft-save})
4094 @kindex C-c C-k (Draft)
4095 @findex wl-draft-kill
4096 Kills the current draft.
4097 (@code{wl-draft-kill})
4100 @kindex C-x k (Draft)
4101 @findex wl-draft-mimic-kill-buffer
4102 Kills the current draft.
4103 (@code{wl-draft-mimic-kill-buffer})
4106 @kindex C-c C-z (Draft)
4107 @findex wl-draft-save-and-exit
4108 Saves the current draft, and erases the draft buffer.
4109 This is useful if you want to suspend editing of the draft.
4110 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4111 the @samp{+draft} folder.
4112 (@code{wl-draft-save-and-exit})
4115 @kindex C-c C-r (Draft)
4116 @findex wl-caesar-region
4117 Encodes or decodes the specified region in Caesar cipher.
4118 (@code{wl-caesar-region})
4122 @findex wl-draft-highlight-and-recenter
4123 Recenter and rehighlight current draft.
4124 (@code{wl-draft-highlight-and-recenter})
4128 @findex wl-toggle-plugged
4129 Toggles off-line/on-line states of Wanderlust.
4130 (@code{wl-toggle-plugged})
4133 @kindex C-c C-o (Draft)
4134 @findex wl-jump-to-draft-buffer
4135 Jumps to the other draft buffer, if exists.
4136 With prefix argument, reads a file (if any) from the draft folder when
4137 there is no such buffer.
4138 (@code{wl-jump-to-draft-buffer})
4141 @kindex C-c C-e (Draft)
4142 @findex wl-draft-config-exec
4143 Applies @code{wl-draft-config-alist}.
4144 (@code{wl-draft-config-exec})
4147 @kindex C-c C-j (Draft)
4148 @findex wl-template-select
4150 (@code{wl-template-select})
4153 @kindex C-c C-a (Draft)
4155 Enter Address Manager.
4156 @xref{Address Manager}.
4160 @section Customizable Variables
4163 @item wl-subscribed-mailing-list
4164 @vindex wl-subscribed-mailing-list
4165 The initial setting is @code{nil}. Mailing lists to which you
4166 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4167 field of a reply draft, removes your own address from
4168 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4169 contained in @samp{To:} or @samp{Cc:} field of a message to be
4170 automatically re-filed, the destination folder will be leaned in
4171 connection with the address.
4177 (setq wl-subscribed-mailing-list
4178 '("wl@@lists.airs.net"
4180 "emacs-mime-ja@@m17n.org"))
4184 @item wl-insert-mail-followup-to
4185 @vindex wl-insert-mail-followup-to
4186 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4187 field is automatically inserted in the draft buffer.
4189 @item wl-insert-mail-reply-to
4190 @vindex wl-insert-mail-reply-to
4191 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4192 field is automatically inserted in the draft buffer.
4194 @item wl-auto-insert-x-face
4195 @vindex wl-auto-insert-x-face
4196 The initial setting is @code{t}. If non-nil and there is an encoded
4197 X-Face string in a file @file{~/.xface} (the value of the variable
4198 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4199 draft buffer. If @code{nil}, it is not automatically inserted.
4201 @item wl-insert-message-id
4202 @vindex wl-insert-message-id
4203 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4204 is automatically inserted on the transmission.
4206 @item wl-local-domain
4207 @vindex wl-local-domain
4208 The initial setting is @code{nil}. If @code{nil}, the return value of
4209 the function @code{system-name} will be used as the domain part of
4212 If @code{system-name} does not return FQDN (i.e. the full name of the
4213 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4214 to the string of the local domain name without hostname (like
4215 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4216 @samp{.} @code{wl-local-domain} is used as domain part of the
4219 If your terminal does not have global IP, set the value of
4220 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4221 you use invalid @samp{Message-ID:}.)
4223 Moreover, concatenation of @code{system-name} @samp{.}
4224 @code{wl-local-domain} will be used as an argument to the HELO command
4227 @item wl-message-id-domain
4228 @vindex wl-message-id-domain
4229 The initial setting is @code{nil}. If non-nil, this value is used as a
4230 domain part of the @samp{Message-ID:}. If your terminal does not have
4231 global IP address, set unique string to this value (e.x. your e-mail
4234 @item wl-message-id-domain
4235 @vindex wl-message-id-domain
4236 The initial setting is @code{nil}. If @code{nil}, the return value of
4237 the function @code{system-name} will be used as the domain part of
4238 @samp{Message-ID:}. If @code{system-name} does not return FQDN
4239 (i.e. the full name of the host, like @samp{smtp.gohome.org}), you
4240 @strong{must} set this variable to the string of the full name of the
4241 host. Otherwise, you might be beaten up on the Net News.
4243 @item wl-draft-config-alist
4244 @vindex wl-draft-config-alist
4245 The initial setting is @code{nil}. Modifies the draft message just
4246 before the transmission. The content of @code{wl-draft-config-alist}
4247 will be automatically applied only once on the transmission. If you
4248 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4251 @item wl-template-alist
4252 @vindex wl-template-alist
4253 The initial setting is @code{nil}.
4254 This variable specifies the template to be applied in the draft buffer.
4256 @item wl-draft-config-matchone
4257 @vindex wl-draft-config-matchone
4258 The initial setting is @code{nil}. If non-nil, only the first matching
4259 item is used when @code{wl-draft-config-alist} is applied. If
4260 @code{nil}, all matching items are used.
4262 @item wl-template-visible-select
4263 @vindex wl-template-visible-select
4264 The initial setting is @code{t}.
4265 If non-nil, you can preview the result of the template selection in
4268 @item wl-template-confirm
4269 @vindex wl-template-confirm
4270 The initial setting is @code{nil}.
4271 If non-nil, asks for confirmation when you press the enter key to select
4272 template while previewing.
4274 @item wl-template-buffer-lines
4275 @vindex wl-template-buffer-lines
4276 The initial setting is 7.
4277 If @code{wl-template-visible-select} is non-nil, this variable specifies
4278 the size of the preview window.
4280 @item wl-draft-reply-buffer-style
4281 @vindex wl-draft-reply-buffer-style
4282 The initial setting is @code{split}. @code{split} or @code{full} can be
4283 specified. In the case of @code{full}, the whole frame will be used for
4284 a reply draft buffer when it is prepared.
4286 @item wl-draft-use-frame
4287 @vindex wl-draft-use-frame
4288 The initial setting is @code{nil}.
4289 If non-nil, use new frame for the draft.
4291 @item wl-draft-truncate-lines
4292 @vindex wl-draft-truncate-lines
4293 The initial value is the value of @code{default-truncate-lines}.
4294 If it is non-nil, truncate long lines in draft buffer.
4298 The initial setting is the value of the variable
4299 @code{user-mail-address}. The value of this variable is inserted as a
4300 @samp{From:} field of the draft when it is prepared.
4302 @item wl-envelope-from
4303 @vindex wl-envelope-from
4304 The initial setting is @code{nil}.
4305 The value of this variable is used for envelope from (MAIL FROM).
4306 If @code{nil}, the address part of @code{wl-from} is used.
4308 @item wl-user-mail-address-list
4309 @vindex wl-user-mail-address-list
4310 The initial setting is @code{nil}.
4311 This is the User's address list. If you have multiple addresses,
4316 The initial setting is @code{nil}.
4317 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4318 the draft when it is prepared. If function is specified, its return
4323 The initial setting is @code{nil}.
4324 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4325 the draft when it is prepared.
4327 @item wl-reply-subject-prefix
4328 @vindex wl-reply-subject-prefix
4329 The initial setting is @samp{Re: }.
4330 In the @samp{Subject:} of the reply draft, this string is prepended to
4331 the @samp{Subject:} of being replied.
4333 @item wl-draft-reply-use-address-with-full-name
4334 @vindex wl-draft-reply-use-address-with-full-name
4335 The initial setting is @code{t}.
4336 If non-nil, insert her full name with address when prepare a draft for
4337 reply a message. If it is @code{nil}, insert her address only.
4339 @item wl-draft-enable-queuing
4340 @vindex wl-draft-enable-queuing
4341 The initial setting is @code{t}.
4342 This flag controls off-line transmission. If non-nil, the draft is
4345 @item wl-draft-use-cache
4346 @vindex wl-draft-use-cache
4347 The initial setting is @code{nil}. If the value is non-nil and
4348 @code{wl-insert-message-id} is nil, cache the message which is sent.
4350 @item wl-auto-flush-queue
4351 @vindex wl-auto-flush-queue
4352 The initial setting is t.
4353 This flag controls automatic transmission of the queue when Wanderlust
4354 becomes on-line. If non-nil, the queue is automatically transmitted
4355 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4356 manually, press @kbd{F} in the folder mode.
4358 @item wl-ignored-forwarded-headers
4359 @vindex wl-ignored-forwarded-headers
4360 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4361 All headers that match this regexp will be deleted when forwarding a message.
4363 @item wl-ignored-resent-headers
4364 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4365 All headers that match this regexp will be deleted when resending a message.
4367 @item wl-draft-always-delete-myself
4368 @vindex wl-draft-always-delete-myself
4369 If non-nil, always removes your own address from @samp{To:} and
4370 @samp{Cc:} when you are replying to the mail addressed to you.
4372 @item wl-draft-delete-myself-from-bcc-fcc
4373 @vindex wl-draft-delete-myself-from-bcc-fcc
4374 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4375 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
4377 @item wl-smtp-posting-server
4378 @vindex wl-smtp-posting-server
4379 The initial setting is @code{nil}.
4380 This is the SMTP server name for mail transmission.
4382 @item wl-smtp-posting-user
4383 @vindex wl-smtp-posting-user
4384 The initial setting is @code{nil}.
4385 This is the user name for SMTP AUTH authentication. If @code{nil},
4386 @code{smtp-authenticate-user} is used.
4388 @item wl-smtp-authenticate-type
4389 @vindex wl-smtp-authenticate-type
4390 The initial setting is @code{nil}.
4391 This is the authentication method for SMTP AUTH authentication. If
4392 @code{nil}, @code{smtp-authenticate-type} is used. If
4393 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4396 @item wl-smtp-connection-type
4397 @vindex wl-smtp-connection-type
4398 The initial setting is @code{nil}.
4399 This variable specifies how to establish SMTP connections.
4400 If @code{nil}, @code{smtp-connection-type} is used.
4401 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4403 @item wl-nntp-posting-server
4404 @vindex wl-nntp-posting-server
4405 The initial setting is @code{nil}.
4406 This is the NNTP server name used for news submission.
4407 If @code{nil}, @code{elmo-nntp-default-server} is used.
4409 @item wl-nntp-posting-user
4410 @vindex wl-nntp-posting-user
4411 The initial setting is @code{nil}.
4412 This is the user name for AUTHINFO authentication on news submission.
4413 If @code{nil}, @code{elmo-nntp-default-user} is used.
4414 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4416 @item wl-nntp-posting-port
4417 @vindex wl-nntp-posting-port
4418 The initial setting is @code{nil}.
4419 This is the port number of the NNTP server used for news submission.
4420 If @code{nil}, @code{elmo-nntp-default-server} is used.
4422 @item wl-nntp-posting-stream-type
4423 @vindex wl-nntp-posting-stream-type
4424 The initial setting is @code{nil}.
4425 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4426 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4427 connection will be established.
4429 @item wl-pop-before-smtp-user
4430 @vindex wl-pop-before-smtp-user
4431 The initial setting is @code{nil}.
4432 This is the POP user name for POP-before-SMTP.
4433 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4435 @item wl-pop-before-smtp-server
4436 @vindex wl-pop-before-smtp-server
4437 The initial setting is @code{nil}.
4438 This is the POP server name for POP-before-SMTP.
4439 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4441 @item wl-pop-before-smtp-authenticate-type
4442 @vindex wl-pop-before-smtp-authenticate-type
4443 The initial setting is @code{nil}.
4444 This is the authentication method for POP-before-SMTP authentication.
4445 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4447 @item wl-pop-before-smtp-port
4448 @vindex wl-pop-before-smtp-port
4449 The initial setting is @code{nil}.
4450 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4451 @code{elmo-pop3-default-port} is used.
4453 @item wl-pop-before-smtp-stream-type
4454 @vindex wl-pop-before-smtp-stream-type
4455 The initial setting is @code{nil}.
4456 This flag controls the use of SSL for POP-before-SMTP. If it is
4457 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4458 STARTTLS (RFC2595) connection will be established.
4460 @item wl-draft-queue-save-variables
4461 @vindex wl-draft-queue-save-variables
4462 Specifies a list of variable to which queued messages are saved on the
4463 off-line transmission.
4465 @item wl-draft-sendlog
4466 @vindex wl-draft-sendlog
4467 The initial setting is @code{t}.
4468 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4472 @item drafts are sent by smtp or qmail
4473 @item saved into folders by fcc
4474 @item saved into folders by queuing
4477 (it is written even if the transmission fails).
4478 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4479 and left to the logging function of @command{imput}.
4482 @item wl-draft-sendlog-max-size
4483 @vindex wl-draft-sendlog-max-size
4484 The initial setting is 20000 (in bytes).
4485 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4486 beyond the size specified by this variable.
4490 The initial setting is @code{nil}.
4491 If non-nil, address completion uses LDAP.
4493 @item wl-ldap-server
4494 @vindex wl-ldap-server
4495 The initial setting is @samp{localhost}.
4496 LDAP server name for address completion.
4499 @vindex wl-ldap-port
4500 The initial setting is @code{nil}.
4501 If non-nil, the value is used as port number.
4504 @vindex wl-ldap-base
4505 The initial setting is @samp{c=US}.
4506 LDAP search starting point (base) for address completion.
4508 @item wl-draft-remove-group-list-contents
4509 @vindex wl-draft-remove-group-list-contents
4510 The initial setting is @code{t}.
4511 If non-nil, remove the group-lists' members in the recipients when
4512 sending the message (group-list means the description such as
4513 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4516 @node Disconnected Operations, Expire and Archive, Draft, Top
4517 @chapter Off-line Management
4518 @cindex Disconnected Operations
4520 Wanderlust has on-line and off-line states.
4523 * Off-line State:: Wanderlust has on-line and off-line states
4524 * Enable Operations:: Enable Disconnected Operations
4525 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4526 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4527 * Variables of Plugged Mode:: Customize Plugged Mode
4531 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4532 @section Off-line State
4534 Wanderlust has on-line and off-line states. In the off-line state, you
4535 cannot access messages via network, unless they are cached.
4537 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4538 in the mode line indicates the off-line state. In folder or summary
4539 modes, press @kbd{M-t} to switch between off- and on-line.
4541 You can invoke Wanderlust in the off-line state by setting
4542 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4544 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4545 ignores uncached messages.
4548 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4549 @section Enable Disconeected Operations
4551 Even in the off-line state, provided that relevant messages are cached,
4552 and the variable @code{elmo-enable-disconnected-operation} (described
4553 later) is non-nil, you can following operations:
4554 @xref{Plugged Mode}, @xref{Off-line State settings}.
4557 * Send Messages off-line:: Transmit Messages
4558 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4559 * Creation of Folders:: Create Folders off-line (IMAP4)
4560 * Marking:: Mark (IMAP4)
4561 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4564 As soon as Wanderlust becomes on-line, such operations invoked off-line
4565 are reflected in the servers via network.
4568 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4569 @subsection Transmission of Messages
4571 You can send mail/news messages off-line (if you are using
4572 @file{im-wl.el}, it is irrelevant). Messages sent off-line are
4573 accumulated in the queue folder, @samp{+queue}. These messages are
4574 transmitted at once when Wanderlust becomes on-line.
4576 You can visit @samp{+queue} in the off-line state and confirm content of
4577 messages in the queue. You can also remove messages. Removed messages
4578 are not transmitted even in the on-line state.
4581 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
4582 @subsection Re-file and Copy (IMAP4)
4584 Re-file and copy operations to IMAP folders invoked during the off-line
4585 state are accumulated in the queue, and reflected in the server side
4586 when Wanderlust becomes on-line. If you visit destination folders after
4587 off-line re-file or copy, it looks as if messages were appended even in
4590 For the safety reasons, messages re-filed off-line are removed from
4591 source folders only if their @samp{Message-ID:} match messages on the
4592 servers. While the queue is processed, messages that failed to be
4593 re-filed or copied to the specified folders are appended to the folder
4597 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
4598 @subsection Creation of Folders (IMAP4)
4600 You can create IMAP folders off-line. The creation of folders are
4601 reflected in the servers when Wanderlust becomes on-line. At that time,
4602 if folders failed to be created on the servers for any reasons, messages
4603 re-filed to such folders are appended to the folder @samp{+lost+found}.
4606 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
4607 @subsection Marking (IMAP4)
4609 Off-line changes in unread/read and importance mark @samp{$} information
4610 are also reflected in the servers when Wanderlust becomes on-line.
4613 @node Pre-fetching Reservations, , Marking, Enable Operations
4614 @subsection Pre-fetching (IMAP4, NNTP)
4616 You can make reservations for pre-fetching messages in IMAP or NNTP
4617 folders. Reserved messages are marked with @samp{!} but not cached
4618 yet. When Wanderlust becomes on-line, they are pre-fetched from
4621 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
4622 these off-line operations for IMAP4 and NNTP do not take place, and
4623 off-line re-file, copy or suchlike simply results in error.
4625 Because off-line operations use cache files, it is a bad idea to erase
4626 them by hand; it may cause Wanderlust to malfunction.
4628 If you want to remove caches, be sure to execute @kbd{M-x
4629 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
4630 remove caches for messages relevant to off-line operations.
4633 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
4634 @section Switching On-line/Off-line per Server/Port
4636 @kbd{M-t} described above switches networking states as a whole, but you
4637 can switch on-line/off-line per server/port.
4639 Pressing @kbd{C-t} in the folder or summary modes brings you in
4640 wl-plugged-mode shown below, in which you can change the plugged state
4645 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
4648 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
4649 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
4651 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
4652 %inbox(delete-msgids:1) @dots{}@r{dop queue}
4658 The first line indicates status of the following three variables, and
4659 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
4660 column modifies the values of these variables.
4664 "Queuing" @code{wl-draft-enable-queuing}
4665 "AutoFlushQueue" @code{wl-auto-flush-queue}
4666 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
4670 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
4673 The second and after lines indicate on-line/off-line states of servers
4674 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
4675 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
4676 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
4678 @dfn{sending queue} means messages accumulated in the folder
4679 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
4680 off-line operations when @code{elmo-enable-disconnected-operation} is
4682 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
4683 @c off-line operations are enabled.
4685 They are displayed if there are any of them. In the example above, in
4686 the sending queue there are two messages (the first and the second in
4687 the queue folder) for smtp to hosta and one (the third) for nntp to
4688 hosta, and in the dop queue there are one for @samp{%inbox} and two for
4691 If you change @samp{(wl-plugged)} in the second line, the variable
4692 @code{wl-plugged} is changed, so that the mode line indicator and
4693 plugged states of all ports are affected. If you change plugged states
4694 of any servers or ports, @samp{(wl-plugged)} in the second line is
4695 affected depending on @code{elmo-plugged-condition} settings and the
4696 plugged state of each port.
4699 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
4700 @section Invoking Wanderlust in the Off-line State
4702 As described before, if you set @code{wl-plugged} to @code{nil} in
4703 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
4704 off-line state. You can specify off-line state on a per server or port
4705 basis. Refer to @code{wl-reset-plugged-alist} also.
4707 Usually, when Wanderlust starts up, the plugged state of each port is
4708 read from @file{~/.folder} and @code{wl-smtp-posting-server},
4709 @code{wl-nntp-posting-server} and so on. If you want to change the
4710 plugged state of these ports or to add other ports, configure
4711 @code{wl-make-plugged-hook} with a function.
4715 (add-hook 'wl-make-plugged-hook
4717 (elmo-set-plugged plugged-value(t/nil) server port)
4718 ;; @r{add or change plugged states of the port of the server}
4719 (elmo-set-plugged plugged-value(t/nil) server)
4720 ;; @r{if the port is omitted, all ports are affected}
4721 ;; @r{(you cannot omit the port if you newly add the server)}
4727 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
4728 @section Customizable Variables
4733 If this variable is set to @code{nil}, Wanderlust starts up in off-line
4734 mode from the beginning.
4736 @item wl-queue-folder
4737 @vindex wl-queue-folder
4738 The initial setting is @samp{+queue}.
4739 This is the folder in which messages in the transmission queue are
4742 @item wl-auto-flush-queue
4743 @vindex wl-auto-flush-queue
4744 The initial setting is @code{t}.
4745 This flag controls automatic transmission of the queue when Wanderlust
4746 becomes on-line. If non-nil, the queue is automatically transmitted
4747 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4748 manually, press @kbd{F} in the folder mode.
4750 @item elmo-enable-disconnected-operation
4751 @vindex elmo-enable-disconnected-operation
4752 The initial setting is @code{nil}. Controls off-line operations
4753 regarding IMAP4. If non-nil, off-line operations are carried out.
4755 @item elmo-lost+found-folder
4756 @vindex elmo-lost+found-folder
4757 The initial setting is @samp{+lost+found}.
4758 This is the folder to which messages are saved when they fails to be
4759 appended while the off-line re-file/copy queue is processed.
4761 @item elmo-plugged-condition
4762 @vindex elmo-plugged-condition
4763 The initial setting is @code{one}.
4764 The value of @code{wl-plugged} reflects the return value of the function
4765 @code{elmo-plugged-p} (without arguments).
4766 This variable @code{elmo-plugged-condition} specifies the condition on
4767 which the return value of @code{(elmo-plugged-p)} should be t depending on the
4768 plugged state of each port.
4771 'one : plugged if one or more ports are plugged.
4772 'all : plugged if all ports are plugged.
4773 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
4774 states of the ports.
4775 @var{function} : reflects the return value of the @var{function}
4776 functions available per default
4777 'elmo-plug-on-by-servers
4778 : reflects the plugged state of the servers specified by the
4779 variable elmo-plug-on-servers.
4780 'elmo-plug-on-by-exclude-servers
4781 : reflects the plugged state of the servers that are not
4782 in elmo-plug-on-exclude-servers.
4783 elmo-plug-on-exclude-servers defaults to
4786 (system-name)without the domain part)
4792 (setq elmo-plugged-condition 'all)
4794 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
4795 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
4797 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
4798 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
4802 @item wl-reset-plugged-alist
4803 @vindex wl-reset-plugged-alist
4804 The initial setting is @code{t}. If non-nil, plugged states are
4805 initialized on a per server or port basis when Wanderlust starts up.
4807 If @code{nil}, plugged states are retained while Emacs is running. In
4808 other words, they are initialized when Emacs is restarted even if the
4809 value is @code{nil}.
4813 @node Expire and Archive, Scoring, Disconnected Operations, Top
4814 @chapter Automatic Expiration and Archiving of Messages
4815 @cindex Expire and Archive
4818 * Expire:: Expiration and Archiving
4819 * Archive:: Archiving All Messages
4823 @node Expire, Archive, Expire and Archive, Expire and Archive
4825 @cindex Expire Message
4827 Expiration means deletion of old messages which have outlasted a
4828 certain period of time.
4830 @code{wl-expire} supports not only simple deletion, but also moving to
4831 specified archiving folders.
4835 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
4836 or @kbd{M-e} in the summary mode.
4838 @subsection Configuring @code{wl-expire-alist}
4840 An example configuration of @code{wl-expire-alist} is shown below.
4841 Everything in this @code{wl-expire-alist} makes a great difference in
4842 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
4843 to @code{t}, especially in the initial stage.
4847 (setq wl-expire-alist
4848 '(("^\\+trash$" (date 14) remove)
4850 ("^\\+tmp$" (date 7) trash)
4851 ;; @r{re-file to @code{wl-trash-folder}}
4852 ("^\\+outbox$" (number 300) "$outbox;lha")
4853 ;; @r{re-file to the specific folder}
4855 ;; @r{do not expire}
4856 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
4857 ;; @r{archive by message number (retaining numbers)}
4858 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
4859 ;; @r{archive by a fixed number (retaining numbers)}
4860 ("^\\+diary$" (date 30) wl-expire-archive-date)
4861 ;; @r{archive by year and month (numbers discarded)}
4866 Items in the list has the format of:
4869 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
4873 The folder is examined if it matches @var{regexp-for-folders} from the
4874 beginning of the list. If you invoke expiration on the folder that does
4875 not match any of them, nothing will happen. And if either the second or
4876 the third element of the item is @code{nil}, expiration will not take
4879 You can use any one of the following for
4880 @var{specification-of-message-to-be-deleted}:
4883 @item (number @var{n1} [@var{n2}])
4884 deletes messages depending on the number of messages in the folder.
4886 @var{n1} is the number of messages which should survive deletion, for example
4887 if its value is 500, the newest 500 messages survive and the rests are
4890 @var{n2} is the number of messages in the folder on which expiration should
4891 take place, which defaults to @var{n1} + 1. For example if its value is 510,
4892 folders with 510 or more messages are expired.
4893 If you configured automatic expiration, frequently used folders may
4894 expire every time it receive messages, and you may be annoyed with the
4895 long delay in reading mail.
4896 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
4897 expiration would not take place until a certain number of messages
4900 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
4901 with important/new/unread) are not deleted.
4902 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
4903 will expire so as to have 500 messages including such ones.
4904 Otherwise, it will have 500 messages except such ones.
4906 @item (date @var{d1})
4907 deletes messages depending on the dates.
4909 Messages dated @var{d1} or more days ago are deleted, for example if its
4910 value is seven, messages seven days old or more are deleted. Note that
4911 the date is the one in the @samp{Date:} field of the message, not when
4912 the message entered the folder.
4914 Messages with no or invalid @samp{Date:} field does not expire; you
4915 might have to delete them by hand.
4918 You can use any one of the following in the place of @var{destination}:
4922 deletes the messages instantly.
4925 hide the messages from summary (messages are not deleted).
4928 moves the messages to @code{wl-trash-folder}.
4930 @item @var{string}(folder)
4931 moves the messages to the folder specified with @var{string}.
4933 It would be useful for specifying an archiving folder, but because this
4934 does not move important messages, it might be better to use the
4935 standard functions described below.
4937 @item @var{function}
4938 invokes the specified @var{function}.
4940 To the @var{function}, three arguments are passed: a folder name, a list
4941 of messages to be deleted, and msgdb information of the summary. You
4942 can specify function-specific arguments after the name of the
4943 @var{function}. Note that the list contains messages with marks in
4944 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
4947 These are three standard functions; they moves messages to an archive
4948 folder in the specified way. This means old messages can be compressed
4949 and saved in a file, being deleted from the original folder.
4952 @item wl-expire-archive-number1
4953 re-files to archiving folders corresponding to the message numbers of
4954 the messages being deleted. For example, a message numbered 102 will be
4955 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
4956 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
4957 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
4959 The archiving folders to which messages are re-filed are determined by
4960 the name of the folder as follows (in this case, archiving folders are
4961 handled as if @code{elmo-archive-treat-file} were non-nil).
4964 @item If the folder type is localdir:
4965 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
4967 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
4968 (@file{~/Mail/ml/wl-00100.zip}).
4970 @item The folder type is other than localdir:
4971 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
4973 For example, @samp{%#mh/ml/wl} corresponds to
4974 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
4977 As you can see, in the case of localdir, the folder type is not included
4978 in the path name, but otherwise it is included.
4979 And you can control the prefix to the archiving folder name by
4980 @code{wl-expire-archive-folder-prefix}.
4981 Refer to @code{wl-expire-archive-folder-prefix} for details.
4983 @item wl-expire-archive-number2
4984 re-files every certain number of messages to archiving folders.
4986 This differs from @samp{wl-expire-archive-number1} in that this re-files
4987 to the folder up to the specified number regardless of message numbers.
4988 The archiving folders to which messages are re-filed are determined in the
4989 same way as @code{wl-expire-archive-number1}.
4991 @item wl-expire-archive-date
4992 re-files messages depending on its date (year and month) to archive
4995 For example, a message dated December 1998 is re-filed to
4996 @code{$folder-199812;zip}. The name of the archiving folders except the
4997 date part are determined in the same way as
4998 @code{wl-expire-archive-number1}.
5001 You can set the first argument to these three standard functions to non-nil
5002 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5003 For example, it can be specified just after the name of the function:
5006 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5009 If you omit the argument, consecutive numbers from 1 are assigned for
5010 each archiving folder.
5013 @subsection Treatment for Important or Unread Messages
5015 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5016 standard function, messages with marks in
5017 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5018 messages} thereafter) are retained.
5020 Per default, this variable include the important, new, and unread marks,
5021 so that messages with these marks are not removed.
5022 Note that you cannot include the temporary mark (i.e. temporary marks
5023 are removed anyway), and be sure to process temporary marks before you
5026 @subsection Auto Expiration
5028 The following setup invokes expiration when you move into the summary
5029 mode. There will be no confirmation, so make sure you made no mistake
5030 in regexp and other settings before you set up this.
5034 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5038 In the folder mode, you can invoke expiration per group as well as per
5039 folder. Therefore, if you specify @samp{Desktop} group, all folders
5040 matching @code{wl-expire-alist} expire.
5044 @subsection Treating archive folders.
5045 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5046 you must set non-nil value to @code{elmo-archive-treat-file}.
5048 @subsection Confirming
5050 If you are to use @code{remove}, try @code{trash} at first and see
5051 messages move to @code{wl-trash-folder} as expected, then replace it
5052 with @code{remove}. It would be dangerous to use @code{remove} from the
5055 If you are to use @code{wl-expire-archive-number1} and the like, try to
5056 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5057 you can append messages to it. Even if settings in
5058 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5059 would not be saved anywhere and disappeared in case the archiver program
5062 After you make sure you can archive to the folder correctly, you can
5063 invoke expiration and utilize the log.
5065 If you set @code{wl-expire-use-log} to @code{t},
5066 @file{~/.elmo/expired-log} should contain the log, for example:
5070 delete +ml/wl (593 594 595 596 597 598 599)
5071 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5075 The first column indicates the operation, i.e. @samp{delete},
5076 @samp{copy}, or @samp{move}. The next is the name of the folder that
5077 expired. In the case of @samp{copy} and @samp{move}, the destination
5078 folder is recorded after @samp{->}. The last is the list of message
5079 numbers that are actually deleted or moved (in the case of @samp{copy}
5080 and @samp{move}, the number is the one in the source folder, rather than
5081 the destination folder).
5083 @subsection Re-filing Reserved Messages
5085 The three standard functions copy reserved messages to the archive
5086 folder, but do not delete them from the source folder. Because
5087 reserved messages and the like always remain, they are recorded in
5088 @file{~/.elmo/expired-alist} so that they are not copied over and over
5089 again. They are not recorded if copied by @code{wl-summary-archive}.
5091 If you enabled logging, usually @samp{move} is recorded for re-filing,
5092 but instead @samp{copy} and @samp{delete} are recorded separately if
5093 reserved messages are involved. This is because it actually copies
5094 messages including reserved, then deletes ones except reserved in that
5097 @section Customizable Variables
5100 @item wl-expire-alist
5101 @vindex wl-expire-alist
5102 The initial setting is @code{nil}.
5103 This variable specifies folders and methods to expire. For details,
5104 refer to @code{wl-expire-alist} settings above.
5106 @item wl-summary-expire-reserve-marks
5107 @vindex wl-summary-expire-reserve-marks
5108 The initial setting is the list below.
5112 (list wl-summary-important-mark
5114 wl-summary-unread-mark
5115 wl-summary-unread-uncached-mark
5116 wl-summary-unread-cached-mark)
5120 Messages with these marks are retained in the folder, even after
5122 Only permanent marks can be listed, not temporary marks.
5124 You can list marks one by one as in the default; you can use the
5125 following settings as well:
5129 All messages with permanent marks are retained,
5130 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5134 All messages are handled as usual ones that are already read, no matter
5135 what marks they have; even important messages are deleted.
5138 @item wl-expire-archive-files
5139 @vindex wl-expire-archive-files
5140 The initial setting is 100.
5141 This variable specifies the number of messages to be retained in one
5144 @item wl-expire-number-with-reserve-marks
5145 @vindex wl-expire-number-with-reserve-marks
5146 The initial setting is @code{nil}.
5147 If non-nil, if expiring messages are specified by @code{number},
5148 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5150 @item wl-expire-archive-get-folder-function
5151 @vindex wl-expire-archive-get-folder-function
5152 The initial setting is @code{wl-expire-archive-get-folder}.
5154 This variable specifies a function that returns the name of an archiving
5155 folder for standard functions in the place of @var{destination}.
5156 You can use the following three variables for simple modification of
5157 folder names; if you want more complex settings, define your own
5158 function in this variable.
5160 @code{wl-expire-archive-get-folder} can be customized by these
5163 @item @code{wl-expire-archive-folder-name-fmt}
5164 @item @code{wl-expire-archive-folder-type}
5165 @item @code{wl-expire-archive-folder-prefix}
5168 @item wl-expire-archive-folder-name-fmt
5169 @vindex wl-expire-archive-folder-name-fmt
5170 The initial setting is @samp{%s-%%05d;%s}.
5171 This is a @code{format} string for archiving folders used in
5172 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5173 Note that you must specify the message number by @samp{%%d}, because it
5174 is parsed twice by @code{format}.
5176 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5179 @item wl-expire-archive-date-folder-name-fmt
5180 @vindex wl-expire-archive-date-folder-name-fmt
5181 The initial setting is @samp{%s-%%04d%%02d;%s}.
5182 This is a @code{format} string for archiving folders used in
5183 @code{wl-expire-archive-date}. Note that you must specify the message
5184 number by @samp{%%d}, because it is parsed twice by @code{format}.
5185 There should be @samp{%%d} twice, one for the year and the other for the
5188 If you modify this, adjust
5189 @code{wl-expire-archive-date-folder-num-regexp} as well.
5191 @item wl-expire-archive-folder-type
5192 @vindex wl-expire-archive-folder-type
5193 The initial setting is @code{zip}.
5194 This variable specifies an archiver type of the archiving folders.
5196 @item wl-expire-archive-folder-prefix
5197 @vindex wl-expire-archive-folder-prefix
5198 The initial setting is @code{nil}.
5199 This variable specifies the prefix (directory structure) to archiving
5201 Exercise extreme caution in using this feature, as it has not been
5203 In the worst case, there is a fear of destructing archiving folders.
5207 There will be no prefix.
5210 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5211 @samp{$ml/wl-00000;zip;wl}.
5214 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5217 @samp{$ml/wl-00000;zip;ml/wl}.
5220 @item wl-expire-archive-folder-num-regexp
5221 @vindex wl-expire-archive-folder-num-regexp
5222 The initial setting is @samp{-\\([-0-9]+\\);}.
5223 This variable specifies the regular expression to be used for getting
5224 message numbers from multiple archiving folders specified by
5225 @code{elmo-list-folders}.
5226 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5228 @item wl-expire-archive-date-folder-num-regexp
5229 @vindex wl-expire-archive-date-folder-num-regexp
5230 The initial setting is @samp{-\\([-0-9]+\\);}.
5231 This is the regular expression to be used for getting message numbers
5232 from multiple archiving folders specified by @code{elmo-list-folders}.
5233 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5235 @item wl-expire-delete-oldmsg-confirm
5236 @vindex wl-expire-delete-oldmsg-confirm
5237 The initial setting is @code{t}.
5238 If non-nil, messages older than the one with the largest number will be
5239 deleted with confirmation.
5240 If @code{nil}, they are deleted without confirmation.
5242 This feature is valid only if non-nil is specified as a argument to the
5243 standard functions so as to retain numbers.
5245 @item wl-expire-use-log
5246 @vindex wl-expire-use-log
5247 The initial setting is @code{nil}.
5248 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5249 They are appended but not truncated or rotated automatically; you might
5250 need to remove it manually.
5252 @item wl-expire-add-seen-list
5253 @vindex wl-expire-add-seen-list
5254 The initial setting is @code{t}.
5256 If non-nil, when messages are re-filed by expiration, read/unread
5257 information is passed to the destination folder.
5259 However if you do not read the destination folder from Wanderlust,
5260 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5261 want to set this to @code{nil} if you are simply saving to some
5262 archiving folders. Even if its value is @code{nil}, messages in the
5263 archiving folders are simply treated as unread; it does not affect
5266 @item wl-expire-folder-update-msgdb
5267 @vindex wl-expire-folder-update-msgdb
5268 The initial setting is @code{t}.
5269 If @code{t}, in the folder mode, expiration is carried out after
5270 updating summary information. If you specified a list of regular
5271 expressions of folder names, summary information is updated for matching
5276 @node Archive, , Expire, Expire and Archive
5277 @section Archiving Messages
5279 @subsection Archiving Messages
5280 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5281 folders. If there are the archiving folders already, only new messages
5284 You can use @code{wl-archive-alist} in order to specify how messages are
5285 archived according to their folder names, as in @code{wl-expire-alist}.
5290 (setq wl-archive-alist
5291 '(("^\\+tmp$" wl-archive-date)
5292 ("^\\+outbox$" wl-archive-number2)
5293 (".*" wl-archive-number1)))
5297 Each item in the list has the following format:
5300 (@var{folders-regexp} @var{deleting-function})
5303 As you can see, you can only use a function after @var{folders-regexp}.
5304 Per default, there are three functions:
5307 @item @code{wl-archive-number1}
5308 @item @code{wl-archive-number2}
5309 @item @code{wl-archive-date}
5312 As inferred from their names, they work similarly to "expire" versions,
5313 other than the following points:
5316 @item No messages are deleted
5317 @item Message numbers are retained even if invoked without arguments
5320 These functions are good to archive all messages in a folder by their
5321 numbers or by their dates.
5322 These are also useful for backup or confirmation purposes before
5324 If you try to re-file them after they are archived, they are deleted but
5327 Per default, the archiving folders to which messages are copied are
5328 determined automatically by @code{wl-expire-archive-get-folder-function}.
5329 You can copy to a specific folder by invoking with a prefix argument,
5330 i.e. @kbd{C-u M-x wl-summary-archive}.
5332 Note that this feature has not been seriously tested, because you can
5333 simply copy to an archiving folder, for example by
5334 @code{wl-summary-copy-region}.
5336 The archiving folders are determined by the same logic as in
5337 @code{wl-summary-expire}; the following customizable variables are
5341 @item @code{wl-expire-archive-files}
5342 @item @code{wl-expire-archive-get-folder-function}
5343 @item @code{wl-expire-archive-folder-name-fmt}
5344 @item @code{wl-expire-archive-folder-type}
5345 @item @code{wl-expire-archive-folder-prefix}
5346 @item @code{wl-expire-archive-folder-num-regexp}
5349 @subsection Customizable Variables
5352 @item wl-archive-alist
5353 @vindex wl-archive-alist
5354 The initial setting is the list shown below:
5358 ((".*" wl-archive-number1))
5363 This variable specifies a function that copies to archiving folders.
5364 To the function, three arguments are passed: a folder name, a list of
5365 messages in the folder, and msgdb information of the summary.
5366 Needless to say, you can use your own function.
5370 @node Scoring, Address Book, Expire and Archive, Top
5371 @chapter Score of the Messages
5373 @c @cindex Kill File
5375 Scoring is the function that associates a score (value) with each
5376 message, and marks as read or deletes from the summary according to it.
5378 You can put target or important marks on essential messages, or read marks
5379 on the ones you do not want to read, for example spam articles.
5381 This scoring function has a capability and a format similar to the one
5382 that Gnus has, although there are some unsupported features and
5383 Wanderlust specifics.
5384 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5387 * Score Commands:: Score Commands
5388 * Score File Format:: Score File Format
5392 @node Score Commands, Score File Format, Scoring, Scoring
5393 @section Score Commands
5394 @cindex Score Commands
5396 @subsection Score File Specification
5398 @code{wl-score-folder-alist} specifies score files or variables in which
5399 scores are defined, corresponding to folder names.
5403 (setq wl-score-folder-alist
5412 If paths to the score files are omitted, the directory specified in the
5413 variable @code{wl-score-files-dir} is assumed.
5415 No matter what you write in @code{wl-score-folder-alist}, the default
5416 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5417 read (it does not have to exist).
5418 Therefore, in the example above, the three score files,
5419 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5420 the folders that matches @samp{^-.*}.
5422 @subsection Scored Messages
5424 Scores are attached to the messages that are specified by
5425 @code{wl-summary-score-marks} temporarily when the summary is updated;
5426 when you exit from the summary, the scores are removed and reverts to
5429 @subsection Creation of Score Files
5431 In the summary buffer, move to an appropriate message and type @kbd{L}.
5432 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5433 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5435 This makes @minus{}1000 are scored for messages with the same
5436 @samp{Subject:} as the string you entered. That is, such a score file
5437 is created automatically.
5439 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5440 The score file you just made appears.
5441 This buffer is called @dfn{score editing buffer} thereafter.
5442 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5443 as you are previously; type @kbd{a}. Then a score entry for "From"
5445 In this way, you can create a score file easily either in the summary
5446 buffer or in the score editing buffer.
5448 By the way, you might be aware the numbers of key strokes are different
5449 between @kbd{s s p} and @kbd{a}.
5450 This is determined by @code{wl-score-header-default-entry}.
5451 This variable specifies the default score entries corresponding to
5453 For example, for "subject" field, a type and a time limit are prompted,
5454 but for "from" field, they are fixed upon automatically as substring and
5455 permanent respectively.
5456 However, score values can be modified by the prefix argument.
5457 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5460 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5461 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5462 erasing contents of the buffer deletes the score file being edited.
5466 @subsubsection Selecting Score Files
5468 You can change score files to which scores are appended by
5469 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5470 @code{wl-score-change-score-file}.
5472 @subsubsection Summing Up the Score
5474 If you add the same entries by @code{wl-summary-increase-score},
5475 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5476 scores for the entry is summed up.
5478 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5479 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5480 @minus{}1200 will be created as a result.
5482 @subsubsection Creating Thread Key
5484 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5485 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5487 @subsubsection Creating Followup Key
5489 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5490 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5491 at the cursor to @samp{References} key.
5492 If @code{wl-score-auto-make-followup-entry} is non-nil,
5493 @samp{Message-ID} of all messages to be followed up within dates
5494 specified by @code{wl-score-expiry-days}.
5496 @subsection Key Bindings
5501 @findex wl-summary-increase-score
5502 Increases the score for the current message.
5503 And the score entry is appended to the score file at the same moment.
5504 You can specify the score value by a prefix argument.
5508 @findex wl-summary-lower-score
5509 Decreases the score for the current message.
5510 And the score entry is appended to the score file at the same moment.
5511 You can specify the score value by a prefix argument.
5514 @kindex h R (Summary)
5515 @findex wl-summary-rescore
5516 Re-applies the scoring.
5517 However, already scored messages are not scored anew.
5520 @kindex h c (Summary)
5521 @findex wl-score-change-score-file
5522 Changes the score file currently selected.
5525 @kindex h e (Summary)
5526 @findex wl-score-edit-current-scores
5527 Edits the score file currently selected.
5528 If there are multiple score files, the previously specified one is
5532 @kindex h f (Summary)
5533 @findex wl-score-edit-file
5534 Edits an arbitrary score file and selects it.
5537 @kindex h F (Summary)
5538 @findex wl-score-flush-cache
5539 Erases caches associated to the score files that are read.
5540 If you modified score files directly (from other than Wanderlust), you
5541 need to re-read them after erasing the cache.
5544 @kindex h m (Summary)
5545 @findex wl-score-set-mark-below
5546 Specifies the criterion for scores to be marked as read.
5547 Messages with scores less than this value are marked as read.
5550 @kindex h x (Summary)
5551 @findex wl-score-set-expunge-below
5552 Specifies the criterion for scores to be deleted from the summary.
5553 Messages with scores less than this value are deleted.
5554 "Deleted" means it is not shown; they are not removed from the summary
5555 information or the folder.
5556 The deleted messages can be shown by rescan-noscore again.
5559 @subsection Key Bindings in the Score Editing Buffer
5563 @kindex C-c C-k (Score Mode)
5564 @findex wl-score-edit-kill
5565 Abandons the file being edited.
5568 @kindex C-c C-c (Score Mode)
5569 @findex wl-score-edit-exit
5570 Saves the file being edited, and quits from the edit mode.
5573 @kindex C-c C-p (Score Mode)
5574 @findex wl-score-pretty-print
5578 @kindex C-c C-d (Score Mode)
5579 @findex wl-score-edit-insert-date
5580 Inserts the number of dates from Dec. 31, 1 B.C.
5581 It is used for creating the third factor of time-limited scores.
5584 @kindex C-c C-s (Score Mode)
5585 @findex wl-score-edit-insert-header
5586 Inserts the header of the message selected in the summary buffer.
5589 @kindex C-c C-e (Score Mode)
5590 @findex wl-score-edit-insert-entry
5591 Inserts the score entry of the message selected in the summary buffer.
5594 @subsection Customizable Variables
5597 @item wl-summary-default-score
5598 @vindex wl-summary-default-score
5599 The initial setting is 0 (zero).
5600 This variable specifies the default value of the score.
5601 The score is increased or decreased based upon this value.
5603 @item wl-summary-important-above
5604 @vindex wl-summary-important-above
5605 The initial setting is @code{nil}.
5606 Messages with scores larger than this value are attached with the
5607 important mark (@samp{$}).
5608 If @code{nil}, no important marks are attached.
5610 @item wl-summary-target-above
5611 @vindex wl-summary-target-above
5612 The initial setting is @code{nil}.
5613 Messages with scores larger than this value are attached with the target
5615 If @code{nil}, no target marks are attached.
5617 @item wl-summary-mark-below
5618 @vindex wl-summary-mark-below
5619 The initial setting is 0 (zero).
5620 Messages with scores smaller than this value are marked as read.
5622 @item wl-summary-expunge-below
5623 @vindex wl-summary-expunge-below
5624 The initial setting is @code{nil}.
5625 Messages with scores smaller than this value are deleted from the
5627 If @code{nil}, they are not deleted.
5629 @item wl-summary-score-marks
5630 @vindex wl-summary-score-marks
5631 The initial setting is the list shown below:
5635 (list wl-summary-new-mark)
5640 Messages with these marks are scored.
5642 @item wl-use-scoring
5643 @vindex wl-use-scoring
5644 The initial setting is t.
5645 If non-nil, scoring is enabled.
5647 @item wl-score-files-dir
5648 @vindex wl-score-files-dir
5649 The initial setting is @file{~/.elmo/}.
5650 The default directory for score files.
5652 @item wl-score-interactive-default-score
5653 @vindex wl-score-interactive-default-score
5654 The initial setting is 1000.
5655 This value is used as a score when a score factor is @code{nil} in the
5656 score file. It is also used in @code{wl-summary-increase-score} and
5657 @code{wl-summary-lower-score}, on condition that the value of
5658 @code{wl-score-header-default-entry} is @code{nil}.
5660 @item wl-score-expiry-days
5661 @vindex wl-score-expiry-days
5662 The initial setting is 7.
5663 This is the number of days before time-limited scores are deleted.
5665 @item wl-score-update-entry-dates
5666 @vindex wl-score-update-entry-dates
5667 The initial setting is @code{t}.
5668 If non-nil, it enables deletion of time-limited scores.
5670 @item wl-score-header-default-entry
5671 @vindex wl-score-header-default-entry
5672 Specifies the default value for each header field for score entries
5673 created by @code{wl-summary-increase-score},
5674 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
5676 @item wl-score-simplify-fuzzy-regexp
5677 @vindex wl-score-simplify-fuzzy-regexp
5678 In the case of a type of a score entry is @code{fuzzy}, this specifies a
5679 regular expression to be deleted from the string.
5680 Because this is usually used for Subject, the default is prefixes that
5681 are attached by mailing list programs.
5683 @item wl-summary-rescore-partial-threshold
5684 @vindex wl-summary-rescore-partial-threshold
5685 The initial setting is 200.
5686 When sync-all or rescan is executed, if there are messages more than
5687 this value, only the last same number of messages as this value are
5690 @item wl-summary-auto-sync-marks
5691 @vindex wl-summary-auto-sync-marks
5692 If non-nil, unread/important marks are synchronized when the summary
5694 Unread marks reflect information on the IMAP4 server.
5695 Important marks reflect information on the IMAP4 server (flagged or
5696 not), and contents of @samp{'mark} folder.
5697 The initial setting is @code{t}.
5701 @node Score File Format, , Score Commands, Scoring
5702 @section Score File Format
5703 @cindex Score File Format
5705 The format of score files are the same as Gnus, and basically you can
5706 use Gnus score files as they are. But they are not fully compatible
5707 because some keys are not supported and there are Wanderlust specifics.
5708 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
5713 ("for sale" -1000 nil s)
5714 ("profit" -1000 nil s))
5716 ("spam@@spamspamspam" -10000 nil s))
5718 ("my@@address" 3001 nil s))
5720 (1000000 -10 nil >))
5730 If the key is a string, it is the name of the header to be matched.
5731 The following keys are available:
5732 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
5733 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
5734 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
5735 @code{Chars} and @code{Lines} mean the size and the number of lines of
5736 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
5737 are described later.
5738 The rest corresponds the field of the same name.
5740 Arbitrary numbers of core entries are specified after the key.
5741 Each score entry consists of these five factors:
5745 A factor that matches header. This should be a number in the cases of
5746 @code{lines} and @code{chars}, otherwise a string.
5749 A score factor. When the first item matches, the score of the message
5750 is increased or decreased by this value.
5753 A time limiting factor. If @code{nil}, the score is permanent, and in the case
5754 of a number, the score is deleted if it does not match for days
5755 (@code{wl-score-expiry-days}) from the date specified by this.
5756 The date is since Dec. 31, 1 B.C.
5759 A type factor. This specifies the way the first factor matches.
5760 Available types depend on keys.
5763 @item From, Subject, References, Message-ID
5764 For these keys in string, @code{r} and @code{R} (regexp),
5765 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
5766 as well as @code{f} and @code{F} (fuzzy) can be used.
5767 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
5770 For these keys, the following five numerical relative operators can be
5771 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
5774 This key matches @code{From} header, and scores all follow-ups to the
5776 For example, it would be useful for increasing scores for follow-ups to
5779 You can use the same types as @code{From} except for @code{f}.
5780 And a @samp{Followup} entry is automatically appended to the score file.
5783 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
5784 A @samp{Thread} entry is automatically appended for each article that
5785 has @var{x} in the @code{References} header.
5786 You can make sure the whole thread including messages that does not have
5787 all ancestors @code{Message-ID} in @code{References} is scored.
5789 You can use the same types as @code{References} except for @code{f}.
5790 And a @samp{Thread} entry is automatically appended to the score file.
5794 A factor for extension header. This is meaningful only if the key is
5796 This specifies headers to be matched other than standard headers like
5797 @code{Subject} and @code{From}.
5798 Note that you should specify the header in
5799 @code{elmo-msgdb-extra-fields} also.
5800 Therefore it does not work in folders where extension headers cannot be
5805 The sum of these scores @emph{after all factors are applied} becomes the
5806 score of the message.
5808 @cindex Score File Atoms
5810 Messages with a score less than this value is marked as read.
5811 The default is @code{wl-summary-mark-below}.
5814 Messages with a score less than this value is deleted from the summary.
5815 The default is @code{wl-summary-expunge-below}.
5817 @item mark-and-expunge
5818 Both @code{mark} and @code{expunge} are applied,
5819 i.e. messages with a score less than this value is marked as read and
5820 deleted from the summary.
5823 Messages with a score greater than this value is attached with temp
5825 The default is @code{wl-summary-target-above}.
5828 Messages with a score greater than this value is attached with important
5830 The default is @code{wl-summary-important-above}.
5835 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
5836 are used, you need to set @code{elmo-msgdb-extra-fields}.
5839 (setq elmo-msgdb-extra-fields '("lines" "xref"))
5842 There are other restrictions as shown below:
5845 @item Because @samp{References} field in the summary information
5846 contains only the last @samp{Message-ID}, @code{references} key matches
5850 Keys that can be seen by folder of types:
5854 chars lines xref extra
5855 localdir,localnews Y E E E
5856 nntp (supporting xover) Y E E N
5862 N: cannot be seen (ignored)
5863 E: can be seen with @code{elmo-msgdb-extra-fields} settings
5868 @node Address Book, Customization, Scoring, Top
5869 @chapter Address Book
5870 @cindex Address Book
5872 With address book, you can utilize address completion, and you have
5873 summary displayed with nicknames.
5876 * Mail Addresses:: Definition of Address Book
5877 * Address Manager:: Address Manager
5880 @node Mail Addresses, Address Manager, Address Book, Address Book
5881 @section Address book
5882 @cindex Address book Definition
5884 @cindex Alias, Address
5886 The file @file{~/.addresses} is a simple address book for Wanderlust.
5887 Make address file @file{~/.addresses}, and edit to suit your requirement.
5889 The data written in @file{~/.addresses} are used for address completion
5890 under draft editing mode. Furthermore, they are used when showing names
5891 in summary display mode. You can safely skip this section, if you don't
5892 want to customize address completion and summary display.
5893 It is possible to add/change/remove addresses from @file{~/.addresses} in
5894 summary buffer after Wanderlust is invoked. @refill
5896 The format is very simple. Like this. @refill
5901 # @r{Lines begin with @samp{#} are comment.}
5902 # @r{Empty lines are ignored}
5904 # @r{Format of each line:}
5905 # @var{email-address} "@var{nickname} "@var{realname}"
5907 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
5908 foo@@bar.gohome.org "Mr. Foo" "John Foo"
5909 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
5914 One line defines one persons description.
5916 Actually, in default setup, @var{nickname} is used in summary-mode and
5917 @var{realname} is used in draft preparation mode. This behavior is
5918 better understood if you try it and confirmed the function first. You
5919 can write and try a small definition, so you will know the idea of the
5920 address book before writing a big one.
5922 And, if MH alias file is specified in variable @code{wl-alias-file},
5923 it is used as an address information in the draft preparation mode.
5925 If variable @code{wl-use-ldap} is non-nil (initial setting is
5926 @code{nil}), address completion in draft mode uses LDAP information.
5928 If you use LDAP, you have to set @code{wl-ldap-server},
5929 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
5930 not have LDAP feature as built-in feature (Currently only XEmacs can
5931 have built-in LDAP feature), you have to set command exec @env{PATH} to
5932 the program @command{ldapsearch}.
5935 @node Address Manager, , Mail Addresses, Address Book
5936 @section Address Manager
5937 @cindex Address Manager
5939 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
5940 the address book and insert address to draft buffer.
5942 @subsection Key Bindings
5946 @kindex t (Address Manager)
5947 @findex wl-addrmgr-set-to
5948 Add @samp{To:} mark.
5951 @kindex c (Address Manager)
5952 @findex wl-addrmgr-set-cc
5953 Add @samp{Cc:} mark.
5956 @kindex b (Address Manager)
5957 @findex wl-addrmgr-set-bcc
5958 Add @samp{Bcc:} mark.
5961 @kindex u (Address Manager)
5962 @findex wl-addrmgr-unmark
5966 @kindex x (Address Manager)
5967 @findex wl-addrmgr-apply
5969 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
5970 buffer and quit address manager. When no draft buffer, make new draft
5971 with insert marked addresses.
5973 If no mark, quit address manager.
5977 @kindex q (Address Manager)
5978 @findex wl-addrmgr-quit
5979 Quit address manager.
5982 @kindex a (Address Manager)
5983 @findex wl-addrmgr-add
5987 @kindex d (Address Manager)
5988 @findex wl-addrmgr-delete
5992 @kindex e (Address Manager)
5993 @findex wl-addrmgr-edit
5998 @node Customization, Mailing List, Address Book, Top
5999 @chapter Customizing Wanderlust
6000 @cindex Customization
6003 * Living with other packages:: Cooperating with other packages
6004 * Highlights:: Highlights
6005 * Biff:: Notify Mail arrival
6006 * Advanced Settings:: Advanced Settings
6007 * Customizable Variables:: Customizable Variables
6012 @node Living with other packages, Highlights, Customization, Customization
6013 @section Living with other packages
6015 Examples with other packages.
6018 * imput:: imput (im-wl.el)
6020 * supercite:: supercite.el
6021 * mu-cite:: mu-cite.el
6022 * X-Face:: x-face,bitmap-mule
6023 * dired-dd:: dired-dd.el
6025 * Addrbook:: Addrbook
6029 @node imput, BBDB, Living with other packages, Living with other packages
6034 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6037 If @command{imput} is on the @code{exec-path} at the installation,
6038 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6042 (autoload 'wl-draft-send-with-imput-async "im-wl")
6043 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6048 @node BBDB, supercite, imput, Living with other packages
6052 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6055 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6056 byte-compiled and installed.
6064 ;; @r{enable pop-ups}
6065 (setq bbdb-use-pop-up t)
6066 ;; @r{auto collection}
6067 (setq bbdb/mail-auto-create-p t)
6068 (setq signature-use-bbdb t)
6069 (setq bbdb-north-american-phone-numbers-p nil)
6070 ;; @r{shows the name of bbdb in the summary} :-)
6071 (setq wl-summary-from-function 'bbdb-wl-from-func)
6072 ;; @r{automatically add mailing list fields}
6073 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6074 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6078 @node supercite, mu-cite, BBDB, Living with other packages
6079 @subsection sc.el(supercite), sc-register.el
6083 The same setting as usual mailers should be OK. The following is an
6084 example of settings:
6088 (autoload 'sc-cite-original "sc" nil t)
6089 (setq mail-yank-hooks 'sc-cite-original)
6090 (setq sc-preferred-header-style 1)
6091 (setq sc-electric-references-p nil)
6092 (setq sc-citation-leader "")
6093 (setq sc-load-hook '(lambda () (require 'sc-register)))
6094 (setq sc-preferred-attribution 'registeredname)
6099 @node mu-cite, X-Face, supercite, Living with other packages
6100 @subsection mu-cite.el
6103 The same setting as usual mailers should be OK. The following is an
6104 example of settings.
6106 If you use mu-cite version 8.0 or earlier:
6110 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6111 (setq mail-citation-hook 'mu-cite/cite-original)
6115 If you use mu-cite version 8.1 or later:
6119 (autoload 'mu-cite-original "mu-cite" nil t)
6120 (add-hook 'mail-citation-hook (function mu-cite-original))
6124 @node X-Face, dired-dd, mu-cite, Living with other packages
6128 If you have installed one of the following, you can decode
6129 @samp{X-Face:} field in message buffer and you will see face image.
6132 * x-face-xmas:: XEmacs case
6133 * x-face-mule:: Emacs 19.34, 20.x case
6134 * x-face-e21:: Emacs 21.x case
6137 If there is an encoded X-Face string in a file @file{~/.xface} (the
6138 value of the variable @code{wl-x-face-file}), it is inserted as a
6139 @samp{X-Face:} field in the draft buffer (if
6140 @code{wl-auto-insert-x-face} is non-nil).
6142 @node x-face-xmas, x-face-mule, X-Face, X-Face
6143 @subsubsection x-face-xmas (for XEmacs)
6146 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6147 1.3.6.13 or later, do the following:
6151 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6152 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6156 @node x-face-mule, x-face-e21, x-face-xmas, X-Face
6157 @subsubsection x-face-mule (for Emacs 19.34, 20.x)
6161 If you use @file{x-face-mule.el} in bitmap-mule
6162 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6166 (autoload 'x-face-decode-message-header "x-face-mule")
6167 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6171 @node x-face-e21, , x-face-mule, X-Face
6172 @subsubsection x-face-e21 (for Emacs 21.x)
6175 If you use @file{x-face-e21.el} (@uref{ftp://jpl.org/pub/elisp/})
6176 with bitmap-mule (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}),
6182 (autoload 'x-face-decode-message-header "x-face-e21")
6183 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6188 @node dired-dd, MHC, X-Face, Living with other packages
6189 @subsection dired-dd(Dired-DragDrop)
6190 @pindex Dired-DragDrop
6192 @cindex Drag and Drop
6194 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6195 compose multi-part by simple Drag-and-Drop from dired to the draft
6196 buffer being edited in GNU Emacs (this feature is not Wanderlust
6197 specific, but general-purpose for SEMI).
6201 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6207 ;; @r{Set dired-x variables here.}
6208 ;; @r{To and flo@dots{}}
6210 (progn (require 'dired-dd)
6211 (require 'dired-dd-mime))))))
6215 @node MHC, Addrbook, dired-dd, Living with other packages
6219 Message Harmonized Calendaring system
6220 (@uref{http://www.quickhack.net/mhc/})
6222 By using MHC, you can make a calendar from the messages.
6228 (setq mhc-mailer-package 'wl)
6229 (autoload 'mhc-mode "mhc" nil t)
6230 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6231 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6239 (autoload 'mhc-wl-setup "mhc-wl")
6240 (add-hook 'wl-init-hook 'mhc-wl-setup)
6244 @node Addrbook, , MHC, Living with other packages
6245 @subsection wl-addrbook.el
6249 (@uref{http://www.mew.org/})
6251 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6252 @code{load-path} and do the following settings.
6256 (require 'wl-addrbook)
6261 @node Highlights, Biff, Living with other packages, Customization
6264 @subsection Customizable Variables
6267 @item wl-summary-highlight
6268 @vindex wl-summary-highlight
6269 The initial setting is @code{t}.
6270 If non-nil, the summary is highlighted.
6272 @item wl-highlight-max-summary-lines
6273 @vindex wl-highlight-max-summary-lines
6274 The initial setting is 10000.
6275 The summary is not highlighted if it has more lines than this value.
6277 @item wl-summary-highlight-partial-threshold
6278 @vindex wl-summary-highlight-partial-threshold
6279 The initial setting is 1000.
6280 This is a threshold whether the whole summary is highlighted.
6281 If there are more lines of messages in the summary, it is partially
6284 @item wl-summary-partial-highlight-above-lines
6285 @vindex wl-summary-partial-highlight-above-lines
6286 The initial setting is 30. If there are more lines of messages than
6287 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6288 after the point that is the same number of lines as this value above the
6289 cursor line are highlighted partially. (If this value is @code{nil},
6290 the last same number of lines as the value of
6291 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6293 @item wl-highlight-body-too
6294 @vindex wl-highlight-body-too
6295 The initial setting is @code{t}.
6296 If non-nil, bodies of drafts and messages are also highlighted.
6298 @item wl-highlight-message-header-alist
6299 @vindex wl-highlight-message-header-alist
6300 When highlighting headers of drafts and messages, this variable
6301 specifies which faces are allocated to important
6302 (@code{wl-highlight-message-important-header-contents}), secondly
6303 important (@code{wl-highlight-message-important-header-contents2}), and
6304 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6306 Similarly, it can be used for allocating arbitrary faces to arbitrary
6307 regular expressions.
6309 @item wl-highlight-citation-prefix-regexp
6310 @vindex wl-highlight-citation-prefix-regexp
6311 Specifies a regular expression to which quoted lines in bodies of
6312 drafts and messages match.
6313 Bodies matching to this regular expression are highlighted by the faces
6314 specified by (@code{wl-highlight-message-cited-text-*}).
6316 @item wl-highlight-highlight-citation-too
6317 @vindex wl-highlight-highlight-citation-too
6318 The initial setting is @code{nil}.
6319 If non-nil, the quoting regular expression itself given by
6320 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6322 @item wl-highlight-citation-header-regexp
6323 @vindex wl-highlight-citation-header-regexp
6324 Specifies a regular expression that denotes beginning of quotation.
6325 Bodies matching to this regular expression are highlighted by the face
6326 specified by @code{wl-highlight-message-headers}.
6328 @item wl-highlight-max-header-size
6329 @vindex wl-highlight-max-header-size
6330 The initial setting is @code{nil}. If a header size is larger than this
6331 value, it will not be highlighted. If @code{nil}, always highlighted
6332 (ignore header size).
6334 @item wl-highlight-max-message-size
6335 @vindex wl-highlight-max-message-size
6336 The initial setting is 10000.
6337 If a message is larger than this value, it will not be highlighted.
6338 With this variable, highlight is suppressed for uuencode or huge digest
6341 @item wl-highlight-signature-separator
6342 @vindex wl-highlight-signature-separator
6343 Specifies regular expressions that denotes the boundary of a signature.
6344 It can be a regular expression, or a list of ones.
6345 Messages after the place that matches this regular expression are
6346 highlighted by the face specified by
6347 @code{wl-highlight-message-signature}.
6349 @item wl-max-signature-size
6350 @vindex wl-max-signature-size
6351 The initial setting is 400.
6352 This is the largest size for a signature to be highlighted.
6354 @item wl-use-highlight-mouse-line
6355 @vindex wl-use-highlight-mouse-line
6356 The initial setting is @code{t}.
6357 If non-nil, the line pointed by the mouse is highlighted in the folder
6358 mode, summary mode, and the like.
6361 @subsection Setting Colors and Fonts of the Characters
6363 If you want to change colors or fonts of the characters, you need to
6364 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6365 want to change fonts, and @code{set-face-foreground} for colors, and so
6366 on. You cannot write face settings in @file{.emacs}; write in
6369 For example, if you want to change the color for signatures to yellow,
6373 (set-face-foreground 'wl-highlight-message-signature "yellow")
6379 Faces defined in Wanderlust:
6382 @item wl-highlight-message-headers
6383 The face for field names of message headers.
6385 @item wl-highlight-message-header-contents
6386 The face for field bodies of message headers.
6388 @item wl-highlight-message-important-header-contents
6389 The face for important parts of message headers.
6390 Per default, this face is used for a body of @samp{Subject:} field.
6391 You can change its value by editing
6392 @code{wl-highlight-message-header-alist}.
6394 @item wl-highlight-message-important-header-contents2
6395 The face for secondly important parts of message headers.
6396 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6397 fields. You can change its value by editing
6398 @code{wl-highlight-message-header-alist}.
6400 @item wl-highlight-message-unimportant-header-contents
6401 The face for unimportant parts of message headers.
6402 Per default, this face is used for bodies of @samp{X-} fields
6403 @samp{User-Agent:} fields. You can change its value by editing
6404 @code{wl-highlight-message-header-alist}.
6406 @item wl-highlight-message-citation-header
6407 The face for headers of quoted messages.
6409 @item wl-highlight-message-cited-text-*
6410 The face for texts of quoted messages. The last @samp{*} is a
6411 @var{single figure} so that 10 different colors can be used according to
6414 @item wl-highlight-message-signature
6415 The face for signatures of messages. The initial settings are
6416 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6417 dark background colors.
6419 @item wl-highlight-header-separator-face
6420 The face for header separators of draft messages.
6422 @item wl-highlight-summary-important-face
6423 The face for message lines with important marks in the summary.
6425 @item wl-highlight-summary-new-face
6426 The face for message lines with new marks in the summary.
6428 @item wl-highlight-summary-displaying-face
6429 The face for the message line that is currently displayed.
6430 This face is overlaid.
6432 @item wl-highlight-thread-indent-face
6433 The face for the threads that is currently displayed.
6435 @item wl-highlight-summary-unread-face
6436 The face for message lines with unread marks in the summary.
6438 @item wl-highlight-summary-deleted-face
6439 The face for message lines with delete marks in the summary.
6441 @item wl-highlight-summary-refiled-face
6442 The face for message lines with re-file marks in the summary.
6444 @item wl-highlight-refile-destination-face
6445 The face for re-file information part of message lines with re-file
6446 marks in the summary.
6448 @item wl-highlight-summary-copied-face
6449 The face for message lines with copy marks in the summary.
6451 @item wl-highlight-summary-target-face
6452 The face for message lines with target marks @samp{*} in the summary.
6454 @item wl-highlight-summary-thread-top-face
6455 The face for message lines that are on the top of the thread in the
6458 @item wl-highlight-summary-normal-face
6459 The face for message lines that are not on top of the thread in the
6462 @item wl-highlight-folder-unknown-face
6463 The face for folders that are not known to have how many unsync messages
6466 @item wl-highlight-folder-zero-face
6467 The face for folders that have no unsync messages in the folder mode.
6469 @item wl-highlight-folder-few-face
6470 The face for folders that have some unsync messages in the folder mode.
6472 @item wl-highlight-folder-many-face
6473 The face for folders that have many unsync messages in the folder mode.
6474 The boundary between `some' and `many' is specified by the variable
6475 @code{wl-folder-many-unsync-threshold}.
6477 @item wl-highlight-folder-unread-face
6478 The face for folders that have no unsync but unread messages in the
6481 @item wl-highlight-folder-killed-face
6482 The face for folders that are deleted from the access group in the
6485 @item wl-highlight-folder-opened-face
6486 The face for open groups in the folder mode.
6487 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6488 @code{nil} or a @var{number}.
6490 @item wl-highlight-folder-closed-face
6491 The face for close groups in the folder mode.
6492 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6493 @code{nil} or a @var{number}.
6495 @item wl-highlight-folder-path-face
6496 The face for the path to the currently selected folder in the folder
6499 @item wl-highlight-logo-face
6500 The face for logo in the demo.
6502 @item wl-highlight-demo-face
6503 The face for strings (for example, a version number) in the demo.
6507 @node Biff, Advanced Settings, Highlights, Customization
6508 @section Notify Mail arrival
6511 Following setting is to notify mail arrival of @samp{%inbox}
6512 by the indicator on the modeline
6515 (setq wl-biff-check-folder-list '("%inbox"))
6518 @subsection Customizable Variables
6520 @item wl-biff-check-folder-list
6521 @vindex wl-biff-check-folder-list
6522 The initial setting is @code{nil}.
6523 This is the list of folders to check mail arrival.
6524 If @code{nil}, wl doesn't check mail arrival.
6526 @item wl-biff-check-interval
6527 @vindex wl-biff-check-interval
6528 The initial setting is 40 (in seconds).
6529 Check mail arrival in this period.
6531 @item wl-biff-notify-hook
6532 @vindex wl-biff-notify-hook
6533 This hook is run at the arrival of new mail.
6534 To beep with mail arrival(initial setting), set as follows.
6536 (setq wl-biff-notify-hook '(ding))
6538 For silence, set to @code{nil}.
6542 @node Advanced Settings, Customizable Variables, Biff, Customization
6543 @section Advanced Settings
6546 * Draft for Reply:: Draft for Reply
6547 * Thread Format:: Appearance of Thread
6548 * User-Agent Field:: @samp{User-Agent:} Header Field
6552 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
6553 @subsection Draft for Replay
6554 @vindex wl-draft-reply-with-argument-list
6555 @vindex wl-draft-reply-without-argument-list
6556 @vindex wl-draft-reply-myself-with-argument-list
6557 @vindex wl-draft-reply-myself-without-argument-list
6559 If you want, when you replying to articles in mailing lists, the address
6560 in Reply-To field of the original message to be prepared to To field of
6561 the reply draft by simply pressing @kbd{a} in the summary mode, try the
6566 (setq wl-draft-reply-without-argument-list
6567 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
6568 ("Followup-To" . (nil nil ("Followup-To")))
6569 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
6570 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
6575 (Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
6576 in the original message, @samp{Reply-To:} field in the original is
6577 copied to @samp{To:} field.)
6579 Moreover, the behavior of @kbd{a} with prefix argument can
6580 be directed by @code{wl-draft-reply-with-argument-list} as well.
6582 Note: To set the behavior when you reply to the message written by yourself, use
6583 @code{wl-draft-reply-myself-without-argument-list} and
6584 @code{wl-draft-reply-myself-with-argument-list}
6587 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
6588 @subsection Appearance of Threads
6592 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
6593 390 09/18(Fri)07:25 +-[ Tsumura-san ]
6594 391 09/18(Fri)19:24 +-[ Murata-san ]
6595 392 09/20(Sun)21:49 +-[ Okunishi-san ]
6596 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
6597 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
6598 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
6599 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
6600 412 09/22(Tue)09:28 | +-[ Teranishi ]
6601 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
6602 416 09/22(Tue)12:38 | +-[ Teranishi ]
6603 395 09/20(Sun)21:49 +-[ Okunishi-san ]
6604 397 09/21(Mon)00:15 +-[ Okunishi-san ]
6608 Settings to make appearance of threads like shown above:
6612 (setq wl-thread-indent-level 2)
6613 (setq wl-thread-have-younger-brother-str "+")
6614 (setq wl-thread-youngest-child-str "+")
6615 (setq wl-thread-vertical-str "|")
6616 (setq wl-thread-horizontal-str "-")
6617 (setq wl-thread-space-str " ")
6621 If you do not want to see branches, do the following:
6625 (setq wl-thread-indent-level 2)
6626 (setq wl-thread-have-younger-brother-str " ")
6627 (setq wl-thread-youngest-child-str " ")
6628 (setq wl-thread-vertical-str " ")
6629 (setq wl-thread-horizontal-str " ")
6630 (setq wl-thread-space-str " ")
6635 @node User-Agent Field, , Thread Format, Advanced Settings
6636 @subsection User-Agent Field
6640 If you are eccentric enough to elaborate @samp{X-Mailer:} or
6641 @samp{User-Agent:} fields, define a function that generate appropriate
6642 strings as you like, and set it to variable
6643 @code{wl-generate-mailer-string-function}.
6645 If you do not want verbose @samp{User-Agent:} field, do the following:
6649 (setq wl-generate-mailer-string-function
6652 (concat "User-Agent: "
6653 (wl-generate-user-agent-string-1 nil)))))
6657 The following is a example:
6661 (setq mime-edit-insert-user-agent-field nil)
6662 (setq wl-generate-mailer-string-function
6665 (format "X-Mailer: %s" (product-string-1 'wl-version)))))
6670 @node Customizable Variables, Hooks, Advanced Settings, Customization
6671 @section Customizable Variables
6673 Customizable variables that have not been described yet:
6676 @item wl-default-folder
6677 @vindex wl-default-folder
6678 The initial setting is @samp{%inbox}. This is the default value for moving to
6679 a folder and the like.
6681 @item wl-draft-folder
6682 @vindex wl-draft-folder
6683 The initial setting is @samp{+draft}. It is the folder to which drafts are
6684 saved. It must be a localdir folder.
6686 @item wl-trash-folder
6687 @vindex wl-trash-folder
6688 The initial setting is @samp{+trash}. It is the wastebasket folder.
6689 If you changed this variable, you had better restart Wanderlust.
6691 @item wl-interactive-exit
6692 @vindex wl-interactive-exit
6693 The initial setting is @code{t}.
6694 If non-nil, you are asked for confirmation when Wanderlust terminates.
6696 @item wl-interactive-send
6697 @vindex wl-interactive-send
6698 The initial setting is @code{t}.
6699 If non-nil, you are asked for confirmation when mail is sent.
6701 @item wl-folder-sync-range-alist
6702 @vindex wl-folder-sync-range-alist
6703 The initial setting is the alist shown below:
6708 ("^\\+draft$\\|^\\+queue$" . "all"))
6713 This is an associative list of regular expressions of folder names and
6714 update range of the summary. Update range is one of the @samp{all},
6715 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
6716 @samp{last}. If a folder do not match, @samp{update} is used.
6719 @vindex wl-ask-range
6720 The initial setting is @code{t}.
6721 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
6722 for updating the summary when you changed folders.
6724 @item wl-mime-charset
6725 @vindex wl-mime-charset
6726 The initial setting is @code{x-ctext}.
6727 This is the MIME charset for messages that are not MIME (e.g. without
6728 @samp{Content-Type:}). This value also used as default charset for
6729 summary. (If you want to share Summary on Nemacs and other Emacsen, set
6730 this value as @code{iso-2022-jp}.)
6732 @item wl-highlight-folder-with-icon
6733 @vindex wl-highlight-folder-with-icon
6734 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
6735 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
6737 @item wl-strict-diff-folders
6738 @vindex wl-strict-diff-folders
6739 This is a list of regular expressions of folders.
6740 Unread messages are checked, for example when you press @kbd{s} in
6741 the folder mode, usually in a brief way (rapidly processed but not
6743 The folders matching this variable are seriously checked.
6744 You may want to set this variable so as to match conditional filter
6745 folders for IMAP4 folders.
6746 The initial setting is @code{nil}.
6748 @item wl-folder-use-server-diff
6749 @vindex wl-folder-use-server-diff
6750 When unread messages are checked, for example when you press @kbd{s} in
6751 the folder mode, usually (the number of messages on the server) @minus{}
6752 (the number of local messages) will be the number of unread messages.
6753 However, if this variable is non-nil, the number of unread messages on
6754 the server is checked. This affects IMAP4 folders only, but IMAP4
6755 folders in mail boxes matching
6756 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
6757 the number of unread messages on the server, even if they matches this
6758 variable. The initial setting is @code{t}.
6760 @item wl-auto-check-folder-name
6761 @vindex wl-auto-check-folder-name
6762 The initial setting is @code{nil}.
6763 If non-nil, the folder with the name of the value is checked for unread
6764 messages at the start.
6765 If it is @code{none}, no folders are checked.
6766 If it is a list, all folders in the list are checked at the start.
6768 @item wl-auto-uncheck-folder-list
6769 @vindex wl-auto-uncheck-folder-list
6770 The initial setting is the list shown below:
6779 Folders with the name matching this variable are not checked for unread
6780 messages at the start, even if they are included in the groups in
6781 @code{wl-auto-check-folder-name}.
6783 @item wl-auto-check-folder-list
6784 @vindex wl-auto-check-folder-list
6785 The initial setting is @code{nil}.
6786 Folders with the name matching this variable are always checked for
6787 unread messages at the start, if they are included in the groups in
6788 @code{wl-auto-check-folder-name}.
6789 This takes precedence over @code{wl-auto-uncheck-folder-list}.
6791 @item wl-no-save-folder-list
6792 @vindex wl-no-save-folder-list
6793 The initial setting is the list shown below:
6802 This is a list of regular expressions of folders not to be saved.
6804 @item wl-save-folder-list
6805 @vindex wl-save-folder-list
6806 The initial setting is @code{nil}.
6807 This is a list of regular expressions of folders to be saved.
6808 This takes precedence over @code{wl-no-save-folder-list}.
6810 @item wl-folder-mime-charset-alist
6811 @vindex wl-folder-mime-charset-alist
6812 The initial setting is the alist shown below:
6816 (("^-alt\\.chinese" . big5)
6817 ("^-relcom\\." . koi8-r)
6819 ("^-han\\." . euc-kr))
6824 This is an associative list of regular expressions of folder names and
6826 If a folder do not match, @code{wl-mime-charset} is used.
6828 @item wl-folder-init-load-access-folders
6829 @vindex wl-folder-init-load-access-folders
6830 The initial setting is @code{nil}.
6831 This is a list of access groups to be loaded specifically at the start.
6832 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
6834 @item wl-folder-init-no-load-access-folders
6835 @vindex wl-folder-init-no-load-access-folders
6836 The initial setting is @code{nil}.
6837 This is a list of access groups not to be loaded specifically at the
6839 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
6841 @item wl-delete-folder-alist
6842 @vindex wl-delete-folder-alist
6843 The initial setting is the alist shown below:
6852 This list determines disposition of messages with delete marks.
6853 Each item in the list is a folder and destination; you can specify any
6854 one of the following in the place of destination:
6857 @code{remove} or @code{null} : deletes the messages instantly.
6858 string : moves the messages to the specific folder.
6859 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
6862 @item wl-refile-policy-alist
6863 @vindex wl-refile-policy-alist
6864 The initial setting is the list shown below:
6874 This list determines whether messages with re-file marks are moved or
6875 copied. Each item in the list is a cons cell of a folder and
6876 @code{copy} or @code{move}.
6878 @item wl-x-face-file
6879 @vindex wl-x-face-file
6880 The initial setting is @file{~/.xface}.
6881 The name of the file that contains encoded X-Face strings.
6884 @item wl-demo-display-logo
6885 @vindex wl-demo-display-logo
6886 If non-nil, bitmap image is shown on the opening demo. If you set
6887 @code{xpm} or @code{xbm}, (if possible) display selected image type
6890 @item elmo-use-database
6891 @vindex elmo-use-database
6892 This is meaningful for XEmacs only. The initial setting depends on
6893 XEmacs (@code{t} for XEmacs with dbm).
6894 If non-nil, Message-ID is controlled by dbm.
6896 @item elmo-passwd-alist-file-name
6897 @vindex elmo-passwd-alist-file-name
6898 The initial setting is @file{passwd}.
6899 This is the name of the file in which passwords are saved.
6900 @code{elmo-passwd-alist-save} saves current passwords to the file.
6902 @item elmo-nntp-list-folders-use-cache
6903 @vindex elmo-nntp-list-folders-use-cache
6904 The initial setting is 600 (in seconds).
6905 This is period in seconds during which results of @samp{list} and
6906 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
6909 @item elmo-nntp-max-number-precedes-list-active
6910 @vindex elmo-nntp-max-number-precedes-list-active
6911 The initial setting is @code{nil}.
6912 If non-nil, the number of article obtained by @samp{list active} in NNTP
6913 are used as the maximum article number of the folder.
6914 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
6915 and if the number of read messages is not correct.
6917 @item elmo-nntp-default-use-listgroup
6918 @vindex elmo-nntp-default-use-listgroup
6919 The initial setting is @code{t}.
6920 If non-nil, @samp{listgroup} is used for checking the total number of
6921 articles. If it is @code{nil}, @samp{group} is used. In the latter
6922 case, the processing will be a little faster at the sacrifice of
6925 @item elmo-pop3-send-command-synchronously
6926 @vindex elmo-pop3-send-command-synchronously
6927 The initial setting is @code{nil}.
6928 If non-nil, POP3 commands are issued synchronously. Some implementation
6929 of POP3 server fails to get summary information without this setting.
6930 You may have to set this variable to @code{t}, if the process hangs
6931 while looking up POP3.
6933 @item elmo-dop-flush-confirm
6934 @vindex elmo-dop-flush-confirm
6935 The initial setting is @code{t}.
6936 If non-nil, you are asked for confirmation if accumulated off-line
6937 operations are executed.
6939 @item elmo-display-progress-threshold
6940 @vindex elmo-display-progress-threshold
6941 The initial setting is 20.
6942 Threshold for display of progress gauge. If number of renewal is more than
6943 this value, display progress gauge.
6947 @node Hooks, , Customizable Variables, Customization
6953 @node Mailing List, Addition, Customization, Top
6954 @chapter Wanderlust Mailing List
6959 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
6962 Topics related to Wanderlust are discussed in the mailing list.
6963 The latest version is also announced there (in Japanese, sorry).
6965 A guide can be obtained automatically by sending mail to
6966 @t{wl-ctl@@lists.airs.net} with the body
6971 Please send bug reports or patches to the mailing list. You can post to
6972 the mailing list even though you are not a member of it.
6974 If you send a bug report, please attach Backtrace with it.
6975 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
6978 I would like to express my thanks to the members of the mailing list for
6979 valuable advice and many pieces of code they contributed.
6982 @node Addition, Index, Mailing List, Top
6983 @chapter Additional Information
6985 @section Brief History
6988 1998 3/05 Tried to make a prototype that displays MH messages in threads.
6989 3/10 Made a msgdb mechanism by elisp.
6990 3/26 IMAP and NNTP can be displayed in threads.
6991 4/13 Began to assemble thread display modules as elmo.
6992 5/01 Finished 0.1.0, initial version with many defects.
6993 6/12 I made a slip of the tongue and said I was writing elisp
6994 mailer supporting IMAP
6995 6/16 0.1.3 was announced at tm-ja, elisp ML.
6996 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
6997 7/01 Support for mm-backend (0.3.0).
6998 8/25 multi folder added (0.5.0).
6999 8/28 filter folder added (0.5.1).
7000 9/10 You can open/close threads (0.6.0).
7001 9/11 fldmgr by Murata-san made editing folders easy.
7002 9/18 lha folders added by Okunishi-san (0.6.3).
7003 9/24 Display of branches of threads (0.6.5).
7004 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7005 10/28 Off-line operations (0.7.4).
7006 12/09 Becomes beta version.
7007 12/21 wl-expire by Murata-san.
7008 1999 2/03 auto-refile by Tsumura-san.
7009 4/28 wl-template by Murata-san.
7010 5/18 Released 1.0.0 stable.
7011 7/05 Scoring by Murata-san (2.1.0).
7012 9/26 New plugged system by Murata-san (2.2.2).
7013 12/20 Support Modified UTF7.
7014 2000 3/24 Released 1.1.0 stable.
7015 4/03 CVS development started.
7016 5/07 Thread restoration & Its speed up with Murata-san.
7017 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7018 7/11 killed message feature.
7019 7/18 Use UIDL in POP3.
7020 9/12 biff feature with Satata-san & Yamaoka-san.
7021 10/17 expire-hide by Okada-san.
7022 11/08 Released 2.4.0 stable.
7023 2001 7/04 Released 2.6.0 stable.
7024 8/21 wl-addrmgr by Kitamoto-san.
7027 See @file{ChangeLog} for details.
7031 According to a dictionary, Wanderlust has the meaning:
7035 n eager longing for or impulse towards travelling in distant lands
7036 [Ger, fr wandern to wander + lust desire, pleasure]
7040 but I had no profound intention. (if farfetched, IMAP @result{} you can
7041 read mail anywhere @result{} desire to wander ?)
7043 Elmo is the abbreviation of @samp{Elisp Library for Message
7044 Orchestration}. At first I meant the red puppet in the Sesame Street,
7045 but you may associate it with Wandering @result{} Drifting @result{}
7046 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7050 Each versions has code names (they are almost jokes).
7051 Currently they are picked up alphabetically from the top 40 hits of
7052 U.S. Billboard magazines in 1980s.
7054 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7057 @node Index, , Addition, Top
7061 * Concept Index:: Concept Index
7062 * Key Index:: Key Index
7063 * Variable Index:: Variable Index
7064 * Function Index:: Function Index
7067 @node Concept Index, Key Index, Index, Index
7068 @unnumberedsec Concept Index
7071 @node Key Index, Variable Index, Concept Index, Index
7072 @unnumberedsec Key Index
7075 @node Variable Index, Function Index, Key Index, Index
7076 @unnumberedsec Variable Index
7079 @node Function Index, , Variable Index, Index
7080 @unnumberedsec Function Index