1 \input texinfo @c -*-texinfo -*-
4 @settitle Wanderlust -- Yet Another Message Interface On Emacsen --
7 @documentencoding us-ascii
12 @dircategory GNU Emacs Lisp
14 * Wanderlust: (wl). Yet Another Message Interface On Emacsen
17 @c permissions text appears in an Info file before the first node.
19 This file documents Wanderlust, Yet another message interface on
22 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
23 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
24 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
25 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
27 This edition is for Wanderlust version @value{VERSION}.
29 Permission is granted to make and distribute verbatim copies of this
30 manual provided the copyright notice and this permission notice are
31 preserved on all copies.
34 Permission is granted to process this file through TeX and print the
35 results, provided the printed document carries copying permission notice
36 identical to this one except for the removal of this paragraph (this
37 paragraph not being relevant to the printed manual).
40 Permission is granted to copy and distribute modified versions of this
41 manual under the conditions for verbatim copying, provided that the
42 entire resulting derived work is distributed under the terms of a
43 permission notice identical to this one.
45 Permission is granted to copy and distribute translations of this manual
46 into another language, under the above conditions for modified versions.
52 @title Wanderlust User's Manual
53 @subtitle Yet another message interface on Emacsen
54 @subtitle for Wanderlust version @value{VERSION}
55 @author Yuuichi Teranishi
56 @author Fujikazu Okunishi
57 @author Masahiro Murata
59 @author Kaoru Takahashi
61 @author Masayuki Osada
62 @author Katsumi Yamaoka
64 @author Yoichi Nakayama
67 @vskip 0pt plus 1filll
68 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
69 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
70 @w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
71 @w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
73 This manual is for Wanderlust version @value{VERSION}.
75 Permission is granted to make and distribute verbatim copies of this
76 manual provided the copyright notice and this permission notice are
77 preserved on all copies.
79 Permission is granted to copy and distribute modified versions of this
80 manual under the conditions for verbatim copying, provided that the
81 entire resulting derived work is distributed under the terms of a
82 permission notice identical to this one.
84 Permission is granted to copy and distribute translations of this manual
85 into another language, under the above conditions for modified versions.
91 @node Top, Introduction, (dir), (dir)
92 @top Wanderlust User's Manual
107 This manual is for Wanderlust @value{VERSION}.
112 * Introduction:: Read this first
113 * Start Me Up:: Invoking Wanderlust
114 * Folders:: How to specify folders
115 * Folder:: Selecting and editing folders
116 * Summary:: Reading and refiling messages
117 * Message:: Saving and playing MIME multipart entities
118 * Draft:: Draft buffer, sending mail and news
119 * Disconnected Operations:: Off-Line management
120 * Expire and Archive:: Automatic expiration and archiving of messages
121 * Scoring:: Score of the messages
122 * Address Book:: Management of Address Book
123 * Customization:: Customizing Wanderlust
124 * Terminology:: Terminologies
125 * Mailing List:: Wanderlust mailing list
126 * Addition:: Additional Information
131 @node Introduction, Start Me Up, Top, Top
132 @chapter Introduction of Wanderlust
135 Wanderlust is an mail/news management system on Emacsen.
136 It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
138 The main features of Wanderlust:
141 @item Pure elisp implementation.
142 @item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
143 @item Unified access method to messages based on Mew-like Folder Specification.
144 @item Mew-like Key-bind and mark handling.
145 @item Manages unread messages.
146 @item Interactive thread display.
147 @item Folder Mode shows the list of subscribed folders.
148 @item Message Cache, Disconnected Operation (Read Only).
149 @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
150 @item MIME compliant (by SEMI).
151 @item Transmission of news and mail are unified by Message transmitting draft.
152 @item Graphical list of folders (XEmacs and Emacs 21).
153 @item View a part of message without retrieving the whole message (IMAP4).
154 @item Server-side message look up (IMAP4). Multi-byte characters are allowed.
155 @item Virtual Folders.
156 @item Supports compressed folder using common archiving utilities.
157 @item Old articles in folders are automatically removed/archived (Expiration).
158 @item Automatic re-file.
159 @item Template function makes it convenient to send fixed form messages.
165 We confirm Wanderlust works on following Emacsen:
168 @item Mule 2.3 based on Emacs 19.34
169 @item Emacs 20.2 or later
170 @item XEmacs 20.4 or later
171 @item Meadow 1.00 or later
172 @item NTEmacs 20.4 or later
176 IMAP4 connectivity with following imapd are confirmed to work with
180 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
181 @item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
182 @item Courier-IMAP 1.3.2 or later
183 @item AIR MAIL (AIRC imapd release 2.00)
185 @item Microsoft Exchange Server 5.5
186 @item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
189 LDAP connectivity with following LDAPd are confirmed to work with
193 @item OpenLDAP 2.0.6 or later
197 @node Start Me Up, Folders, Introduction, Top
198 @chapter Start up Wanderlust
201 The necessary procedure for starting Wanderlust is explained in steps
204 (Of course, you need a mail/news readable environment in advance)
207 * MIME Modules:: Installing the MIME modules
208 * Download:: Download and extract the packages
209 * Install:: Byte-compile and install
210 * Minimal Settings:: @file{.emacs} setup
211 * Folder Definition:: Folder definition
212 * Start Wanderlust:: Starting Wanderlust
213 * Overview:: Basic components of Wanderlust
217 @node MIME Modules, Download, Start Me Up, Start Me Up
218 @section Installing MIME modules
224 You must install SEMI beforehand to use Wanderlust.
226 SEMI can be downloaded from following site:
230 SEMI: ftp://ftp.m17n.org/pub/mule/semi/
234 You need packages named APEL and FLIM to use SEMI.
235 You can download APEL and FLIM from following URLs:
239 APEL: ftp://ftp.m17n.org/pub/mule/apel/
240 FLIM: ftp://ftp.m17n.org/pub/mule/flim/
244 You have to install APEL, FLIM and SEMI in this order. Generally,
245 @samp{make install} will do the job. (In XEmacs 21, @samp{make
248 Refer to the documents of each package for detailed installation
249 procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
250 @uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
254 Recommended combination of APEL, FLIM and SEMI are following:
257 @item APEL 10.3, FLIM 1.14.3 and SEMI 1.14.3
260 You can also use many other FLIM/SEMI variants. Combination of the
261 latest versions should work. For example, the following combination are
265 @item APEL 10.2, Chao 1.14.1, REMI 1.14.2
266 @item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
269 You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
272 @node Download, Install, MIME Modules, Start Me Up
273 @section Download and Extract the Package
276 You can download Wanderlust package from following sites:
280 ftp://ftp.gohome.org/wl/
283 Mirrored ftp/http sites:
287 ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
288 http://www.jpl.org/elips/wl/
289 http://www.ring.gr.jp/archives/text/elisp/wl/
290 ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
291 ftp://opaopa.org/pub/mirror/elisp/wl/
292 @c ftp://roguelife.org/pub/tsumura/wl/
296 Extract the obtained package to your working directory:
301 % tar zxvf wl-@var{version}.tar.gz
302 % cd wl-@var{version}
306 @subsection To use SSL (Secure Socket Layer)
311 SSL (Secure Socket Layer) can be used for
312 SMTP, IMAP, NNTP and POP connections in Wanderlust.
314 There are two ways to use SSL. One is to start SSL negotiation just
315 after the connection establishment (generic way). The other one is to
316 start SSL negotiation by invoking STARTTLS command in the each session.
318 To use the formal SSL (generic SSL), you must set @env{PATH} to the
319 directory that OpenSSL commands are installed.
321 To use the latter SSL(STARTTLS), you must install starttls package in
323 You can download starttls package from the following site.
326 ftp://opaopa.org/pub/elisp/
329 @node Install, Minimal Settings, Download, Start Me Up
330 @section Byte-compile and install
337 @subsection Installation
339 Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
340 Set the Emacs's command name to @code{EMACS}.
341 Set package installation directory to @code{LISPDIR}.
342 Then, please execute following commands.
351 Destination directory is auto-probed if you leave @code{LISPDIR}
352 in @file{Makefile} as is. (That is, leave it as @samp{NONE})
354 If you are using an Emacs variant which does not merge specified directory
355 to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
356 then you will see the error message:
359 Cannot open load file: mime-setup
363 In this case, either add destination directories of custom, APEL, FLIM
364 and SEMI to environmental variable @env{EMACSLOADPATH}, or define
365 @code{load-path} in @file{WL-CFG} in extracted directory.
367 If you want to handle shimbun folders or to use BBDB, add directory
368 where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
369 modules will be byte-compiled and installed.
370 @xref{Shimbun Folder}, @xref{BBDB}.
372 @subsection @file{WL-CFG}
374 Contents of the file @file{WL-CFG} is loaded under installation if a file
375 with that name exists in extracted directory. You can use @file{WL-CFG} to
376 configure @code{load-path} to extra packages such as SEMI if needed.
378 If you want to specify the install directory of Wanderlust related
379 files, then set following variables in @file{WL-CFG}
383 A directory to install WL modules.
384 This directory is relative directory from @code{LISPDIR}.
385 WL modules include @file{wl*.el}, @file{wl*.elc} files.
386 @c Modules under the directory @file{util/} are also installed if
387 @c it detected as necessary.
390 A directory to install ELMO modules.
391 This directory is relative directory from @code{LISPDIR}.
392 ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
393 @c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
397 Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
399 If you want to install ELMO related files under a sub-directory
400 such as "elmo" then add following to @file{WL-CFG}:
403 (setq ELMO_PREFIX "elmo")
406 @subsection Install as a XEmacs package
407 @cindex XEmacs package
408 @cindex XEmacs package install
409 @cindex Package, XEmacs
410 @cindex Package install, XEmacs
411 @c @cindex install-package
413 It is possible to install Wanderlust as one of packages of XEmacs (21.0
414 or later). Configuration for autoload and icon-path in local
415 @file{~/.emacs} files are no longer necessary, if you install Wanderlust
418 Follow the next example to install Wanderlust as an XEmacs package.
424 % make install-package
428 package directory is auto-probed, if SEMI is installed.
429 (you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
431 @subsection Run in place
433 If wl and elmo directories are defined in @code{load-path}, then
434 byte-compilation and installation are not necessary to start Wanderlust.
435 For example, if package is extracted in @file{~/work}, Wanderlust can be
436 invoked with following setting in @file{~/.emacs}.
440 (add-to-list 'load-path "~/work/wl-@var{version}/wl")
441 (add-to-list 'load-path "~/work/wl-@var{version}/elmo")
447 Manual is described in Info format. Please do following.
456 If you install Wanderlust as a XEmacs package, Info file is already
457 installed too, so there are no need of these commands.
459 Manual directory is automatically detected. Of course, it can be
460 configured by @code{INFODIR} in @file{Makefile}.
462 You can read manual at the following URL:
465 http://www.gohome.org/wl/doc/wl_toc.html
468 @node Minimal Settings, Folder Definition, Install, Start Me Up
469 @section Set up .emacs
470 @cindex Minimal Settings
472 @cindex Configuration
476 The Wanderlust package contains two module groups.
479 @item ELMO (elmo-*.el)
480 These modules show everything as folders. This is the back-end for WL.
482 These modules controls the behavior of main body of Wanderlust.
483 They are also the front-end for ELMO.
486 You can customize the behavior of Wanderlust by changing the value
487 of environmental variables which begins with @code{elmo-} and @code{wl-}.
489 The minimal requirement for settings is as the following.
493 ;; @r{autoload configuration}
494 ;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
495 (autoload 'wl "wl" "Wanderlust" t)
496 (autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
497 (autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
499 ;; @r{Directory where icons are placed.}
500 ;; @r{Default: the peculiar value to the running version of Emacs.}
501 ;; @r{(Not required if the default value points properly)}
502 (setq wl-icon-directory "~/work/wl/etc")
504 ;; @r{SMTP server for mail posting. Default: @code{nil}}
505 (setq wl-smtp-posting-server "your.smtp.example.com")
506 ;; @r{NNTP server for news posting. Default: @code{nil}}
507 (setq wl-nntp-posting-server "your.nntp.example.com")
511 @file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
512 file exists). So it is convenient to gather Wanderlust specific settings
513 in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
514 because you can't write them in @file{.emacs}
515 (if you write it to @file{.emacs}, you'll get an error).
518 All above described settings except autoload configuration can be written
521 @subsection @code{mail-user-agent}
522 @cindex Default Mailer
523 @cindex Mailer, Default
524 @vindex mail-user-agent
527 If you write following setting in your @file{~/.emacs}, you can
528 start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
529 This means it enables you to run Wanderlust as a default mail composer
532 It is effective only when your Emacs can define @code{mail-user-agent}.
533 @xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
537 (autoload 'wl-user-agent-compose "wl-draft" nil t)
538 (if (boundp 'mail-user-agent)
539 (setq mail-user-agent 'wl-user-agent))
540 (if (fboundp 'define-mail-user-agent)
541 (define-mail-user-agent
543 'wl-user-agent-compose
552 @node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
553 @section Folder Definition
554 @cindex Folder Definition
557 You can skip this section because it is possible to add/edit the
558 subscribe folders from the buffer for list of folders.
559 @xref{Folder Manager}.
561 Define the folders you want to subscribe in file @file{~/.folders}. The
562 contents written in @file{~/.folders} become the folders which you
563 subscribe to as it is.
565 Format for @file{~/.folders} is very simple. Here is an example:
570 # @r{Lines begin with @samp{#} are comment.}
571 # @r{Empty lines are ignored}
573 # @var{folder name} "@var{folder nickname}"
574 # @r{(nicknames are not necessary)}
579 %#mh/Backup@@my.imap.example.com "Sent"
582 %#mh/spool/wl "Wanderlust ML"
583 %#mh/spool/elips "ELIPS ML"
584 %#mh/spool/apel-ja "APEL Japanese ML"
585 %#mh/spool/xemacs-beta "XEmacs beta"
586 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
587 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
590 # @r{If folder name ends with @samp{/}, that means an `access group',}
591 # @r{all subfolders automatically included in one folder group.}
593 %#mh/expire@@localhost /
594 # @r{All MH folders are included in one folder group.}
599 Each line contains one folder you want to read. The definition of
600 folders will be explained in detail in the next section.
602 The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
603 become one folder group. One folder group is treated as a directory
604 which can be opened and closed in folder mode. It is convenient for
605 collecting some folders and putting them in order.
607 Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
608 line and you have to write it that way (It is because the parser sucks).
610 There are two types of groups. One is like @samp{Emacsen} from above
611 example which the user chooses his favorite folders as a group.
613 The other one is @dfn{access group} like @samp{+ /} from above example.
614 It collects all sub-folders in the folder to make a group. (Its
615 behavior differs by the type of the folder. For example, @samp{+}
616 followed by @samp{/} makes entire MH sub-directories to one group)
618 This behavior is better understood if you try it and confirmed the
619 function first. You can write and try a small folder definition, so you
620 will know the idea of the folder function before writing the real one.
622 @node Start Wanderlust, Overview, Folder Definition, Start Me Up
623 @section Start Wanderlust
624 @cindex Start Wanderlust
626 If installation and configuration worked well, you can invoke Wanderlust by
627 typing following command in Emacs.
634 After initialization, Folder Mode which shows the list of folders will
635 appear. That means the folders you defined in the @file{~/.folders} are
638 If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
639 can skip folder checking.
642 @node Overview, , Start Wanderlust, Start Me Up
646 Basically, you will handle messages in wanderlust while you come and go
647 from/to each of the following buffers. Details of each ones are
648 explained in following chapters.
652 You can see the list of folders. You can select some folder and go into the summary
653 of it. You can subscribe new folder or edit subscription list.
655 You can see the list of messages in the folder. You can select message
656 and view its contents, and reply to some message. You can delete ones or
657 move ones to another folder.
659 You can see the contents of the message. You can save part to disk or
660 open in external programs.
662 You can edit message.
666 @node Folders, Folder, Start Me Up, Top
667 @chapter Wanderlust's folders
670 This chapter describes the folder types which Wanderlust is able to handle.
672 Wanderlust uses ELMO as it's interface, so you can use every folder types
675 As of version @value{VERSION}, 11 types of folders are predefined. These are
676 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
677 Pipe and Internal folder types.
680 * IMAP Folder:: @samp{%} -- IMAP folder
681 * NNTP Folder:: @samp{-} -- NNTP folder
682 * MH Folder:: @samp{+} -- MH folder
683 * Maildir Folder:: @samp{.} -- Maildir folder
684 * News Spool Folder:: @samp{=} -- News spool folder
685 * Archive Folder:: @samp{$} -- Archive folder
686 * POP Folder:: @samp{&} -- POP folder
687 * Shimbun Folder:: @samp{@@} -- Shimbun Folder
688 * Namazu Folder:: @samp{[} -- Namazu Folder
689 * Multi Folder:: @samp{*} -- Multi folder
690 * Filter Folder:: @samp{/} -- Filter folder
691 * Pipe Folder:: @samp{|} -- Pipe folder
692 * Internal Folder:: @samp{'} -- Internal folder
696 @node IMAP Folder, NNTP Folder, Folders, Folders
704 A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
710 @samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
714 You can specify @code{login} (encoded password transmission),
715 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
716 authentication) or @code{clear} (or @code{nil}, plain password
717 transmission) as @var{authenticate-type}.
722 @var{username} -> The value of @code{elmo-imap4-default-user}.
723 Initial setting is @env{USER} environment variable or
724 @env{LOGNAME} environment variable or return value of
725 @code{(user-login-name)}.
726 @var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
727 Initial setting is "auth".
728 @var{hostname} -> The value of @code{elmo-imap4-default-server}.
729 Initial setting is "localhost".
730 @var{port} -> The value of @code{elmo-imap4-default-port}.
731 Initial setting is 143.
734 You can omit the @var{hostname} from folder names if you set
735 @code{elmo-imap4-default-server} as your main IMAP server.
736 For example, you can specify a folder as @samp{foo%imap@@gateway} even
737 if you have to go through a firewall.
741 ;; @r{Example: imap4.exaple.org as main IMAP server}
742 (setq elmo-imap4-default-server "imap4.example.org")
746 SSL (Secure Socket Layer) connection will be used if a folder name ends
747 with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
748 is @code{ssl}, SSL will be the default connection. If a folder name
749 ends with @samp{!!}, STARTTLS connection will be established. If the
750 value of @code{elmo-imap4-default-stream-type} is @code{starttls},
751 STARTTLS will be the default connection.
755 ;; @r{Example: Use SSL connection}
756 (setq elmo-imap4-default-stream-type 'ssl)
760 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
761 authentication method, the password is sent in encoded form. But, if
762 your server is unable to receive an encoded password, authentication
763 will fall back to @code{clear} (that is, sending password in raw format)
764 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
765 authentication will fall back to @code{clear} without confirmation
766 (default value is @code{nil}).
770 ;; @r{Example: password in raw format}
771 (setq elmo-imap4-default-authenticate-type 'clear)
779 %inbox -> IMAP mailbox "inbox"
780 %#mh/inbox -> IMAP mailbox "#mh/inbox"
782 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
783 %inbox:hoge/clear@@server1
784 -> server1's IMAP mailbox "inbox"
785 of user "hoge", with plain password authentication
790 @subsection International mailbox names (Modified UTF7)
791 @cindex Modified UTF7
798 You can use international mailbox names in @var{mailbox} part, if you
799 are using Emacs which can treat unicode and
800 @code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
801 value is @code{nil}).
803 Currently, following Emacsen can treat unicode.
806 @item Emacs 20.3 or later + Mule-UCS
808 If you installed Mule-UCS package, Emacs can treat unicode.
809 You can obtain Mule-UCS package from following URL.
812 ftp://ftp.m17n.org/pub/mule/Mule-UCS/
815 @item XEmacs 21.2.13 or later + ucs-conv package
817 By default, XEmacs 21 cannot treat unicodes, but if you installed
818 ucs-conv package, it can.
819 You can obtain ucs-conv package from following anonymous CVS.
823 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
824 Password: @var{NULL} (Just enter return key)
825 cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
829 You also need utf7 conversion programs, @command{u7tou8} and
830 @command{u8tou7} to use international mailbox name in the current
831 XEmacs. These programs are included in the UTF7 package which can be
832 obtained from following URL.
835 ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
840 @node NNTP Folder, MH Folder, IMAP Folder, Folders
851 A folder to access USENET news via NNTP protocol (RFC 977).
852 One newsgroup is treated as a folder.
858 @samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
864 @var{hostname} -> The value of @code{elmo-nntp-default-server}.
865 Initial setting is @samp{localhost}.
866 @var{username} -> The value of @code{elmo-nntp-default-user}.
867 Initial setting is @code{nil}.
868 @var{port} -> The value of @code{elmo-nntp-default-port}.
869 Initial setting is 119.
872 AUTHINFO is used as authentication method if the @var{username} is
873 non-nil. SSL will be default method if
874 @code{elmo-nntp-default-stream-type} is non-nil even if the folder name
875 doesn't end with @samp{!}. If a folder name ends with @samp{!!},
876 STARTTLS connection will be established. if the value of
877 @code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
878 be the default connection.
884 -fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
885 -fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
890 @node MH Folder, Maildir Folder, NNTP Folder, Folders
897 A folder to access MH format mail (1 file is 1 mail).
902 @samp{+} @var{directory-name}
905 Normally, @var{directory-name} is an relative path to the variable
906 @code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
907 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
908 (this is also true for drive-letters).
910 Message number is used for the name of the message file.
916 +inbox -> @file{~/Mail/inbox}
917 +from/teranisi -> @file{~/Mail/from/teranisi}
918 +~/test -> @file{~/test}
923 @node Maildir Folder, News Spool Folder, MH Folder, Folders
924 @section Maildir Folder
926 @cindex Maildir Folder
930 A folder to access Maildir format (1 file is 1 mail).
935 @samp{.} [@var{directory-name}]
938 Normally, @var{directory-name} is a relative path to the variable
939 @code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
940 starts with @samp{/} or @samp{~}, then it is treated as an absolute path
941 (this is also true for drive-letters).
943 Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
944 Messages are contained in the @file{cur} directory. All message files
945 in the @file{new} directory are moved to @file{cur} directory when you
946 access the folder. All message files contained in the @file{tmp}
947 directory and not accessed for 36 hours are deleted.
949 This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
955 . -> @file{~/Maildir}
956 .inbox -> @file{~/Maildir/inbox}
957 .from/teranisi -> @file{~/Maildir/from/teranisi}
958 .~/test -> @file{~/test}
963 @node News Spool Folder, Archive Folder, Maildir Folder, Folders
964 @section News Spool Folder
966 @cindex News spool Folder
969 This folder handles locally saved news articles which are proposed by
970 Mew/IM. You can also read articles directly from a spool-file which is
971 retrieved by an utility like @command{gnspool}.
976 @samp{=} @var{directory-name}
979 @var{directory-name} is a sub-directory to the directory defined by
980 variable @code{elmo-localnews-folder-path} (default is @file{~/News})
981 You can use @samp{.} as directory delimiter as well as @samp{/}.
987 =fj/os/os2 -> @file{~/News/fj/os/os2}
988 =fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
993 @node Archive Folder, POP Folder, News Spool Folder, Folders
994 @section Archive Folder
996 @cindex Archive Folder
999 This method can handle archive files, which are compressed by utilities
1000 such as Info-ZIP or LHA, as one folder.
1006 @samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
1010 @var{path-name} is the relative path from
1011 @code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
1012 @var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
1013 DOS', @var{path-name} is treated as absolute path. ange-ftp format is
1014 also permitted under the environment of ange-ftp, efs.
1016 The actual file name of the archive folder is
1017 @code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
1018 under the @var{path-name}. If a file named @var{path-name} exists, it is
1019 treated as folder. The suffix is automatically decided for
1020 @var{archiver-type}.
1022 If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
1023 (Initial setting is @code{zip}) is referred.
1025 @var{prefix} specifies the internal directory structure of the archive.
1026 For example, if the ML server is fml, @file{msend.tar.gz} has a
1027 structure like @file{spool/1}, so you have to specify @samp{spool} as
1034 $teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
1035 $bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
1036 $/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
1037 $d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
1038 $ml;zip/ -> Access group consists of archive folders
1039 under @file{~/Mail/ml}
1044 * Archiver:: Supported Archivers
1045 * Archive Tips:: TIPS
1046 * Archive Vars:: Customization
1050 @node Archiver, Archive Tips, Archive Folder, Archive Folder
1051 @subsection Supported Archives
1061 By default, following archives are supported.
1065 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
1066 GNU TAR('tgz, 'tar) ;; read-only
1070 If your archiver can include multiple files in one archive, you have a
1071 possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
1072 of the candidate. TAR is supported read-only because it cannot delete
1073 file in the archive (@code{mv})).
1075 @command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
1076 archiver of Wanderlust because they cannot include multiple
1077 files. Archivers that cannot extract files to standard output are also
1080 @subsection OS specific information about archiver.
1082 Behaviors of the following archivers are confirmed by further experiences.
1083 (@samp{*} mark means recommended archiver).
1086 [OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
1087 LHA OS/2 version Rel.2.06b Feb 18, 1998
1088 *UnZip 5.32 of 3 November 1997, by Info-ZIP.
1089 *Zip 2.2 (November 3rd 1997).
1090 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $
1091 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
1092 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)
1094 [UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
1095 LHa for UNIX V 1.14c
1096 UnZip 5.32 of 3 November 1997
1097 Zip 2.2 (November 3rd 1997)
1098 GNU tar 1.12 (1.11.x is no good)
1099 gzip 1.2.4 (18 Aug 93)
1101 [Win32] Win.98/Meadow
1105 GNU tar 1.11.8 + 1.5(WIN32)
1112 If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported.
1113 Hiramatsu version of LHA is only supported.
1114 In Win32, LHa32 is only supported (DOS version is no good).
1116 * Caution about GNU tar
1118 You have to take care about GNU tar's version because many version has
1119 problem on deleting file from archive.
1121 Please test @option{--delete} @option{-f} options work. Otherwise, your
1122 archive will be destroyed. No problem is reported on above versions of
1126 @node Archive Tips, Archive Vars, Archiver, Archive Folder
1128 @cindex Archive Tips
1130 For comfortable migration, usage of @code{wl-summary-archive}
1131 (@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
1132 archive folders created by expiration, you must set non-nil value to
1133 @code{elmo-archive-treat-file}.
1135 On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
1136 in processing speed. For comfortable use, Emacs20 is recommended.
1137 (If re-search's performance is the problem, 19.3x or later may be okay.)
1139 If many files are included in one archive,
1140 it takes long time to access the archive folder because
1141 archiver starting overhead is increased (especially LHA).
1142 150-200 messages in one archive is recommended.
1144 Of course, following is possible @t{:-)}
1145 (meanings of these variables are described later.)
1149 (setq wl-fcc "$backup")
1150 (setq wl-trash-folder "$trash;lha")
1154 @node Archive Vars, , Archive Tips, Archive Folder
1155 @subsection Variables About Archive Folder
1156 @cindex Archive variables
1159 @item elmo-archive-default-type
1160 @vindex elmo-archive-default-type
1161 The initial setting is @code{zip}.
1162 Set archiver type by symbol.
1164 @item elmo-archive-@var{type}-method-alist
1165 @vindex elmo-archive-TYPE-method-alist
1166 Define archiver @var{type}'s methods.
1167 (@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc)
1168 Each element of the alist is following.
1172 (@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
1173 (@var{action} . @var{function}) ;; function
1177 Currently available actions are following.
1181 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
1182 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
1189 actions enclosed with braces are optional (They are used for better
1192 @item elmo-archive-suffix-alist
1193 @vindex elmo-archive-suffix-alist
1194 An alist of archiver-type (symbol) and suffix.
1196 @item elmo-archive-file-regexp-alist
1197 @vindex elmo-archive-file-regexp-alist
1198 An alist of a regexp to get file number from list output of archiver
1199 and archiver-type (symbol).
1201 @item elmo-archive-method-list
1202 @vindex elmo-archive-method-list
1203 A list of elmo-archive-@var{type}-method-alist
1204 (@var{type} is a symbol of archiver-type).
1206 @item elmo-archive-lha-dos-compatible
1207 @vindex elmo-archive-lha-dos-compatible
1208 The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
1209 DOS (Mr. Yoshizaki original) compatible.
1211 @item elmo-archive-cmdstr-max-length
1212 @vindex elmo-archive-cmdstr-max-length
1213 The initial setting is 8000.
1215 Max length of command line argument for external archiver program.
1216 Emacs does not have a limit of command line byte length, but some OS
1217 (e.x OS/2) have. It depends on the OS. Archive folder is affected by
1218 this limit because it calls external archiver program directly (not
1219 called via shell). For example, you cannot delete messages if archiver
1220 program must receive larger bytes of arguments to delete. OS/2 have a
1221 command line argument limit of 8190 bytes, so we defined default as 8000
1224 However, you don't have an influence of command line argument limit
1225 if the archiver has `actions' to receive target file information from
1226 standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
1230 @node POP Folder, Shimbun Folder, Archive Folder, Folders
1238 A folder to access e-mails via POP3 protocol (RFC 1939).
1244 @samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
1249 @samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
1250 as @var{authenticate-type}.
1252 You can specify @samp{uidl} (use UIDL command for message numbering) or
1253 @samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
1257 @var{username} -> The value of @code{elmo-pop3-default-user}.
1258 Initial setting is @env{USER} environment variable or
1259 @env{LOGNAME} environment variable or return value of
1260 @code{(user-login-name)}.
1261 @var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
1262 Initial setting is @samp{user}.
1263 @var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
1264 If t, use UIDL for numbering. Initial setting is t.
1265 @var{hostname} -> The value of @code{elmo-pop3-default-server}.
1266 Initial setting is @samp{localhost}.
1267 @var{port} -> The value of @code{elmo-pop3-default-port}.
1268 Initial setting is 110.
1275 &hoge@@localhost -> access localhost as user @samp{hoge}.
1276 &hoge@@popserver:109 -> access the server "popserver" on port 109
1277 as user @samp{hoge}.
1281 To use apop as an @var{authenticate-type}, @file{md5.el} is needed
1282 (XEmacs doesn't need @file{md5.el}). @file{md5.el} is included in
1283 @file{utils/sasl/lisp/} or Emacs/W3 package
1284 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
1287 If the last character of the folder name is @samp{!}, Wanderlust
1288 connects to the POP server via SSL (Secure Socket Layer). If you set
1289 non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
1290 @samp{!} in the end of the folder name to use SSL. If a folder name ends
1291 with @samp{!!}, STARTTLS connection will be established. if the value
1292 of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
1296 @node Shimbun Folder, Namazu Folder, POP Folder, Folders
1297 @section Shimbun Folder
1299 @cindex Shimbun Folder
1300 @cindex Folder, Shimbun
1305 A folder for watching "shimbun" (means "newspaper" in Japanese),
1306 news site and mailing list archives on WWW by using emacs-w3m
1307 (@uref{http://emacs-w3m.namazu.org/}).
1309 You should possess w3m and emacs-w3m to use this.
1315 @samp{@@} @var{module-name} @samp{.} @var{folder-name}
1319 Admissible values of @var{module-name} and @var{folder-name} are
1320 described in @file{README.shimbun.ja} distributed with emacs-w3m.
1326 @@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
1327 @@asahi/ -> access group of all folders in module @file{sb-asahi.el}
1331 @subsection Variables About Shimbun Folder
1334 @item elmo-shimbun-update-overview-folder-list
1335 @vindex elmo-shimbun-update-overview-folder-list
1336 The initial setting is @code{nil}. You can specify a list of regular
1337 expressions of shimbun folder names. The overview of matched shimbun
1338 folder is updated when messages are fetched.
1339 You should @kbd{s rescan} after fetching to update summary.
1343 @node Namazu Folder, Multi Folder, Shimbun Folder, Folders
1344 @section Namazu Folder
1346 @cindex Namazu Folder
1347 @cindex Folder, Namazu
1348 @cindex Folder, Text Search
1351 A folder to access messages found in namazu-index with some condition.
1352 It uses namazu (@uref{http://www.namazu.org/}) for search.
1358 @samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
1362 Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
1368 [wanderlust] -> search messages matched with
1369 "wanderlust" from the default index
1370 [semi flim]~/Mail/semi -> search "semi flim" from the index
1371 in the directory "~/Mail/semi"
1377 @subsubsection Enter space to separate keywords
1379 If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
1381 @subsubsection Alias name for index
1383 You can define an alias name for index.
1388 (setq elmo-nmz-index-alias-alist
1389 '(("cache" . "~/.elmo/cache")
1390 ("docs" . "~/documents")))
1393 Above definition defines two index aliases.
1400 to execute a namazu search with keyword @samp{wanderlust} using a index in the
1401 directory @file{~/.elmo/cache}.
1403 @subsubsection Multiple indices
1405 You can specify a list for @code{elmo-nmz-default-index-path} and
1406 @code{elmo-nmz-index-alias-alist}.
1407 When list is specified, all index contained in the list is used as the
1413 (setq elmo-nmz-index-alias-alist
1414 '(("all" . ("~/.elmo/cache" "~/documents"))
1415 ("cache" . "~/.elmo/cache")))
1418 Using above alias setting, you can specify
1424 to execute a namazu search with keyword @samp{wanderlust} using indices in the
1425 directory @file{~/.elmo/cache} and @file{~/documents}.
1427 @node Multi Folder, Filter Folder, Namazu Folder, Folders
1428 @section Multi Folder
1430 @cindex Multi Folder
1431 @cindex Folder, Multiple
1432 @cindex Folder, Marge
1434 A folder to access virtual folder which collects messages from
1441 @samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
1445 After @samp{*} character, specify multiple folders you want to collect
1446 separated by @samp{,} like
1447 @samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
1453 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
1454 -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
1455 treated as one folder.
1457 *+inbox,-fj.rec.tv,%inbox
1458 -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
1463 @node Filter Folder, Pipe Folder, Multi Folder, Folders
1464 @section Filter Folder
1466 @cindex Filter Folder
1467 @cindex Folder, Filtering
1468 @cindex Folder, Virtual
1469 @cindex Folder, Conditional
1471 A folder to access virtual folder which collects all messages that
1472 satisfy a condition.
1477 @samp{/} @var{condition} @samp{/} @var{target-folder}
1480 In the @var{condition} part, you can specify following.
1484 Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
1486 first: @var{number} messages are picked from top of folder.
1487 last: @var{number} messages are picked from bottom of folder.
1493 /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
1494 /first:20/%inbox -> First 20 messages from %inbox are picked.
1499 Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
1501 since: only messages arrived since @var{date} are picked.
1502 before: only messages arrived before @var{date} are picked.
1504 You can specify following as @var{date}.
1508 yesterday -> a day before today.
1509 lastweek -> same day of last week.
1510 lastmonth -> same day of last month.
1511 lastyear -> same day of last year.
1512 @var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
1513 @var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
1521 /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
1523 /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
1529 Field filter: @samp{@var{field}:@var{value}}
1531 All messages that have @var{field} and its value is @var{value} are picked.
1532 @var{field} and @var{value} are case insensitive.
1538 /from:teranisi/+inbox -> In +inbox, messages which have From: field
1539 and its value includes "teranisi" string are picked.
1540 /body:foo/%inbox -> In %inbox, messages which have "foo" text
1548 If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
1549 Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
1551 @samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
1552 @samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
1558 /from:teranisi&!to:teranisi/+inbox
1559 -> In +inbox, messages are picked if the message's
1560 From: field includes "teranisi" and
1561 To: field doesn't include "teranisi".
1563 /tocc:"Yuuichi Teranishi"/+inbox
1564 -> In +inbox, messages are picked if the
1565 message's To: field or Cc: field includes
1566 "Yuuichi Teranishi".
1568 /(from:yt|from:teranisi)&subject:report/+inbox
1569 -> In +inbox, messages are picked if the message's
1570 From: field includes "yt" or "teranisi", and
1571 Subject includes "report".
1577 Tip for string description:
1579 Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
1580 should be enclosed with @samp{"} in @var{value} string. (@samp{"}
1581 should be escaped with @samp{\} in it). You can enclose the string with
1582 @samp{"} even it does not contain these characters.
1588 *%inbox,/from:teranisi/%inbox@@server
1589 -> Messages in %inbox or
1590 message is in the %inbox@@server folder and it's From field
1591 includes "teranisi" are collected.
1593 /last:100//to:teranisi/*+inbox,%inbox
1594 -> Latest 100 messages which is in the +inbox or %inbox folder
1595 and To: field matches "teranisi".
1597 /from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
1598 -> Pick messages which have From: field and it includes "hogehoge"
1599 from latest 20 messages in the %#mh/inbox@@localhost
1600 and To: or Cc: field includes "teranisi".
1603 @node Pipe Folder, Internal Folder, Filter Folder, Folders
1604 @section Pipe Folder
1608 @cindex Download Message
1609 @cindex Incorporate Message
1611 In the pipe folder, messages are automatically transferred from the source
1612 folder to destination folder.
1617 @samp{|} @var{source-folder} @samp{|} @var{destination-folder}
1620 When you access the pipe folder, messages are automatically transferred
1621 from @var{source-folder} to @var{destination-folder}.
1622 It is convenient if you want to download messages to local disk via POP.
1623 For example, if you specify following
1626 |&username@@popserver|+inbox
1630 and access it, Wanderlust downloads messages from
1631 @samp{&username@@popserver} to @samp{+inbox} automatically.
1633 On the other hand, if you put @samp{|:} instead of second @samp{|},
1634 then messages are copied to the destination folder (not deleted from
1635 source-folder). At the next time you access that folder, copies new
1639 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
1642 If you want to copy messages from POP server and view them, specify the
1646 |&username@@popserver|:+inbox
1649 where messages will be kept on the server.
1655 |%inbox|%myinbox -> Download %inbox to %myinbox.
1656 |*&user@@popserver1,&user@@popserver2|+inbox
1657 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
1658 |-gnu.emacs.sources|:+sources
1659 -> Copy messages from -gnu.emacs.sources to +sources.
1663 After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
1665 @node Internal Folder, , Pipe Folder, Folders
1666 @section Internal folder
1668 @cindex Internal Folder
1669 @cindex Folder, @samp{$} mark
1671 @c @cindex Folder, Null
1673 A folder to access internal messages of Wanderlust.
1685 A folder named @samp{'mark} is a special virtual folder which collects
1686 messages which have important mark @samp{$}.
1688 You can review important messages at once after you put important marks
1689 on the messages in the different folders.
1691 In this folder, if you delete message, important mark @samp{$} put on
1692 the message is removed. If you append messages to this folder, the
1693 message will have @samp{$} mark.
1695 (Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
1696 folder. If you want IMAP folder's message remove from @samp{'mark}
1697 folder, remove important mark at IMAP Folder.)
1700 A folder named @samp{'sendlog} is a virtual folder which collects
1701 cached messages which are recoded on @file{~/.elmo/sendlog}.
1702 It might be useful when you forgot to add cc for yourself.
1703 To use this, you should set @code{wl-draft-use-cache} to non-nil
1704 so that sent messages are cached.
1707 You can access cached messages fetched via network by accessing
1708 folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
1709 the name of the subdirectories of the cache directory
1710 (@file{~/.elmo/cache}).
1713 @node Folder, Summary, Folders, Top
1714 @chapter Folder mode
1717 After you start Wanderlust, folder mode is appeared firstly.
1718 It contains folder list you subscribed.
1719 You can select and edit folders in this mode.
1722 * Selecting Folder:: Select folder you want to read
1723 * Folder Manager:: Editing folders
1727 @node Selecting Folder, Folder Manager, Folder, Folder
1728 @section Selecting Folder
1729 @cindex Selecting Folder
1731 @subsection Usage (TIPS)
1733 @subsubsection Check new, unread number
1735 Folder mode looks like this.
1736 (In XEmacs, it looks much nicer @t{;-)})
1740 [-]Desktop:14186/35580/67263
1745 [-]Emacsen:0/34/4837
1746 Wanderlust ML:0/0/558
1749 XEmacs Beta:0/29/255
1760 @var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
1764 @kbd{s} key on the folder line updates these numbers.
1765 It changes its color if it has many new messages.
1767 The whole folder mode is a folder group named @samp{Desktop}.
1768 Folder group open/close by return key.
1769 A operation to a folder group is treated as operations on the
1771 For example, when you type @kbd{s} on @samp{[-]Emacsen},
1772 six children folders update its unread number status.
1774 @subsubsection Select Folder
1776 To enter summary mode of the folder, type return (or space) key on
1778 If the variable @code{wl-stay-folder-window} has non-nil value,
1779 summary window appears on the right of the folder mode window.
1781 @subsection Key bindings
1783 Folder mode's key binding (related to selecting folders) is following.
1788 @kindex @key{SPC} (Folder)
1789 @kindex @key{RET} (Folder)
1790 @findex wl-folder-jump-to-current-entity
1791 Enter to the summary mode of the folder at the current cursor point.
1792 With prefix argument, enter the sticky summary.
1793 If the cursor is on the top of folder group line,
1794 the folder group is opened or closed.
1795 When the cursor is on the access group and this command is called
1796 with prefix argument, folder children list is updated to the newest one.
1797 (Children list is updated recursively if the access folder has hierarchical
1799 (@code{wl-folder-jump-to-current-entity})
1802 @kindex M-@key{RET} (Folder)
1803 @findex wl-folder-update-recursive-current-entity
1804 Folder children list of the access group at the current cursor point
1805 is updated to the newest one.
1806 (Children list is updated recursively if the access folder has hierarchical
1808 (@code{wl-folder-update-recursive-current-entity})
1813 Create a new draft message.
1818 @findex wl-folder-write-current-folder
1819 If the current cursor point is on the NNTP folder, create a new draft
1820 message which already has @samp{Newsgroups:} field. If the current
1821 cursor point is on the folder for mailing list (refile destination),
1822 create a new draft message which already has @samp{To:} field with
1823 guessed mailing list address (If @code{wl-subscribed-mailing-list} is
1825 (@code{wl-folder-write-current-folder})
1828 @kindex C-c C-o (Folder)
1829 @findex wl-jump-to-draft-buffer
1830 Move to the draft buffer if available. If multiple draft buffer exists,
1831 moved to one after another. If prefix argument is specified, load draft
1832 folder's message to the draft buffer and jump to it.
1833 (@code{wl-jump-to-draft-buffer})
1837 @findex wl-folder-check-current-entity
1838 Update new and unread number information of the folder at the current
1840 (@code{wl-folder-check-current-entity})
1844 @findex wl-folder-sync-current-entity
1845 Update summary information of the folder at the current cursor point.
1846 (@code{wl-folder-sync-current-entity})
1849 @kindex r s (Folder)
1850 @findex wl-folder-check-region
1851 Update new and unread number information of the folders in the currently
1853 (@code{wl-folder-check-region})
1856 @kindex r S (Folder)
1857 @findex wl-folder-sync-region
1858 Update summary information of the folders in the currently selected region.
1859 (@code{wl-folder-sync-region})
1863 @findex wl-status-update
1864 Sync up address book status with @file{~/.addresses}'s content.
1865 (@code{wl-status-update})
1869 @findex wl-folder-prev-unread
1870 Jump cursor to the folder which have unread messages on the upward from
1871 current cursor point.
1872 (@code{wl-folder-prev-unread})
1876 Jump cursor to the folder which have unread messages on the downward
1877 from current cursor point.
1878 (@code{wl-folder-next-unread})
1882 Move cursor to the folder on the previous line.
1883 (@code{wl-folder-prev-entity})
1887 Move cursor to the folder on the next line.
1888 (@code{wl-folder-next-entity})
1892 Jump to the folder specified by the user input.
1893 (@code{wl-folder-jump-folder})
1897 @findex wl-folder-prefetch-current-entity
1898 Prefetch new messages of the folder at the current cursor point by
1899 @code{wl-summary-incorporate}.
1900 If the cursor is on the folder group, it is executed recursively.
1901 (@code{wl-folder-prefetch-current-entity})
1905 @findex wl-folder-mark-as-read-all-current-entity
1906 Mark all unread messages of the folder at the current cursor point as read.
1907 If the cursor is on the folder group, it is executed recursively.
1908 (@code{wl-folder-mark-as-read-all-current-entity})
1912 @findex wl-folder-goto-first-unread-folder
1913 Enter summary mode of the first unread folder.
1914 (@code{wl-folder-goto-first-unread-folder})
1918 @findex wl-folder-empty-trash
1920 (@code{wl-folder-empty-trash})
1924 @findex wl-folder-flush-queue
1926 (@code{wl-folder-flush-queue})
1930 @findex wl-folder-virtual
1931 Move to the virtual folder with the condition specified.
1932 (@code{wl-folder-virtual})
1936 @findex wl-folder-pick
1937 Search the folders with the condition specified.
1938 (@code{wl-folder-pick})
1942 @findex wl-folder-open-all-unread-folder
1943 All unread folder is opened.
1944 (@code{wl-folder-open-all-unread-folder})
1948 @findex wl-folder-open-close
1949 Folder group is opened/closed.
1950 (@code{wl-thread-open-close})
1954 All folder group is opened.
1955 (@code{wl-folder-open-all})
1959 All folder group is closed.
1960 (@code{wl-folder-close-all})
1970 (@code{wl-folder-suspend})
1973 @kindex M-s (Folder)
1974 Save current folder status.
1978 @kindex M-t (Folder)
1979 Toggle Wanderlust's offline/online status.
1980 (@code{wl-toggle-plugged})
1983 @kindex C-t (Folder)
1984 Start Wanderlust's plug-status manager.
1985 (@code{wl-plugged-change})
1988 @subsection Customize variables
1991 @item wl-folders-file
1992 @vindex wl-folders-file
1993 The initial setting is @file{~/.folders}.
1994 Subscribed folders are described (saved) in this file.
1996 @item wl-folder-info-save
1997 @vindex wl-folder-info-save
1998 The initial setting is @code{t}. If non-nil, unread information is
1999 saved and used in the next Wanderlust session.
2001 @item wl-stay-folder-window
2002 @vindex wl-stay-folder-window
2003 The initial setting is @code{nil}.
2004 If non-nil, summary window is appeared on the right side of the folder buffer.
2006 @item wl-folder-window-width
2007 @vindex wl-folder-window-width
2008 The initial setting is 20.
2009 Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
2011 @item wl-folder-use-frame
2012 @vindex wl-folder-use-frame
2013 The initial setting is @code{nil}.
2014 If non-nil, use new frame for the folder window.
2016 @item wl-folder-many-unsync-threshold
2017 @vindex wl-folder-many-unsync-threshold
2018 The initial setting is 70.
2019 If the number of unread messages is more than this value,
2020 folder color is changed.
2022 @item wl-highlight-folder-by-numbers
2023 @vindex wl-highlight-folder-by-numbers
2024 This option controls how to highlight each line in the folder buffer.
2025 The default value is @code{t}, highlighting with various colors based on
2026 the message numbers. If it is @code{nil}, highlighting with various
2027 colors based on the folder status. In addition, if it is a number
2028 (e.g. 1), highlighting will be done based on both the message numbers
2029 and the folder status.
2031 @item wl-folder-desktop-name
2032 @vindex wl-folder-desktop-name
2033 The initial setting is @samp{Desktop}.
2034 The name of top folder group.
2036 @item wl-folder-petname-alist
2037 @vindex wl-folder-petname-alist
2038 The initial setting is @code{nil}.
2039 An alist of folder's realname and its nickname.
2041 @item wl-folder-access-subscribe-alist
2042 @vindex wl-folder-access-subscribe-alist
2043 The initial setting is @code{nil}.
2045 Control automatic subscribing and unsubscribing of the children list
2051 (@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
2055 If @var{subscribe-flag} is non-nil, folders which have name matched to
2056 @var{regexp-of-folders} are displayed. Otherwise, hidden. However,
2057 already unsubscribed folder is not displayed even when the
2058 @var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
2065 '(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
2066 "^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
2067 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
2068 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
2072 @item wl-folder-hierarchy-access-folders
2073 @vindex wl-folder-hierarchy-access-folders
2074 The initial setting is the list shown below:
2083 A list of regular expressions for access groups which creates children
2084 folder list hierarchically.
2086 For example, if you specify
2087 @code{wl-folder-hierarchy-access-folders} like following,
2091 (setq wl-folder-hierarchy-access-folders
2092 '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
2097 you obtain the access group hierarchy as follows.
2103 -fj.comp.announce:0/0/2
2104 -fj.comp.dev.cdrom:0/0/0
2106 [+]-japan:238/238/1688
2109 -comp.unix.admin:0/0/0
2110 -comp.unix.dos-under-unix:0/0/0
2111 -comp.unix.programmer:0/0/0
2112 [-]-comp.unix.bsd:0/0/23
2113 -comp.unix.bsd.freebsd.announce:0/0/0
2118 If you opened @samp{-} in this example, only the direct children is created
2119 (@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}).
2120 second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{})
2121 is not created until the children access group is opened.
2125 @node Folder Manager, , Selecting Folder, Folder
2126 @section Editing Folders
2127 @cindex Folder Manager
2128 @cindex Folder, Edit
2129 @cindex Folder, Subscribe
2130 @cindex Folder, Unsubscribe
2132 As described before, subscribed folder list is saved in @file{~/.folders} file.
2133 But you don't have to edit @file{~/.folders} directly.
2134 You can append, delete, edit folders from folder mode.
2136 @subsection Usage (Tips)
2138 @subsubsection Append Folder
2140 @kbd{m a} appends new folder to the folder mode.
2141 @kbd{m g} appends new folder group.
2142 To append new folder to this group, firstly open it,
2143 then execute append command in the next line.
2145 @subsubsection Edit Folder
2147 You can cut folder by @kbd{C-k}, paste by @kbd{C-y}.
2148 Thus, you can change folder position as if you were editing a normal file.
2150 @subsubsection Create Multi Folder.
2154 Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}.
2156 Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}.
2158 Type @kbd{m m}, then you can create multi folder.
2161 @subsubsection Delete Nickname, Filter
2163 You can delete nickname or filter by putting ``''(@var{NULL}) from the
2164 minibuffer while appending.
2166 @subsubsection Append Folder to Empty Group
2168 To append new folder to the empty folder group
2169 (after you create folder group by typing @kbd{m g}),
2170 firstly open it, then execute append command in the next line.
2171 If it is closed, folder is appended on the same level with
2172 the folder group above. It is difficult to explain by words so try it.
2173 In other words, appended position depends on the
2174 open/close status of the upper one.
2176 @subsubsection Charset of the Folders File.
2178 @code{wl-mime-charset} is used for saving @code{wl-folders-file}.
2180 @subsubsection Create Filter
2182 @kbd{m f} adds filter to the folder at the current cursor point. To
2183 create new filter folder and leave the current folder unchanged, copy it
2184 @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
2185 filter can be specified while appending filter. If you put
2186 ``''(@var{NULL}), filter is deleted.
2188 @subsubsection Sort Folders
2190 Sorting of the folders is executed by the function specified by
2191 @code{wl-fldmgr-sort-function}.
2192 The initial setting is @code{wl-fldmgr-sort-standard},
2193 which sorts alphabetically.
2194 Sorting affects only on the current folder group. It does not
2195 affect on the child groups.
2197 @subsubsection Hiding Folders in the Access Group
2199 Usually, access group displays all children folders, but you can set
2200 some folders hidden. Following operations are only available on access
2203 Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
2204 (subscribe/unsubscribe) of the folder at current cursor point. Against
2205 this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
2208 Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
2209 @code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
2210 argument and if the argument has positive number, the unsubscribe it.
2211 If the prefix argument has negative value, folder becomes visible and if
2212 zero, folder visibility is toggled.
2214 The other commands, @code{wl-fldmgr-subscribe} and
2215 @code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
2218 Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
2219 executed in the access group, they have a same effect with
2220 @code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
2221 The difference is that cut commands deletes folders from the current
2224 @subsubsection Operations in the Access Group
2226 You can insert and delete folders in the access group like usual folder
2227 group. But insert and delete commands can be only available for the
2228 children folders of the access group and they only sets the subscribe
2229 status. In other words, insertion of the folder means subscribing,
2230 deletion means unsubscribing.
2231 @footnote{In the current implementation,
2232 it is faster to delete region than to unsubscribe region.}
2234 To update the access group when children folders are inserted or deleted
2235 by other way (other than Wanderlust),
2236 open the access group by typing @kbd{C-u @key{RET}}.
2237 @xref{Selecting Folder}.
2239 The order of children folders of access group is saved after
2240 insertion/deletion/sorting.
2241 If you set @code{wl-force-fetch-folders} to non-nil or open access group
2242 by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and
2243 newly created folders are inserted on the top of the access group.
2245 @subsection Key bindings
2246 @cindex Keybind, Folder Mode
2247 @cindex Keybind, Folder Buffer
2249 Key bindings on the folder mode related to folder editing are shown below.
2250 All bindings starts with @kbd{m}, and primary commands are binded to
2251 one stroke key binding.
2255 @kindex m a (Folder)
2256 @findex wl-fldmgr-add
2258 (@code{wl-fldmgr-add})
2263 @kindex m g (Folder)
2264 @findex wl-fldmgr-make-group
2265 Create a folder group.
2266 (@code{wl-fldmgr-make-group})
2269 @kindex m A (Folder)
2270 @findex wl-fldmgr-make-access-group
2271 Create an access group.
2272 (@code{wl-fldmgr-make-access-group})
2275 @kindex m d (Folder)
2276 @findex wl-fldmgr-delete
2277 Delete folder itself and msgdb.
2278 If the folder itself cannot be deleted like NNTP folder,
2279 only msgdb is deleted.
2280 (@code{wl-fldmgr-delete})
2285 @kindex m R (Folder)
2286 @findex wl-fldmgr-rename
2287 Change the name of folder or folder group.
2288 msgdb's path is also changed.
2289 (@code{wl-fldmgr-rename})
2295 @findex wl-fldmgr-make-multi
2296 Create a multi folders in the cutlist (cut, copied folders).
2297 (@code{wl-fldmgr-make-multi})
2302 @kindex m f (Folder)
2303 @findex wl-fldmgr-make-filter
2304 Create a filter folder. (Put a filter on the folder).
2305 (@code{wl-fldmgr-make-filter})
2309 @kindex M-c (Folder)
2310 @kindex m c (Folder)
2311 @findex wl-fldmgr-copy
2312 Copy folder (it is not available on folder group).
2313 (@code{wl-fldmgr-copy})
2317 @kindex M-w (Folder)
2318 @kindex m W (Folder)
2319 @findex wl-fldmgr-copy-region
2320 Copy folders in the specified region.
2321 (@code{wl-fldmgr-copy-region})
2325 @kindex C-k (Folder)
2326 @kindex m k (Folder)
2327 @findex wl-fldmgr-cut
2328 Cut folder. Folder itself is not deleted.
2329 (@code{wl-fldmgr-cut})
2333 @kindex C-w (Folder)
2334 @kindex m C-w (Folder)
2335 @findex wl-fldmgr-cut-region
2336 Cut folders in the specified region.
2337 (@code{wl-fldmgr-cut-region})
2341 @kindex C-y (Folder)
2342 @kindex m y (Folder)
2343 @findex wl-fldmgr-yank
2344 Paste folders that are copied or cut (folders in the cut-list).
2345 (@code{wl-fldmgr-yank})
2348 @kindex m p (Folder)
2349 @findex wl-fldmgr-set-petname
2350 Put nickname on the folder.
2351 (@code{wl-fldmgr-set-petname})
2354 @kindex m q (Folder)
2355 @findex wl-fldmgr-clear-cut-entity-list
2356 Clear the cut-list. (cut, copied folder information is cleared,
2357 you cannot paste after this)
2358 (@code{wl-fldmgr-clear-cut-entity-list})
2361 @kindex m s (Folder)
2362 @findex wl-fldmgr-sort
2363 Sort folders in the current folder group.
2364 (@code{wl-fldmgr-sort})
2367 @kindex m C-s (Folder)
2368 @findex wl-fldmgr-save
2369 Save current folder view to the @file{wl-folders-file}.
2370 (@code{wl-fldmgr-save})
2373 [Following commands are only available on the access groups]
2379 @kindex m u (Folder)
2380 @findex wl-fldmgr-unsubscribe
2381 Set the visibility of folder (subscribe/unsubscribe).
2382 (@code{wl-fldmgr-unsubscribe})
2387 @kindex r u (Folder)
2388 @findex wl-fldmgr-unsubscribe-region
2389 Set the visibility of the folders (subscribe/unsubscribe) in the
2391 (@code{wl-fldmgr-unsubscribe-region})
2396 @kindex m l (Folder)
2397 @findex wl-fldmgr-access-display-normal
2398 List folders that are currently available.
2399 (@code{wl-fldmgr-access-display-normal})
2404 @kindex m L (Folder)
2405 @findex wl-fldmgr-access-display-all
2406 List all folders regardless of the subscription status.
2407 (@code{wl-fldmgr-access-display-all})
2411 @subsection Customize variables
2414 @item wl-interactive-save-folders
2415 @vindex wl-interactive-save-folders
2416 The initial setting is @code{t}. If non-nil and folder view is
2417 modified, confirm saving it before Wanderlust or Emacs exits. If
2418 @code{nil}, save without confirmation.
2420 @item wl-fldmgr-make-backup
2421 @vindex wl-fldmgr-make-backup
2422 The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
2423 created before saving the folder status.
2425 @item wl-fldmgr-sort-function
2426 @vindex wl-fldmgr-sort-function
2427 The initial setting is @code{wl-fldmgr-sort-standard}. A function to
2428 sort folders. By default function, folders are sorted alphabetically
2429 and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
2432 @item wl-fldmgr-sort-group-first
2433 @vindex wl-fldmgr-sort-group-first
2434 The initial setting is @code{t}. If non-nil,
2435 @code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
2436 does not care whether it is folder group or not.
2438 @item wl-folder-check-async
2439 @vindex wl-folder-check-async
2440 The initial setting is @code{t}. If non-nil, check folder's unread
2441 status asynchronously. It boosts newsgroup checking.
2443 @item wl-folder-check-fast
2444 @vindex wl-folder-check-fast
2445 The initial setting is @code{nil}.
2446 If non-nil, it does not update folder status while checking.
2448 @item wl-folder-notify-deleted
2449 @vindex wl-folder-notify-deleted
2450 The initial setting is @code{nil}.
2452 If non-nil, negative value is displayed when the message is deleted. If
2453 @code{sync}, folder is synchronized when the message is deleted. If
2454 @code{nil}, message deletion is ignored.
2456 @item wl-fldmgr-add-complete-with-current-folder-list
2457 @vindex wl-fldmgr-add-complete-with-current-folder-list
2458 The initial setting is @code{nil}.
2459 Non-nil means call @code{elmo-folder-list-subfolders} and get completion
2460 candidate for @code{wl-fldmgr-add}.
2463 @subsection Miscellanea
2465 Following is a note for folder editing.
2469 cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}.
2470 paste(yank) command pastes the folders on one cut or copy command
2471 (If copy command is executed by region, folders in the region are pasted
2472 by one paste command)
2475 You cannot cut @samp{Desktop} group.
2476 Also, you cannot paste folders at the outside of the @samp{Desktop}.
2479 You cannot copy folder group.
2482 Operations on the access group are only available for the folders
2483 in the same access group.
2486 You cannot create a folder which has same name with the folders already exist.
2489 You cannot insert folders which have same name in one group.
2490 You can insert them in the different groups.
2491 You cannot put same nickname to the different folders.
2495 @node Summary, Message, Folder, Top
2496 @chapter Summary Mode
2498 After you select the folder via folder mode, you enter to the summary
2502 * Usage of Summary Mode:: TIPS
2503 * Thread Operations:: Thread operations
2504 * Cache:: File cache, Buffer cache, and Prefetch
2505 * Auto Refile:: Auto refile settings
2506 * Sticky Summary:: Summary make sticky
2507 * Summary View:: Format of summary lines
2508 * Key Bindings of Summary:: Key bindings
2509 * Variables of Summary:: Customize Summary Mode
2513 @node Usage of Summary Mode, Thread Operations, Summary, Summary
2514 @section Usage (Tips)
2516 @subsection Summary Content
2518 In the summary mode, messages are displayed like following.
2522 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
2523 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
2524 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
2525 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
2532 @var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
2536 If you want to know how to change the format for this, please refer
2537 the section format of Summary lines.
2538 @xref{Summary View}.
2540 @var{Message number} is the message's unique number in the folder. In
2541 the NNTP folder, it is article number, in the IMAP folder, it is UID and
2542 in the MH folder, it is the filename of the message.
2544 @var{Temporal mark} and @var{Persistent mark} are described later.
2546 @var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
2547 Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
2548 Japanese, but if you want to display it in English, set the value of
2549 @code{wl-summary-weekday-name-lang} as @samp{en}.
2551 @var{Sender}'s indentation corresponds to the depth of the thread.
2552 Sender name is displayed as nickname if it is defined in the address
2553 book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
2554 displaying with nickname.
2556 If number is printed at the head of @var{Sender} part like @samp{+2},
2557 that means the message have 2 follow messages.
2559 @var{Subject} is the @samp{Subject:} header field of the message. If
2560 the message have same @samp{Subject:} with the parent message, it is not
2561 displayed. Some mailing list puts its sequence number in the
2562 @samp{Subject:} field, but it is
2563 ignored. @code{wl-summary-no-subject-message} is displayed when the
2564 message has empty subject field.
2566 @subsection Temporary Marks
2567 @cindex Mark, Temporary
2569 There are four temporary marks,
2570 @samp{*}, @samp{D}, @samp{o} and @samp{O}.
2571 Temporary marks indicates message operations.
2576 You can execute a command on the all messages that have @samp{*} mark,
2577 with the key bindings which begins with @kbd{m}.
2580 The mark to delete. You can put @samp{D} by typing @kbd{d} key.
2584 After you type @kbd{o} key, prompt appears to input refile destination.
2585 Your answer is printed in the summary line.
2589 You can put this mark by typing @kbd{O} key.
2590 The difference between this mark and refile mark is,
2591 this mark does not delete the message while latter does.
2594 @kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
2596 @subsection Persistent Marks
2598 There are five persistent marks,
2599 @samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
2601 The persistent mark indicates the message's status and it is saved.
2602 Each persistent mark indicates:
2608 It is unread message.
2610 It is unread but cached message.
2612 It is read but it is not cached.
2614 It is important message. You can put @samp{$} mark by typing @kbd{$}
2615 key (if already exists, the mark is deleted). It is convenient to put
2616 this mark on the messages to remember (If you want to remember to write
2617 a reply for the message, for example) because this mark remains after
2618 you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
2619 @samp{'mark} folder even the message itself is deleted in the actual folder.
2622 If the message is read and cached (or local message),there are no
2626 @samp{N}, @samp{U} and @samp{u} indicates that the message have no
2627 cache. Messages with the marks other than these, you can read them in
2628 the offline status even they are in the IMAP folder or netnews folder.
2630 Among messages with persistent marks, ones with marks specified by
2631 @code{wl-summary-expire-reserve-marks} are excluded from the expiration
2632 (as a function of wanderlust) explained later. @xref{Expire and Archive}.
2634 @subsection How To Read
2636 Basically, you can read messages only typing space key again and again.
2638 To update summary status to the newest status (synchronize),
2641 You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key
2642 moves cursor to the next message.
2643 Enter message buffer by typing @kbd{j} key.
2644 To operate multipart, you have to enter to the message buffer.
2647 @subsection Pack the Message Numbers
2648 You can pack the message numbers in Summary by
2649 @kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
2650 News Spool Folder and Maildir Folder are supported folder types.
2653 @node Thread Operations, Cache, Usage of Summary Mode, Summary
2654 @section Thread Operations
2656 For example, the following line indicates one thread (a context of a topic).
2659 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2
2663 If you type @kbd{/} on this line, the thread is opened and it changes
2664 the appearance like following.
2668 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
2669 388 09/17(Thu)22:34 +-[ Murata san ]
2673 (Message 388 is the replied message to the message 384.)
2674 If you type @kbd{/} key once again, the thread is closed.
2675 With prefix argument, @kbd{/} opens all children threads.
2677 If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all
2680 Commands with the key binding that begins with @kbd{t} executes commands
2681 on the messages in the thread.
2682 @xref{Key Bindings of Summary}.
2684 @subsection reconstruct thread by hand
2686 You can reconstruct the thread manually. In Summary, @kbd{M-w}
2687 (@code{wl-summary-save-current-message}) at the corresponding message,
2688 and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
2689 message then you have the reconstructed thread.
2692 @node Cache, Auto Refile, Thread Operations, Summary
2695 @subsection Cache File
2697 The messages which have to access via network (e.x. IMAP, NNTP folder)
2698 are cached as a local file. The cache file is saved under the directory
2699 @file{~/.elmo/cache}. To expire cache, type @kbd{M-x
2700 elmo-cache-expire-by-size}. The command deletes cache files to the
2701 specified size by the order of last accessed time.
2703 @subsection Buffer Cache and Prefetching
2705 The messages that are read are kept in the cache buffer. It is called
2706 `buffer cache'. The number of cache buffer is specified by
2707 @code{wl-message-buffer-cache-size}.
2709 There are message prefetching mechanism in the Wanderlust that
2710 prefetches next message while you are reading.
2712 You can control the message prefetching mechanism by these two
2716 @item wl-message-buffer-prefetch-folder-type-list
2717 @vindex wl-message-buffer-prefetch-folder-type-list
2718 The initial setting is @code{t}. In this case, prefetch messages in all
2720 If it is a list of folder types, it specifies the folder types in which
2721 message prefetching is enabled.
2722 Following is an example (prefetch messages in nntp and imap4 folders)
2726 (setq wl-message-buffer-prefetch-folder-type-list
2731 In this case, multi folder that contains localdir and imap4 prefetches
2732 only imap4 messages. This variable precedes the value of
2733 @code{wl-message-buffer-prefetch-folder-list}.
2735 @item wl-message-buffer-prefetch-folder-list
2736 @vindex wl-message-buffer-prefetch-folder-list
2737 The initial setting is @code{nil}.
2738 A list of regexp of folders to enable message prefetching.
2740 @item wl-message-buffer-prefetch-depth
2741 @vindex wl-message-buffer-prefetch-depth
2742 The initial setting is 3. The number of messages for automatical prefetch.
2744 @item wl-message-buffer-prefetch-idle-time
2745 @vindex wl-message-buffer-prefetch-idle-time
2746 The initial setting is 0.2 (in seconds). The period of automatical prefetch.
2748 @item wl-message-buffer-prefetch-threshold
2749 @vindex wl-message-buffer-prefetch-threshold
2750 The initial setting is 30000 (bytes). If prefetching message has larger
2751 size than this value, Wanderlust does not prefetch automatically.
2752 If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
2753 the message is not checked for the size.
2755 @item wl-auto-prefetch-first
2756 @vindex wl-auto-prefetch-first
2757 The initial setting is @code{nil}.
2758 If non-nil, first message is automatically prefetched to the buffer
2759 when you enter the folder.
2763 @node Auto Refile, Sticky Summary, Cache, Summary
2764 @section Auto Refile
2765 @vindex elmo-msgdb-extra-fields
2766 @vindex wl-refile-rule-alist
2767 @findex wl-summary-auto-refile
2769 You can refile messages automatically, by typing @kbd{C-o}
2770 (@code{wl-summary-auto-refile}). It decides destination of refile by
2771 the content of the message header information (information in the msgdb).
2773 By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
2774 available. If you want to decide destination by other header fields,
2775 set the variable @code{elmo-msgdb-extra-fields} like following.
2779 (setq elmo-msgdb-extra-fields
2789 By this setting, Wanderlust saves extra fields in the msgdb. You have
2790 to type @kbd{s all} to get extra fields for the messages that are
2791 already exists in the summary.
2793 Then, specify the refile rule. The refile target folder of auto
2794 refiling is decided by the value of @code{wl-refile-rule-alist}.
2795 @code{wl-refile-rule-alist} is a list of a rule:
2799 (@var{field} (@var{regexp} . @var{target})
2800 (@var{regexp} . @var{target})
2805 Each rule means `if @var{field} value matches @var{regexp},
2806 then refile to @var{target} folder'.
2807 The rule matched first is applied.
2809 @var{field} is a string of field name. You can specify a list of field name
2810 string, too. In this case, if one of these fields is matched, then the
2811 rule is fired (i.e. OR condition).
2813 @var{regexp} is a regular expression for field value. @var{target} is a target
2814 folder string. You can specify a rule at @var{target} part, too. In this
2815 case, If the field value of the rule and the current rule is matched,
2816 then the current rule is fired (i.e. AND condition).
2818 You can refer matched substring of @var{regexp} to specify @var{target} part.
2819 To refer substring, use following keys:
2823 means substitute original matched text.
2826 means substitute what matched the @var{N}th `\(@dots{}\)'.
2827 (@var{N} is a number.)
2830 Following is an example of @code{wl-refile-rule-alist}.
2834 (setq wl-refile-rule-alist
2836 ("^Wanderlust" . "+wl")
2837 ("^Elisp" . "+elisp"))
2839 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1"))
2841 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" .
2842 "+from-me-to-you"))))))
2846 After these settings, refile marks are automatically put on the condition
2847 matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
2849 Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
2851 By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
2852 with these persistent marks are not automatically refiled.
2853 It means Wanderlust does not execute auto refile on unread messages by
2854 the default setting.
2855 To execute auto refile on all messages, set following.
2858 (setq wl-summary-auto-refile-skip-marks nil)
2862 @node Sticky Summary, Summary View, Auto Refile, Summary
2863 @section Sticky Summary
2864 @cindex Summary, Sticky
2865 @cindex Sticky Summary
2867 The buffer of the `sticky summary' does not killed by typing @kbd{q}.
2869 By entering the summary by typing @kbd{Shift RET} in Folder mode or
2870 @kbd{G} in some suummary sticky summary buffer is created.
2871 Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
2872 makes current one sticky.
2874 The buffer name of the sticky summary becomes like
2875 @samp{Summary:@var{folder-name}}.
2876 You can visit the sticky summary at any time by @kbd{C-x b}
2877 (@code{switch-to-buffer}), or you can go round summary buffers by
2878 @kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
2879 (@code{wl-summary-next-buffer}) in summary mode.
2881 In sticky summary, the summary buffer is preserved after @kbd{g} or
2882 @kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
2883 another summary by @kbd{C-u g}. Other operations in the sticky summary
2884 are same as normal summary.
2886 @code{wl-summary-always-sticky-folder-list} specifies the folders that
2887 are automatically stuck.
2890 @node Summary View, Key Bindings of Summary, Sticky Summary, Summary
2891 @section Format of summary lines
2892 @cindex Format of summary lines
2893 You can alter the format of lines in Summary mode.
2895 Summary line format is specified by @code{wl-summary-line-format}.
2896 You can use control strings defined by
2897 @code{wl-summary-line-format-spec-alist}.
2903 ;; @r{number temporary-mark persistent-mark date branch}
2904 ;; @r{[ (number-of-children) sender ] subject}
2905 (setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
2909 Where the number set the column number of the field (for negative value,
2912 Major control strings defined by @code{wl-summary-line-format-spec-alist}
2913 are displayed in the following list.
2924 %t branch of the thread
2925 %[ [ (< for re-connected child)
2926 %] ] (> for re-connected child)
2930 %c +number-of-children: (display only for opened thread)
2931 %C [+number-of-children] (display only for opened thread)
2932 %T temporary mark (mandatory)
2933 %P persistent mark (mandatory)
2937 @code{wl-summary-line-format} must contain temporary mark (@samp{%T})
2938 and persistent mark (@samp{%P}). Furthermore, these marks must appear at
2939 the constant column. For example, if you specify @samp{%T} or
2940 @samp{%P} after the @samp{%t}, which changes its length by thread
2941 position, marks are not treated correctly.
2943 If the format string is enclosed by @samp{%number(} and @samp{%)}, the
2944 column of the enclosed region is justified to the `number'. Multiple
2945 level @samp{%number(} parenthesis can be defined. It is useful to
2946 justify the column of the multiple control strings. For example, in the
2947 above @code{wl-summary-line-format},
2953 means ``Adjust number-of-children and sender string to the 17 column''.
2955 You can specify the format by each folders with
2956 @code{wl-folder-summary-line-format-alist}. Please set regular
2957 expression for folder names and summary line format as the following
2962 (setq wl-folder-summary-line-format-alist
2963 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
2964 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
2969 @node Key Bindings of Summary, Variables of Summary, Summary View, Summary
2970 @section Key bindings
2971 @cindex Keybind, Summary Mode
2972 @cindex Keybind, Summary Buffer
2974 Key bindings of the summary mode are shown below.
2978 @kindex @key{SPC} (Summary)
2979 @findex wl-summary-read
2980 Proceed reading a message at the current cursor point.
2981 (@code{wl-summary-read})
2985 @findex wl-summary-redisplay
2986 Redisplay a message at the current cursor point.
2987 If this command is called with prefix argument,
2988 Redisplay message regardless of the message cache (message is re-loaded
2990 (@code{wl-summary-redisplay})
2994 @findex wl-summary-display-top
2995 Display the top message in the folder.
2996 (@code{wl-summary-display-top})
3000 @findex wl-summary-display-bottom
3001 Display the bottom message in the folder.
3002 (@code{wl-summary-display-bottom})
3006 @kindex @key{BS} (Summary)
3007 @kindex @key{DEL} (Summary)
3008 Display the previous page of the message at the current cursor point.
3009 @findex wl-summary-prev-page
3010 (@code{wl-summary-prev-page})
3013 @kindex @key{RET} (Summary)
3014 @findex wl-summary-next-line-content
3015 Display the next line of the message at the current cursor point.
3016 Display the message at the current cursor point if it is not displayed yet.
3017 (@code{wl-summary-next-line-content})
3022 @kindex M-@key{RET} (Summary)
3023 @findex wl-summary-prev-line-content
3024 Display the previous line of the message at the current cursor point.
3025 Display the message at the current cursor point if it is not displayed yet.
3026 (@code{wl-summary-prev-line-content})
3030 @findex wl-thread-open-close
3031 Toggle open or close the thread at the current cursor point.
3032 (@code{wl-thread-open-close})
3037 @findex wl-thread-open-all
3038 (@code{wl-thread-open-all})
3043 @findex wl-thread-close-all
3044 (@code{wl-thread-close-all})
3048 @findex wl-summary-goto-folder
3050 (@code{wl-summary-goto-folder})
3054 Mark all messages in the folder as read.
3055 @findex wl-summary-mark-as-read-all
3056 (@code{wl-summary-mark-as-read-all})
3060 @findex wl-summary-reply
3061 Prepare a draft for reply the message at the current cursor point.
3062 (@code{wl-summary-reply})
3066 @findex wl-summary-reply-with-citation
3067 Prepare a draft for reply the message at the current cursor point.
3068 (@code{wl-summary-reply-with-citation})
3072 @findex wl-summary-cancel-message
3073 If the message at current cursor point is your own netnews article,
3075 (@code{wl-summary-cancel-message})
3079 @findex wl-summary-reedit
3080 Prepare a draft for re-editing the message at current cursor point.
3081 If the message at current cursor point is your own netnews article,
3082 a draft for `supersedes message' for the message is prepared.
3083 (@code{wl-summary-reedit})
3086 @kindex M-e (Summary)
3087 @findex wl-summary-resend-bounced-mail
3088 If the message at current cursor point is a bounced message,
3089 a draft for re-sending original message is prepared.
3090 (@code{wl-summary-resend-bounced-mail})
3094 @findex wl-summary-forward
3095 A draft for forwarding the message at current cursor point is prepared.
3096 (@code{wl-summary-forward})
3100 @findex wl-summary-mark-as-important
3101 Put @samp{$} mark on the message at current cursor point.
3102 If already marked as @samp{$}, delete it.
3103 (@code{wl-summary-mark-as-important})
3109 Save the message at current cursor point.
3110 @findex wl-summary-save
3111 (@code{wl-summary-save})
3115 @findex wl-summary-next
3116 Move cursor to the next message.
3117 If message is marked with a temporal mark in
3118 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3119 In the offline mode, cursor is not moved to the messages which are not cached
3121 (@code{wl-summary-next})
3125 @findex wl-summary-prev
3126 Move cursor to the previous message.
3127 If message is marked with a temporal mark in
3128 @code{wl-summary-skip-mark-list}, cursor is not moved to it.
3129 In the offline mode, cursor is not moved to the messages which are not cached
3131 (@code{wl-summary-prev})
3135 @findex wl-summary-down
3136 Move cursor to the downward message which is unread or marked
3138 In the offline mode, cursor is not moved to the messages which are not cached
3140 If there are messages which have target mark @samp{*} in the summary,
3141 cursor is moved to the downward message which have a target mark.
3142 This behavior is changed according to the value of @code{wl-summary-move-order}.
3143 (@code{wl-summary-down})
3147 @findex wl-summary-up
3148 Move cursor to the upward message which is unread or marked
3150 In the offline mode, cursor is not moved to the messages which are not cached
3152 If there are messages which have target mark @samp{*} in the summary,
3153 cursor is moved to the downward message which have a target mark.
3154 This behavior is changed according to the value of @code{wl-summary-move-order}.
3155 (@code{wl-summary-up})
3159 @findex wl-summary-write
3160 Prepare a new draft.
3161 (@code{wl-summary-write})
3165 @findex wl-summary-write-current-folder
3166 Prepare a new draft. If the current folder is NNTP folder,
3167 @samp{Newsgroups:} field is completed. If the current folder is mailing
3168 list folder (refile destination), guess @samp{To:} field and completed
3169 (If @code{wl-subscribed-mailing-list} is valid list)
3170 (@code{wl-summary-write-current-folder})
3174 @findex wl-summary-redisplay-all-header
3175 Redisplay the message at current cursor point with all header fields.
3176 (@code{wl-summary-redisplay-all-header})
3180 @findex wl-summary-redisplay-no-mime
3181 Redisplay the message at current cursor point without MIME analysis.
3182 (@code{wl-summary-redisplay-no-mime})
3186 @findex wl-summary-burst
3187 If the message at current cursor point has
3188 encapsulates multiple messages using MIME,
3189 de-capsulate and extract them on the current folder.
3190 (@code{wl-summary-burst})
3193 @kindex @@ (Summary)
3194 @findex wl-summary-edit-addresses
3195 Append/change/delete the message's sender information to the address
3196 book @file{~/.addresses} interactively. If this command is called with
3197 prefix argument, arbitrary address can be edited.
3198 (@code{wl-summary-edit-petname})
3202 @findex wl-status-update
3203 Sync up address book status with @file{~/.addresses}'s content.
3204 (@code{wl-status-update})
3208 @findex wl-summary-pipe-message
3209 Pipe current message's content to the external process.
3210 (@code{wl-summary-pipe-message})
3214 @findex wl-summary-print-message
3215 Print out current message's content.
3216 It uses @code{ps-print} module in Emacs 20.x.
3217 If you don't use color printer, you might want to set
3218 @code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
3221 (setq wl-ps-print-buffer-function 'ps-print-buffer)
3224 (@code{wl-summary-print-message})
3228 @findex wl-summary-exit
3229 Exit current folder.
3230 (@code{wl-summary-exit})
3234 @findex wl-summary-jump-to-current-message
3235 Jump cursor to the currently displayed message's window.
3236 (@code{wl-summary-jump-to-current-message})
3240 Jump cursor to the other message.
3241 @findex wl-summary-jump-to-msg
3242 (@code{wl-summary-jump-to-msg})
3246 Update summary status and
3247 prefetch all messages which have marks included in the
3248 @code{wl-summary-incorporate-marks}.
3249 @findex wl-summary-incorporate
3250 (@code{wl-summary-incorporate})
3253 @kindex M-j (Summary)
3254 @findex wl-summary-jump-to-msg-by-message-id
3255 Jump cursor to the message which have specified @samp{Message-Id:}. If
3256 @code{elmo-use-database} is non-nil, other folder is also searched.
3257 (@code{wl-summary-jump-to-msg-by-message-id})
3261 Jump to parent message.
3262 @findex wl-summary-jump-to-parent-message
3263 (@code{wl-summary-jump-to-parent-message})
3267 @findex wl-summary-mark-as-unread
3268 Mark as unread the message at current cursor point.
3269 (@code{wl-summary-mark-as-unread})
3273 @findex wl-summary-sync
3274 Synchronize summary view after prompting the update range
3275 (@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
3279 all ...Discard current summary and update all message.
3280 all-visible ...Discard current summary and update all visible message.
3281 update ...Update the difference between summary and the folder itself.
3282 rescan ...Rescan the msgdb and display again.
3283 rescan-noscore ...Rescan the msgdb and display again (without scoring).
3284 cache-status ...Sync the all marks with the real status of cache.
3285 first, last ...Move to the filter folder(partial filter).
3290 (@code{wl-summary-sync})
3294 @findex wl-summary-sort
3296 You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
3297 (@code{wl-summary-sort})
3301 @findex wl-summary-toggle-thread
3302 Toggle the threading.
3303 Threading status is displayed on the modeline.
3304 @samp{@{S@}} means threading is off (Sequence) and
3305 @samp{@{T@}} means threading is on (Thread).
3306 (@code{wl-summary-toggle-thread})
3310 @findex wl-summary-toggle-disp-folder
3311 Toggle displaying of folder window.
3312 (@code{wl-summary-toggle-disp-folder})
3316 Toggle displaying of message window.
3317 @findex wl-summary-toggle-disp-msg
3318 (@code{wl-summary-toggle-disp-msg})
3322 Move to the virtual folder with the condition specified.
3323 If called with prefix argument and current folder is virtual, exit it.
3324 @findex wl-summary-virtual
3325 (@code{wl-summary-virtual})
3328 @kindex @key{TAB} (Summary)
3329 @findex wl-summary-goto-last-displayed-msg
3330 Jump to the message which is displayed last.
3331 (@code{wl-summary-goto-last-displayed-msg})
3335 Put @samp{*} mark on the messages that satisfies the specified condition.
3336 @findex wl-summary-pick
3337 (@code{wl-summary-pick})
3341 @findex wl-summary-mark-as-read
3342 Mark as read the message at the current cursor point.
3343 (@code{wl-summary-mark-as-read})
3347 Prefetch the message at the current cursor point.
3348 With prefix argument, prefetch the message even if it is cached.
3349 @findex wl-summary-prefetch
3350 (@code{wl-summary-prefetch})
3354 Execute @samp{D}, @samp{o} and @samp{O} marks.
3355 @findex wl-summary-exec
3356 (@code{wl-summary-exec})
3360 @findex wl-summary-target-mark-line
3361 Put target mark on the message at the current cursor point.
3362 (@code{wl-summary-target-mark-line})
3366 Put refile mark on the message at the current cursor point.
3367 @findex wl-summary-refile
3368 (@code{wl-summary-refile})
3371 @kindex C-o (Summary)
3372 Execute auto refile.
3373 @findex wl-summary-auto-refile
3374 (@code{wl-summary-auto-refile})
3378 Put copy mark on the message at the current cursor point.
3379 @findex wl-summary-copy
3380 (@code{wl-summary-copy})
3383 @kindex M-o (Summary)
3384 Put refile mark on the message at the current cursor point with the destination
3385 previously specified.
3386 @findex wl-summary-refile-prev-destination
3387 (@code{wl-summary-refile-prev-destination})
3391 @findex wl-summary-delete
3392 Put delete mark on the message at the current cursor point.
3393 (@code{wl-summary-delete})
3397 @findex wl-summary-unmark
3398 Unmark the temporal mark on the message at the current cursor point.
3399 (@code{wl-summary-unmark})
3403 Unmark all the temporal marks.
3404 @findex wl-summary-unmark-all
3405 (@code{wl-summary-unmark-all})
3408 @kindex r R (Summary)
3409 @findex wl-summary-mark-as-read-region
3410 Mark as read messages in the specified region.
3411 (@code{wl-summary-mark-as-read-region})
3414 @kindex r $ (Summary)
3415 @findex wl-summary-mark-as-important-region
3416 Mark as important @samp{$} messages in the specified region.
3417 If @samp{$} already exists, it is deleted.
3418 (@code{wl-summary-mark-as-important-region})
3421 @kindex r ! (Summary)
3422 @findex wl-summary-mark-as-unread-region
3423 Mark as unread messages in the specified region.
3424 (@code{wl-summary-mark-as-unread-region})
3427 @kindex r i (Summary)
3428 @findex wl-summary-prefetch-region
3429 Prefetch messages in the specified region.
3430 (@code{wl-summary-prefetch-region})
3433 @kindex r x (Summary)
3434 @findex wl-summary-exec-region
3435 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
3437 (@code{wl-summary-exec-region})
3440 @kindex r * (Summary)
3441 @findex wl-summary-target-mark-region
3442 Put target mark on the messages in the specified region.
3443 (@code{wl-summary-target-mark-region})
3446 @kindex r o (Summary)
3447 @findex wl-summary-refile-region
3448 Put refile mark on the messages in the specified region.
3449 (@code{wl-summary-refile-region})
3452 @kindex r O (Summary)
3453 @findex wl-summary-copy-region
3454 Put copy mark on the messages in the specified region.
3455 (@code{wl-summary-copy-region})
3458 @kindex r d (Summary)
3459 @findex wl-summary-delete-region
3460 Put delete mark on the messages in the specified region.
3461 (@code{wl-summary-delete-region})
3464 @kindex r u (Summary)
3465 @findex wl-summary-unmark-region
3466 Delete temporal mark on the messages in the specified region.
3467 (@code{wl-summary-unmark-region})
3470 @kindex r y (Summary)
3471 Save messages in the specified region.
3472 @findex wl-summary-save-region
3473 (@code{wl-summary-save-region})
3476 @kindex t R (Summary)
3477 @findex wl-thread-mark-as-read
3478 Mark as read messages which are the descendant of the current thread.
3479 With prefix argument, it affects on the all messages in the thread tree.
3480 (@code{wl-thread-mark-as-read})
3483 @kindex t $ (Summary)
3484 @findex wl-thread-mark-as-important
3485 Put important mark @samp{$} on the messages which are the
3486 descendant of the current thread.
3487 If @samp{$} mark exists, it is deleted.
3488 With prefix argument, it affects on the all messages in the thread tree.
3489 (@code{wl-thread-mark-as-important})
3492 @kindex t ! (Summary)
3493 @findex wl-thread-mark-as-unread
3494 Mark as unread messages which are the descendant of the current thread.
3495 With prefix argument, it affects on the all messages in the thread tree.
3496 (@code{wl-thread-mark-as-unread})
3499 @kindex t i (Summary)
3500 @findex wl-thread-prefetch
3501 Prefetch messages which are the descendant of the current thread.
3502 With prefix argument, it affects on the all messages in the thread tree.
3503 (@code{wl-thread-prefetch})
3506 @kindex t x (Summary)
3507 @findex wl-thread-exec
3508 Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
3509 the descendant of the current thread. With prefix argument, it affects
3510 on the all messages in the thread tree.
3511 (@code{wl-thread-exec})
3514 @kindex t * (Summary)
3515 @findex wl-thread-target-mark
3516 Put target mark @samp{*} on the messages which are the descendant of the
3517 current thread. With prefix argument, it affects on the all messages in
3519 (@code{wl-thread-target-mark})
3522 @kindex t o (Summary)
3523 @findex wl-thread-refile
3524 Put refile mark on the messages which are the descendant of the current thread.
3525 With prefix argument, it affects on the all messages in the thread tree.
3526 (@code{wl-thread-refile})
3529 @kindex t O (Summary)
3530 @findex wl-thread-copy
3531 Put copy mark on the messages which are the descendant of the current thread.
3532 With prefix argument, it affects on the all messages in the thread tree.
3533 (@code{wl-thread-copy})
3536 @kindex t d (Summary)
3537 @findex wl-thread-delete
3538 Put delete mar on the messages which are the descendant of the current thread.
3539 With prefix argument, it affects on the all messages in the thread tree.
3540 (@code{wl-thread-delete})
3543 @kindex t u (Summary)
3544 @findex wl-thread-unmark
3545 Unmark temporal mark on the messages which are the descendant of the
3546 current thread. With prefix argument, it affects on the all messages in
3548 (@code{wl-thread-unmark})
3551 @kindex t y (Summary)
3552 @findex wl-thread-save
3553 Save messages which are the descendant of the current thread.
3554 With prefix argument, it affects on the all messages in the thread tree.
3555 (@code{wl-thread-save})
3558 @kindex m i (Summary)
3559 @findex wl-summary-target-mark-prefetch
3560 Prefetch all messages which have target mark @samp{*}.
3561 With prefix argument, prefetch all targets even if some of them are cached.
3562 (@code{wl-summary-target-mark-prefetch})
3565 @kindex m R (Summary)
3566 @findex wl-summary-target-mark-mark-as-read
3567 Mark as read all messages which have target mark @samp{*}.
3568 (@code{wl-summary-target-mark-mark-as-read})
3571 @kindex m $ (Summary)
3572 @findex wl-summary-target-mark-mark-as-important
3573 Mark as important all messages which have target mark @samp{*}.
3574 If already marked as @samp{$}, it is deleted.
3575 (@code{wl-summary-target-mark-mark-as-important})
3578 @kindex m ! (Summary)
3579 @findex wl-summary-target-mark-mark-as-unread
3580 Mark as unread all messages which have target mark @samp{*}.
3581 (@code{wl-summary-target-mark-mark-as-unread})
3584 @kindex m o (Summary)
3585 @findex wl-summary-target-mark-refile
3586 Put refile mark on the messages which have target mark @samp{*}.
3587 (@code{wl-summary-target-mark-refile})
3590 @kindex m O (Summary)
3591 @findex wl-summary-target-mark-copy
3592 Put copy mark on the messages which have target mark @samp{*}.
3593 (@code{wl-summary-target-mark-copy})
3596 @kindex m d (Summary)
3597 @findex wl-summary-target-mark-delete
3598 Put delete mark on the messages which have target mark @samp{*}.
3599 (@code{wl-summary-target-mark-delete})
3602 @kindex m y (Summary)
3603 @findex wl-summary-target-mark-save
3604 Save messages which have target mark @samp{*}.
3605 (@code{wl-summary-target-mark-save})
3608 @kindex m u (Summary)
3609 Unmark all temporal marks.
3610 (@code{wl-summary-delete-all-temp-marks})
3611 @findex wl-summary-delete-all-temp-marks
3614 @kindex m a (Summary)
3615 Put target mark @samp{*} on the all messages.
3616 (@code{wl-summary-target-mark-all})
3617 @findex wl-summary-target-mark-all
3620 @kindex m t (Summary)
3621 Put target mark @samp{*} on the messages in the current thread.
3622 @findex wl-summary-target-mark-thread
3623 (@code{wl-summary-target-mark-thread})
3626 @kindex m r (Summary)
3627 @findex wl-summary-target-mark-region
3628 Put target mark @samp{*} on the messages in the specified region.
3629 (@code{wl-summary-target-mark-region})
3632 @kindex m A (Summary)
3633 @findex wl-summary-target-mark-reply-with-citation
3634 Prepare a draft which cites all messages which have target mark @samp{*}.
3635 (@code{wl-summary-target-mark-reply-with-citation})
3638 @kindex m f (Summary)
3639 @findex wl-summary-target-mark-forward
3640 Prepare a draft which forwards all messages which have target mark @samp{*}.
3641 (@code{wl-summary-target-mark-forward})
3644 @kindex m U (Summary)
3645 @findex wl-summary-target-mark-uudecode
3646 Uudecode the messages which have target mark @samp{*}.
3647 (@code{wl-summary-target-mark-uudecode})
3650 @kindex m ? (Summary)
3651 @findex wl-summary-target-mark-pick
3652 Pick messages from the @samp{*} marked messages.
3653 That is, @samp{*} marks on the messages are remained
3654 if the specified condition is satisfied.
3655 (@code{wl-summary-target-mark-pick})
3658 @kindex m # (Summary)
3659 @findex wl-summary-target-mark-print
3660 Print out all messages which have target mark @samp{*}.
3661 (@code{wl-summary-target-mark-print})
3664 @kindex m | (Summary)
3665 @findex wl-summary-target-mark-pipe
3666 Pipe content of each message with target mark @samp{*} to some specified
3668 (@code{wl-summary-target-mark-pipe})
3671 @kindex M-t (Summary)
3672 @findex wl-toggle-plugged
3673 Toggle offline/online status of Wanderlust.
3674 (@code{wl-toggle-plugged})
3677 @kindex C-t (Summary)
3678 Start Wanderlust's plug-status manager.
3679 (@code{wl-plugged-change})
3682 @kindex C-c C-o (Summary)
3683 @findex wl-jump-to-draft-buffer
3684 Move to the draft buffer if available. If multiple draft buffer exists,
3685 moved to one after another. If prefix argument is specified, load draft
3686 folder's message to the draft buffer and jump to it.
3687 (@code{wl-jump-to-draft-buffer})
3690 @kindex M-w (Summary)
3691 @findex wl-summary-save-current-message
3692 Save the message at the current cursor point.
3693 (@code{wl-summary-save-current-message})
3696 @kindex C-y (Summary)
3697 @findex wl-summary-yank-saved-message
3698 Regard the message at the current cursor point as
3699 parent, connect the message saved by
3700 @code{wl-summary-save-current-message}
3702 (@code{wl-summary-yank-saved-message})
3705 @kindex C-x C-s (Summary)
3706 @findex wl-summary-save-status
3707 Save the current summary.
3708 (@code{wl-summary-save-status})
3712 @node Variables of Summary, , Key Bindings of Summary, Summary
3713 @section Customiziable variables
3716 @item wl-summary-move-order
3717 @vindex wl-summary-move-order
3718 The initial setting is @code{unread}. Specify cursor moving policy. If
3719 you want to precede new messages, set @code{new}. If you want to
3720 precede unread messages, set @code{unread}. If @code{nil}, proceed to
3723 @item wl-auto-select-first
3724 @vindex wl-auto-select-first
3725 The initial setting is @code{nil}.
3726 If non-nil, first message is automatically displayed when you enter
3729 @item wl-auto-select-next
3730 @vindex wl-auto-select-next
3731 The initial setting is @code{nil}. This controls behavior when there is
3732 no unread message in current summary.
3735 nil: asks whether you want to go back to folder mode
3736 'unread: asks whether you want to go to next unread folder
3737 If the next one comes to be possessing no unread message
3738 by treatment of cross-posted messages or Scoring, then
3739 asks whether you want to go to next to next folder.
3740 'skip-no-unread: similar as unread
3741 But does not ask before going to next to next folder.
3742 otherwise: asks whether you want to go to next unread folder
3745 It might be useful to set @code{'skip-no-unread} for people who
3746 want to continue reading by just pressing and pressing space key.
3748 @item wl-thread-insert-opened
3749 @vindex wl-thread-insert-opened
3750 The initial setting is @code{nil}.
3751 If non-nil, thread is inserted as opened.
3753 @item wl-thread-open-reading-thread
3754 @vindex wl-thread-open-reading-thread
3755 The initial setting is @code{t}. If non-nil, reading thread is
3756 automatically opened though it is closed thread.
3758 @item wl-summary-exit-next-move
3759 @vindex wl-summary-exit-next-move
3760 The initial setting is @code{t}. If non-nil, move to next folder at
3763 @item wl-folder-move-cur-folder
3764 @vindex wl-folder-move-cur-folder
3765 The initial setting is @code{nil}. If non-nil, cursor position on the
3768 @item wl-summary-weekday-name-lang
3769 @vindex wl-summary-weekday-name-lang
3770 The initial setting is @samp{ja}. Specify language of the weekday.
3771 @samp{en} displays English, @samp{fr} displays French, @samp{de}
3772 displays Deutsch. You should rescan summary view after changing this value.
3774 @item wl-summary-fix-timezone
3775 @vindex wl-summary-fix-timezone
3776 The initial setting is @code{nil}.
3777 Time zone of the date string in summary mode is adjusted using this value.
3778 If @code{nil}, it is adjust to the default time zone information
3779 (system's default time zone or environment variable @samp{TZ}).
3781 @item wl-use-petname
3782 @vindex wl-use-petname
3783 The initial setting is @code{t}.
3784 If non-nil, sender part displays nickname.
3786 @item wl-break-pages
3787 @vindex wl-break-pages
3788 The initial setting is @code{t}.
3789 If non-nil, message is split as pages by @samp{^L}.
3791 @item wl-message-window-size
3792 @vindex wl-message-window-size
3793 The initial setting is '(1 . 4).
3794 A cons cell to specify the rate of summary and message window.
3795 car:cdr corresponds summary:message.
3797 @item wl-summary-no-from-message
3798 @vindex wl-summary-no-from-message
3799 The initial setting is @samp{nobody@@nowhere?}. A string which is
3800 displayed when there's no @samp{From:} field in the message.
3802 @item wl-summary-no-subject-message
3803 @vindex wl-summary-no-subject-message
3804 The initial setting is @samp{(WL:No Subject in original.)}. A string
3805 which is displayed when there's no @samp{Subject:} field in the message.
3807 @item wl-summary-use-frame
3808 @vindex wl-summary-use-frame
3809 The initial setting is @code{nil}.
3810 If non-nil, use new frame for the summary.
3812 @item wl-use-folder-petname
3813 @vindex wl-use-folder-petname
3814 The initial setting is the list shown below:
3823 A list of display policy (symbol) of folder nickname. Available symbols
3828 Display folder petname on modeline.
3830 Destination folder is notified as nickname if
3831 @code{wl-auto-select-next} is non-nil.
3833 You can input folder name by nickname in the function
3834 @code{wl-summary-read-folder}.
3837 @item wl-summary-move-direction-toggle
3838 @vindex wl-summary-move-direction-toggle
3839 The initial setting is @code{t}. If non-nil, last executed @kbd{p},
3840 @kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
3841 want to aware of reading direction, set this to @code{t}.
3843 @item wl-summary-width
3844 @vindex wl-summary-width
3845 The initial setting is 80.
3846 Width of summary line. If @code{nil}, summary line's width is as is.
3848 @item wl-summary-from-width
3849 @vindex wl-summary-from-width
3850 The initial setting is 17.
3851 Width of sender part of summary line.
3853 @item wl-summary-subject-length-limit
3854 @vindex wl-summary-subject-length-limit
3855 The initial setting is @code{nil}. Specify the limit for the length of
3856 subject parts in summary. @code{nil} means unlimited.
3858 @item wl-summary-indent-length-limit
3859 @vindex wl-summary-indent-length-limit
3860 The initial setting is 46.
3861 Specify the limit of thread indent level. @code{nil} means unlimited
3863 If you set this to @code{nil} you should set @code{wl-summary-width}
3866 @item wl-summary-recenter
3867 @vindex wl-summary-recenter
3868 The initial setting is t.
3869 If non-nil, cursor point is moved to the center of the summary window.
3871 @item wl-summary-divide-thread-when-subject-changed
3872 @vindex wl-summary-divide-thread-when-subject-changed
3873 The initial setting is @code{nil}. If non-nil, thread is split if
3874 the subject is changed.
3876 @item wl-summary-search-via-nntp
3877 @vindex wl-summary-search-via-nntp
3878 The initial setting is @code{confirm}.
3880 If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
3881 @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
3882 from the NNTP server @code{elmo-nntp-default-server}. The value of
3883 @code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
3884 @code{elmo-nntp-default-stream-type} are used.
3886 If @code{confirm}, server name can be specified. You can specify NNTP
3887 folder format like @samp{-:username@@servername:119!}.
3889 @item wl-summary-keep-cursor-command
3890 @vindex wl-summary-keep-cursor-command
3891 The initial setting is the list shown below:
3895 (wl-summary-goto-folder wl-summary-goto-last-visited-folder)
3900 When you entered to summary by these commands and the target summary
3901 buffer already exists, summary status is not automatically updated and
3902 cursor position is saved.
3904 @item elmo-folder-update-threshold
3905 @vindex elmo-folder-update-threshold
3906 The initial setting is 500. If updated message number is larger than
3907 this value, confirm whether drop them or not (in the case where the value
3908 of @code{elmo-folder-update-confirm} is non-nil).
3910 @item elmo-folder-update-confirm
3911 @vindex elmo-folder-update-confirm
3912 The initial setting is @code{t}. If the value is non-nil, do check with
3913 @code{elmo-folder-update-threshold}.
3915 @item wl-summary-always-sticky-folder-list
3916 @vindex wl-summary-always-sticky-folder-list
3917 The initial setting is @code{nil}.
3918 @code{wl-summary-always-sticky-folder-list} specifies the folders that
3919 are automatically stuck. Each element is regexp of folder name.
3921 @item wl-summary-reserve-mark-list
3922 @vindex wl-summary-reserve-mark-list
3923 The initial setting is the list shown below:
3932 If a message is already marked as temporal marks in this list, the
3933 message is not marked by any mark command.
3935 @item wl-summary-skip-mark-list
3936 @vindex wl-summary-skip-mark-list
3937 The initial setting is the list shown below:
3946 If a message is already marked as temporal marks in this list, the
3947 message is skipped at cursor move.
3949 @item elmo-message-fetch-threshold
3950 @vindex elmo-message-fetch-threshold
3951 The initial setting is 30000 (bytes). If displaying message has larger
3952 size than this value, Wanderlust confirms whether fetch the message or
3953 not (in the case where the value of @code{elmo-message-fetch-confirm}
3956 @item elmo-message-fetch-confirm
3957 @vindex elmo-message-fetch-confirm
3958 The initial setting is @code{t}. If the value is non-nil, do check with
3959 @code{elmo-message-fetch-threshold}.
3961 @item wl-prefetch-threshold
3962 @vindex wl-prefetch-threshold
3963 The initial setting is 30000 (bytes). If prefetching message has larger
3964 size than this value and @code{wl-prefetch-confirm} is non-nil,
3965 Wanderlust confirms whether prefetch the message or not. If
3966 @code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
3967 without confirmation.
3969 @item wl-prefetch-confirm
3970 @vindex wl-prefetch-confirm
3971 The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
3972 prefetch the message or not if the message has larger size than
3973 @code{wl-prefetch-threshold}.
3975 @item elmo-imap4-use-cache
3976 @vindex elmo-imap4-use-cache
3977 The initial setting is @code{t}. If non-nil, messages read via IMAP4
3980 @item elmo-nntp-use-cache
3981 @vindex elmo-nntp-use-cache
3982 The initial setting is @code{t}. If non-nil, messages read via NNTP are
3985 @item elmo-pop3-use-cache
3986 @vindex elmo-pop3-use-cache
3987 The initial setting is @code{t}. If non-nil, messages read via POP3 are
3990 @item elmo-shimbun-use-cache
3991 @vindex elmo-shimbun-use-cache
3992 The initial setting is @code{t}. If non-nil, messages read in Shimbun
3995 @item wl-folder-process-duplicates-alist
3996 @vindex wl-folder-process-duplicates-alist
3997 The initial setting is @code{nil}.
3998 This list determines how to deal with duplicated messages in the same folder.
3999 Each item in the list is regexp of folder name and action; you can specify any
4000 one of the following in the place of action:
4003 @code{nil} : do nothing for duplicated messages.
4004 @code{hide} : hide duplicated messages from the summary.
4005 @code{read} : set duplicated messages as read.
4009 Following is an example (hide duplicated messages in multi folders)
4013 (setq wl-folder-process-duplicates-alist
4014 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
4015 ("^\\*.*" . hide) (".*" . read)))
4021 @node Message, Draft, Summary, Top
4022 @chapter Message Buffer
4024 Message Buffers utilize MIME-View mode of SEMI. For operational
4025 procedures and key bindings, refer to respective documents.
4026 @xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
4027 You can also see help by @kbd{?} in message buffer.
4029 @kbd{p} at the top of a message or @kbd{n} at the bottom of a message
4030 brings you back to Summary mode. @kbd{l} toggles display of Summary
4033 @section Key Bindings
4039 @findex wl-message-toggle-disp-summary
4040 Toggles display of Summary buffer.
4041 (@code{wl-message-toggle-disp-summary})
4044 @findex wl-message-refer-article-or-url
4045 @kindex Button-2 (Message)
4046 Assumes @samp{Message-ID:} at the mouse pointer, and shows the
4047 corresponding message if found.
4048 (@code{wl-message-refer-article-or-url})
4050 @item Button-4 (upward movement of a wheel)
4051 @kindex Button-4 (Message)
4052 @findex wl-message-wheel-down
4053 Scrolls the message backwards. When the top of the message is hit,
4054 moves to the previous message.
4055 (@code{wl-message-wheel-down})
4057 @item Button-5 (downward movement of a wheel)
4058 @kindex Button-5 (Message)
4059 @findex wl-message-wheel-up
4060 Scrolls the message forward. When the bottom of the message is hit,
4061 moves to the next message.
4062 (@code{wl-message-wheel-up})
4065 @section Customizable Variables
4068 @item wl-message-window-size
4069 @vindex wl-message-window-size
4070 Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
4071 its car and cdr value corresponds to the ratio of Summary and Message
4074 @item wl-message-ignored-field-list
4075 @vindex wl-message-ignored-field-list
4076 (SEMI only) Initial setting is @code{nil}.
4077 All fields that match this list will be hidden in message buffer.
4078 Each elements are regexp of field-name.
4079 If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
4081 @item wl-message-visible-field-list
4082 @vindex wl-message-visible-field-list
4083 (SEMI only) Initial setting is @code{nil}.
4084 All fields that match this list will be display in message buffer.
4085 Each elements are regexp of field-name. This value precedes
4086 @code{wl-message-ignored-field-list}.
4087 If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
4089 @item wl-message-sort-field-list
4090 @vindex wl-message-sort-field-list
4091 (SEMI only) Initial setting is
4092 '("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
4093 Header fields in message buffer are ordered by this value.
4094 Each elements are regexp of field-name.
4096 @item wl-message-truncate-lines
4097 @vindex wl-message-truncate-lines
4098 The initial value is the value of @code{default-truncate-lines}.
4099 If it is non-nil, truncate long lines in message buffer.
4102 @node Draft, Disconnected Operations, Message, Top
4103 @chapter Draft Buffer
4105 At Summary mode, pressing @kbd{w} and the like creates a new draft
4106 buffer. You can edit and send mail and news articles in this buffer.
4108 By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
4109 with those if possible.
4112 * Usage of Draft Mode:: TIPS
4113 * Key Bindings of Draft:: Key bindings
4114 * Variables of Draft Mode:: Customize Draft Mode
4117 @node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
4120 Basically it is Emacs-standard mail mode.
4124 * Editing Message Body::
4125 * Dynamical Message Re-arrangement::
4130 @node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
4131 @subsection Editing Message Header
4133 Initially, the cursor is at the @samp{To:} field. Fill in recipients
4134 addresses. @kbd{@key{TAB}} completes them.
4136 You can use following headers to specify recipients. Add some of them
4137 by yourself. Field names can be completed by @kbd{@key{TAB}}.
4140 @item @samp{Newsgroups:}
4141 Specify newsgroups to which you post the news article.
4144 Specify addresses to send a copy (Carbon Copy) of the message.
4147 Following ones are removed from the header contents before sending.
4151 Specify addresses to send a copy (Blind Carbon Copy) of the message.
4154 Specify folders in which a copy of the message is saved.
4157 Specify recipients to send encapsulated copy of the message.
4160 You can add initial headers by following variables.
4166 The initial setting is @code{nil}.
4167 If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
4168 the draft when it is prepared. If function is specified, its return
4173 The initial setting is @code{nil}.
4174 If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
4175 the draft when it is prepared.
4178 @node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
4179 @subsection Editing Messages
4181 Multi-part editing utilize MIME edit mode of SEMI. For procedures of
4182 editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
4183 a MIME user interface for GNU Emacs}.
4184 You can also see help by @kbd{C-c C-x ?} in draft buffer.
4186 If you save the draft buffer you are editing, it is appended to the
4187 folder specified by @code{wl-draft-folder}.
4189 @node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
4190 @subsection Dynamic Modification of Messages
4191 @vindex wl-draft-config-alist
4192 @c @cindex Change Message
4193 @c @cindex Message, Change Dynamic
4195 You can set @code{wl-draft-config-alist} so that header and body of the
4196 message will automatically modified depending on information of header
4199 The initial setting of @code{wl-draft-config-alist} is @code{nil}.
4201 In the example below, the header is modified when
4202 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
4203 can set @code{wl-interactive-send} to non-nil so as to confirm changes
4204 before sending the message.
4208 (setq wl-draft-config-alist
4209 '(((string-match "aaa\\.example\\.com$" (system-name))
4210 ;; @r{applied if the expression is non-nil}
4211 (wl-smtp-posting-server . "mailserver-B")
4212 (wl-nntp-posting-server . "newsserver-B")
4213 ;; @r{settings of temporary variables}
4215 ("^To: .*user@@aaa\\.bbb\\.example\\.com"
4216 ;; @r{applied if it matches the header of the draft buffer}
4217 ("Organization" . (format "Go %s" my-webpage)))
4218 ;; @r{you can write elisp expressions here (eval only)}
4219 (top . "Hello.\n") ;; @r{inserted at the top of the body}
4220 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
4225 The format of @code{wl-draft-config-alist} is:
4229 '(("@var{regexp of the header}" or @var{elisp expression}
4230 ("@var{Field}" . value(@var{elisp expression}))
4231 (@var{variable} . value(@var{elisp expression}))
4232 (@var{sub-function} . value(@var{elisp expression}))
4235 ("@var{regexp of the header}" or @var{elisp expression}
4236 ("@var{Field}" . value(@var{elisp expression}))
4241 Per default, there are 10 following sub-functions.
4244 'header: Inserts the specified string at the bottom of the header.
4245 'header-top: Inserts the specified string at the top of the header.
4246 'header-file: Inserts the specified file at the bottom of the header.
4247 'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
4248 'top: Inserts the specified string at the top of the body.
4249 'top-file: Inserts the specified file at the top of the body.
4250 'body: Replaces the body with the specified string.
4251 Specifying @code{nil} deletes the entire body string.
4252 'body-file: Replaces the body with the content of the specified file.
4253 'bottom: Inserts the specified string at the bottom of the body.
4254 'bottom-file: Inserts the specified file at the top of the body.
4255 'part-top: Inserts the specified string at the top of the current part.
4256 'part-bottom: Inserts the specified string at the bottom of the current part.
4257 'template: Applies the specified template.
4258 (refer to the next subsection)
4261 These are defined in @code{wl-draft-config-sub-func-alist} and you can
4262 change them or add your own functions. If you read the code, you can
4263 easily find how to write the functions.
4265 At the first of each item, @var{a regular expression of the header} or
4266 an @var{elisp expression} should be specified. In the case of an elisp
4267 expression, the item is applied when the expression is evaluated
4270 Per default, when multiple items match or are evaluated non-nil, all
4271 such items are applied, but if you set a variable
4272 @code{wl-draft-config-matchone} to @code{t}, only the first matching one
4275 At the second of the item, a cons or a list of functions should be
4276 specified. The car part of the cons should be a header field, a
4277 variable, or a sub-function. When a header field is specified, the
4278 field will be modified. If a variable is specified, the value of the
4279 variable will be modified temporarily.
4281 In the cdr part of a cons, not only a variable but also an elisp
4282 expression can be specified as is. If the car part is a header field
4283 and the cdr part is @code{nil}, the field will be deleted.
4285 If you want to use name of parent folder, you can refer the buffer local
4286 variable @code{wl-draft-parent-folder}.
4288 See the next example as well:
4292 (setq wl-draft-config-alist
4294 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
4295 ;; @r{applied if it matches the header of the buffer being replied}
4296 (body . " Hello.\n")
4297 (template . "default")
4302 As in the (1) above, if a header regexp is prepended with @code{reply},
4303 it is applied when the draft is prepared by @code{wl-summary-reply} for
4304 example, and when it matches the header being replied. It is ignored
4305 when there is no buffer being replied, like after @code{wl-draft} was
4308 Note that @code{wl-draft-config-alist} is applied only once when
4309 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
4310 Therefore, if you want to apply @code{wl-draft-config-alist} again after
4311 aborting transmission, execute @kbd{C-c C-e}
4312 (@code{wl-draft-config-exec}) explicitly.
4314 If you don't want to apply @code{wl-draft-config-alist} when
4315 @code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
4319 (remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
4322 If you want to apply @code{wl-draft-config-alist} when a draft buffer is
4323 prepared, do the following:
4326 (add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
4329 If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
4330 from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
4334 (add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
4337 @node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
4338 @subsection Inserting Templates
4340 @cindex Apply Template
4342 Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
4343 @kbd{M-x wl-template-select} in the draft buffer.
4345 The format of @code{wl-template-alist} is almost the same as
4346 @code{wl-draft-config-alist}.
4350 (setq wl-template-alist
4353 ("Organization" . "Example Co.Ltd.")
4354 (body . "Hello.\n"))
4356 (template . "default") ;; @r{(a)}
4357 ("To" . "boss@@example.com")
4358 ("Subject" . "Report")
4359 (body-file . "~/work/report.txt")
4365 As you can see, the only difference is item (template) names such as
4366 @samp{default} and @samp{report}, instead of a regexp of header.
4367 Because definition of each item is the same as
4368 @code{wl-draft-config-alist}, you can call another template, like (a).
4370 Executing the command @code{wl-template-select} results in template
4371 selection, but the result differs depending on variable
4372 @code{wl-template-visible-select}.
4374 If @code{wl-template-visible-select} is @code{t} (default), a buffer
4375 window is shown below the draft buffer. You can select a template by
4376 @kbd{n} and @kbd{p} seeing the buffer window.
4378 Press the @key{RET} key and the template is actually applied to the draft
4379 buffer. If you press @kbd{q}, nothing is applied. In addition, you can
4380 adjust the window size by @code{wl-template-buffer-lines}.
4382 If @code{wl-template-visible-select} is @code{nil}, you should type the
4383 name of the template in the mini buffer.
4385 As shown in the example in @code{wl-draft-config-alist}, you can select
4386 @samp{default} template by writing:
4389 (template . "default")
4392 @node POP-before-SMTP, , Template, Usage of Draft Mode
4393 @subsection Sending mail by POP-before-SMTP
4394 @cindex POP-before-SMTP
4396 You can send mail by POP-before-SMTP with this single line:
4399 (setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
4403 Configure the following variables if you need.
4406 @item wl-pop-before-smtp-user
4407 The POP user name for POP-before-SMTP authentication.
4408 If unset, @code{elmo-pop3-default-user} is used.
4410 @item wl-pop-before-smtp-server
4411 The POP server name for POP-before-SMTP authentication.
4412 If unset, @code{elmo-pop3-default-server} is used.
4414 @item wl-pop-before-smtp-authenticate-type
4415 The POP authentication method for POP-before-SMTP authentication.
4416 If unset, @code{elmo-pop3-default-authenticate-type} is used.
4418 @item wl-pop-before-smtp-port
4419 The POP port number for POP-before-SMTP authentication.
4420 If unset, @code{elmo-pop3-default-port} is used.
4422 @item wl-pop-before-smtp-stream-type
4423 If non-nil, POP connection is established using SSL. If
4424 @code{starttls}, STARTTLS (RFC2595) connection will be established. If
4425 unset, @code{elmo-pop3-default-stream-type} is used.
4428 If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
4429 unset, settings for POP folders (@code{elmo-pop3-default-*}) are
4431 Therefore, if SMTP server and POP server are actually the same, and if
4432 POP folder per default (such as @samp{&}) is available, no settings are
4435 Refer to the following URL about POP-before-SMTP.
4439 http://spam.ayamura.org/tools/smPbS.html
4440 http://www.iecc.com/pop-before-smtp.html
4445 @node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
4446 @section Key Bindings
4447 @cindex Keybind, Draft Mode
4448 @cindex Keybind, Draft Buffer
4453 @kindex C-c C-y (Draft)
4454 @findex wl-draft-yank-original
4455 Cites the content of the current message buffer.
4456 (@code{wl-draft-yank-original})
4459 @kindex C-c C-p (Draft)
4460 @findex wl-draft-preview-message
4461 Previews the content of the current draft.
4462 This is useful for previewing MIME multi-part messages.
4463 (@code{wl-draft-preview-message})
4466 @kindex C-c C-s (Draft)
4467 @findex wl-draft-send
4468 Sends the content of the current draft. Does not erase the draft buffer.
4469 This is useful for sending multiple messages, which are a little different
4471 (@code{wl-draft-send})
4474 @kindex C-c C-c (Draft)
4475 @findex wl-draft-send-and-exit
4476 Sends the content of the current draft and erases the draft buffer.
4477 (@code{wl-draft-send-and-exit})
4480 @kindex C-x C-s (Draft)
4481 @findex wl-draft-save
4482 Save the current draft.
4483 (@code{wl-draft-save})
4486 @kindex C-c C-k (Draft)
4487 @findex wl-draft-kill
4488 Kills the current draft.
4489 (@code{wl-draft-kill})
4492 @kindex C-x k (Draft)
4493 @findex wl-draft-mimic-kill-buffer
4494 Kills the current draft.
4495 (@code{wl-draft-mimic-kill-buffer})
4498 @kindex C-c C-z (Draft)
4499 @findex wl-draft-save-and-exit
4500 Saves the current draft, and erases the draft buffer.
4501 This is useful if you want to suspend editing of the draft.
4502 You can resume editing by pressing @kbd{E} (@code{wl-summary-reedit}) in
4503 the @samp{+draft} folder.
4504 (@code{wl-draft-save-and-exit})
4507 @kindex C-c C-r (Draft)
4508 @findex wl-caesar-region
4509 Encodes or decodes the specified region in Caesar cipher.
4510 (@code{wl-caesar-region})
4514 @findex wl-draft-highlight-and-recenter
4515 Recenter and rehighlight current draft.
4516 (@code{wl-draft-highlight-and-recenter})
4520 @findex wl-toggle-plugged
4521 Toggles off-line/on-line states of Wanderlust.
4522 (@code{wl-toggle-plugged})
4525 @kindex C-c C-o (Draft)
4526 @findex wl-jump-to-draft-buffer
4527 Jumps to the other draft buffer, if exists.
4528 With prefix argument, reads a file (if any) from the draft folder when
4529 there is no such buffer.
4530 (@code{wl-jump-to-draft-buffer})
4533 @kindex C-c C-e (Draft)
4534 @findex wl-draft-config-exec
4535 Applies @code{wl-draft-config-alist}.
4536 (@code{wl-draft-config-exec})
4539 @kindex C-c C-j (Draft)
4540 @findex wl-template-select
4542 (@code{wl-template-select})
4545 @kindex C-c C-a (Draft)
4547 Enter Address Manager.
4548 @xref{Address Manager}.
4552 @kindex C-c C-d (Draft)
4553 @findex wl-draft-elide-region
4554 Elide the text between point and mark (@code{wl-draft-elide-region}).
4555 The text is killed and replaced with the contents of the variable
4556 @code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
4560 @node Variables of Draft Mode, , Key Bindings of Draft, Draft
4561 @section Customizable Variables
4564 @item wl-subscribed-mailing-list
4565 @vindex wl-subscribed-mailing-list
4566 The initial setting is @code{nil}. Mailing lists to which you
4567 subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
4568 field of a reply draft, removes your own address from
4569 @samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
4570 contained in @samp{To:} or @samp{Cc:} field of a message to be
4571 automatically re-filed, the destination folder will be leaned in
4572 connection with the address.
4578 (setq wl-subscribed-mailing-list
4579 '("wl@@lists.airs.net"
4581 "emacs-mime-ja@@m17n.org"))
4585 @item wl-insert-mail-followup-to
4586 @vindex wl-insert-mail-followup-to
4587 The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
4588 field is automatically inserted in the draft buffer.
4590 @item wl-insert-mail-reply-to
4591 @vindex wl-insert-mail-reply-to
4592 The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
4593 field is automatically inserted in the draft buffer.
4595 @item wl-auto-insert-x-face
4596 @vindex wl-auto-insert-x-face
4597 The initial setting is @code{t}. If non-nil and there is an encoded
4598 X-Face string in a file @file{~/.xface} (the value of the variable
4599 @code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
4600 draft buffer. If @code{nil}, it is not automatically inserted.
4602 @item wl-insert-message-id
4603 @vindex wl-insert-message-id
4604 The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
4605 is automatically inserted on the transmission.
4607 @item wl-message-id-use-wl-from
4608 @vindex wl-message-id-use-wl-from
4609 The initial setting is @code{nil}. If non-nil, the value of
4610 @code{wl-from} will be used as the domain part of @samp{Message-ID:}.
4612 @item wl-local-domain
4613 @vindex wl-local-domain
4614 The initial setting is @code{nil}. If @code{nil}, the return value of
4615 the function @code{system-name} will be used as the domain part of
4618 If @code{system-name} does not return FQDN (i.e. the full name of the
4619 host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
4620 to the string of the local domain name without hostname (like
4621 @samp{gohome.org}). That is, a concatenation of @code{system-name}
4622 @samp{.} @code{wl-local-domain} is used as domain part of the
4625 If your terminal does not have global IP, set the value of
4626 @code{wl-message-id-domain}. (You might be beaten up on the Net News if
4627 you use invalid @samp{Message-ID:}.)
4629 Moreover, concatenation of @code{system-name} @samp{.}
4630 @code{wl-local-domain} will be used as an argument to the HELO command
4633 @item wl-message-id-domain
4634 @vindex wl-message-id-domain
4635 The initial setting is @code{nil}. If non-nil, this value is used as a
4636 domain part of the @samp{Message-ID:}. If your terminal does not have
4637 global IP address, set unique string to this value (e.x. your e-mail
4640 @item wl-unique-id-suffix
4641 @vindex wl-unique-id-suffix
4642 The initial setting is @samp{.wl}. You can specify the string in generated
4643 Message-ID which appear just before @samp{@@}.
4645 @item wl-draft-config-alist
4646 @vindex wl-draft-config-alist
4647 The initial setting is @code{nil}. Modifies the draft message just
4648 before the transmission. The content of @code{wl-draft-config-alist}
4649 will be automatically applied only once on the transmission. If you
4650 want to apply it manually, use @kbd{C-c C-e}. This command can be used
4653 @item wl-template-alist
4654 @vindex wl-template-alist
4655 The initial setting is @code{nil}.
4656 This variable specifies the template to be applied in the draft buffer.
4658 @item wl-draft-config-matchone
4659 @vindex wl-draft-config-matchone
4660 The initial setting is @code{nil}. If non-nil, only the first matching
4661 item is used when @code{wl-draft-config-alist} is applied. If
4662 @code{nil}, all matching items are used.
4664 @item wl-template-visible-select
4665 @vindex wl-template-visible-select
4666 The initial setting is @code{t}.
4667 If non-nil, you can preview the result of the template selection in
4670 @item wl-template-confirm
4671 @vindex wl-template-confirm
4672 The initial setting is @code{nil}.
4673 If non-nil, asks for confirmation when you press the enter key to select
4674 template while previewing.
4676 @item wl-template-buffer-lines
4677 @vindex wl-template-buffer-lines
4678 The initial setting is 7.
4679 If @code{wl-template-visible-select} is non-nil, this variable specifies
4680 the size of the preview window.
4682 @item wl-draft-reply-buffer-style
4683 @vindex wl-draft-reply-buffer-style
4684 The initial setting is @code{split}. @code{split} or @code{full} can be
4685 specified. In the case of @code{full}, the whole frame will be used for
4686 a reply draft buffer when it is prepared.
4688 @item wl-draft-use-frame
4689 @vindex wl-draft-use-frame
4690 The initial setting is @code{nil}.
4691 If non-nil, use new frame for the draft.
4693 @item wl-draft-truncate-lines
4694 @vindex wl-draft-truncate-lines
4695 The initial value is the value of @code{default-truncate-lines}.
4696 If it is non-nil, truncate long lines in draft buffer.
4700 The initial setting is the value of the variable
4701 @code{user-mail-address}. The value of this variable is inserted as a
4702 @samp{From:} field of the draft when it is prepared.
4704 @item wl-envelope-from
4705 @vindex wl-envelope-from
4706 The initial setting is @code{nil}.
4707 The value of this variable is used for envelope from (MAIL FROM).
4708 If @code{nil}, the address part of @code{wl-from} is used.
4710 @item wl-user-mail-address-list
4711 @vindex wl-user-mail-address-list
4712 The initial setting is @code{nil}.
4713 This is the User's address list. If you have multiple addresses,
4716 @item wl-reply-subject-prefix
4717 @vindex wl-reply-subject-prefix
4718 The initial setting is @samp{Re: }.
4719 In the @samp{Subject:} of the reply draft, this string is prepended to
4720 the @samp{Subject:} of being replied.
4722 @item wl-forward-subject-prefix
4723 @vindex wl-forward-subject-prefix
4724 The initial setting is @samp{Forward: }.
4725 In the @samp{Subject:} of the forwarding draft, this string is prepended
4726 to the @samp{Subject:} of being forwarded.
4728 @item wl-draft-reply-use-address-with-full-name
4729 @vindex wl-draft-reply-use-address-with-full-name
4730 The initial setting is @code{t}.
4731 If non-nil, insert her full name with address when prepare a draft for
4732 reply a message. If it is @code{nil}, insert her address only.
4734 @item wl-draft-enable-queuing
4735 @vindex wl-draft-enable-queuing
4736 The initial setting is @code{t}.
4737 This flag controls off-line transmission. If non-nil, the draft is
4740 @item wl-draft-use-cache
4741 @vindex wl-draft-use-cache
4742 The initial setting is @code{nil}. If the value is non-nil and
4743 @code{wl-insert-message-id} is nil, cache the message which is sent.
4745 @item wl-fcc-force-as-read
4746 @vindex wl-fcc-force-as-read
4747 The initial setting is @code{nil}. If the value is non-nil,
4748 Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
4750 @item wl-auto-flush-queue
4751 @vindex wl-auto-flush-queue
4752 The initial setting is t.
4753 This flag controls automatic transmission of the queue when Wanderlust
4754 becomes on-line. If non-nil, the queue is automatically transmitted
4755 (with confirmation by @code{y-or-n-p}). If you want to transmit it
4756 manually, press @kbd{F} in the folder mode.
4758 @item wl-ignored-forwarded-headers
4759 @vindex wl-ignored-forwarded-headers
4760 Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
4761 All headers that match this regexp will be deleted when forwarding a message.
4763 @item wl-ignored-resent-headers
4764 Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
4765 All headers that match this regexp will be deleted when resending a message.
4767 @item wl-draft-always-delete-myself
4768 @vindex wl-draft-always-delete-myself
4769 If non-nil, always removes your own address from @samp{To:} and
4770 @samp{Cc:} when you are replying to the mail addressed to you.
4772 @item wl-draft-delete-myself-from-bcc-fcc
4773 @vindex wl-draft-delete-myself-from-bcc-fcc
4774 If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
4775 or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
4777 @item wl-smtp-posting-server
4778 @vindex wl-smtp-posting-server
4779 The initial setting is @code{nil}.
4780 This is the SMTP server name for mail transmission.
4782 @item wl-smtp-posting-user
4783 @vindex wl-smtp-posting-user
4784 The initial setting is @code{nil}.
4785 This is the user name for SMTP AUTH authentication. If @code{nil},
4786 @code{smtp-authenticate-user} is used.
4788 @item wl-smtp-authenticate-type
4789 @vindex wl-smtp-authenticate-type
4790 The initial setting is @code{nil}.
4791 This is the authentication method for SMTP AUTH authentication. If
4792 @code{nil}, @code{smtp-authenticate-type} is used. If
4793 @code{smtp-authenticate-type} is still @code{nil}, authentication will
4796 @item wl-smtp-connection-type
4797 @vindex wl-smtp-connection-type
4798 The initial setting is @code{nil}.
4799 This variable specifies how to establish SMTP connections.
4800 If @code{nil}, @code{smtp-connection-type} is used.
4801 If it is @code{starttls}, STARTTLS (RFC2595) is used.
4803 @item wl-nntp-posting-server
4804 @vindex wl-nntp-posting-server
4805 The initial setting is @code{nil}.
4806 This is the NNTP server name used for news submission.
4807 If @code{nil}, @code{elmo-nntp-default-server} is used.
4809 @item wl-nntp-posting-user
4810 @vindex wl-nntp-posting-user
4811 The initial setting is @code{nil}.
4812 This is the user name for AUTHINFO authentication on news submission.
4813 If @code{nil}, @code{elmo-nntp-default-user} is used.
4814 If it is still @code{nil}, AUTHINFO authentication will not be carried out.
4816 @item wl-nntp-posting-port
4817 @vindex wl-nntp-posting-port
4818 The initial setting is @code{nil}.
4819 This is the port number of the NNTP server used for news submission.
4820 If @code{nil}, @code{elmo-nntp-default-server} is used.
4822 @item wl-nntp-posting-stream-type
4823 @vindex wl-nntp-posting-stream-type
4824 The initial setting is @code{nil}.
4825 If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
4826 SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
4827 connection will be established.
4829 @item wl-nntp-posting-function
4830 @vindex wl-nntp-posting-function
4831 The initial setting is @code{elmo-nntp-post}.
4832 This is the function to post NNTP message.
4834 @item wl-nntp-posting-config-alist
4835 @vindex wl-nntp-posting-config-alist
4836 The initial setting is @code{nil}.
4837 The value takes an alist to define NNTP server like following example.
4838 It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
4842 (setq wl-nntp-posting-config-alist
4843 '((",?gmane\\." . "news.gmane.org")
4845 ((server . "news-server")
4846 (user . "newsmaster")
4848 (function . elmo-nntp-post)))
4849 (".*" . "default-news-server")))
4853 @item wl-pop-before-smtp-user
4854 @vindex wl-pop-before-smtp-user
4855 The initial setting is @code{nil}.
4856 This is the POP user name for POP-before-SMTP.
4857 If it is @code{nil}, @code{elmo-pop3-default-user} is used.
4859 @item wl-pop-before-smtp-server
4860 @vindex wl-pop-before-smtp-server
4861 The initial setting is @code{nil}.
4862 This is the POP server name for POP-before-SMTP.
4863 If it is @code{nil}, @code{elmo-pop3-default-server} is used.
4865 @item wl-pop-before-smtp-authenticate-type
4866 @vindex wl-pop-before-smtp-authenticate-type
4867 The initial setting is @code{nil}.
4868 This is the authentication method for POP-before-SMTP authentication.
4869 If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
4871 @item wl-pop-before-smtp-port
4872 @vindex wl-pop-before-smtp-port
4873 The initial setting is @code{nil}.
4874 This is the POP port number for POP-before-SMTP. If it is @code{nil},
4875 @code{elmo-pop3-default-port} is used.
4877 @item wl-pop-before-smtp-stream-type
4878 @vindex wl-pop-before-smtp-stream-type
4879 The initial setting is @code{nil}.
4880 This flag controls the use of SSL for POP-before-SMTP. If it is
4881 @code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
4882 STARTTLS (RFC2595) connection will be established.
4884 @item wl-draft-queue-save-variables
4885 @vindex wl-draft-queue-save-variables
4886 Specifies a list of variable to which queued messages are saved on the
4887 off-line transmission.
4889 @item wl-draft-sendlog
4890 @vindex wl-draft-sendlog
4891 The initial setting is @code{t}.
4892 If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
4896 @item drafts are sent by smtp or qmail
4897 @item saved into folders by fcc
4898 @item saved into folders by queuing
4901 (it is written even if the transmission fails).
4902 But transmission by @file{im-wl.el} is not written in the @file{sendlog}
4903 and left to the logging function of @command{imput}.
4906 @item wl-draft-sendlog-max-size
4907 @vindex wl-draft-sendlog-max-size
4908 The initial setting is 20000 (in bytes).
4909 If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
4910 beyond the size specified by this variable.
4914 The initial setting is @code{nil}.
4915 If non-nil, address completion uses LDAP.
4917 @item wl-ldap-server
4918 @vindex wl-ldap-server
4919 The initial setting is @samp{localhost}.
4920 LDAP server name for address completion.
4923 @vindex wl-ldap-port
4924 The initial setting is @code{nil}.
4925 If non-nil, the value is used as port number.
4928 @vindex wl-ldap-base
4929 The initial setting is @samp{c=US}.
4930 LDAP search starting point (base) for address completion.
4932 @item wl-draft-remove-group-list-contents
4933 @vindex wl-draft-remove-group-list-contents
4934 The initial setting is @code{t}.
4935 If non-nil, remove the group-lists' members in the recipients when
4936 sending the message (group-list means the description such as
4937 @samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
4940 @node Disconnected Operations, Expire and Archive, Draft, Top
4941 @chapter Off-line Management
4942 @cindex Disconnected Operations
4944 Wanderlust has on-line and off-line states.
4947 * Off-line State:: Wanderlust has on-line and off-line states
4948 * Enable Operations:: Enable Disconnected Operations
4949 * Plugged Mode:: Switching On-line/Off-line per Server/Port
4950 * Off-line State settings:: Invoking Wanderlust in the Off-line State
4951 * Variables of Plugged Mode:: Customize Plugged Mode
4955 @node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
4956 @section Off-line State
4958 Wanderlust has on-line and off-line states. In the off-line state, you
4959 cannot access messages via network, unless they are cached.
4961 @samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
4962 in the mode line indicates the off-line state. In folder or summary
4963 modes, press @kbd{M-t} to switch between off- and on-line.
4965 You can invoke Wanderlust in the off-line state by setting
4966 @code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
4968 In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
4969 ignores uncached messages.
4972 @node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
4973 @section Enable Disconeected Operations
4975 Even in the off-line state, provided that relevant messages are cached,
4976 and the variable @code{elmo-enable-disconnected-operation} (described
4977 later) is non-nil, you can following operations:
4978 @xref{Plugged Mode}, @xref{Off-line State settings}.
4981 * Send Messages off-line:: Transmit Messages
4982 * Re-file and Copy queue:: Re-file and Copy (IMAP4)
4983 * Creation of Folders:: Create Folders off-line (IMAP4)
4984 * Marking:: Mark (IMAP4)
4985 * Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
4988 As soon as Wanderlust becomes on-line, such operations invoked off-line
4989 are reflected in the servers via network.
4992 @node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
4993 @subsection Transmission of Messages
4995 You can proceed sending operation for mail/news messages while you are
4996 off-line, then it will be reserved for sending (if you are using
4997 @file{im-wl.el}, it is irrelevant).
4998 Messages reserved for sending while off-line are accumulated in the
4999 queue folder, @samp{+queue}. These messages are transmitted at once when
5000 Wanderlust becomes on-line.
5002 You can visit @samp{+queue} in the off-line state and confirm content of
5003 messages in the queue. You can also remove messages. Removed messages
5004 are not transmitted even in the on-line state.
5007 @node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
5008 @subsection Re-file and Copy (IMAP4)
5010 Re-file and copy operations to IMAP folders invoked during the off-line
5011 state are accumulated in the queue, and reflected in the server side
5012 when Wanderlust becomes on-line. If you visit destination folders after
5013 off-line re-file or copy, it looks as if messages were appended even in
5016 For the safety reasons, messages re-filed off-line are removed from
5017 source folders only if their @samp{Message-ID:} match messages on the
5018 servers. While the queue is processed, messages that failed to be
5019 re-filed or copied to the specified folders are appended to the folder
5023 @node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
5024 @subsection Creation of Folders (IMAP4)
5026 You can create IMAP folders off-line. The creation of folders are
5027 reflected in the servers when Wanderlust becomes on-line. If the creation
5028 of those folders fails at that time for some reasons, messages
5029 to be re-filed into those are appended to the folder @samp{+lost+found}
5033 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
5034 @subsection Marking (IMAP4)
5036 Off-line changes in unread/read and importance mark @samp{$} information
5037 are also reflected in the servers when Wanderlust becomes on-line.
5040 @node Pre-fetching Reservations, , Marking, Enable Operations
5041 @subsection Pre-fetching (IMAP4, NNTP)
5043 You can make reservations for pre-fetching messages in IMAP or NNTP
5044 folders. Reserved messages are marked with @samp{!} but not cached
5045 yet. When Wanderlust becomes on-line, they are pre-fetched from
5048 If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
5049 these off-line operations for IMAP4 and NNTP do not take place, and
5050 off-line re-file, copy or suchlike simply results in error.
5052 Because off-line operations use cache files, it is a bad idea to erase
5053 them by hand; it may cause Wanderlust to malfunction.
5055 If you want to remove caches, be sure to execute @kbd{M-x
5056 elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
5057 remove caches for messages relevant to off-line operations.
5060 @node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
5061 @section Switching On-line/Off-line per Server/Port
5063 @kbd{M-t} described above switches networking states as a whole, but you
5064 can switch on-line/off-line per server/port.
5066 Pressing @kbd{C-t} in the folder or summary modes brings you in
5067 wl-plugged-mode shown below, in which you can change the plugged state
5072 Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
5075 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue}
5076 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue}
5078 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
5079 %inbox(delete-msgids:1) @dots{}@r{dop queue}
5085 The first line indicates status of the following three variables, and
5086 simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
5087 column modifies the values of these variables.
5091 "Queuing" @code{wl-draft-enable-queuing}
5092 "AutoFlushQueue" @code{wl-auto-flush-queue}
5093 "DisconnectedOperation" @code{elmo-enable-disconnected-operation}
5097 where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
5100 The second and after lines indicate on-line/off-line states of servers
5101 and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
5102 off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
5103 @kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
5105 @dfn{sending queue} means messages accumulated in the folder
5106 @samp{+queue} for off-line transmission, and @dfn{dop queue} means
5107 off-line operations when @code{elmo-enable-disconnected-operation} is
5109 @c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
5110 @c off-line operations are enabled.
5112 They are displayed if there are any of them. In the example above, in
5113 the sending queue there are two messages (the first and the second in
5114 the queue folder) for smtp to hosta and one (the third) for nntp to
5115 hosta, and in the dop queue there are one for @samp{%inbox} and two for
5118 If you change @samp{(wl-plugged)} in the second line, the variable
5119 @code{wl-plugged} is changed, so that the mode line indicator and
5120 plugged states of all ports are affected. If you change plugged states
5121 of any servers or ports, @samp{(wl-plugged)} in the second line is
5122 affected depending on @code{elmo-plugged-condition} settings and the
5123 plugged state of each port.
5126 @node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
5127 @section Invoking Wanderlust in the Off-line State
5129 As described before, if you set @code{wl-plugged} to @code{nil} in
5130 @file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
5131 off-line state. You can specify off-line state on a per server or port
5132 basis. Refer to @code{wl-reset-plugged-alist} also.
5134 Usually, when Wanderlust starts up, the plugged state of each port is
5135 read from @file{~/.folders} and @code{wl-smtp-posting-server},
5136 @code{wl-nntp-posting-server} and so on. If you want to change the
5137 plugged state of these ports or to add other ports, configure
5138 @code{wl-make-plugged-hook} with a function.
5142 (add-hook 'wl-make-plugged-hook
5144 (elmo-set-plugged plugged-value(t/nil) server port)
5145 ;; @r{add or change plugged states of the port of the server}
5146 (elmo-set-plugged plugged-value(t/nil) server)
5147 ;; @r{if the port is omitted, all ports are affected}
5148 ;; @r{(you cannot omit the port if you newly add the server)}
5154 @node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
5155 @section Customizable Variables
5160 If this variable is set to @code{nil}, Wanderlust starts up in off-line
5161 mode from the beginning.
5163 @item wl-queue-folder
5164 @vindex wl-queue-folder
5165 The initial setting is @samp{+queue}.
5166 This is the folder in which messages in the transmission queue are
5169 @item wl-auto-flush-queue
5170 @vindex wl-auto-flush-queue
5171 The initial setting is @code{t}.
5172 This flag controls automatic transmission of the queue when Wanderlust
5173 becomes on-line. If non-nil, the queue is automatically transmitted
5174 (with confirmation by @code{y-or-n-p}). If you want to transmit it
5175 manually, press @kbd{F} in the folder mode.
5177 @item elmo-enable-disconnected-operation
5178 @vindex elmo-enable-disconnected-operation
5179 The initial setting is @code{nil}. Controls off-line operations
5180 regarding IMAP4. If non-nil, off-line operations are carried out.
5182 @item elmo-lost+found-folder
5183 @vindex elmo-lost+found-folder
5184 The initial setting is @samp{+lost+found}.
5185 This is the folder to which messages are saved when they fails to be
5186 appended while the off-line re-file/copy queue is processed.
5188 @item elmo-plugged-condition
5189 @vindex elmo-plugged-condition
5190 The initial setting is @code{one}.
5191 The value of @code{wl-plugged} reflects the return value of the function
5192 @code{elmo-plugged-p} (without arguments).
5193 This variable @code{elmo-plugged-condition} specifies the condition on
5194 which the return value of @code{(elmo-plugged-p)} should be t depending on the
5195 plugged state of each port.
5198 'one : plugged if one or more ports are plugged.
5199 'all : plugged if all ports are plugged.
5200 'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
5201 states of the ports.
5202 @var{function} : reflects the return value of the @var{function}
5203 functions available per default
5204 'elmo-plug-on-by-servers
5205 : reflects the plugged state of the servers specified by the
5206 variable elmo-plug-on-servers.
5207 'elmo-plug-on-by-exclude-servers
5208 : reflects the plugged state of the servers that are not
5209 in elmo-plug-on-exclude-servers.
5210 elmo-plug-on-exclude-servers defaults to
5213 (system-name)without the domain part)
5219 (setq elmo-plugged-condition 'all)
5221 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
5222 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
5224 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
5225 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
5229 @item wl-reset-plugged-alist
5230 @vindex wl-reset-plugged-alist
5231 The initial setting is @code{t}. If non-nil, plugged states are
5232 initialized on a per server or port basis when Wanderlust starts up.
5234 If @code{nil}, plugged states are retained while Emacs is running. In
5235 other words, they are initialized when Emacs is restarted even if the
5236 value is @code{nil}.
5240 @node Expire and Archive, Scoring, Disconnected Operations, Top
5241 @chapter Automatic Expiration and Archiving of Messages
5242 @cindex Expire and Archive
5245 * Expire:: Expiration and Archiving
5246 * Archive:: Archiving All Messages
5250 @node Expire, Archive, Expire and Archive, Expire and Archive
5252 @cindex Expire Message
5254 Expiration means deletion of old messages which have outlasted a
5255 certain period of time.
5257 @code{wl-expire} supports not only simple deletion, but also moving to
5258 specified archiving folders.
5262 Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode,
5263 or @kbd{M-e} in the summary mode.
5265 @subsection Configuring @code{wl-expire-alist}
5267 An example configuration of @code{wl-expire-alist} is shown below.
5268 Everything in this @code{wl-expire-alist} makes a great difference in
5269 expiration, so be careful. I advise you to set @code{wl-expire-use-log}
5270 to @code{t}, especially in the initial stage.
5274 (setq wl-expire-alist
5275 '(("^\\+trash$" (date 14) remove)
5277 ("^\\+tmp$" (date 7) trash)
5278 ;; @r{re-file to @code{wl-trash-folder}}
5279 ("^\\+outbox$" (number 300) "$outbox;lha")
5280 ;; @r{re-file to the specific folder}
5282 ;; @r{do not expire}
5283 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t)
5284 ;; @r{archive by message number (retaining numbers)}
5285 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
5286 ;; @r{archive by a fixed number (retaining numbers)}
5287 ("^\\+diary$" (date 30) wl-expire-archive-date)
5288 ;; @r{archive by year and month (numbers discarded)}
5293 Items in the list has the format of:
5296 (@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
5300 The folder is examined if it matches @var{regexp-for-folders} from the
5301 beginning of the list. If you invoke expiration on the folder that does
5302 not match any of them, nothing will happen. And if either the second or
5303 the third element of the item is @code{nil}, expiration will not take
5306 You can use any one of the following for
5307 @var{specification-of-message-to-be-deleted}:
5310 @item (number @var{n1} [@var{n2}])
5311 deletes messages depending on the number of messages in the folder.
5313 @var{n1} is the number of messages which should survive deletion, for example
5314 if its value is 500, the newest 500 messages survive and the rests are
5317 @var{n2} is the number of messages in the folder on which expiration should
5318 take place, which defaults to @var{n1} + 1. For example if its value is 510,
5319 folders with 510 or more messages are expired.
5320 If you configured automatic expiration, frequently used folders may
5321 expire every time it receive messages, and you may be annoyed with the
5322 long delay in reading mail.
5323 In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
5324 expiration would not take place until a certain number of messages
5327 Messages with marks in @code{wl-summary-expire-reserve-marks} (marked
5328 with important/new/unread) are not deleted.
5329 If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder
5330 will expire so as to have 500 messages including such ones.
5331 Otherwise, it will have 500 messages except such ones.
5333 @item (date @var{d1})
5334 deletes messages depending on the dates.
5336 Messages dated @var{d1} or more days ago are deleted, for example if its
5337 value is seven, messages seven days old or more are deleted. Note that
5338 the date is the one in the @samp{Date:} field of the message, not when
5339 the message entered the folder.
5341 Messages with no or invalid @samp{Date:} field does not expire; you
5342 might have to delete them by hand.
5345 You can use any one of the following in the place of @var{destination}:
5349 deletes the messages instantly.
5352 hide the messages from summary (messages are not deleted).
5355 moves the messages to @code{wl-trash-folder}.
5357 @item @var{string}(folder)
5358 moves the messages to the folder specified with @var{string}.
5360 It would be useful for specifying an archiving folder, but because this
5361 does not move important messages, it might be better to use the
5362 standard functions described below.
5364 @item @var{function}
5365 invokes the specified @var{function}.
5367 To the @var{function}, three arguments are passed: a folder name, a list
5368 of messages to be deleted, and msgdb information of the summary. You
5369 can specify function-specific arguments after the name of the
5370 @var{function}. Note that the list contains messages with marks in
5371 @code{wl-summary-expire-reserve-marks}, be careful in writing your own
5374 These are four standard functions; three of them move messages to an archive
5375 folder in the specified way. This means old messages can be compressed
5376 and saved in a file, being deleted from the original folder.
5377 The last one divides messages to some MH folders.
5380 @item wl-expire-archive-number1
5381 re-files to archiving folders corresponding to the message numbers of
5382 the messages being deleted. For example, a message numbered 102 will be
5383 re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
5384 If @code{wl-expire-archive-files} is 200, messages will be re-filed to
5385 @file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
5387 The archiving folders to which messages are re-filed are determined by
5388 the name of the folder as follows (in this case, archiving folders are
5389 handled as if @code{elmo-archive-treat-file} were non-nil).
5392 @item If the folder type is localdir:
5393 @file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
5395 For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
5396 (@file{~/Mail/ml/wl-00100.zip}).
5398 @item The folder type is other than localdir:
5399 @file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
5401 For example, @samp{%#mh/ml/wl} corresponds to
5402 @samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
5405 As you can see, in the case of localdir, the folder type is not included
5406 in the path name, but otherwise it is included.
5407 And you can control the prefix to the archiving folder name by
5408 @code{wl-expire-archive-folder-prefix}.
5409 Refer to @code{wl-expire-archive-folder-prefix} for details.
5411 @item wl-expire-archive-number2
5412 re-files every certain number of messages to archiving folders.
5414 This differs from @samp{wl-expire-archive-number1} in that this re-files
5415 to the folder up to the specified number regardless of message numbers.
5416 The archiving folders to which messages are re-filed are determined in the
5417 same way as @code{wl-expire-archive-number1}.
5419 @item wl-expire-archive-date
5420 re-files messages depending on its date (year and month) to archive
5423 For example, a message dated December 1998 is re-filed to
5424 @code{$folder-199812;zip}. The name of the archiving folders except the
5425 date part are determined in the same way as
5426 @code{wl-expire-archive-number1}.
5429 You can set the first argument to these three standard functions to non-nil
5430 in @code{wl-expire-alist} so as to retain message numbers in the folder.
5431 For example, it can be specified just after the name of the function:
5434 ("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
5437 If you omit the argument, consecutive numbers from 1 are assigned for
5438 each archiving folder.
5440 @item wl-expire-localdir-date
5441 divedes messages depending on its date (year and month) to MH folders
5442 e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
5446 @subsection Treatment for Important or Unread Messages
5448 If you specify any of @code{remove}, @code{trash}, a folder name, or a
5449 standard function, messages with marks in
5450 @code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
5451 messages} thereafter) are retained.
5453 Per default, this variable include the important, new, and unread marks,
5454 so that messages with these marks are not removed.
5455 Note that you cannot include the temporary mark (i.e. temporary marks
5456 are removed anyway), and be sure to process temporary marks before you
5459 @subsection Auto Expiration
5461 The following setup invokes expiration when you move into the summary
5462 mode. There will be no confirmation, so make sure you made no mistake
5463 in regexp and other settings before you set up this.
5467 (add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
5471 In the folder mode, you can invoke expiration per group as well as per
5472 folder. Therefore, if you specify @samp{Desktop} group, all folders
5473 matching @code{wl-expire-alist} expire.
5477 @subsection Treating archive folders.
5478 To treat archive folders created by @code{wl-expire-archive-number1} and so on,
5479 you must set non-nil value to @code{elmo-archive-treat-file}.
5481 @subsection Confirming
5483 If you are to use @code{remove}, try @code{trash} at first and see
5484 messages move to @code{wl-trash-folder} as expected, then replace it
5485 with @code{remove}. It would be dangerous to use @code{remove} from the
5488 If you are to use @code{wl-expire-archive-number1} and the like, try to
5489 make a folder of the archiver type (@code{zip} or @code{lha}) and see if
5490 you can append messages to it. Even if settings in
5491 @code{wl-expire-alist} and @code{elmo-archive} are correct, messages
5492 would not be saved anywhere and disappeared in case the archiver program
5495 After you make sure you can archive to the folder correctly, you can
5496 invoke expiration and utilize the log.
5498 If you set @code{wl-expire-use-log} to @code{t},
5499 @file{~/.elmo/expired-log} should contain the log, for example:
5503 delete +ml/wl (593 594 595 596 597 598 599)
5504 move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
5508 The first column indicates the operation, i.e. @samp{delete},
5509 @samp{copy}, or @samp{move}. The next is the name of the folder that
5510 expired. In the case of @samp{copy} and @samp{move}, the destination
5511 folder is recorded after @samp{->}. The last is the list of message
5512 numbers that are actually deleted or moved (in the case of @samp{copy}
5513 and @samp{move}, the number is the one in the source folder, rather than
5514 the destination folder).
5516 @subsection Re-filing Reserved Messages
5518 The three standard functions copy reserved messages to the archive
5519 folder, but do not delete them from the source folder. Because
5520 reserved messages and the like always remain, they are recorded in
5521 @file{~/.elmo/expired-alist} so that they are not copied over and over
5522 again. They are not recorded if copied by @code{wl-summary-archive}.
5524 If you enabled logging, usually @samp{move} is recorded for re-filing,
5525 but instead @samp{copy} and @samp{delete} are recorded separately if
5526 reserved messages are involved. This is because it actually copies
5527 messages including reserved, then deletes ones except reserved in that
5530 @section Customizable Variables
5533 @item wl-expire-alist
5534 @vindex wl-expire-alist
5535 The initial setting is @code{nil}.
5536 This variable specifies folders and methods to expire. For details,
5537 refer to @code{wl-expire-alist} settings above.
5539 @item wl-summary-expire-reserve-marks
5540 @vindex wl-summary-expire-reserve-marks
5541 The initial setting is the list below.
5545 (list wl-summary-important-mark
5547 wl-summary-unread-mark
5548 wl-summary-unread-uncached-mark
5549 wl-summary-unread-cached-mark)
5553 Messages with these marks are retained in the folder, even after
5555 Only permanent marks can be listed, not temporary marks.
5557 You can list marks one by one as in the default; you can use the
5558 following settings as well:
5562 All messages with permanent marks are retained,
5563 i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
5567 All messages are handled as usual ones that are already read, no matter
5568 what marks they have; even important messages are deleted.
5571 @item wl-expire-archive-files
5572 @vindex wl-expire-archive-files
5573 The initial setting is 100.
5574 This variable specifies the number of messages to be retained in one
5577 @item wl-expire-number-with-reserve-marks
5578 @vindex wl-expire-number-with-reserve-marks
5579 The initial setting is @code{nil}.
5580 If non-nil, if expiring messages are specified by @code{number},
5581 messages with @code{wl-summary-expire-reserve-marks} are also retained.
5583 @item wl-expire-archive-get-folder-function
5584 @vindex wl-expire-archive-get-folder-function
5585 The initial setting is @code{wl-expire-archive-get-folder}.
5587 This variable specifies a function that returns the name of an archiving
5588 folder for standard functions in the place of @var{destination}.
5589 You can use the following three variables for simple modification of
5590 folder names; if you want more complex settings, define your own
5591 function in this variable.
5593 @code{wl-expire-archive-get-folder} can be customized by these
5596 @item @code{wl-expire-archive-folder-name-fmt}
5597 @item @code{wl-expire-archive-folder-type}
5598 @item @code{wl-expire-archive-folder-prefix}
5601 @item wl-expire-archive-folder-name-fmt
5602 @vindex wl-expire-archive-folder-name-fmt
5603 The initial setting is @samp{%s-%%05d;%s}.
5604 This is a @code{format} string for archiving folders used in
5605 @code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
5606 Note that you must specify the message number by @samp{%%d}, because it
5607 is parsed twice by @code{format}.
5609 If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
5612 @item wl-expire-archive-date-folder-name-fmt
5613 @vindex wl-expire-archive-date-folder-name-fmt
5614 The initial setting is @samp{%s-%%04d%%02d;%s}.
5615 This is a @code{format} string for archiving folders used in
5616 @code{wl-expire-archive-date}. Note that you must specify the message
5617 number by @samp{%%d}, because it is parsed twice by @code{format}.
5618 There should be @samp{%%d} twice, one for the year and the other for the
5621 If you modify this, adjust
5622 @code{wl-expire-archive-date-folder-num-regexp} as well.
5624 @item wl-expire-archive-folder-type
5625 @vindex wl-expire-archive-folder-type
5626 The initial setting is @code{zip}.
5627 This variable specifies an archiver type of the archiving folders.
5629 @item wl-expire-archive-folder-prefix
5630 @vindex wl-expire-archive-folder-prefix
5631 The initial setting is @code{nil}.
5632 This variable specifies the prefix (directory structure) to archiving
5634 Exercise extreme caution in using this feature, as it has not been
5636 In the worst case, there is a fear of destructing archiving folders.
5640 There will be no prefix.
5643 For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
5644 @samp{$ml/wl-00000;zip;wl}.
5647 For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl},
5650 @samp{$ml/wl-00000;zip;ml/wl}.
5653 @item wl-expire-archive-folder-num-regexp
5654 @vindex wl-expire-archive-folder-num-regexp
5655 The initial setting is @samp{-\\([-0-9]+\\);}.
5656 This variable specifies the regular expression to be used for getting
5657 message numbers from multiple archiving folders specified by
5658 @code{elmo-list-folders}.
5659 Set it in accordance with @code{wl-expire-archive-folder-name-fmt}.
5661 @item wl-expire-archive-date-folder-num-regexp
5662 @vindex wl-expire-archive-date-folder-num-regexp
5663 The initial setting is @samp{-\\([-0-9]+\\);}.
5664 This is the regular expression to be used for getting message numbers
5665 from multiple archiving folders specified by @code{elmo-list-folders}.
5666 Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
5668 @item wl-expire-delete-oldmsg-confirm
5669 @vindex wl-expire-delete-oldmsg-confirm
5670 The initial setting is @code{t}.
5671 If non-nil, messages older than the one with the largest number will be
5672 deleted with confirmation.
5673 If @code{nil}, they are deleted without confirmation.
5675 This feature is valid only if non-nil is specified as a argument to the
5676 standard functions so as to retain numbers.
5678 @item wl-expire-use-log
5679 @vindex wl-expire-use-log
5680 The initial setting is @code{nil}.
5681 If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
5682 They are appended but not truncated or rotated automatically; you might
5683 need to remove it manually.
5685 @item wl-expire-add-seen-list
5686 @vindex wl-expire-add-seen-list
5687 The initial setting is @code{t}.
5689 If non-nil, when messages are re-filed by expiration, read/unread
5690 information is passed to the destination folder.
5692 However if you do not read the destination folder from Wanderlust,
5693 @file{seen} under @file{~/.elmo/} grows larger and larger, so you might
5694 want to set this to @code{nil} if you are simply saving to some
5695 archiving folders. Even if its value is @code{nil}, messages in the
5696 archiving folders are simply treated as unread; it does not affect
5699 @item wl-expire-folder-update-msgdb
5700 @vindex wl-expire-folder-update-msgdb
5701 The initial setting is @code{t}.
5702 If @code{t}, in the folder mode, expiration is carried out after
5703 updating summary information. If you specified a list of regular
5704 expressions of folder names, summary information is updated for matching
5709 @node Archive, , Expire, Expire and Archive
5710 @section Archiving Messages
5712 @subsection Archiving Messages
5713 @kbd{M-x wl-summary-archive} copies the whole folder to archiving
5714 folders. If there are the archiving folders already, only new messages
5717 You can use @code{wl-archive-alist} in order to specify how messages are
5718 archived according to their folder names, as in @code{wl-expire-alist}.
5723 (setq wl-archive-alist
5724 '(("^\\+tmp$" wl-archive-date)
5725 ("^\\+outbox$" wl-archive-number2)
5726 (".*" wl-archive-number1)))
5730 Each item in the list has the following format:
5733 (@var{folders-regexp} @var{deleting-function})
5736 As you can see, you can only use a function after @var{folders-regexp}.
5737 Per default, there are three functions:
5740 @item @code{wl-archive-number1}
5741 @item @code{wl-archive-number2}
5742 @item @code{wl-archive-date}
5745 As inferred from their names, they work similarly to "expire" versions,
5746 other than the following points:
5749 @item No messages are deleted
5750 @item Message numbers are retained even if invoked without arguments
5753 These functions are good to archive all messages in a folder by their
5754 numbers or by their dates.
5755 These are also useful for backup or confirmation purposes before
5757 If you try to re-file them after they are archived, they are deleted but
5760 Per default, the archiving folders to which messages are copied are
5761 determined automatically by @code{wl-expire-archive-get-folder-function}.
5762 You can copy to a specific folder by invoking with a prefix argument,
5763 i.e. @kbd{C-u M-x wl-summary-archive}.
5765 Note that this feature has not been seriously tested, because you can
5766 simply copy to an archiving folder, for example by
5767 @code{wl-summary-copy-region}.
5769 The archiving folders are determined by the same logic as in
5770 @code{wl-summary-expire}; the following customizable variables are
5774 @item @code{wl-expire-archive-files}
5775 @item @code{wl-expire-archive-get-folder-function}
5776 @item @code{wl-expire-archive-folder-name-fmt}
5777 @item @code{wl-expire-archive-folder-type}
5778 @item @code{wl-expire-archive-folder-prefix}
5779 @item @code{wl-expire-archive-folder-num-regexp}
5782 @subsection Customizable Variables
5785 @item wl-archive-alist
5786 @vindex wl-archive-alist
5787 The initial setting is the list shown below:
5791 ((".*" wl-archive-number1))
5796 This variable specifies a function that copies to archiving folders.
5797 To the function, three arguments are passed: a folder name, a list of
5798 messages in the folder, and msgdb information of the summary.
5799 Needless to say, you can use your own function.
5803 @node Scoring, Address Book, Expire and Archive, Top
5804 @chapter Score of the Messages
5806 @c @cindex Kill File
5808 Scoring is the function that associates a score (value) with each
5809 message, and marks as read or deletes from the summary according to it.
5811 You can put target or important marks on essential messages, or read marks
5812 on the ones you do not want to read, for example spam articles.
5814 This scoring function has a capability and a format similar to the one
5815 that Gnus has, although there are some unsupported features and
5816 Wanderlust specifics.
5817 @xref{Scoring, , ,gnus, The gnus Newsreader}.
5820 * Score Commands:: Score Commands
5821 * Score File Format:: Score File Format
5825 @node Score Commands, Score File Format, Scoring, Scoring
5826 @section Score Commands
5827 @cindex Score Commands
5829 @subsection Score File Specification
5831 @code{wl-score-folder-alist} specifies score files or variables in which
5832 scores are defined, corresponding to folder names.
5836 (setq wl-score-folder-alist
5845 If paths to the score files are omitted, the directory specified in the
5846 variable @code{wl-score-files-directory} is assumed.
5848 No matter what you write in @code{wl-score-folder-alist}, the default
5849 score file @code{wl-score-default-file} (@file{all.SCORE}) is always
5850 read (it does not have to exist).
5851 Therefore, in the example above, the three score files,
5852 @file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for
5853 the folders that matches @samp{^-.*}.
5855 @subsection Scored Messages
5857 Scores are attached to the messages that are specified by
5858 @code{wl-summary-score-marks} temporarily when the summary is updated;
5859 when you exit from the summary, the scores are removed and reverts to
5862 @subsection Creation of Score Files
5864 In the summary buffer, move to an appropriate message and type @kbd{L}.
5865 Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
5866 The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
5868 This makes @minus{}1000 are scored for messages with the same
5869 @samp{Subject:} as the string you entered. That is, such a score file
5870 is created automatically.
5872 Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
5873 The score file you just made appears.
5874 This buffer is called @dfn{score editing buffer} thereafter.
5875 When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
5876 as you are previously; type @kbd{a}. Then a score entry for "From"
5878 In this way, you can create a score file easily either in the summary
5879 buffer or in the score editing buffer.
5881 By the way, you might be aware the numbers of key strokes are different
5882 between @kbd{s s p} and @kbd{a}.
5883 This is determined by @code{wl-score-header-default-entry}.
5884 This variable specifies the default score entries corresponding to
5886 For example, for "subject" field, a type and a time limit are prompted,
5887 but for "from" field, they are fixed upon automatically as substring and
5888 permanent respectively.
5889 However, score values can be modified by the prefix argument.
5890 Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
5893 At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
5894 score file and terminates the edit mode. Typing @kbd{C-c C-c} after
5895 erasing contents of the buffer deletes the score file being edited.
5899 @subsubsection Selecting Score Files
5901 You can change score files to which scores are appended by
5902 @code{wl-summary-increase-score} and @code{wl-summary-lower-score} by
5903 @code{wl-score-change-score-file}.
5905 @subsubsection Summing Up the Score
5907 If you add the same entries by @code{wl-summary-increase-score},
5908 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
5909 scores for the entry is summed up.
5911 For example, if you create @samp{from} entry with the score of @minus{}1000 by
5912 @kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
5913 @minus{}1200 will be created as a result.
5915 @subsubsection Creating Thread Key
5917 Creating @samp{Thread} key by @code{wl-summary-increase-score} or
5918 @code{wl-summary-lower-score} appends @samp{Message-ID} of all children.
5920 @subsubsection Creating Followup Key
5922 Creating @samp{Followup} key by @code{wl-summary-increase-score} or
5923 @code{wl-summary-lower-score} appends @samp{Message-ID} of the message
5924 at the cursor to @samp{References} key.
5925 If @code{wl-score-auto-make-followup-entry} is non-nil,
5926 @samp{Message-ID} of all messages to be followed up within dates
5927 specified by @code{wl-score-expiry-days}.
5929 @subsection Key Bindings
5934 @findex wl-summary-increase-score
5935 Increases the score for the current message.
5936 And the score entry is appended to the score file at the same moment.
5937 You can specify the score value by a prefix argument.
5941 @findex wl-summary-lower-score
5942 Decreases the score for the current message.
5943 And the score entry is appended to the score file at the same moment.
5944 You can specify the score value by a prefix argument.
5947 @kindex h R (Summary)
5948 @findex wl-summary-rescore
5949 Re-applies the scoring.
5950 However, already scored messages are not scored anew.
5953 @kindex h c (Summary)
5954 @findex wl-score-change-score-file
5955 Changes the score file currently selected.
5958 @kindex h e (Summary)
5959 @findex wl-score-edit-current-scores
5960 Edits the score file currently selected.
5961 If there are multiple score files, the previously specified one is
5965 @kindex h f (Summary)
5966 @findex wl-score-edit-file
5967 Edits an arbitrary score file and selects it.
5970 @kindex h F (Summary)
5971 @findex wl-score-flush-cache
5972 Erases caches associated to the score files that are read.
5973 If you modified score files directly (from other than Wanderlust), you
5974 need to re-read them after erasing the cache.
5977 @kindex h m (Summary)
5978 @findex wl-score-set-mark-below
5979 Specifies the criterion for scores to be marked as read.
5980 Messages with scores less than this value are marked as read.
5983 @kindex h x (Summary)
5984 @findex wl-score-set-expunge-below
5985 Specifies the criterion for scores to be deleted from the summary.
5986 Messages with scores less than this value are deleted.
5987 "Deleted" means it is not shown; they are not removed from the summary
5988 information or the folder.
5989 The deleted messages can be shown by rescan-noscore again.
5992 @subsection Key Bindings in the Score Editing Buffer
5996 @kindex C-c C-k (Score Mode)
5997 @findex wl-score-edit-kill
5998 Abandons the file being edited.
6001 @kindex C-c C-c (Score Mode)
6002 @findex wl-score-edit-exit
6003 Saves the file being edited, and quits from the edit mode.
6006 @kindex C-c C-p (Score Mode)
6007 @findex wl-score-pretty-print
6011 @kindex C-c C-d (Score Mode)
6012 @findex wl-score-edit-insert-date
6013 Inserts the number of dates from Dec. 31, 1 B.C.
6014 It is used for creating the third factor of time-limited scores.
6017 @kindex C-c C-s (Score Mode)
6018 @findex wl-score-edit-insert-header
6019 Inserts the header of the message selected in the summary buffer.
6022 @kindex C-c C-e (Score Mode)
6023 @findex wl-score-edit-insert-entry
6024 Inserts the score entry of the message selected in the summary buffer.
6027 @subsection Customizable Variables
6030 @item wl-summary-default-score
6031 @vindex wl-summary-default-score
6032 The initial setting is 0 (zero).
6033 This variable specifies the default value of the score.
6034 The score is increased or decreased based upon this value.
6036 @item wl-summary-important-above
6037 @vindex wl-summary-important-above
6038 The initial setting is @code{nil}.
6039 Messages with scores larger than this value are attached with the
6040 important mark (@samp{$}).
6041 If @code{nil}, no important marks are attached.
6043 @item wl-summary-target-above
6044 @vindex wl-summary-target-above
6045 The initial setting is @code{nil}.
6046 Messages with scores larger than this value are attached with the target
6048 If @code{nil}, no target marks are attached.
6050 @item wl-summary-mark-below
6051 @vindex wl-summary-mark-below
6052 The initial setting is 0 (zero).
6053 Messages with scores smaller than this value are marked as read.
6055 @item wl-summary-expunge-below
6056 @vindex wl-summary-expunge-below
6057 The initial setting is @code{nil}.
6058 Messages with scores smaller than this value are deleted from the
6060 If @code{nil}, they are not deleted.
6062 @item wl-summary-score-marks
6063 @vindex wl-summary-score-marks
6064 The initial setting is the list shown below:
6068 (list wl-summary-new-mark)
6073 Messages with these marks are scored.
6075 @item wl-use-scoring
6076 @vindex wl-use-scoring
6077 The initial setting is t.
6078 If non-nil, scoring is enabled.
6080 @item wl-score-files-directory
6081 @vindex wl-score-files-directory
6082 The initial setting is @file{~/.elmo/}.
6083 The default directory for score files.
6085 @item wl-score-interactive-default-score
6086 @vindex wl-score-interactive-default-score
6087 The initial setting is 1000.
6088 This value is used as a score when a score factor is @code{nil} in the
6089 score file. It is also used in @code{wl-summary-increase-score} and
6090 @code{wl-summary-lower-score}, on condition that the value of
6091 @code{wl-score-header-default-entry} is @code{nil}.
6093 @item wl-score-expiry-days
6094 @vindex wl-score-expiry-days
6095 The initial setting is 7.
6096 This is the number of days before time-limited scores are deleted.
6098 @item wl-score-update-entry-dates
6099 @vindex wl-score-update-entry-dates
6100 The initial setting is @code{t}.
6101 If non-nil, it enables deletion of time-limited scores.
6103 @item wl-score-header-default-entry
6104 @vindex wl-score-header-default-entry
6105 Specifies the default value for each header field for score entries
6106 created by @code{wl-summary-increase-score},
6107 @code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}.
6109 @item wl-score-simplify-fuzzy-regexp
6110 @vindex wl-score-simplify-fuzzy-regexp
6111 In the case of a type of a score entry is @code{fuzzy}, this specifies a
6112 regular expression to be deleted from the string.
6113 Because this is usually used for Subject, the default is prefixes that
6114 are attached by mailing list programs.
6116 @item wl-summary-rescore-partial-threshold
6117 @vindex wl-summary-rescore-partial-threshold
6118 The initial setting is 200.
6119 When sync-all or rescan is executed, if there are messages more than
6120 this value, only the last same number of messages as this value are
6123 @item wl-summary-auto-sync-marks
6124 @vindex wl-summary-auto-sync-marks
6125 If non-nil, unread/important marks are synchronized when the summary
6127 Unread marks reflect information on the IMAP4 server.
6128 Important marks reflect information on the IMAP4 server (flagged or
6129 not), and contents of @samp{'mark} folder.
6130 The initial setting is @code{t}.
6134 @node Score File Format, , Score Commands, Scoring
6135 @section Score File Format
6136 @cindex Score File Format
6138 The format of score files are the same as Gnus, and basically you can
6139 use Gnus score files as they are. But they are not fully compatible
6140 because some keys are not supported and there are Wanderlust specifics.
6141 @xref{Score File Format, , ,gnus, The gnus Newsreader}.
6146 ("for sale" -1000 nil s)
6147 ("profit" -1000 nil s))
6149 ("spam@@spamspamspam" -10000 nil s))
6151 ("my@@address" 3001 nil s))
6153 (1000000 -10 nil >))
6163 If the key is a string, it is the name of the header to be matched.
6164 The following keys are available:
6165 @code{Subject}, @code{From}, @code{Date}, @code{Message-ID},
6166 @code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines},
6167 @code{Xref}, @code{Extra}, @code{Followup}, @code{Thread}
6168 @code{Chars} and @code{Lines} mean the size and the number of lines of
6169 the message, respectively. @code{Extra}, @code{Followup}, @code{Thread}
6170 are described later.
6171 The rest corresponds the field of the same name.
6173 Arbitrary numbers of core entries are specified after the key.
6174 Each score entry consists of these five factors:
6178 A factor that matches header. This should be a number in the cases of
6179 @code{lines} and @code{chars}, otherwise a string.
6182 A score factor. When the first item matches, the score of the message
6183 is increased or decreased by this value.
6186 A time limiting factor. If @code{nil}, the score is permanent, and in the case
6187 of a number, the score is deleted if it does not match for days
6188 (@code{wl-score-expiry-days}) from the date specified by this.
6189 The date is since Dec. 31, 1 B.C.
6192 A type factor. This specifies the way the first factor matches.
6193 Available types depend on keys.
6196 @item From, Subject, References, Message-ID
6197 For these keys in string, @code{r} and @code{R} (regexp),
6198 @code{s} and @code{S} (substring), @code{e} and @code{E} (exact match),
6199 as well as @code{f} and @code{F} (fuzzy) can be used.
6200 @code{R}, @code{S}, @code{E}, and @code{F} are case sensitive.
6203 For these keys, the following five numerical relative operators can be
6204 used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}.
6207 This key matches @code{From} header, and scores all follow-ups to the
6209 For example, it would be useful for increasing scores for follow-ups to
6212 You can use the same types as @code{From} except for @code{f}.
6213 And a @samp{Followup} entry is automatically appended to the score file.
6216 This key scores (sub-)threads beginning with @code{Message-ID} @var{x}.
6217 A @samp{Thread} entry is automatically appended for each article that
6218 has @var{x} in the @code{References} header.
6219 You can make sure the whole thread including messages that does not have
6220 all ancestors @code{Message-ID} in @code{References} is scored.
6222 You can use the same types as @code{References} except for @code{f}.
6223 And a @samp{Thread} entry is automatically appended to the score file.
6227 A factor for extension header. This is meaningful only if the key is
6229 This specifies headers to be matched other than standard headers like
6230 @code{Subject} and @code{From}.
6231 Note that you should specify the header in
6232 @code{elmo-msgdb-extra-fields} also.
6233 Therefore it does not work in folders where extension headers cannot be
6238 The sum of these scores @emph{after all factors are applied} becomes the
6239 score of the message.
6241 @cindex Score File Atoms
6243 Messages with a score less than this value is marked as read.
6244 The default is @code{wl-summary-mark-below}.
6247 Messages with a score less than this value is deleted from the summary.
6248 The default is @code{wl-summary-expunge-below}.
6250 @item mark-and-expunge
6251 Both @code{mark} and @code{expunge} are applied,
6252 i.e. messages with a score less than this value is marked as read and
6253 deleted from the summary.
6256 Messages with a score greater than this value is attached with temp
6258 The default is @code{wl-summary-target-above}.
6261 Messages with a score greater than this value is attached with important
6263 The default is @code{wl-summary-important-above}.
6268 Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
6269 are used, you need to set @code{elmo-msgdb-extra-fields}.
6272 (setq elmo-msgdb-extra-fields '("lines" "xref"))
6275 There are other restrictions as shown below:
6278 @item Because @samp{References} field in the summary information
6279 contains only the last @samp{Message-ID}, @code{references} key matches
6283 Keys that can be seen by folder of types:
6287 chars lines xref extra
6288 localdir,localnews Y E E E
6289 nntp (supporting xover) Y E E N
6295 N: cannot be seen (ignored)
6296 E: can be seen with @code{elmo-msgdb-extra-fields} settings
6301 @node Address Book, Customization, Scoring, Top
6302 @chapter Address Book
6303 @cindex Address Book
6305 With address book, you can utilize address completion, and you have
6306 summary displayed with nicknames.
6309 * Mail Addresses:: Definition of Address Book
6310 * Address Manager:: Address Manager
6313 @node Mail Addresses, Address Manager, Address Book, Address Book
6314 @section Address book
6315 @cindex Address book Definition
6317 @cindex Alias, Address
6319 The file @file{~/.addresses} is a simple address book for Wanderlust.
6320 Make address file @file{~/.addresses}, and edit to suit your requirement.
6322 The data written in @file{~/.addresses} are used for address completion
6323 under draft editing mode. Furthermore, they are used when showing names
6324 in summary display mode. You can safely skip this section, if you don't
6325 want to customize address completion and summary display.
6326 It is possible to add/change/remove addresses from @file{~/.addresses} in
6327 summary buffer after Wanderlust is invoked. @refill
6329 The format is very simple. Like this. @refill
6334 # @r{Lines begin with @samp{#} are comment.}
6335 # @r{Empty lines are ignored}
6337 # @r{Format of each line:}
6338 # @var{email-address} "@var{nickname} "@var{realname}"
6340 teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
6341 foo@@bar.gohome.org "Mr. Foo" "John Foo"
6342 bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
6347 One line defines one persons description.
6349 Actually, in default setup, @var{nickname} is used in summary-mode and
6350 @var{realname} is used in draft preparation mode. This behavior is
6351 better understood if you try it and confirmed the function first. You
6352 can write and try a small definition, so you will know the idea of the
6353 address book before writing a big one.
6355 And, if MH alias file is specified in variable @code{wl-alias-file},
6356 it is used as an address information in the draft preparation mode.
6358 If variable @code{wl-use-ldap} is non-nil (initial setting is
6359 @code{nil}), address completion in draft mode uses LDAP information.
6361 If you use LDAP, you have to set @code{wl-ldap-server},
6362 @code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
6363 not have LDAP feature as built-in feature (Currently only XEmacs can
6364 have built-in LDAP feature), you have to set command exec @env{PATH} to
6365 the program @command{ldapsearch}.
6368 @node Address Manager, , Mail Addresses, Address Book
6369 @section Address Manager
6370 @cindex Address Manager
6372 You can type @kbd{C-c C-a} to enter address manger mode. you can edit
6373 the address book and insert address to draft buffer.
6375 @subsection Key Bindings
6379 @kindex t (Address Manager)
6380 @findex wl-addrmgr-set-to
6381 Add @samp{To:} mark.
6384 @kindex c (Address Manager)
6385 @findex wl-addrmgr-set-cc
6386 Add @samp{Cc:} mark.
6389 @kindex b (Address Manager)
6390 @findex wl-addrmgr-set-bcc
6391 Add @samp{Bcc:} mark.
6394 @kindex u (Address Manager)
6395 @findex wl-addrmgr-unmark
6399 @kindex x (Address Manager)
6400 @findex wl-addrmgr-apply
6402 Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
6403 buffer and quit address manager. When no draft buffer, make new draft
6404 with insert marked addresses.
6406 If no mark, quit address manager.
6410 @kindex q (Address Manager)
6411 @findex wl-addrmgr-quit
6412 Quit address manager.
6415 @kindex a (Address Manager)
6416 @findex wl-addrmgr-add
6420 @kindex d (Address Manager)
6421 @findex wl-addrmgr-delete
6425 @kindex e (Address Manager)
6426 @findex wl-addrmgr-edit
6431 @node Customization, Terminology, Address Book, Top
6432 @chapter Customizing Wanderlust
6433 @cindex Customization
6436 * Living with other packages:: Cooperating with other packages
6437 * Highlights:: Highlights
6438 * Biff:: Notify Mail arrival
6439 * Advanced Settings:: Advanced Settings
6440 * Customizable Variables:: Customizable Variables
6445 @node Living with other packages, Highlights, Customization, Customization
6446 @section Living with other packages
6448 Examples with other packages.
6451 * imput:: imput (im-wl.el)
6452 * BBDB:: The Insidious Big Brother Database
6453 * LSDB:: The Lovely Sister Database
6454 * supercite:: supercite.el
6455 * mu-cite:: mu-cite.el
6456 * X-Face:: x-face,bitmap-mule
6457 * dired-dd:: dired-dd.el
6459 * Addrbook:: Addrbook
6460 * mime-w3m:: mime-w3m.el
6464 @node imput, BBDB, Living with other packages, Living with other packages
6469 Place @file{util/im-wl.el} on the @code{load-path} and do the following
6472 If @command{imput} is on the @code{exec-path} at the installation,
6473 @file{im-wl.el} is byte-compiled and installed. @xref{Install}.
6477 (autoload 'wl-draft-send-with-imput-async "im-wl")
6478 (setq wl-draft-send-function 'wl-draft-send-with-imput-async)
6483 @node BBDB, LSDB, imput, Living with other packages
6487 Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
6490 If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
6491 byte-compiled and installed.
6499 ;; @r{enable pop-ups}
6500 (setq bbdb-use-pop-up t)
6501 ;; @r{auto collection}
6502 (setq bbdb/mail-auto-create-p t)
6503 ;; @r{exceptional folders against auto collection}
6504 (setq bbdb-wl-ignore-folder-regexp "^@@")
6505 (setq signature-use-bbdb t)
6506 (setq bbdb-north-american-phone-numbers-p nil)
6507 ;; @r{shows the name of bbdb in the summary} :-)
6508 (setq wl-summary-from-function 'bbdb-wl-from-func)
6509 ;; @r{automatically add mailing list fields}
6510 (add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
6511 (setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
6515 You can complete address with BBDB by @kbd{M-@key{TAB}}
6519 @node LSDB, supercite, BBDB, Living with other packages
6523 The following is an example of settings:
6529 (add-hook 'wl-draft-mode-hook
6531 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
6535 In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
6536 (complete address with LSDB).
6539 @node supercite, mu-cite, LSDB, Living with other packages
6540 @subsection sc.el(supercite), sc-register.el
6544 The same setting as usual mailers should be OK. The following is an
6545 example of settings:
6549 (autoload 'sc-cite-original "supercite" nil t)
6550 (add-hook 'mail-citation-hook 'sc-cite-original)
6555 @node mu-cite, X-Face, supercite, Living with other packages
6556 @subsection mu-cite.el
6559 The same setting as usual mailers should be OK. The following is an
6560 example of settings.
6562 If you use mu-cite version 8.0 or earlier:
6566 (autoload 'mu-cite/cite-original "mu-cite" nil t)
6567 (setq mail-citation-hook 'mu-cite/cite-original)
6571 If you use mu-cite version 8.1 or later:
6575 (autoload 'mu-cite-original "mu-cite" nil t)
6576 (add-hook 'mail-citation-hook (function mu-cite-original))
6580 @node X-Face, dired-dd, mu-cite, Living with other packages
6584 If you have installed one of the following, you can decode
6585 @samp{X-Face:} field in message buffer and you will see face image.
6588 * x-face-xmas:: XEmacs case
6589 * x-face-mule:: Emacs case
6592 If there is an encoded X-Face string in a file @file{~/.xface} (the
6593 value of the variable @code{wl-x-face-file}), it is inserted as a
6594 @samp{X-Face:} field in the draft buffer (if
6595 @code{wl-auto-insert-x-face} is non-nil).
6597 @node x-face-xmas, x-face-mule, X-Face, X-Face
6598 @subsubsection x-face-xmas (for XEmacs)
6601 If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
6602 1.3.6.13 or later, do the following:
6606 (autoload 'x-face-xmas-wl-display-x-face "x-face")
6607 (setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
6611 @node x-face-mule, , x-face-xmas, X-Face
6612 @subsubsection x-face-mule (for Emacs)
6616 If you use @file{x-face-mule.el} in bitmap-mule
6617 (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
6621 (autoload 'x-face-decode-message-header "x-face-mule")
6622 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6626 @subsubsection x-face-e21 (for Emacs 21.x)
6629 With Emacs 21.x, you can use @file{x-face-e21.el}
6630 (@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
6631 to display X-Face. In this case, bitmap-mule is not required.
6636 (autoload 'x-face-decode-message-header "x-face-e21")
6637 (setq wl-highlight-x-face-function 'x-face-decode-message-header)
6642 @node dired-dd, MHC, X-Face, Living with other packages
6643 @subsection dired-dd(Dired-DragDrop)
6644 @pindex Dired-DragDrop
6646 @cindex Drag and Drop
6648 If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
6649 compose multi-part by simple Drag-and-Drop from dired to the draft
6650 buffer being edited in GNU Emacs (this feature is not Wanderlust
6651 specific, but general-purpose for SEMI).
6655 ;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
6661 ;; @r{Set dired-x variables here.}
6662 ;; @r{To and flo@dots{}}
6664 (progn (require 'dired-dd)
6665 (require 'dired-dd-mime))))))
6669 @node MHC, Addrbook, dired-dd, Living with other packages
6673 Message Harmonized Calendaring system
6674 (@uref{http://www.quickhack.net/mhc/})
6676 By using MHC, you can make a calendar from the messages.
6682 (setq mhc-mailer-package 'wl)
6683 (autoload 'mhc-mode "mhc" nil t)
6684 (add-hook 'wl-summary-mode-hook 'mhc-mode)
6685 (add-hook 'wl-folder-mode-hook 'mhc-mode)
6693 (autoload 'mhc-wl-setup "mhc-wl")
6694 (add-hook 'wl-init-hook 'mhc-wl-setup)
6698 @node Addrbook, mime-w3m, MHC, Living with other packages
6699 @subsection wl-addrbook.el
6703 (@uref{http://www.mew.org/})
6705 Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
6706 @code{load-path} and do the following settings.
6710 (require 'wl-addrbook)
6715 @node mime-w3m, , Addrbook, Living with other packages
6716 @subsection mime-w3m.el
6719 You can display html part by using @file{mime-w3m.el}
6720 distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
6721 You can find the usage in comment region at the head of @file{mime-w3m.el}.
6724 @node Highlights, Biff, Living with other packages, Customization
6727 @subsection Customizable Variables
6730 @item wl-summary-highlight
6731 @vindex wl-summary-highlight
6732 The initial setting is @code{t}.
6733 If non-nil, the summary is highlighted.
6735 @item wl-highlight-max-summary-lines
6736 @vindex wl-highlight-max-summary-lines
6737 The initial setting is 10000.
6738 The summary is not highlighted if it has more lines than this value.
6740 @item wl-summary-highlight-partial-threshold
6741 @vindex wl-summary-highlight-partial-threshold
6742 The initial setting is 1000.
6743 This is a threshold whether the whole summary is highlighted.
6744 If there are more lines of messages in the summary, it is partially
6747 @item wl-summary-partial-highlight-above-lines
6748 @vindex wl-summary-partial-highlight-above-lines
6749 The initial setting is 30. If there are more lines of messages than
6750 @code{wl-summary-highlight-partial-threshold} in the summary, messages
6751 after the point that is the same number of lines as this value above the
6752 cursor line are highlighted partially. (If this value is @code{nil},
6753 the last same number of lines as the value of
6754 @code{wl-summary-highlight-partial-threshold} are highlighted.)
6756 @item wl-highlight-body-too
6757 @vindex wl-highlight-body-too
6758 The initial setting is @code{t}.
6759 If non-nil, bodies of drafts and messages are also highlighted.
6761 @item wl-highlight-message-header-alist
6762 @vindex wl-highlight-message-header-alist
6763 When highlighting headers of drafts and messages, this variable
6764 specifies which faces are allocated to important
6765 (@code{wl-highlight-message-important-header-contents}), secondly
6766 important (@code{wl-highlight-message-important-header-contents2}), and
6767 unimportant (@code{wl-highlight-message-unimportant-header-contents})
6769 Similarly, it can be used for allocating arbitrary faces to arbitrary
6770 regular expressions.
6772 @item wl-highlight-citation-prefix-regexp
6773 @vindex wl-highlight-citation-prefix-regexp
6774 Specifies a regular expression to which quoted lines in bodies of
6775 drafts and messages match.
6776 Bodies matching to this regular expression are highlighted by the faces
6777 specified by (@code{wl-highlight-message-cited-text-*}).
6779 @item wl-highlight-highlight-citation-too
6780 @vindex wl-highlight-highlight-citation-too
6781 The initial setting is @code{nil}.
6782 If non-nil, the quoting regular expression itself given by
6783 @code{wl-highlight-citation-prefix-regexp} is also highlighted.
6785 @item wl-highlight-citation-header-regexp
6786 @vindex wl-highlight-citation-header-regexp
6787 Specifies a regular expression that denotes beginning of quotation.
6788 Bodies matching to this regular expression are highlighted by the face
6789 specified by @code{wl-highlight-message-headers}.
6791 @item wl-highlight-max-header-size
6792 @vindex wl-highlight-max-header-size
6793 The initial setting is @code{nil}. If a header size is larger than this
6794 value, it will not be highlighted. If @code{nil}, always highlighted
6795 (ignore header size).
6797 @item wl-highlight-max-message-size
6798 @vindex wl-highlight-max-message-size
6799 The initial setting is 10000.
6800 If a message is larger than this value, it will not be highlighted.
6801 With this variable, highlight is suppressed for uuencode or huge digest
6804 @item wl-highlight-signature-separator
6805 @vindex wl-highlight-signature-separator
6806 Specifies regular expressions that denotes the boundary of a signature.
6807 It can be a regular expression, or a list of ones.
6808 Messages after the place that matches this regular expression are
6809 highlighted by the face specified by
6810 @code{wl-highlight-message-signature}.
6812 @item wl-max-signature-size
6813 @vindex wl-max-signature-size
6814 The initial setting is 400.
6815 This is the largest size for a signature to be highlighted.
6817 @item wl-use-highlight-mouse-line
6818 @vindex wl-use-highlight-mouse-line
6819 The initial setting is @code{t}.
6820 If non-nil, the line pointed by the mouse is highlighted in the folder
6821 mode, summary mode, and the like.
6824 @subsection Setting Colors and Fonts of the Characters
6826 If you want to change colors or fonts of the characters, you need to
6827 modify faces defined in Wanderlust. Use @code{set-face-font} if you
6828 want to change fonts, and @code{set-face-foreground} for colors, and so
6829 on. You cannot write face settings in @file{.emacs}; write in
6832 For example, if you want to change the color for signatures to yellow,
6836 (set-face-foreground 'wl-highlight-message-signature "yellow")
6842 Faces defined in Wanderlust:
6845 @item wl-highlight-message-headers
6846 The face for field names of message headers.
6848 @item wl-highlight-message-header-contents
6849 The face for field bodies of message headers.
6851 @item wl-highlight-message-important-header-contents
6852 The face for important parts of message headers.
6853 Per default, this face is used for a body of @samp{Subject:} field.
6854 You can change its value by editing
6855 @code{wl-highlight-message-header-alist}.
6857 @item wl-highlight-message-important-header-contents2
6858 The face for secondly important parts of message headers.
6859 Per default, this face is used for bodies of @samp{From:} and @samp{To:}
6860 fields. You can change its value by editing
6861 @code{wl-highlight-message-header-alist}.
6863 @item wl-highlight-message-unimportant-header-contents
6864 The face for unimportant parts of message headers.
6865 Per default, this face is used for bodies of @samp{X-} fields
6866 @samp{User-Agent:} fields. You can change its value by editing
6867 @code{wl-highlight-message-header-alist}.
6869 @item wl-highlight-message-citation-header
6870 The face for headers of quoted messages.
6872 @item wl-highlight-message-cited-text-*
6873 The face for texts of quoted messages. The last @samp{*} is a
6874 @var{single figure} so that 10 different colors can be used according to
6877 @item wl-highlight-message-signature
6878 The face for signatures of messages. The initial settings are
6879 @samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
6880 dark background colors.
6882 @item wl-highlight-header-separator-face
6883 The face for header separators of draft messages.
6885 @item wl-highlight-summary-important-face
6886 The face for message lines with important marks in the summary.
6888 @item wl-highlight-summary-new-face
6889 The face for message lines with new marks in the summary.
6891 @item wl-highlight-summary-displaying-face
6892 The face for the message line that is currently displayed.
6893 This face is overlaid.
6895 @item wl-highlight-thread-indent-face
6896 The face for the threads that is currently displayed.
6898 @item wl-highlight-summary-unread-face
6899 The face for message lines with unread marks in the summary.
6901 @item wl-highlight-summary-deleted-face
6902 The face for message lines with delete marks in the summary.
6904 @item wl-highlight-summary-refiled-face
6905 The face for message lines with re-file marks in the summary.
6907 @item wl-highlight-refile-destination-face
6908 The face for re-file information part of message lines with re-file
6909 marks in the summary.
6911 @item wl-highlight-summary-copied-face
6912 The face for message lines with copy marks in the summary.
6914 @item wl-highlight-summary-target-face
6915 The face for message lines with target marks @samp{*} in the summary.
6917 @item wl-highlight-summary-thread-top-face
6918 The face for message lines that are on the top of the thread in the
6921 @item wl-highlight-summary-normal-face
6922 The face for message lines that are not on top of the thread in the
6925 @item wl-highlight-folder-unknown-face
6926 The face for folders that are not known to have how many unsync messages
6929 @item wl-highlight-folder-zero-face
6930 The face for folders that have no unsync messages in the folder mode.
6932 @item wl-highlight-folder-few-face
6933 The face for folders that have some unsync messages in the folder mode.
6935 @item wl-highlight-folder-many-face
6936 The face for folders that have many unsync messages in the folder mode.
6937 The boundary between `some' and `many' is specified by the variable
6938 @code{wl-folder-many-unsync-threshold}.
6940 @item wl-highlight-folder-unread-face
6941 The face for folders that have no unsync but unread messages in the
6944 @item wl-highlight-folder-killed-face
6945 The face for folders that are deleted from the access group in the
6948 @item wl-highlight-folder-opened-face
6949 The face for open groups in the folder mode.
6950 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6951 @code{nil} or a @var{number}.
6953 @item wl-highlight-folder-closed-face
6954 The face for close groups in the folder mode.
6955 It is meaningful when @code{wl-highlight-folder-by-numbers} is
6956 @code{nil} or a @var{number}.
6958 @item wl-highlight-folder-path-face
6959 The face for the path to the currently selected folder in the folder
6962 @item wl-highlight-logo-face
6963 The face for logo in the demo.
6965 @item wl-highlight-demo-face
6966 The face for strings (for example, a version number) in the demo.
6970 @node Biff, Advanced Settings, Highlights, Customization
6971 @section Notify Mail arrival
6974 Following setting is to notify mail arrival of @samp{%inbox}
6975 by the indicator on the modeline
6978 (setq wl-biff-check-folder-list '("%inbox"))
6981 @subsection Customizable Variables
6983 @item wl-biff-check-folder-list
6984 @vindex wl-biff-check-folder-list
6985 The initial setting is @code{nil}.
6986 This is the list of folders to check mail arrival.
6987 If @code{nil}, wl doesn't check mail arrival.
6989 @item wl-biff-check-interval
6990 @vindex wl-biff-check-interval
6991 The initial setting is 40 (in seconds).
6992 Check mail arrival in this period.
6994 @item wl-biff-notify-hook
6995 @vindex wl-biff-notify-hook
6996 This hook is run at the arrival of new mail.
6997 To beep with mail arrival(initial setting), set as follows.
6999 (setq wl-biff-notify-hook '(ding))
7001 For silence, set to @code{nil}.
7005 @node Advanced Settings, Customizable Variables, Biff, Customization
7006 @section Advanced Settings
7009 * Draft for Reply:: Draft for Reply
7010 * Thread Format:: Appearance of Thread
7011 * User-Agent Field:: @samp{User-Agent:} Header Field
7015 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
7016 @subsection Draft for Replay
7017 @vindex wl-draft-reply-with-argument-list
7018 @vindex wl-draft-reply-without-argument-list
7019 @vindex wl-draft-reply-myself-with-argument-list
7020 @vindex wl-draft-reply-myself-without-argument-list
7022 If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
7023 The addressee for the draft is decided by following rules.
7025 For example, you can set as follows:
7029 (setq wl-draft-reply-without-argument-list
7030 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7031 ("Followup-To" . (nil nil ("Followup-To")))
7032 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7033 ("From" . (("From") ("To" "Cc") ("Newsgroups")))))
7037 Where each element of the list @code{wl-draft-reply-without-argument-list}
7041 (key . (to-list cc-list newsgroup-list))
7044 and if the field designated by @samp{key} exist in the parent message,
7045 parent's field values designated by @samp{to-list} are copied to @samp{To:}
7046 in the draft. Similarly, parent's fields designated by @samp{cc-list} and
7047 @samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
7048 the draft respectively.
7053 ("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
7056 Match if the parent has @samp{Mail-Followup-To} field.
7057 The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
7058 fields are copied to @samp{To} and @samp{Newsgroups} in the draft
7062 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
7065 Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
7066 Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
7069 ("From" . (("From") ("To" "Cc") ("Newsgroups")))
7072 Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
7073 @samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
7076 These are evaluated in order and first matched one is used.
7078 Moreover, the behavior of @kbd{a} with prefix argument can
7079 be directed by @code{wl-draft-reply-with-argument-list} as well.
7081 By the way, you can use some function (will be evaluated in the parent
7082 message buffer) in the place of @samp{key} or @samp{to-list} etc.
7083 For example, if you only want to reply to mailing lists in
7084 @code{wl-subscribed-mailing-list} if the parent has some of them,
7089 (defun wl-mailing-list-addresses ()
7093 (nth 1 (std11-extract-address-components addr)))
7096 (elmo-multiple-fields-body-list (list "To" "Cc"))
7098 (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
7099 (setq list-addrs (cons to list-addrs))))
7100 (nreverse list-addrs)))
7102 (setq wl-draft-reply-with-argument-list
7103 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
7104 ("Reply-To" . (("Reply-To") nil nil))
7105 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
7106 ("From" . (("From") nil nil))))
7111 Note: To set the behavior when you reply to the message written by yourself,
7112 use @code{wl-draft-reply-myself-without-argument-list} and
7113 @code{wl-draft-reply-myself-with-argument-list} instead of them.
7115 @node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
7116 @subsection Appearance of Threads
7120 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
7121 390 09/18(Fri)07:25 +-[ Tsumura-san ]
7122 391 09/18(Fri)19:24 +-[ Murata-san ]
7123 392 09/20(Sun)21:49 +-[ Okunishi-san ]
7124 396 09/20(Sun)22:11 | +-[ Tsumura-san ]
7125 398 09/21(Mon)00:17 | +-[ Tsumura-san ]
7126 408 09/21(Mon)22:37 | +-[ Okunishi-san ]
7127 411 09/22(Tue)01:34 | +-[ Tsumura-san ]
7128 412 09/22(Tue)09:28 | +-[ Teranishi ]
7129 415 09/22(Tue)11:52 | +-[ Tsumura-san ]
7130 416 09/22(Tue)12:38 | +-[ Teranishi ]
7131 395 09/20(Sun)21:49 +-[ Okunishi-san ]
7132 397 09/21(Mon)00:15 +-[ Okunishi-san ]
7136 Settings to make appearance of threads like shown above:
7140 (setq wl-thread-indent-level 2)
7141 (setq wl-thread-have-younger-brother-str "+")
7142 (setq wl-thread-youngest-child-str "+")
7143 (setq wl-thread-vertical-str "|")
7144 (setq wl-thread-horizontal-str "-")
7145 (setq wl-thread-space-str " ")
7149 If you do not want to see branches, do the following:
7153 (setq wl-thread-indent-level 2)
7154 (setq wl-thread-have-younger-brother-str " ")
7155 (setq wl-thread-youngest-child-str " ")
7156 (setq wl-thread-vertical-str " ")
7157 (setq wl-thread-horizontal-str " ")
7158 (setq wl-thread-space-str " ")
7163 @node User-Agent Field, , Thread Format, Advanced Settings
7164 @subsection User-Agent Field
7168 If you are eccentric enough to elaborate @samp{X-Mailer:} or
7169 @samp{User-Agent:} fields, define a function that generate appropriate
7170 strings as you like, and set it to variable
7171 @code{wl-generate-mailer-string-function}.
7173 If you do not want verbose @samp{User-Agent:} field, do the following:
7177 (setq wl-generate-mailer-string-function
7178 'wl-generate-user-agent-string-1)
7182 The following is a example:
7186 (setq wl-generate-mailer-string-function nil)
7187 (setq wl-draft-additional-header-alist
7189 (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
7194 @node Customizable Variables, Hooks, Advanced Settings, Customization
7195 @section Customizable Variables
7197 Customizable variables that have not been described yet:
7200 @item wl-default-folder
7201 @vindex wl-default-folder
7202 The initial setting is @samp{%inbox}. This is the default value for moving to
7203 a folder and the like.
7205 @item wl-draft-folder
7206 @vindex wl-draft-folder
7207 The initial setting is @samp{+draft}. It is the folder to which drafts are
7208 saved. It must be a localdir folder.
7210 @item wl-trash-folder
7211 @vindex wl-trash-folder
7212 The initial setting is @samp{+trash}. It is the wastebasket folder.
7213 If you changed this variable, you had better restart Wanderlust.
7215 @item wl-interactive-exit
7216 @vindex wl-interactive-exit
7217 The initial setting is @code{t}.
7218 If non-nil, you are asked for confirmation when Wanderlust terminates.
7220 @item wl-interactive-send
7221 @vindex wl-interactive-send
7222 The initial setting is @code{t}.
7223 If non-nil, you are asked for confirmation when mail is sent.
7225 @item wl-folder-sync-range-alist
7226 @vindex wl-folder-sync-range-alist
7227 The initial setting is the alist shown below:
7232 ("^\\+draft$\\|^\\+queue$" . "all"))
7237 This is an associative list of regular expressions of folder names and
7238 update range of the summary. Update range is one of the @samp{all},
7239 @samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
7240 @samp{last}. If a folder do not match, @samp{update} is used.
7243 @vindex wl-ask-range
7244 The initial setting is @code{t}.
7245 If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
7246 for updating the summary when you changed folders.
7248 @item wl-mime-charset
7249 @vindex wl-mime-charset
7250 The initial setting is @code{x-ctext}.
7251 This is the MIME charset for messages that are not MIME (e.g. without
7252 @samp{Content-Type:}). This value also used as default charset for
7253 summary. (If you want to share Summary on Nemacs and other Emacsen, set
7254 this value as @code{iso-2022-jp}.)
7256 @item wl-highlight-folder-with-icon
7257 @vindex wl-highlight-folder-with-icon
7258 This is meaningful for XEmacs or Emacs 21.. The initial setting depends
7259 on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
7261 @item wl-strict-diff-folders
7262 @vindex wl-strict-diff-folders
7263 This is a list of regular expressions of folders.
7264 Unread messages are checked, for example when you press @kbd{s} in
7265 the folder mode, usually in a brief way (rapidly processed but not
7267 The folders matching this variable are seriously checked.
7268 You may want to set this variable so as to match conditional filter
7269 folders for IMAP4 folders.
7270 The initial setting is @code{nil}.
7272 @item wl-folder-use-server-diff
7273 @vindex wl-folder-use-server-diff
7274 When unread messages are checked, for example when you press @kbd{s} in
7275 the folder mode, usually (the number of messages on the server) @minus{}
7276 (the number of local messages) will be the number of unread messages.
7277 However, if this variable is non-nil, the number of unread messages on
7278 the server is checked. This affects IMAP4 folders only, but IMAP4
7279 folders in mail boxes matching
7280 @code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
7281 the number of unread messages on the server, even if they matches this
7282 variable. The initial setting is @code{t}.
7284 @item wl-auto-check-folder-name
7285 @vindex wl-auto-check-folder-name
7286 The initial setting is @code{nil}.
7287 You can specify a folder or a group which is checked for unread message
7288 at the start. You can also specify a list of folders (groups) to be checked.
7289 If the value is @code{nil}, whole Desktop is checked at the start.
7290 If it is @code{none}, no folders are checked.
7292 @item wl-auto-uncheck-folder-list
7293 @vindex wl-auto-uncheck-folder-list
7294 The initial setting is the list shown below:
7303 You can set a list of regular expressions to specify folders
7304 which are not automatically checked even if they are included
7305 in some groups assigned by @code{wl-auto-check-folder-name}.
7307 @item wl-auto-check-folder-list
7308 @vindex wl-auto-check-folder-list
7309 The initial setting is @code{nil}.
7310 You can set a list of regular expressions to specify exceptions
7311 for @code{wl-auto-uncheck-folder-list}.
7313 @item wl-no-save-folder-list
7314 @vindex wl-no-save-folder-list
7315 The initial setting is the list shown below:
7324 This is a list of regular expressions of folders not to be saved.
7326 @item wl-save-folder-list
7327 @vindex wl-save-folder-list
7328 The initial setting is @code{nil}.
7329 This is a list of regular expressions of folders to be saved.
7330 This takes precedence over @code{wl-no-save-folder-list}.
7332 @item wl-folder-mime-charset-alist
7333 @vindex wl-folder-mime-charset-alist
7334 The initial setting is the alist shown below:
7338 (("^-alt\\.chinese" . big5)
7339 ("^-relcom\\." . koi8-r)
7341 ("^-han\\." . euc-kr))
7346 This is an associative list of regular expressions of folder names and
7348 If a folder do not match, @code{wl-mime-charset} is used.
7350 @item wl-folder-init-load-access-folders
7351 @vindex wl-folder-init-load-access-folders
7352 The initial setting is @code{nil}.
7353 This is a list of access groups to be loaded specifically at the start.
7354 If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
7356 @item wl-folder-init-no-load-access-folders
7357 @vindex wl-folder-init-no-load-access-folders
7358 The initial setting is @code{nil}.
7359 This is a list of access groups not to be loaded specifically at the
7361 It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
7363 @item wl-delete-folder-alist
7364 @vindex wl-delete-folder-alist
7365 The initial setting is the alist shown below:
7374 This list determines disposition of messages with delete marks.
7375 Each item in the list is a folder and destination; you can specify any
7376 one of the following in the place of destination:
7379 @code{remove} or @code{null} : deletes the messages instantly.
7380 string : moves the messages to the specific folder.
7381 @code{trash} or others : moves the messages to @code{wl-trash-folder}.
7384 @item wl-refile-policy-alist
7385 @vindex wl-refile-policy-alist
7386 The initial setting is the list shown below:
7396 This list determines whether messages with re-file marks are moved or
7397 copied. Each item in the list is a cons cell of a folder and
7398 @code{copy} or @code{move}.
7400 @item wl-x-face-file
7401 @vindex wl-x-face-file
7402 The initial setting is @file{~/.xface}.
7403 The name of the file that contains encoded X-Face strings.
7406 @item wl-demo-display-logo
7407 @vindex wl-demo-display-logo
7408 If non-nil, bitmap image is shown on the opening demo. If you set
7409 @code{xpm} or @code{xbm}, (if possible) display selected image type
7412 @item elmo-use-database
7413 @vindex elmo-use-database
7414 This is meaningful for XEmacs only. The initial setting depends on
7415 XEmacs (@code{t} for XEmacs with dbm).
7416 If non-nil, Message-ID is controlled by dbm.
7418 @item elmo-passwd-alist-file-name
7419 @vindex elmo-passwd-alist-file-name
7420 The initial setting is @file{passwd}.
7421 This is the name of the file in which passwords are saved.
7422 @code{elmo-passwd-alist-save} saves current passwords to the file.
7424 @item elmo-nntp-list-folders-use-cache
7425 @vindex elmo-nntp-list-folders-use-cache
7426 The initial setting is 600 (in seconds).
7427 This is period in seconds during which results of @samp{list} and
7428 @samp{list active} in NNTP are cached. If it is @code{nil}, they are
7431 @item elmo-nntp-max-number-precedes-list-active
7432 @vindex elmo-nntp-max-number-precedes-list-active
7433 The initial setting is @code{nil}.
7434 If non-nil, the number of article obtained by @samp{list active} in NNTP
7435 are used as the maximum article number of the folder.
7436 Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
7437 and if the number of read messages is not correct.
7439 @item elmo-nntp-default-use-listgroup
7440 @vindex elmo-nntp-default-use-listgroup
7441 The initial setting is @code{t}.
7442 If non-nil, @samp{listgroup} is used for checking the total number of
7443 articles. If it is @code{nil}, @samp{group} is used. In the latter
7444 case, the processing will be a little faster at the sacrifice of
7447 @item elmo-pop3-send-command-synchronously
7448 @vindex elmo-pop3-send-command-synchronously
7449 The initial setting is @code{nil}.
7450 If non-nil, POP3 commands are issued synchronously. Some implementation
7451 of POP3 server fails to get summary information without this setting.
7452 You may have to set this variable to @code{t}, if the process hangs
7453 while looking up POP3.
7455 @item elmo-dop-flush-confirm
7456 @vindex elmo-dop-flush-confirm
7457 The initial setting is @code{t}.
7458 If non-nil, you are asked for confirmation if accumulated off-line
7459 operations are executed.
7461 @item elmo-display-progress-threshold
7462 @vindex elmo-display-progress-threshold
7463 The initial setting is 20.
7464 Threshold for display of progress gauge. If number of renewal is more than
7465 this value, display progress gauge.
7469 @node Hooks, , Customizable Variables, Customization
7474 @node Terminology, Mailing List, Customization, Top
7475 @chapter Terminology around Wanderlust
7478 Here we explain terminologies used in this manual.
7482 A container in which messages are stored.
7485 A set consists of some folders.
7488 A special group consists of automatically collected folders under
7489 some specified path.
7490 @xref{Folder Definition}.
7492 @item summary buffer
7493 A buffer for displaying list of messages in some folder.
7495 @item sticky summary
7496 Compared with ordinary summary buffer which will be destroyed after
7497 exiting from it, this type of summary will be remain even after exiting
7498 by @kbd{q} or @kbd{g}.
7499 @xref{Sticky Summary}.
7502 To delete or put into the archive expired messages.
7509 To cache messages beforehand in order to read messages after you will be
7510 disconnected from the server.
7514 @node Mailing List, Addition, Terminology, Top
7515 @chapter Wanderlust Mailing List
7519 Topics related to Wanderlust are discussed in following mailing lists.
7520 The latest version is also announced there.
7523 Wanderlust Mailing List @t{<wl@@lists.airs.net>}
7526 In this list Japanese is mainly used for discussion. We also have a list
7527 for discussion in English:
7530 Wanderlust List in English @t{<wl-en@@lists.airs.net>}
7532 (Messages posted to this list are also forwarded to the former one.)
7534 A guide can be obtained automatically by sending mail to
7535 @t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
7536 the English one) with the body
7542 Please send bug reports or patches to one of those lists. You can post to
7543 the mailing list even though you are not a member of it.
7545 If you send a bug report, please attach Backtrace with it.
7546 @footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
7549 I would like to express my thanks to the members of the mailing list for
7550 valuable advice and many pieces of code they contributed.
7553 @node Addition, Index, Mailing List, Top
7554 @chapter Additional Information
7556 @section Brief History
7559 1998 3/05 Tried to make a prototype that displays MH messages in threads.
7560 3/10 Made a msgdb mechanism by elisp.
7561 3/26 IMAP and NNTP can be displayed in threads.
7562 4/13 Began to assemble thread display modules as elmo.
7563 5/01 Finished 0.1.0, initial version with many defects.
7564 6/12 I made a slip of the tongue and said I was writing elisp
7565 mailer supporting IMAP
7566 6/16 0.1.3 was announced at tm-ja, elisp ML.
7567 6/22 Thanks to Kitame-san, the mailing list started at northeye.org.
7568 7/01 Support for mm-backend (0.3.0).
7569 8/25 multi folder added (0.5.0).
7570 8/28 filter folder added (0.5.1).
7571 9/10 You can open/close threads (0.6.0).
7572 9/11 fldmgr by Murata-san made editing folders easy.
7573 9/18 lha folders added by Okunishi-san (0.6.3).
7574 9/24 Display of branches of threads (0.6.5).
7575 9/28 Compression folder supporting multiple archivers by Okunishi-san.
7576 10/28 Off-line operations (0.7.4).
7577 12/09 Becomes beta version.
7578 12/21 wl-expire by Murata-san.
7579 1999 2/03 auto-refile by Tsumura-san.
7580 4/28 wl-template by Murata-san.
7581 5/18 Released 1.0.0 stable.
7582 7/05 Scoring by Murata-san (2.1.0).
7583 9/26 New plugged system by Murata-san (2.2.2).
7584 12/20 Support Modified UTF7.
7585 2000 3/24 Released 1.1.0 stable.
7586 4/03 CVS development started.
7587 5/07 Thread restoration & Its speed up with Murata-san.
7588 6/12 Address completion with LDAP with Chiba-san & Goto-san.
7589 7/11 killed message feature.
7590 7/18 Use UIDL in POP3.
7591 9/12 biff feature with Satata-san & Yamaoka-san.
7592 10/17 expire-hide by Okada-san.
7593 11/08 Released 2.4.0 stable.
7594 2001 7/04 Released 2.6.0 stable.
7595 8/21 wl-addrmgr by Kitamoto-san.
7596 12/27 Released 2.8.1 stable.
7599 See @file{ChangeLog} for details.
7603 According to a dictionary, Wanderlust has the meaning:
7607 n eager longing for or impulse towards travelling in distant lands
7608 [Ger, fr wandern to wander + lust desire, pleasure]
7612 but I had no profound intention. (if farfetched, IMAP @result{} you can
7613 read mail anywhere @result{} desire to wander ?)
7615 Elmo is the abbreviation of @samp{Elisp Library for Message
7616 Orchestration}. At first I meant the red puppet in the Sesame Street,
7617 but you may associate it with Wandering @result{} Drifting @result{}
7618 Guidepost @result{} St.@: Elmo's fire @result{} elmo.
7622 Each versions has code names (they are almost jokes).
7623 Currently they are picked up alphabetically from the top 40 hits of
7624 U.S. Billboard magazines in 1980s.
7626 (@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
7629 @node Index, , Addition, Top
7633 * Concept Index:: Concept Index
7634 * Key Index:: Key Index
7635 * Variable Index:: Variable Index
7636 * Function Index:: Function Index
7639 @node Concept Index, Key Index, Index, Index
7640 @unnumberedsec Concept Index
7643 @node Key Index, Variable Index, Concept Index, Index
7644 @unnumberedsec Key Index
7647 @node Variable Index, Function Index, Key Index, Index
7648 @unnumberedsec Variable Index
7651 @node Function Index, , Variable Index, Index
7652 @unnumberedsec Function Index