1\input texinfo @c -*-texinfo -*- coding: us-ascii -*- 2@c %**start of header 3@setfilename wl.info 4@settitle Wanderlust -- Yet Another Message Interface On Emacsen -- 5@c %**end of header 6@documentlanguage en 7@include version.texi 8@synindex pg cp 9@finalout 10 11@dircategory GNU Emacs Lisp 12@direntry 13* Wanderlust: (wl). Yet Another Message Interface On Emacsen 14@end direntry 15 16@c permissions text appears in an Info file before the first node. 17@ifinfo 18This file documents Wanderlust, Yet another message interface on 19Emacsen. 20 21Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi}, 22@w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada}, 23@w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}, 24@w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}. 25 26This edition is for Wanderlust version @value{VERSION}. 27 28Permission is granted to make and distribute verbatim copies of this 29manual provided the copyright notice and this permission notice are 30preserved on all copies. 31 32@ignore 33Permission is granted to process this file through TeX and print the 34results, provided the printed document carries copying permission notice 35identical to this one except for the removal of this paragraph (this 36paragraph not being relevant to the printed manual). 37 38@end ignore 39Permission is granted to copy and distribute modified versions of this 40manual under the conditions for verbatim copying, provided that the 41entire resulting derived work is distributed under the terms of a 42permission notice identical to this one. 43 44Permission is granted to copy and distribute translations of this manual 45into another language, under the above conditions for modified versions. 46 47@end ifinfo 48 49@titlepage 50@sp 10 51@title Wanderlust User's Manual 52@subtitle Yet another message interface on Emacsen 53@subtitle for Wanderlust version @value{VERSION} 54@author Yuuichi Teranishi 55@author Fujikazu Okunishi 56@author Masahiro Murata 57@author Kenichi Okada 58@author Kaoru Takahashi 59@author Bun Mizuhara 60@author Masayuki Osada 61@author Katsumi Yamaoka 62@author Hiroya Murata 63@author Yoichi Nakayama 64@page 65 66@vskip 0pt plus 1filll 67Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi}, 68@w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada}, 69@w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada}, 70@w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}. 71 72This manual is for Wanderlust version @value{VERSION}. 73 74Permission is granted to make and distribute verbatim copies of this 75manual provided the copyright notice and this permission notice are 76preserved on all copies. 77 78Permission is granted to copy and distribute modified versions of this 79manual under the conditions for verbatim copying, provided that the 80entire resulting derived work is distributed under the terms of a 81permission notice identical to this one. 82 83Permission is granted to copy and distribute translations of this manual 84into another language, under the above conditions for modified versions. 85 86@end titlepage 87 88 89@ifinfo 90@node Top, Introduction, (dir), (dir) 91@top Wanderlust User's Manual 92 93@flushright 94Yuuichi Teranishi 95Fujikazu Okunishi 96Masahiro Murata 97Kenichi Okada 98Kaoru Takahashi 99Bun Mizuhara 100Masayuki Osada 101Katsumi Yamaoka 102Hiroya Murata 103Yoichi Nakayama 104@end flushright 105 106This manual is for Wanderlust @value{VERSION}. 107 108@end ifinfo 109 110@menu 111* Introduction:: Read this first 112* Start Me Up:: Invoking Wanderlust 113* Folders:: How to specify folders 114* Folder:: Selecting and editing folders 115* Summary:: Reading and refiling messages 116* Message:: Saving and playing MIME multipart entities 117* Draft:: Draft buffer, sending mail and news 118* Disconnected Operations:: Off-Line management 119* Expire and Archive:: Automatic expiration and archiving of messages 120* Scoring:: Score of the messages 121* Address Book:: Management of Address Book 122* Quick Search:: Quickly search your mail archive 123* Spam Filter:: Spam filtering 124* Advanced Issues:: Advanced Issues 125* Migration:: Switch from older version of Wanderlust 126* Terminology:: Terminologies 127* Mailing List:: Wanderlust mailing list 128* Addition:: Additional Information 129* Index:: Key index 130@end menu 131 132 133@node Introduction, Start Me Up, Top, Top 134@chapter Introduction of Wanderlust 135@cindex Introduction 136 137Wanderlust is an mail/news management system on Emacsen. 138It supports IMAP4rev1(RFC2060), NNTP, POP and local message files. 139 140The main features of Wanderlust: 141 142@itemize @minus 143@item Pure elisp implementation. 144@item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format. 145@item Unified access method to messages based on Mew-like Folder Specification. 146@item Mew-like Key-bind and mark handling. 147@item Manages unread messages. 148@item Interactive thread display. 149@item Folder Mode shows the list of subscribed folders. 150@item Message Cache, Disconnected Operation. 151@item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed). 152@item MIME compliant (by SEMI). 153@item Transmission of news and mail are unified by Message transmitting draft. 154@item Graphical list of folders. 155@item View a part of message without retrieving the whole message (IMAP4). 156@item Server-side message look up (IMAP4). Multi-byte characters are allowed. 157@item Virtual Folders. 158@item Supports compressed folder using common archiving utilities. 159@item Old articles in folders are automatically removed/archived (Expiration). 160@item Automatic re-file. 161@item Template function makes it convenient to send fixed form messages. 162@end itemize 163 164 165@section Environment 166 167We confirm Wanderlust works on following Emacsen: 168 169@itemize @bullet 170@item Emacs 24.5 or later 171@end itemize 172 173IMAP4 connectivity with following imapd are confirmed to work with 174Wanderlust: 175 176@itemize @bullet 177@item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later 178@item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later 179@item Courier-IMAP 1.3.2 or later 180@item AIR MAIL (AIRC imapd release 2.00) 181@item Express Mail 182@item Microsoft Exchange Server 5.5 183@item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0 184@end itemize 185 186LDAP connectivity with following LDAPd are confirmed to work with 187Wanderlust: 188 189@itemize @bullet 190@item OpenLDAP 2.0.6 or later 191@end itemize 192 193 194@node Start Me Up, Folders, Introduction, Top 195@chapter Start up Wanderlust 196@cindex Start up 197 198The necessary procedure for starting Wanderlust is explained in steps 199here. 200 201(Of course, you need a mail/news readable environment in advance) 202 203@menu 204* MIME Modules:: Installing the MIME modules 205* Download:: Download and extract the packages 206* Install:: Byte-compile and install 207* Minimal Settings:: @file{.emacs} setup 208* Folder Definition:: Folder definition 209* Start Wanderlust:: Starting Wanderlust 210* Overview:: Basic components of Wanderlust 211@end menu 212 213 214@node MIME Modules, Download, Start Me Up, Start Me Up 215@section Installing MIME modules 216@cindex MIME modules 217@pindex APEL 218@pindex FLIM 219@pindex SEMI 220 221You must install packages named APEL-LB, FLIM-LB and SEMI-EPG, which are 222variants of APEL, FLIM and SEMI, beforehand to use Wanderlust. 223 224@example 225@group 226APEL-LB: @uref{https://github.com/wanderlust/apel} 227FLIM-LB: @uref{https://github.com/wanderlust/flim} 228SEMI-EPG: @uref{https://github.com/wanderlust/semi} 229@end group 230@end example 231 232You can download original APEL, FLIM and SEMI from following URLs: 233 234@example 235@group 236APEL: @uref{http://git.chise.org/elisp/dist/semi/} 237FLIM: @uref{http://git.chise.org/elisp/dist/apel/} 238SEMI: @uref{http://git.chise.org/elisp/dist/semi/} 239@end group 240@end example 241 242You have to install APEL-LB, FLIM-LB and SEMI-EPG in this order. 243Generally, @samp{make install} will do the job. 244 245Refer to the documents of each package for detailed installation 246procedure. 247 248You have to re-install Wanderlust if you upgraded APEL-LB, FLIM-LB or 249SEMI-EPG. 250 251 252@node Download, Install, MIME Modules, Start Me Up 253@section Download and Extract the Package 254@cindex Download 255 256You can download Wanderlust package from following sites: 257 258Original site: 259@example 260@uref{https://github.com/wanderlust/wanderlust} 261@end example 262 263Mirrored ftp/http sites: 264 265@example 266@group 267@uref{http://www.jpl.org/ftp/pub/github-snapshots/} 268@end group 269@end example 270 271Extract the obtained package to your working directory: 272 273@example 274@group 275% cd ~/work 276% tar zxvf wl-@var{version}.tar.gz 277% cd wl-@var{version} 278@end group 279@end example 280 281@subsection To use SSL (Secure Socket Layer) 282@cindex SSL 283@pindex OpenSSL 284@pindex starttls 285 286SSL (Secure Socket Layer) can be used for 287SMTP, IMAP, NNTP and POP connections in Wanderlust. 288Emacs 24 and later uses built-in GnuTLS if available. 289 290There are two ways to use SSL. One is to start SSL negotiation just 291after the connection establishment (generic way). The other one is to 292start SSL negotiation by invoking STARTTLS command in the each session. 293 294If built-in GnuTLS is not available, Emacs try to use @file{tls.el} for 295the formal SSL (generic SSL). In this case, GnuTLS's 296@command{gnutls-cli} is needed. if neither avialable, @file{ssl.el} of 297@file{utils} directory and OpenSSL's @command{openssl}. 298 299For the latter SSL (STARTTLS), you need @file{starttls.el} if built-in 300GnuTLS is not available. Moreover, GnuTLS or starttls package is needed 301according to @code{starttls-use-gnutls} variable's value. If your Emacs 302doesn't have @file{starttls.el} or @file{starttls.el} doesn't have the 303defninition of @code{starttls-use-gnutls}, you need starttls package. 304 305You can download starttls package from the following site. 306 307@example 308@uref{ftp://opaopa.org/pub/elisp/} 309@end example 310 311@node Install, Minimal Settings, Download, Start Me Up 312@section Byte-compile and install 313@cindex Byte-compile 314@cindex Compile 315@cindex Install 316@cindex Makefile 317@cindex Make 318 319@subsection Installation 320 321Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}. 322Set the Emacs's command name to @code{EMACS}. 323Set package installation directory to @code{LISPDIR}. 324Then, please execute following commands. 325 326@example 327@group 328% make 329% make install 330@end group 331@end example 332 333Destination directory is auto-probed if you leave @code{LISPDIR} 334in @file{Makefile} as is. (That is, leave it as @samp{NONE}) 335 336If you want to handle shimbun folders, add directory where emacs-w3m is 337installed to @code{load-path}. Then necessary modules will be 338byte-compiled and installed. 339@xref{Shimbun Folder}. 340 341@subsection @file{WL-CFG} 342 343Contents of the file @file{WL-CFG} is loaded under installation if a file 344with that name exists in extracted directory. You can use @file{WL-CFG} to 345configure @code{load-path} to extra packages such as SEMI if needed. 346 347If you want to specify the install directory of Wanderlust related 348files, then set following variables in @file{WL-CFG} 349 350@table @code 351@item WL_PREFIX 352A directory to install WL modules. 353This directory is relative directory from @code{LISPDIR}. 354WL modules include @file{wl*.el}, @file{wl*.elc} files. 355@c Modules under the directory @file{util/} are also installed if 356@c it detected as necessary. 357 358@item ELMO_PREFIX 359A directory to install ELMO modules. 360This directory is relative directory from @code{LISPDIR}. 361ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files. 362@c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO. 363@end table 364 365@noindent 366Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}. 367 368If you want to install ELMO related files under a sub-directory 369such as "elmo" then add following to @file{WL-CFG}: 370 371@lisp 372(setq ELMO_PREFIX "elmo") 373@end lisp 374 375@subsection Run in place 376 377If wl and elmo directories are defined in @code{load-path}, then 378byte-compilation and installation are not necessary to start Wanderlust. 379For example, if package is extracted in @file{~/work}, Wanderlust can be 380invoked with following setting in @file{~/.emacs}. 381 382@lisp 383@group 384(add-to-list 'load-path "~/work/wl-@var{version}/wl") 385(add-to-list 'load-path "~/work/wl-@var{version}/elmo") 386@end group 387@end lisp 388 389@subsection Manual 390 391Manual is described in Info format. Please do following. 392 393@example 394@group 395% make info 396% make install-info 397@end group 398@end example 399 400Manual directory is automatically detected. Of course, it can be 401configured by @code{INFODIR} in @file{Makefile}. 402 403You can read manual at the following URL: 404 405@example 406@uref{http://wanderlust.github.io/wl-docs/wl.html} 407@end example 408 409@node Minimal Settings, Folder Definition, Install, Start Me Up 410@section Set up .emacs 411@cindex Minimal Settings 412@cindex Settings 413@cindex Configuration 414@cindex .emacs 415@cindex .wl 416 417The Wanderlust package contains two module groups. 418 419@table @samp 420@item ELMO (elmo-*.el) 421These modules show everything as folders. This is the back-end for WL. 422@item WL (wl-*.el) 423These modules controls the behavior of main body of Wanderlust. 424They are also the front-end for ELMO. 425@end table 426 427You can customize the behavior of Wanderlust by changing the value 428of environmental variables which begins with @code{elmo-} and @code{wl-}. 429 430The minimal requirement for settings is as the following. 431 432@lisp 433@group 434;; @r{autoload configuration} 435(autoload 'wl "wl" "Wanderlust" t) 436(autoload 'wl-other-frame "wl" "Wanderlust on new frame." t) 437(autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t) 438 439;; @r{Directory where icons are placed.} 440;; @r{Default: the peculiar value to the running version of Emacs.} 441;; @r{(Not required if the default value points properly)} 442(setq wl-icon-directory "~/work/wl/etc") 443 444;; @r{SMTP server for mail posting. Default: @code{nil}} 445(setq wl-smtp-posting-server "your.smtp.example.com") 446;; @r{NNTP server for news posting. Default: @code{nil}} 447(setq wl-nntp-posting-server "your.nntp.example.com") 448@end group 449@end lisp 450 451@file{~/.wl} is automatically loaded when Wanderlust starts up (if such a 452file exists). So it is convenient to gather Wanderlust specific settings 453in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl}, 454because you can't write them in @file{.emacs} 455(if you write it to @file{.emacs}, you'll get an error). 456@xref{Highlights}. 457 458All above described settings except autoload configuration can be written 459in @file{~/.wl}). 460 461@subsection @code{mail-user-agent} 462@cindex Default Mailer 463@cindex Mailer, Default 464@vindex mail-user-agent 465@findex compose-mail 466 467If you write following setting in your @file{~/.emacs}, you can 468start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}). 469This means it enables you to run Wanderlust as a default mail composer 470 of Emacsen. 471 472It is effective only when your Emacs can define @code{mail-user-agent}. 473@xref{Mail Methods, , Mail-Composition Methods, emacs, GNU Emacs Manual}. 474 475@lisp 476@group 477(autoload 'wl-user-agent-compose "wl-draft" nil t) 478(if (boundp 'mail-user-agent) 479 (setq mail-user-agent 'wl-user-agent)) 480(if (fboundp 'define-mail-user-agent) 481 (define-mail-user-agent 482 'wl-user-agent 483 'wl-user-agent-compose 484 'wl-draft-send 485 'wl-draft-kill 486 'mail-send-hook)) 487@end group 488@end lisp 489 490 491 492@node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up 493@section Folder Definition 494@cindex Folder Definition 495@cindex .folders 496 497You can skip this section because it is possible to add/edit the 498subscribe folders from the buffer for list of folders. 499@xref{Folder Manager}. 500 501Define the folders you want to subscribe in file @file{~/.folders}. The 502contents written in @file{~/.folders} become the folders which you 503subscribe to as it is. 504 505Format for @file{~/.folders} is very simple. Here is an example: 506 507@example 508@group 509# 510# @r{Lines begin with @samp{#} are comment.} 511# @r{Empty lines are ignored} 512# 513# @var{folder name} "@var{folder nickname}" 514# @r{(nicknames are not necessary)} 515# 516%inbox "Inbox" 517+trash "Trash" 518+draft "Drafts" 519%#mh/Backup@@my.imap.example.com "Sent" 520# Folder Group 521Emacsen@{ 522 %#mh/spool/wl "Wanderlust ML" 523 %#mh/spool/elips "ELIPS ML" 524 %#mh/spool/apel-ja "APEL Japanese ML" 525 %#mh/spool/xemacs-beta "XEmacs beta" 526 -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news" 527 *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen" 528@} 529# 530# @r{If folder name ends with @samp{/}, that means an `access group',} 531# @r{all subfolders automatically included in one folder group.} 532# 533%#mh/expire@@localhost / 534# @r{All MH folders are included in one folder group.} 535+ / 536@end group 537@end example 538 539Each line contains one folder you want to read. The definition of 540folders will be explained in detail in the next section. 541 542The part surrounded by @samp{@var{group name}@{} and @samp{@}} will 543become one folder group. One folder group is treated as a directory 544which can be opened and closed in folder mode. It is convenient for 545collecting some folders and putting them in order. 546 547Please note that @samp{@var{group name}@{} and @samp{@}} occupies one 548line and you have to write it that way (It is because the parser sucks). 549 550There are two types of groups. One is like @samp{Emacsen} from above 551example which the user chooses his favorite folders as a group. 552 553The other one is @dfn{access group} like @samp{+ /} from above example. 554It collects all sub-folders in the folder to make a group. (Its 555behavior differs by the type of the folder. For example, @samp{+} 556followed by @samp{/} makes entire MH sub-directories to one group) 557 558This behavior is better understood if you try it and confirmed the 559function first. You can write and try a small folder definition, so you 560will know the idea of the folder function before writing the real one. 561 562@node Start Wanderlust, Overview, Folder Definition, Start Me Up 563@section Start Wanderlust 564@cindex Start Wanderlust 565 566If installation and configuration worked well, you can invoke Wanderlust by 567typing following command in Emacs. 568 569@example 570M-x wl 571@end example 572 573@noindent 574After initialization, Folder Mode which shows the list of folders will 575appear. That means the folders you defined in the @file{~/.folders} are 576listed. 577 578If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you 579can skip folder checking. 580 581 582@node Overview, , Start Wanderlust, Start Me Up 583@section Overview 584@cindex Overview 585 586Basically, you will handle messages in wanderlust while you come and go 587from/to each of the following buffers. Details of each ones are 588explained in following chapters. 589 590@table @samp 591@item Folder Buffer 592You can see the list of folders. You can select some folder and go into the summary 593of it. You can subscribe new folder or edit subscription list. 594@item Summary Buffer 595You can see the list of messages in the folder. You can select message 596and view its contents, and reply to some message. You can delete ones or 597move ones to another folder. 598@item Message Buffer 599You can see the contents of the message. You can save part to disk or 600open in external programs. 601@item Draft Buffer 602You can edit message. 603@end table 604 605 606@node Folders, Folder, Start Me Up, Top 607@chapter Wanderlust's folders 608@cindex Folder Type 609 610This chapter describes the folder types which Wanderlust is able to handle. 611 612Wanderlust uses ELMO as it's interface, so you can use every folder types 613supported by ELMO. 614 615As of version @value{VERSION}, 15 types of folders are predefined. These 616are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, 617Shimbun, Search, Multi, Filter, Pipe, File, Access and Internal folder 618types. 619 620@menu 621* IMAP Folder:: @samp{%} -- IMAP folder 622* NNTP Folder:: @samp{-} -- NNTP folder 623* MH Folder:: @samp{+} -- MH folder 624* Maildir Folder:: @samp{.} -- Maildir folder 625* News Spool Folder:: @samp{=} -- News spool folder 626* Archive Folder:: @samp{$} -- Archive folder 627* POP Folder:: @samp{&} -- POP folder 628* Shimbun Folder:: @samp{@@} -- Shimbun Folder 629* RSS Folder:: @samp{rss} -- RSS folder 630* Search Folder:: @samp{[} -- Search Folder 631* Multi Folder:: @samp{*} -- Multi folder 632* Filter Folder:: @samp{/} -- Filter folder 633* Pipe Folder:: @samp{|} -- Pipe folder 634* Internal Folder:: @samp{'} -- Internal folder 635* File Folder:: -- File folder 636* Access Folder:: -- Access folder 637@end menu 638 639 640@node IMAP Folder, NNTP Folder, Folders, Folders 641@section IMAP Folder 642@cindex @samp{%} 643@cindex IMAP Folder 644@cindex Folder, IMAP 645@cindex RFC 2060 646@cindex IMAP4rev1 647 648A folder to access e-mails via IMAP4rev1 protocol (RFC 2060). 649 650Format: 651 652@example 653@group 654@samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}] 655@end group 656@end example 657 658You can specify @code{login} (encoded password transmission), 659@code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5 660authentication) or @code{clear} (or @code{nil}, plain password 661transmission) as @var{authenticate-type}. 662 663default: 664 665@example 666@var{username} -> The value of @code{elmo-imap4-default-user}. 667 Initial setting is @env{USER} environment variable or 668 @env{LOGNAME} environment variable or return value of 669 @code{(user-login-name)}. 670@var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}. 671 Initial setting is "auth". 672@var{hostname} -> The value of @code{elmo-imap4-default-server}. 673 Initial setting is "localhost". 674@var{port} -> The value of @code{elmo-imap4-default-port}. 675 Initial setting is 143. 676@end example 677 678You can omit the @var{hostname} from folder names if you set 679@code{elmo-imap4-default-server} as your main IMAP server. 680For example, you can specify a folder as @samp{foo%imap@@gateway} even 681if you have to go through a firewall. 682 683@lisp 684@group 685;; @r{Example: imap4.exaple.org as main IMAP server} 686(setq elmo-imap4-default-server "imap4.example.org") 687@end group 688@end lisp 689 690SSL (Secure Socket Layer) connection will be used if a folder name ends 691with @samp{!}. If a folder name ends with @samp{!!}, STARTTLS 692connection will be established. 693 694If the value of @code{elmo-imap4-default-stream-type} is @code{ssl}, 695SSL will be the default connection, i.e. you can omit @samp{!}. If it 696is is @code{starttls}, STARTTLS will be the default connection. To use 697normal connection in these cases, add @samp{!direct} at the end of 698folder name. 699 700@lisp 701@group 702;; @r{Example: Use SSL connection} 703(setq elmo-imap4-default-stream-type 'ssl) 704@end group 705@end lisp 706 707If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as 708authentication method, the password is sent in encoded form. But, if 709your server is unable to receive an encoded password, authentication 710will fall back to @code{clear} (that is, sending password in raw format) 711after confirmation to user. If @code{elmo-imap4-force-login} is non-nil, 712authentication will fall back to @code{clear} without confirmation 713(default value is @code{nil}). 714 715@lisp 716@group 717;; @r{Example: password in raw format} 718(setq elmo-imap4-default-authenticate-type 'clear) 719@end group 720@end lisp 721 722Example: 723 724@example 725@group 726%inbox -> IMAP mailbox "inbox" 727%#mh/inbox -> IMAP mailbox "#mh/inbox" 728 729%inbox:hoge -> IMAP mailbox "inbox" of user "hoge". 730%inbox:hoge/clear@@server1 731 -> server1's IMAP mailbox "inbox" 732 of user "hoge", with plain password authentication 733 ('clear). 734@end group 735@end example 736 737@subsection International mailbox names (Modified UTF7) 738@cindex Modified UTF7 739@cindex UTF7 740@cindex UTF8 741@cindex Unicode 742 743You can use international mailbox names in @var{mailbox} part, if 744@code{elmo-imap4-use-modified-utf7} is set to non-nil value (default 745value is @code{t}). 746 747 748@node NNTP Folder, MH Folder, IMAP Folder, Folders 749@section NNTP Folder 750@cindex @samp{-} 751@cindex NNTP Folder 752@cindex Folder, NNTP 753@cindex Folder, News 754@cindex NetNews 755@cindex News 756@cindex Newsgroup 757@cindex RFC 977 758 759A folder to access USENET news via NNTP protocol (RFC 977). 760One newsgroup is treated as a folder. 761 762Format: 763 764@example 765@group 766@samp{-} @var{newsgroup} [@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}] 767@end group 768@end example 769 770default: 771@example 772@var{hostname} -> The value of @code{elmo-nntp-default-server}. 773 Initial setting is @samp{localhost}. 774@var{username} -> The value of @code{elmo-nntp-default-user}. 775 Initial setting is @code{nil}. 776@var{port} -> The value of @code{elmo-nntp-default-port}. 777 Initial setting is 119. 778@end example 779 780AUTHINFO is used as authentication method if the @var{username} is 781non-nil. SSL connection will be used if a folder name ends with @samp{!}. 782If a folder name ends with @samp{!!}, STARTTLS connection will be 783established. 784 785If the value of @code{elmo-nntp-default-stream-type} is @code{ssl}, 786SSL will be the default connection, i.e. you can omit @samp{!}. If it 787is is @code{starttls}, STARTTLS will be the default connection. To use 788normal connection in these cases, add @samp{!direct} at the end of 789folder name. 790 791Example: 792 793@example 794@group 795-fj.rec.tv -> Newsgroup @samp{fj.rec.tv}. 796-fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}. 797@end group 798@end example 799 800 801@node MH Folder, Maildir Folder, NNTP Folder, Folders 802@section MH Folder 803@cindex @samp{+} 804@cindex MH Folder 805@cindex Folder, MH 806@pindex MH 807 808A folder to access MH format mail (1 file is 1 mail). 809 810Format: 811 812@example 813@samp{+} @var{directory-name} 814@end example 815 816Normally, @var{directory-name} is an relative path to the variable 817@code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it 818starts with @samp{/} or @samp{~}, then it is treated as an absolute path 819(this is also true for drive-letters). 820 821Message number is used for the name of the message file. 822 823Example: 824 825@example 826@group 827+inbox -> @file{~/Mail/inbox} 828+from/teranisi -> @file{~/Mail/from/teranisi} 829+~/test -> @file{~/test} 830@end group 831@end example 832 833 834@node Maildir Folder, News Spool Folder, MH Folder, Folders 835@section Maildir Folder 836@cindex @samp{.} 837@cindex Maildir Folder 838@pindex Maildir 839@pindex qmail 840 841A folder to access Maildir format (1 file is 1 mail). 842 843Format: 844 845@example 846@samp{.} [@var{directory-name}] 847@end example 848 849Normally, @var{directory-name} is a relative path to the variable 850@code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it 851starts with @samp{/} or @samp{~}, then it is treated as an absolute path 852(this is also true for drive-letters). 853 854Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories. 855Messages are contained in the @file{cur} directory. All message files 856in the @file{new} directory are moved to @file{cur} directory when you 857access the folder. All message files contained in the @file{tmp} 858directory and not accessed for 36 hours are deleted. 859 860This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}. 861 862Example: 863 864@example 865@group 866. -> @file{~/Maildir} 867.inbox -> @file{~/Maildir/inbox} 868.from/teranisi -> @file{~/Maildir/from/teranisi} 869.~/test -> @file{~/test} 870@end group 871@end example 872 873 874@node News Spool Folder, Archive Folder, Maildir Folder, Folders 875@section News Spool Folder 876@cindex @samp{=} 877@cindex News spool Folder 878@pindex gnspool 879 880This folder handles locally saved news articles which are proposed by 881Mew/IM. You can also read articles directly from a spool-file which is 882retrieved by an utility like @command{gnspool}. 883 884Format: 885 886@example 887@samp{=} @var{directory-name} 888@end example 889 890@var{directory-name} is a sub-directory to the directory defined by 891variable @code{elmo-localnews-folder-path} (default is @file{~/News}) 892You can use @samp{.} as directory delimiter as well as @samp{/}. 893 894Example: 895 896@example 897@group 898=fj/os/os2 -> @file{~/News/fj/os/os2} 899=fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd} 900@end group 901@end example 902 903 904@node Archive Folder, POP Folder, News Spool Folder, Folders 905@section Archive Folder 906@cindex @samp{$} 907@cindex Archive Folder 908@c @pindex ange-ftp 909 910This method can handle archive files, which are compressed by utilities 911such as Info-ZIP or LHA, as one folder. 912 913Format: 914 915@example 916@group 917@samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}] 918@end group 919@end example 920 921@var{path-name} is the relative path from 922@code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If 923@var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of 924DOS', @var{path-name} is treated as absolute path. ange-ftp format is 925also permitted under the environment of ange-ftp, efs. 926 927The actual file name of the archive folder is 928@code{elmo-archive-basename} (Initial setting is @file{elmo-archive}) 929under the @var{path-name}. If a file named @var{path-name} exists, it is 930treated as folder. The suffix is automatically decided for 931@var{archiver-type}. 932 933If @var{archiver-type} is omitted, @code{elmo-archive-default-type} 934(Initial setting is @code{zip}) is referred. 935 936@var{prefix} specifies the internal directory structure of the archive. 937For example, if the ML server is fml, @file{msend.tar.gz} has a 938structure like @file{spool/1}, so you have to specify @samp{spool} as 939@var{prefix}. 940 941Example: 942 943@example 944@group 945$teranisi -> @file{~/Mail/teranisi/elmo-archive.zip} 946$bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh} 947$/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server 948$d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz} 949$ml;zip/ -> Access group consists of archive folders 950 under @file{~/Mail/ml} 951@end group 952@end example 953 954@menu 955* Archiver:: Supported Archivers 956* Archive Tips:: TIPS 957* Archive Vars:: Customization 958@end menu 959 960 961@node Archiver, Archive Tips, Archive Folder, Archive Folder 962@subsection Supported Archives 963@cindex Archiver 964@pindex LHA 965@pindex Info-ZIP 966@pindex UNZIP 967@pindex ZOO 968@pindex RAR 969@pindex TAR 970@pindex GNU TAR 971 972By default, following archives are supported. 973 974@example 975@group 976 LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access 977 GNU TAR('tgz, 'tar) ;; read-only 978@end group 979@end example 980 981If your archiver can include multiple files in one archive, you have a 982possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one 983of the candidate. TAR is supported read-only because it cannot delete 984file in the archive (@code{mv})). 985 986@command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an 987archiver of Wanderlust because they cannot include multiple 988files. Archivers that cannot extract files to standard output are also 989not supported. 990 991@subsection OS specific information about archiver 992 993Behaviors of the following archivers are confirmed by further experiences. 994(@samp{*} mark means recommended archiver). 995 996@example 997[OS/2] Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM 998 LHA OS/2 version Rel.2.06b Feb 18, 1998 999 *UnZip 5.32 of 3 November 1997, by Info-ZIP. 1000 *Zip 2.2 (November 3rd 1997). 1001 Zoo archiver, zoo 2.1 $@asis{}Date: 91/07/09 02:10:34 $ 1002 GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version 1003 gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san) 1004 1005[UN|X] FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07 1006 LHa for UNIX V 1.14c 1007 UnZip 5.32 of 3 November 1997 1008 Zip 2.2 (November 3rd 1997) 1009 GNU tar 1.12 (1.11.x is no good) 1010 gzip 1.2.4 (18 Aug 93) 1011 1012[Win32] Win.98/Meadow 1013 Lha32 version 1.28 1014 Zip 2.2 1015 UnZip 5.40 1016 GNU tar 1.11.8 + 1.5(WIN32) 1017 GZIP 1.2.4 1018 RAR 2.06 1019@end example 1020 1021* Caution about LHA 1022 1023If you are an OS/2 user, Peter Fitzsimmons's LH/2 is not supported. 1024Hiramatsu version of LHA is only supported. 1025In Win32, LHa32 is only supported (DOS version is no good). 1026 1027* Caution about GNU tar 1028 1029You have to take care about GNU tar's version because many version has 1030problem on deleting file from archive. 1031 1032Please test @option{--delete} @option{-f} options work. Otherwise, your 1033archive will be destroyed. No problem is reported on above versions of 1034GNU tar. 1035 1036 1037@node Archive Tips, Archive Vars, Archiver, Archive Folder 1038@subsection TIPS 1039@cindex Archive Tips 1040 1041For comfortable migration, usage of @code{wl-summary-archive} 1042(@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat 1043archive folders created by expiration, you must set non-nil value to 1044@code{elmo-archive-treat-file}. 1045 1046If many files are included in one archive, 1047it takes long time to access the archive folder because 1048archiver starting overhead is increased (especially LHA). 1049150-200 messages in one archive is recommended. 1050 1051Of course, following is possible @t{:-)} 1052(meanings of these variables are described later.) 1053 1054@lisp 1055@group 1056(setq wl-fcc "$backup") 1057(setq wl-trash-folder "$trash;lha") 1058@end group 1059@end lisp 1060 1061@node Archive Vars, , Archive Tips, Archive Folder 1062@subsection Variables About Archive Folder 1063@cindex Archive variables 1064 1065@table @code 1066@item elmo-archive-default-type 1067@vindex elmo-archive-default-type 1068The initial setting is @code{zip}. 1069Set archiver type by symbol. 1070 1071@item elmo-archive-@var{type}-method-alist 1072@vindex elmo-archive-TYPE-method-alist 1073Define archiver @var{type}'s methods. 1074(@var{type} is @samp{lha}, @samp{zip}, @samp{zoo}, @samp{tgz} etc) 1075Each element of the alist is following. 1076 1077@example 1078@group 1079(@var{action} . (@var{exec-name} @var{options})) ;; external program and its option. 1080(@var{action} . @var{function}) ;; function 1081@end group 1082@end example 1083 1084Currently available actions are following. 1085 1086@example 1087@group 1088'ls, 'cat ('cat-headers) ;; Minimal setting(read-only) 1089'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above) 1090'cp ('cp-pipe) ;; 1091@end group 1092@end example 1093 1094@noindent 1095In above actions, 1096actions enclosed with braces are optional (They are used for better 1097performance). 1098 1099@item elmo-archive-suffix-alist 1100@vindex elmo-archive-suffix-alist 1101An alist of archiver-type (symbol) and suffix. 1102 1103@item elmo-archive-file-regexp-alist 1104@vindex elmo-archive-file-regexp-alist 1105An alist of a regexp to get file number from list output of archiver 1106and archiver-type (symbol). 1107 1108@item elmo-archive-method-list 1109@vindex elmo-archive-method-list 1110A list of elmo-archive-@var{type}-method-alist 1111(@var{type} is a symbol of archiver-type). 1112 1113@item elmo-archive-lha-dos-compatible 1114@vindex elmo-archive-lha-dos-compatible 1115The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is 1116DOS (Mr. Yoshizaki original) compatible. 1117 1118@item elmo-archive-cmdstr-max-length 1119@vindex elmo-archive-cmdstr-max-length 1120The initial setting is 8000. 1121 1122Max length of command line argument for external archiver program. 1123Emacs does not have a limit of command line byte length, but some OS 1124(e.x OS/2) have. It depends on the OS. Archive folder is affected by 1125this limit because it calls external archiver program directly (not 1126called via shell). For example, you cannot delete messages if archiver 1127program must receive larger bytes of arguments to delete. OS/2 have a 1128command line argument limit of 8190 bytes, so we defined default as 8000 1129with some margin. 1130 1131However, you don't have an influence of command line argument limit 1132if the archiver has `actions' to receive target file information from 1133standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action). 1134@end table 1135 1136 1137@node POP Folder, Shimbun Folder, Archive Folder, Folders 1138@section POP Folder 1139@cindex @samp{&} 1140@cindex POP Folder 1141@cindex RFC 1939 1142@cindex POP3 1143@cindex APOP 1144 1145A folder to access e-mails via POP3 protocol (RFC 1939). 1146 1147Format: 1148 1149@example 1150@group 1151@samp{&} [@var{username}][@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}] 1152@end group 1153@end example 1154 1155You can specify 1156@samp{user} (plain password transmission) or @samp{apop} (APOP authentication) 1157as @var{authenticate-type}. 1158 1159You can specify @samp{uidl} (use UIDL command for message numbering) or 1160@samp{list} (use LIST command for message numbering) as @samp{numbering-method}. 1161 1162default: 1163@example 1164@var{username} -> The value of @code{elmo-pop3-default-user}. 1165 Initial setting is @env{USER} environment variable or 1166 @env{LOGNAME} environment variable or return value of 1167 @code{(user-login-name)}. 1168@var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}. 1169 Initial setting is @samp{user}. 1170@var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}. 1171 If t, use UIDL for numbering. Initial setting is t. 1172@var{hostname} -> The value of @code{elmo-pop3-default-server}. 1173 Initial setting is @samp{localhost}. 1174@var{port} -> The value of @code{elmo-pop3-default-port}. 1175 Initial setting is 110. 1176@end example 1177 1178Example: 1179 1180@example 1181@group 1182&hoge@@localhost -> access localhost as user @samp{hoge}. 1183&hoge@@popserver:109 -> access the server "popserver" on port 109 1184 as user @samp{hoge}. 1185@end group 1186@end example 1187 1188If the last character of the folder name is @samp{!}, Wanderlust 1189connects to the POP server via SSL (Secure Socket Layer). If a folder 1190name ends with @samp{!!}, STARTTLS connection will be established. 1191 1192If the value of @code{elmo-pop3-default-stream-type} is @code{ssl}, 1193SSL will be the default connection, i.e. you can omit @samp{!}. If it 1194is is @code{starttls}, STARTTLS will be the default connection. To use 1195normal connection in these cases, add @samp{!direct} at the end of 1196folder name. 1197 1198 1199@node Shimbun Folder, RSS Folder, POP Folder, Folders 1200@section Shimbun Folder 1201@cindex @samp{@@} 1202@cindex Shimbun Folder 1203@cindex Folder, Shimbun 1204@cindex Folder, Web 1205@pindex w3m 1206@pindex emacs-w3m 1207 1208A folder for watching "shimbun" (means "newspaper" in Japanese), 1209news site and mailing list archives on WWW by using emacs-w3m 1210(@uref{http://emacs-w3m.namazu.org/}). 1211 1212You should possess w3m and emacs-w3m to use this. 1213 1214Format: 1215 1216@example 1217@group 1218@samp{@@} @var{module-name} @samp{.} @var{folder-name} 1219@end group 1220@end example 1221 1222Admissible values of @var{module-name} and @var{folder-name} are 1223described in @file{README.shimbun.ja} distributed with emacs-w3m. 1224 1225Example: 1226 1227@example 1228@group 1229@@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el}) 1230@@asahi/ -> access group of all folders in module @file{sb-asahi.el} 1231@end group 1232@end example 1233 1234@subsection Variables About Shimbun Folder 1235 1236@table @code 1237@item elmo-shimbun-update-overview-folder-list 1238@vindex elmo-shimbun-update-overview-folder-list 1239The initial setting is @code{all}. Specify a set of folders to update 1240overview when messages are fetched. Specify @code{all} to update 1241overview in all shimbun folders. You can specify a list of regular 1242expressions of shimbun folder names to restrict affected folders. 1243 1244Example: 1245 1246@example 1247(setq elmo-shimbun-update-overview-folder-list 1248 '("^@@airs\\." "^@@namazu\\.")) 1249@end example 1250 1251Update summary view automatically after fetching. 1252@end table 1253 1254@node RSS Folder, Search Folder, Shimbun Folder, Folders 1255@section RSS Folder 1256@cindex RSS Folder 1257@cindex Atom Folder 1258 1259An RSS folder presents the messages contained in an RSS or Atom feed: 1260 1261Format: 1262 1263@example 1264@samp{rss:} @var{URL for RSS or Atom} 1265@end example 1266 1267Example: 1268 1269@example 1270rss:https://github.com/wanderlust/wanderlust/commits/master.atom 1271@end example 1272 1273This folder type attempts to automatically handle all known versions of 1274RSS and Atom. Should you need more configurability, please use 1275a Shimbun folder (@pxref{Shimbun Folder}) instead. 1276 1277Since this folder doesn't do any persistent caching, messages will 1278disappear as soon as they expire from the feed. Should you want 1279persistent messages, combine this with a pipe folder (@pxref{Pipe Folder}): 1280 1281@example 1282|rss:http://lwn.net/headlines/newrss|+lwn 1283@end example 1284 1285You may also use an RSS, Atom or OPML feed as an access group, in which 1286case related feeds will appear as subfolders. 1287 1288@node Search Folder, Multi Folder, RSS Folder, Folders 1289@section Search Folder 1290@cindex @samp{[} 1291@cindex Search Folder 1292@cindex Folder, Search 1293@cindex Folder, Text Search 1294 1295A folder to access messages found by an external program with some 1296condition. 1297 1298Format: 1299 1300@example 1301@group 1302@samp{[} @var{search condition} @samp{]} [ @var{search target} [ @samp{!} @var{search engine} ] ] 1303@end group 1304@end example 1305 1306The format of the @var{search condition} and @var{search target} depend 1307on the @var{search engine}. 1308 1309@subsection Supported search engines 1310 1311Supported search engines are following ones. Default search engine can 1312be assigned by @code{elmo-search-default-engine}. 1313 1314@menu 1315* namazu:: namazu 1316* grep:: grep 1317* rgrep:: rgrep 1318* mu:: mu 1319* notmuch:: notmuch 1320@end menu 1321 1322 1323@node namazu, grep, Search Folder, Search Folder 1324@subsection namazu 1325@pindex namazu 1326 1327The messages registered in the namazu-index is found by using namazu 1328(@uref{http://www.namazu.org/}). 1329 1330@var{search condition} is a query of namazu. Please refer to the 1331document of the attached to namazu for details. 1332 1333@var{search target} is a namazu-index used for search. The directory 1334with the index or the alias that explain in the following can be 1335specified. Default value of the path of namazu index can be assigned by 1336@code{elmo-search-namazu-default-index-path}. 1337 1338Example: 1339 1340@example 1341@group 1342[wanderlust] -> search messages matched with 1343 "wanderlust" from the default index 1344[semi flim]~/Mail/semi -> search "semi flim" from the index 1345 in the directory "~/Mail/semi" 1346@end group 1347@end example 1348 1349@c @subsection TIPS 1350 1351@subsubsection Enter space to separate keywords 1352 1353If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you. 1354 1355@subsubsection Alias name for index 1356 1357You can define an alias name for index. 1358 1359Example: 1360 1361@example 1362(setq elmo-search-namazu-index-alias-alist 1363 '(("cache" . "~/.elmo/cache") 1364 ("docs" . "~/documents"))) 1365@end example 1366 1367Above definition defines two index aliases. 1368You can specify 1369 1370@example 1371[wanderlust]cache 1372@end example 1373 1374to execute a namazu search with keyword @samp{wanderlust} using a index in the 1375directory @file{~/.elmo/cache}. 1376 1377@subsubsection Multiple indices 1378 1379You can specify a list for @code{elmo-search-namazu-default-index-path} and 1380@code{elmo-search-namazu-index-alias-alist}. 1381When list is specified, all index contained in the list is used as the 1382namazu indices. 1383 1384Example: 1385 1386@example 1387(setq elmo-search-namazu-index-alias-alist 1388 '(("all" . ("~/.elmo/cache" "~/documents")) 1389 ("cache" . "~/.elmo/cache"))) 1390@end example 1391 1392Using above alias setting, you can specify 1393 1394@example 1395[wanderlust]all 1396@end example 1397 1398to execute a namazu search with keyword @samp{wanderlust} using indices in the 1399directory @file{~/.elmo/cache} and @file{~/documents}. 1400 1401@node grep, rgrep, namazu, Search Folder 1402@subsection grep 1403@pindex grep 1404@pindex find 1405 1406The files that exists in the directory specified with the @var{search 1407target} are found by using grep. 1408 1409@var{search condition} is a regular expression of grep. The directory 1410as @var{search target} cannot be omitted. 1411 1412Example: 1413 1414@example 1415@group 1416[wanderlust]~/Mail/inbox!grep 1417 -> search messages matched with "wanderlust" 1418 from the directory "~/Mail/inbox" 1419 1420["[sr]emi"]~/Mail/semi!grep 1421 -> If @samp{]} is included in regular expression, 1422 @var{search condition} should be enclosed with @samp{"}. 1423@end group 1424@end example 1425 1426Because this method passes all target filenames to grep process as 1427arguments, starting grep process may fail when there are too many files 1428in the target directory. If your find proram accepts @samp{-maxdepth} 1429option, adding the below code in @file{~/.wl} may resolve the problem. 1430 1431@example 1432(eval-after-load "elmo-search" 1433 '(elmo-search-register-engine 1434 'grep 'local-file 1435 :prog "find" 1436 :args '(elmo-search-rgrep-target 1437 "-maxdepth" "1" "-type" "f" "-exec" "grep" "-l" "-e" 1438 pattern "@{@}" "+"))) 1439@end example 1440 1441If your find program can't handle @samp{-exec command @{@} +} option 1442correctly, replacing the last @samp{+} with @samp{;} would do the trick, 1443but it is probably very slow. 1444 1445@node rgrep, mu, grep, Search Folder 1446@subsection rgrep 1447 1448Using grep with @samp{-r} option to search files in subdirectories of 1449the target directory. 1450Grep must accept @samp{-r} option. 1451 1452There is no limitation about the number of files such as grep method (@pxref{grep}). 1453Syntax is similar to grep method. 1454 1455Example: 1456 1457@example 1458@group 1459[wanderlust]~/Mail/inbox!rgrep 1460 -> search messages matched with "wanderlust" 1461 from the directory "~/Mail/inbox" including subdirectories. 1462@end group 1463@end example 1464 1465@node mu, notmuch, rgrep, Search Folder 1466@subsection mu 1467@pindex mu 1468 1469Search mail using mu (@uref{http://www.djcbsoftware.nl/code/mu/}). 1470 1471Examples (from the mu cheatsheet) 1472 1473@example 1474@group 1475[Helsinki] 1476 -> messages about Helsinki (in message body, subject, sender, ...) 1477 1478[to:Jack subject:jellyfish tumbleweed] 1479 -> messages to Jack with subject jellyfish containing the word tumbleweed 1480 1481[size:2k..2m date:20091201..20093112 flag:attach from:bill] 1482 -> messages between 2 kilobytes and a 2Mb, 1483 written in December 2009 with an attachment from Bill 1484 1485[subject:soc* flag:unread] 1486 -> unread messages about things starting with 'soc' 1487 (soccer, society, socrates, ...) 1488 1489[mime:image/*] 1490 -> messages with images as attachment 1491 1492['foo bar'] 1493 -> search for messages with the phrase "foo bar" 1494 1495@end group 1496@end example 1497 1498@node notmuch, , mu, Search Folder 1499@subsection notmuch 1500@pindex notmuch 1501 1502Search mail using notmuch (@uref{http://notmuchmail.org/}). 1503 1504Examples (from the notmuch manual) 1505 1506@example 1507@group 1508[term1] 1509 -> messages that contain 'term1' 1510 1511[-term1] 1512 -> messages that DO NOT contain 'term1' 1513 1514[term1 term2] 1515 -> messages containing term1 and term2 1516 1517['foo bar'] 1518 -> search for messages with the phrase "foo bar" 1519 1520@end group 1521@end example 1522 1523@node Multi Folder, Filter Folder, Search Folder, Folders 1524@section Multi Folder 1525@cindex @samp{*} 1526@cindex Multi Folder 1527@cindex Folder, Multiple 1528@cindex Folder, Marge 1529 1530A folder to access virtual folder which collects messages from 1531multiple folders. 1532 1533Format: 1534 1535@example 1536@group 1537@samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}] 1538@end group 1539@end example 1540 1541After @samp{*} character, specify multiple folders you want to collect 1542separated by @samp{,} like 1543@samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}. 1544 1545Example: 1546 1547@example 1548@group 1549*-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs 1550-> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are 1551 treated as one folder. 1552 1553*+inbox,-fj.rec.tv,%inbox 1554-> +inbox, -fj.rec.tv and %inbox are treated as one folder. 1555@end group 1556@end example 1557 1558 1559@node Filter Folder, Pipe Folder, Multi Folder, Folders 1560@section Filter Folder 1561@cindex @samp{/} 1562@cindex Filter Folder 1563@cindex Folder, Filtering 1564@cindex Folder, Virtual 1565@cindex Folder, Conditional 1566@cindex Flag 1567 1568A folder to access virtual folder which collects all messages that 1569satisfy a condition. 1570 1571Format: 1572 1573@example 1574@samp{/} @var{condition} @samp{/} @var{target-folder} 1575@end example 1576 1577In the @var{condition} part, you can specify following. 1578 1579@enumerate 1580@item 1581Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}} 1582 1583first: @var{number} messages are picked from top of folder. 1584last: @var{number} messages are picked from bottom of folder. 1585 1586Example: 1587 1588@example 1589@group 1590/last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked. 1591/first:20/%inbox -> First 20 messages from %inbox are picked. 1592@end group 1593@end example 1594 1595@item 1596Date filter: @samp{since:@var{date}}, @samp{before:@var{date}} 1597 1598since: only messages arrived since @var{date} are picked (@var{date} is included). 1599before: only messages arrived before @var{date} are picked (@var{date} is not included). 1600 1601You can specify following as @var{date}. 1602 1603@example 1604@group 1605yesterday -> a day before today. 1606lastweek -> same day of last week. 1607lastmonth -> same day of last month. 1608lastyear -> same day of last year. 1609@var{number}daysago -> @var{number} days ago. (e.x. '3daysago') 1610@var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998) 1611@end group 1612@end example 1613 1614Example: 1615 1616@example 1617@group 1618/since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox 1619 are picked. 1620/before:yesterday/+inbox -> messages arrived before yesterday in +inbox 1621 are picked. 1622@end group 1623@end example 1624 1625@item 1626Field filter: @samp{@var{field}:@var{value}} 1627 1628All messages that have @var{field} and its value is @var{value} are picked. 1629@var{field} and @var{value} are case insensitive. 1630 1631Example: 1632 1633@example 1634@group 1635/from:teranisi/+inbox -> In +inbox, messages which have From: field 1636 and its value includes "teranisi" string are picked. 1637/body:foo/%inbox -> In %inbox, messages which have "foo" text 1638 are picked. 1639@end group 1640@end example 1641 1642@item 1643Flag filter: @samp{flag:@var{flag-name}} 1644 1645Pick up messages with flag specified by @var{flag-name}. 1646 1647You can specify following flag names: 1648 1649@example 1650@group 1651unread -> unread 1652important -> important 1653answered -> replied 1654forwarded -> forwarded 1655digest -> unread or important 1656any -> unread or replied or forwarded or global-flag. 1657@end group 1658@end example 1659 1660You can also use flags which you have set as `global-flag'. global-flag 1661is a flag which has arbitrary name. You can put global-flag on messages 1662by invoking @code{wl-summary-set-flags} (Key @key{F}). By default, 1663@samp{important} flag is prepared. You can view messages with 1664global-flag by visiting the subfolder of @samp{'flag} folder. 1665 1666@xref{Internal Folder}. 1667 1668Example: 1669 1670@example 1671@group 1672/flag:digest/%inbox -> a folder consist of unread or important 1673 message in %inbox. 1674/flag:wl/+ML/Wanderlust -> a folder consist of messages with global flag 1675 wl in +ML/Wanderlust. 1676@end group 1677@end example 1678 1679@item 1680Compound condition 1681 1682A condition starting with @samp{!} indicates a negation. 1683If you combine conditions by character @samp{|}, it is considered as OR condition. 1684@samp{&} is considered as AND condition, likewise. 1685Condition can be grouped by parentheses (@samp{(}, and @samp{)}). 1686 1687@samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}. 1688@samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}. 1689 1690Example: 1691 1692@example 1693@group 1694/from:teranisi&!to:teranisi/+inbox 1695 -> In +inbox, messages are picked if the message's 1696 From: field includes "teranisi" and 1697 To: field doesn't include "teranisi". 1698 1699/tocc:"Yuuichi Teranishi"/+inbox 1700 -> In +inbox, messages are picked if the 1701 message's To: field or Cc: field includes 1702 "Yuuichi Teranishi". 1703 1704/(from:yt|from:teranisi)&subject:report/+inbox 1705 -> In +inbox, messages are picked if the message's 1706 From: field includes "yt" or "teranisi", and 1707 Subject includes "report". 1708@end group 1709@end example 1710@end enumerate 1711 1712@noindent 1713Tip for string description: 1714 1715Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&} 1716should be enclosed with @samp{"} in @var{value} string. (@samp{"} 1717should be escaped with @samp{\} in it). You can enclose the string with 1718@samp{"} even it does not contain these characters. 1719 1720@noindent 1721Advanced example: 1722 1723@example 1724*%inbox,/from:teranisi/%inbox@@server 1725 -> Messages in %inbox or 1726 message is in the %inbox@@server folder and it's From field 1727 includes "teranisi" are collected. 1728 1729/last:100//to:teranisi/*+inbox,%inbox 1730 -> Latest 100 messages which is in the +inbox or %inbox folder 1731 and To: field matches "teranisi". 1732 1733/from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost 1734 -> Pick messages which have From: field and it includes "hogehoge" 1735 from latest 20 messages in the %#mh/inbox@@localhost 1736 and To: or Cc: field includes "teranisi". 1737@end example 1738 1739@node Pipe Folder, Internal Folder, Filter Folder, Folders 1740@section Pipe Folder 1741@cindex @samp{|} 1742@cindex Pipe Folder 1743@cindex Get Message 1744@cindex Download Message 1745@cindex Incorporate Message 1746 1747In the pipe folder, messages are automatically transferred from the source 1748folder to destination folder. 1749 1750Format: 1751 1752@example 1753@samp{|} @var{source-folder} @samp{|} @var{destination-folder} 1754@end example 1755 1756When you access the pipe folder, messages are automatically transferred 1757from @var{source-folder} to @var{destination-folder}. 1758It is convenient if you want to download messages to local disk via POP. 1759For example, if you specify following 1760 1761@example 1762|&username@@popserver|+inbox 1763@end example 1764 1765@noindent 1766and access it, Wanderlust downloads messages from 1767@samp{&username@@popserver} to @samp{+inbox} automatically. 1768 1769On the other hand, if you put @samp{|:} instead of second @samp{|}, 1770then messages are copied to the destination folder (not deleted from 1771source-folder). At the next time you access that folder, copies new 1772messages only. 1773 1774@example 1775@samp{|} @var{source-folder} @samp{|:} @var{destination-folder} 1776@end example 1777 1778If you want to copy messages from POP server and view them, specify the 1779folder as follows: 1780 1781@example 1782|&username@@popserver|:+inbox 1783@end example 1784 1785where messages will be kept on the server. 1786 1787Example: 1788 1789@example 1790@group 1791|%inbox|%myinbox -> Download %inbox to %myinbox. 1792|*&user@@popserver1,&user@@popserver2|+inbox 1793 -> Download from &user@@popserver1 and &user@@popserver2 to +inbox. 1794|-gnu.emacs.sources|:+sources 1795 -> Copy messages from -gnu.emacs.sources to +sources. 1796@end group 1797@end example 1798 1799After messages are moved, a hook @code{elmo-pipe-drained-hook} is called. 1800 1801@node Internal Folder, File Folder, Pipe Folder, Folders 1802@section Internal folder 1803@cindex @samp{'} 1804@cindex Internal Folder 1805@cindex Folder, @samp{$} mark 1806@cindex Flag 1807@cindex Cache 1808@c @cindex Folder, Null 1809 1810A folder to access internal messages of Wanderlust. 1811 1812Format: 1813 1814@example 1815@group 1816@samp{'flag} [@samp{/} @var{global-flag}] 1817@samp{'sendlog} 1818@samp{'cache/00} - @samp{'cache/1F} 1819@end group 1820@end example 1821 1822A folder named @samp{'flag} is a special virtual folder which collects 1823messages which have @var{global-flag}. 1824 1825There is @samp{important} flag defined as @var{global-flag} by default. 1826You can review important messages at once after you put important marks 1827on the messages in the different folders. If @var{global-flag} is omitted, 1828it is treated as @samp{important} flag is specified. 1829 1830In addition, in summary mode, to be described later, you can freely 1831define global flags and put them on messages. 1832@xref{Usage of Summary Mode}. 1833 1834In this folder, if you delete message, @var{global-flag} put on the 1835message is removed. If you append messages to this folder, the message 1836will have @var{global-flag}. 1837 1838 1839A folder named @samp{'sendlog} is a virtual folder which collects 1840cached messages which are recoded on @file{~/.elmo/sendlog}. 1841It might be useful when you forgot to add cc for yourself. 1842To use this, you should set @code{wl-draft-use-cache} to non-nil 1843so that sent messages are cached. 1844 1845 1846You can access cached messages fetched via network by accessing 1847folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are 1848the name of the subdirectories of the cache directory 1849(@file{~/.elmo/cache}). 1850 1851 1852@node File Folder, Access Folder, Internal Folder, Folders 1853@section File folder 1854@cindex File Folder 1855 1856File Folder gives the view for local file system. 1857The one File Folder corresponds to the one directory. 1858 1859Format: 1860 1861@example 1862@samp{file:} @var{Path-of-the-directory} 1863@end example 1864 1865Example: 1866 1867@example 1868@group 1869file:~/work -> @file{~/work} 1870file:/etc -> @file{/etc} 1871@end group 1872@end example 1873 1874 1875@node Access Folder,, File Folder, Folders 1876@section Access folder 1877@cindex Access Folder 1878 1879A folder to access virtual folder which collects messages from a root 1880folder and subfolders of one. The add and remove of the subfolder is 1881automatically reflected. 1882 1883 1884Format: 1885 1886@example 1887@samp{access:} @var{root-folder} 1888@end example 1889 1890Example: 1891 1892@example 1893@group 1894access:%INBOX -> All subfolders of IMAP mailbox "inbox". 1895access:'cache -> All of 'cache folder 1896@end group 1897@end example 1898 1899 1900@node Folder, Summary, Folders, Top 1901@chapter Folder mode 1902@cindex Folder 1903 1904After you start Wanderlust, folder mode is appeared firstly. 1905It contains folder list you subscribed. 1906You can select and edit folders in this mode. 1907 1908@menu 1909* Selecting Folder:: Select folder you want to read 1910* Folder Manager:: Editing folders 1911@end menu 1912 1913 1914@node Selecting Folder, Folder Manager, Folder, Folder 1915@section Selecting Folder 1916@cindex Selecting Folder 1917 1918@subsection Usage (TIPS) 1919 1920@subsubsection Check new, unread number 1921 1922Folder mode looks like this. 1923 1924@example 1925@group 1926[-]Desktop:14186/35580/67263 1927 Inbox:3/10/10 1928 Trash:2/7/10 1929 Drafts:0/0/3 1930 Sent:0/9/348 1931 [-]Emacsen:0/34/4837 1932 Wanderlust ML:0/0/558 1933 ELIPS ML:0/0/626 1934 tm:0/0/821 1935 XEmacs Beta:0/29/255 1936 Mew:0/0/998 1937 Mule-Win32:0/0/1491 1938 fj's Emacsen:0/5/88 1939@end group 1940@end example 1941 1942 1943Each line means: 1944 1945@example 1946@var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number} 1947@end example 1948 1949@noindent 1950@kbd{s} key on the folder line updates these numbers. 1951It changes its color if it has many new messages. 1952 1953The whole folder mode is a folder group named @samp{Desktop}. 1954Folder group open/close by return key. 1955An operation on a folder group is treated as operations on the 1956children folders. 1957For example, when you type @kbd{s} on @samp{[-]Emacsen}, 1958seven children folders update their unread number status. 1959 1960@subsubsection Select Folder 1961 1962To enter summary mode of the folder, type return (or space) key on 1963the folder line. 1964If the variable @code{wl-stay-folder-window} has non-nil value, 1965summary window appears on the right of the folder mode window. 1966 1967@subsection Key bindings 1968 1969Folder mode's key binding (related to selecting folders) is following. 1970 1971@table @kbd 1972@item @key{SPC} 1973@itemx @key{RET} 1974@kindex @key{SPC} (Folder) 1975@kindex @key{RET} (Folder) 1976@findex wl-folder-jump-to-current-entity 1977Enter to the summary mode of the folder at the current cursor point. 1978With prefix argument, enter the sticky summary. 1979If the cursor is on the top of folder group line, 1980the folder group is opened or closed. 1981When the cursor is on the access group and this command is called 1982with prefix argument, folder children list is updated to the newest one. 1983(Children list is updated recursively if the access folder has hierarchical 1984structure.) 1985(@code{wl-folder-jump-to-current-entity}) 1986 1987@item M-@key{RET} 1988@kindex M-@key{RET} (Folder) 1989@findex wl-folder-update-recursive-current-entity 1990Folder children list of the access group at the current cursor point 1991is updated to the newest one. 1992(Children list is updated recursively if the access folder has hierarchical 1993structure.) 1994(@code{wl-folder-update-recursive-current-entity}) 1995 1996@item w 1997@kindex w (Folder) 1998@findex wl-draft 1999Create a new draft message. 2000(@code{wl-draft}) 2001 2002@item W 2003@kindex W (Folder) 2004@findex wl-folder-write-current-folder 2005If the current cursor point is on the NNTP folder, create a new draft 2006message which already has @samp{Newsgroups:} field. If the current 2007cursor point is on the folder for mailing list (refile destination), 2008create a new draft message which already has @samp{To:} field with 2009guessed mailing list address (If @code{wl-subscribed-mailing-list} is 2010valid list). 2011(@code{wl-folder-write-current-folder}) 2012 2013@item C-c C-o 2014@kindex C-c C-o (Folder) 2015@findex wl-jump-to-draft-buffer 2016Move to the draft buffer if available. If multiple draft buffer exists, 2017moved to one after another. If prefix argument is specified, load draft 2018folder's message to the draft buffer and jump to it. 2019(@code{wl-jump-to-draft-buffer}) 2020 2021@item s 2022@kindex s (Folder) 2023@findex wl-folder-check-current-entity 2024Update new and unread number information of the folder at the current 2025cursor point. 2026(@code{wl-folder-check-current-entity}) 2027 2028@item S 2029@kindex S (Folder) 2030@findex wl-folder-sync-current-entity 2031Update summary information of the folder at the current cursor point. 2032(@code{wl-folder-sync-current-entity}) 2033 2034@item r s 2035@kindex r s (Folder) 2036@findex wl-folder-check-region 2037Update new and unread number information of the folders in the currently 2038selected region. 2039(@code{wl-folder-check-region}) 2040 2041@item r S 2042@kindex r S (Folder) 2043@findex wl-folder-sync-region 2044Update summary information of the folders in the currently selected region. 2045(@code{wl-folder-sync-region}) 2046 2047@item Z 2048@kindex Z (Folder) 2049@findex wl-status-update 2050Sync up address book status with @file{~/.addresses}'s content. 2051(@code{wl-status-update}) 2052 2053@item P 2054@kindex P (Folder) 2055@findex wl-folder-prev-unread 2056Jump cursor to the folder which have unread messages on the upward from 2057current cursor point. 2058(@code{wl-folder-prev-unread}) 2059 2060@item N 2061@kindex N (Folder) 2062@findex wl-folder-next-unread 2063Jump cursor to the folder which have unread messages on the downward 2064from current cursor point. 2065(@code{wl-folder-next-unread}) 2066 2067@item p 2068@kindex p (Folder) 2069@findex wl-folder-prev-entity 2070Move cursor to the folder on the previous line. 2071(@code{wl-folder-prev-entity}) 2072 2073@item n 2074@kindex n (Folder) 2075@findex wl-folder-next-entity 2076Move cursor to the folder on the next line. 2077(@code{wl-folder-next-entity}) 2078 2079@item J 2080@kindex J (Folder) 2081@findex wl-folder-jump-folder 2082Jump to the folder specified by the user input. 2083(@code{wl-folder-jump-folder}) 2084 2085@item I 2086@kindex I (Folder) 2087@findex wl-folder-prefetch-current-entity 2088Prefetch new messages of the folder at the current cursor point by 2089@code{wl-summary-incorporate}. 2090If the cursor is on the folder group, it is executed recursively. 2091(@code{wl-folder-prefetch-current-entity}) 2092 2093@item c 2094@kindex c (Folder) 2095@findex wl-folder-mark-as-read-all-current-entity 2096Mark all unread messages of the folder at the current cursor point as read. 2097If the cursor is on the folder group, it is executed recursively. 2098(@code{wl-folder-mark-as-read-all-current-entity}) 2099 2100@item f 2101@kindex f (Folder) 2102@findex wl-folder-goto-first-unread-folder 2103Enter summary mode of the first unread folder. 2104(@code{wl-folder-goto-first-unread-folder}) 2105 2106@item E 2107@kindex E (Folder) 2108@findex wl-folder-empty-trash 2109Empty trash. 2110(@code{wl-folder-empty-trash}) 2111 2112@item F 2113@kindex F (Folder) 2114@findex wl-folder-flush-queue 2115Flush queue. 2116(@code{wl-folder-flush-queue}) 2117 2118@item V 2119@kindex V (Folder) 2120@findex wl-folder-virtual 2121Move to the virtual folder (filter folder) with the condition specified. 2122(@code{wl-folder-virtual}) 2123 2124@item ? 2125@kindex ? (Folder) 2126@findex wl-folder-pick 2127Search the folders with the condition specified. 2128(@code{wl-folder-pick}) 2129 2130@item o 2131@kindex o (Folder) 2132@findex wl-folder-open-all-unread-folder 2133All unread folders are opened. 2134(@code{wl-folder-open-all-unread-folder}) 2135 2136@item x 2137@kindex x (Folder) 2138@findex wl-execute-temp-marks 2139Execute marks in summary buffers. @xref{Sticky Summary}. 2140(@code{wl-execute-temp-marks}) 2141 2142@item / 2143@kindex / (Folder) 2144@findex wl-folder-open-close 2145Folder group is opened/closed. 2146(@code{wl-folder-open-close}) 2147 2148@item [ 2149@kindex [ (Folder) 2150@findex wl-folder-open-all 2151All folder groups are opened. 2152(@code{wl-folder-open-all}) 2153 2154@item ] 2155@kindex ] (Folder) 2156@findex wl-folder-close-all 2157All folder groups are closed. 2158(@code{wl-folder-close-all}) 2159 2160@item q 2161@kindex q (Folder) 2162@findex wl-exit 2163Quit Wanderlust. 2164(@code{wl-exit}) 2165 2166@item z 2167@kindex z (Folder) 2168@findex wl-folder-suspend 2169Suspend Wanderlust. 2170(@code{wl-folder-suspend}) 2171 2172@item C-x C-s 2173@kindex C-x C-s (Folder) 2174@findex wl-save 2175Save current folder status. 2176(@code{wl-save}) 2177 2178@item M-t 2179@kindex M-t (Folder) 2180@findex wl-toggle-plugged 2181Toggle Wanderlust's offline/online status. 2182(@code{wl-toggle-plugged}) 2183 2184@item C-t 2185@kindex C-t (Folder) 2186@findex wl-plugged-change 2187Start Wanderlust's plug-status manager. 2188(@code{wl-plugged-change}) 2189@end table 2190 2191@subsection Customize variables 2192 2193@table @code 2194@item wl-folders-file 2195@vindex wl-folders-file 2196The initial setting is @file{~/.folders}. 2197Subscribed folders are described (saved) in this file. 2198 2199@item wl-folder-info-save 2200@vindex wl-folder-info-save 2201The initial setting is @code{t}. If non-nil, unread information is 2202saved and used in the next Wanderlust session. 2203 2204@item wl-stay-folder-window 2205@vindex wl-stay-folder-window 2206The initial setting is @code{nil}. 2207If non-nil, summary window is appeared on the right side of the folder buffer. 2208 2209@item wl-folder-window-width 2210@vindex wl-folder-window-width 2211The initial setting is 20. 2212Folder mode's window width when @code{wl-stay-folder-window} is non-nil. 2213 2214@item wl-folder-use-frame 2215@vindex wl-folder-use-frame 2216The initial setting is @code{nil}. 2217If non-nil, use new frame for the folder window. 2218 2219@item wl-folder-many-unsync-threshold 2220@vindex wl-folder-many-unsync-threshold 2221The initial setting is 70. 2222If the number of unread messages is more than this value, 2223folder color is changed. 2224 2225@item wl-highlight-folder-by-numbers 2226@vindex wl-highlight-folder-by-numbers 2227This option controls how to highlight each line in the folder buffer. 2228The default value is @code{t}, highlighting with various colors based on 2229the message numbers. If it is @code{nil}, highlighting with various 2230colors based on the folder status. In addition, if it is a number 2231(e.g. 1), highlighting will be done based on both the message numbers 2232and the folder status. 2233 2234@item wl-folder-desktop-name 2235@vindex wl-folder-desktop-name 2236The initial setting is @samp{Desktop}. 2237The name of top folder group. 2238 2239@item wl-folder-petname-alist 2240@vindex wl-folder-petname-alist 2241The initial setting is @code{nil}. 2242An alist of folder's realname and its nickname. 2243 2244@item wl-folder-access-subscribe-alist 2245@vindex wl-folder-access-subscribe-alist 2246The initial setting is @code{nil}. 2247 2248Control automatic subscribing and unsubscribing of the children list 2249of access groups. 2250 2251Each element is: 2252 2253@example 2254(@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{})) 2255@end example 2256 2257@noindent 2258If @var{subscribe-flag} is non-nil, folders which have name matched to 2259@var{regexp-of-folders} are displayed. Otherwise, hidden. However, 2260already unsubscribed folder is not displayed even when the 2261@var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be 2262specified. 2263 2264Example: 2265 2266@lisp 2267@group 2268'(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)" 2269 "^-fj\\.\\(net\\|news\\|os\\|rec\\)")) 2270 ("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)")) 2271 ("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp"))) 2272@end group 2273@end lisp 2274 2275@item wl-folder-hierarchy-access-folders 2276@vindex wl-folder-hierarchy-access-folders 2277A list of regular expressions for access groups which creates children 2278folder list hierarchically. 2279 2280For example, if you specify 2281@code{wl-folder-hierarchy-access-folders} like following, 2282 2283@lisp 2284@group 2285(setq wl-folder-hierarchy-access-folders 2286 '("^-[^\\.]*$" "^-comp.unix$" "^-comp.unix.bsd$")) 2287@end group 2288@end lisp 2289 2290@noindent 2291you obtain the access group hierarchy as follows. 2292 2293@example 2294@group 2295 [-]-:912/912/3011 2296 [-]-fj:674/674/1314 2297 -fj.comp.announce:0/0/2 2298 -fj.comp.dev.cdrom:0/0/0 2299 @dots{} 2300 [+]-japan:238/238/1688 2301 [-]-comp:0/0/4 2302 [-]-comp.unix:0/0/0 2303 -comp.unix.admin:0/0/0 2304 -comp.unix.dos-under-unix:0/0/0 2305 -comp.unix.programmer:0/0/0 2306 [-]-comp.unix.bsd:0/0/23 2307 -comp.unix.bsd.freebsd.announce:0/0/0 2308 @dots{} 2309@end group 2310@end example 2311 2312If you opened @samp{-} in this example, only the direct children is created 2313(@samp{-fj}, @samp{-japan}, @samp{-tnn}, @dots{}). 2314second hierarchy (@samp{-fj.comp.announce}, @dots{}, @samp{-comp.unix}, @dots{}) 2315is not created until the children access group is opened. 2316@end table 2317 2318 2319@node Folder Manager, , Selecting Folder, Folder 2320@section Editing Folders 2321@cindex Folder Manager 2322@cindex Folder, Edit 2323@cindex Folder, Subscribe 2324@cindex Folder, Unsubscribe 2325 2326As described before, subscribed folder list is saved in @file{~/.folders} file. 2327But you don't have to edit @file{~/.folders} directly. 2328You can append, delete, edit folders from folder mode. 2329 2330@subsection Usage (Tips) 2331 2332@subsubsection Append Folder 2333 2334@kbd{m a} appends new folder to your folder list. If you enter non-existent 2335folder, it will ask you to create a new one. 2336@kbd{m g} appends new folder group. 2337To append new folder to this group, firstly open it, 2338then execute append command in the next line. 2339 2340@subsubsection Edit Folder 2341 2342You can cut folder by @kbd{C-k}, paste by @kbd{C-y}. 2343Thus, you can change folder position as if you were editing a normal file. 2344 2345@subsubsection Create Multi Folder 2346 2347@enumerate 2348@item 2349Type @kbd{m q} to clear @code{wl-fldmgr-cut-entity-list}. 2350@item 2351Cut folder by @kbd{C-k} or copy folder by @kbd{M-c}. 2352@item 2353Type @kbd{m m}, then you can create multi folder. 2354@end enumerate 2355 2356@subsubsection Delete Nickname, Filter 2357 2358You can delete nickname or filter by putting ``''(@var{NULL}) from the 2359minibuffer while appending. 2360 2361@subsubsection Append Folder to Empty Group 2362 2363To append new folder to the empty folder group 2364(after you create folder group by typing @kbd{m g}), 2365firstly open it, then execute append command in the next line. 2366If it is closed, folder is appended on the same level with 2367the folder group above. It is difficult to explain by words so try it. 2368In other words, appended position depends on the 2369open/close status of the upper one. 2370 2371@subsubsection Charset of the Folders File 2372 2373@code{wl-mime-charset} is used for saving @code{wl-folders-file}. 2374 2375@subsubsection Create Filter 2376 2377@kbd{m f} adds filter to the folder at the current cursor point. To 2378create new filter folder and leave the current folder unchanged, copy it 2379@kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple 2380filter can be specified while appending filter. If you put 2381``''(@var{NULL}), filter is deleted. 2382 2383@subsubsection Sort Folders 2384 2385Sorting of the folders is executed by the function specified by 2386@code{wl-fldmgr-sort-function}. 2387The initial setting is @code{wl-fldmgr-sort-standard}, 2388which sorts alphabetically. 2389Sorting affects only on the current folder group. It does not 2390affect on the child groups. 2391 2392@subsubsection Hiding Folders in the Access Group 2393 2394Usually, access group displays all children folders, but you can set 2395some folders hidden. Following operations are only available on access 2396group. 2397 2398Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility 2399(subscribe/unsubscribe) of the folder at current cursor point. Against 2400this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the 2401specified region. 2402 2403Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while 2404@code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix 2405argument and if the argument has positive number, the unsubscribe it. 2406If the prefix argument has negative value, folder becomes visible and if 2407zero, folder visibility is toggled. 2408 2409The other commands, @code{wl-fldmgr-subscribe} and 2410@code{wl-fldmgr-subscribe-region} are also prepared (not binded to the 2411key). 2412 2413Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is 2414executed in the access group, they have a same effect with 2415@code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}. 2416The difference is that cut commands deletes folders from the current 2417buffer. 2418 2419@subsubsection Operations in the Access Group 2420 2421You can insert and delete folders in the access group like usual folder 2422group. But insert and delete commands can be only available for the 2423children folders of the access group and they only sets the subscribe 2424status. In other words, insertion of the folder means subscribing, 2425deletion means unsubscribing. 2426@footnote{In the current implementation, 2427it is faster to delete region than to unsubscribe region.} 2428 2429To update the access group when children folders are inserted or deleted 2430by other way (other than Wanderlust), 2431open the access group by typing @kbd{C-u @key{RET}}. 2432@xref{Selecting Folder}. 2433 2434The order of children folders of access group is saved after 2435insertion/deletion/sorting. 2436If you set @code{wl-force-fetch-folders} to non-nil or open access group 2437by typing @kbd{C-u @key{RET}}, disappeared folders are deleted and 2438newly created folders are inserted on the top of the access group. 2439 2440@subsection Key bindings 2441@cindex Keybind, Folder Mode 2442@cindex Keybind, Folder Buffer 2443 2444Key bindings on the folder mode related to folder editing are shown below. 2445All bindings starts with @kbd{m}, and primary commands are binded to 2446one stroke key binding. 2447 2448@table @kbd 2449@item m a 2450@kindex m a (Folder) 2451@findex wl-fldmgr-add 2452Add specified folder to your folder list . If you enter non-existent 2453folder, create it after confirmation. 2454(@code{wl-fldmgr-add}) 2455 2456@item + 2457@itemx m g 2458@kindex + (Folder) 2459@kindex m g (Folder) 2460@findex wl-fldmgr-make-group 2461Create a folder group. 2462(@code{wl-fldmgr-make-group}) 2463 2464@item m A 2465@kindex m A (Folder) 2466@findex wl-fldmgr-make-access-group 2467Create an access group. 2468(@code{wl-fldmgr-make-access-group}) 2469 2470@item m d 2471@kindex m d (Folder) 2472@findex wl-fldmgr-delete 2473Delete folder itself and msgdb. 2474If the folder itself cannot be deleted like NNTP folder, 2475only msgdb is deleted. 2476(@code{wl-fldmgr-delete}) 2477 2478@item R 2479@itemx m R 2480@kindex R (Folder) 2481@kindex m R (Folder) 2482@findex wl-fldmgr-rename 2483Change the name of folder or folder group. 2484msgdb's path is also changed. 2485(@code{wl-fldmgr-rename}) 2486 2487@item * 2488@itemx m m 2489@kindex * (Folder) 2490@kindex m m(Folder) 2491@findex wl-fldmgr-make-multi 2492Create a multi folders in the cutlist (cut, copied folders). 2493(@code{wl-fldmgr-make-multi}) 2494 2495@item | 2496@itemx m f 2497@kindex | (Folder) 2498@kindex m f (Folder) 2499@findex wl-fldmgr-make-filter 2500Create a filter folder. (Put a filter on the folder). 2501(@code{wl-fldmgr-make-filter}) 2502 2503@item M-c 2504@itemx m c 2505@kindex M-c (Folder) 2506@kindex m c (Folder) 2507@findex wl-fldmgr-copy 2508Copy folder (it is not available on folder group). 2509(@code{wl-fldmgr-copy}) 2510 2511@item M-w 2512@itemx m W 2513@kindex M-w (Folder) 2514@kindex m W (Folder) 2515@findex wl-fldmgr-copy-region 2516Copy folders in the specified region. 2517(@code{wl-fldmgr-copy-region}) 2518 2519@item C-k 2520@itemx m k 2521@kindex C-k (Folder) 2522@kindex m k (Folder) 2523@findex wl-fldmgr-cut 2524Cut folder. Folder itself is not deleted. 2525(@code{wl-fldmgr-cut}) 2526 2527@item C-w 2528@itemx m C-w 2529@kindex C-w (Folder) 2530@kindex m C-w (Folder) 2531@findex wl-fldmgr-cut-region 2532Cut folders in the specified region. 2533(@code{wl-fldmgr-cut-region}) 2534 2535@item C-y 2536@itemx m y 2537@kindex C-y (Folder) 2538@kindex m y (Folder) 2539@findex wl-fldmgr-yank 2540Paste folders that are copied or cut (folders in the cut-list). 2541(@code{wl-fldmgr-yank}) 2542 2543@item m p 2544@kindex m p (Folder) 2545@findex wl-fldmgr-set-petname 2546Put nickname on the folder. 2547(@code{wl-fldmgr-set-petname}) 2548 2549@item m q 2550@kindex m q (Folder) 2551@findex wl-fldmgr-clear-cut-entity-list 2552Clear the cut-list. (cut, copied folder information is cleared, 2553you cannot paste after this) 2554(@code{wl-fldmgr-clear-cut-entity-list}) 2555 2556@item m s 2557@kindex m s (Folder) 2558@findex wl-fldmgr-sort 2559Sort folders in the current folder group. 2560(@code{wl-fldmgr-sort}) 2561 2562@item m C-s 2563@kindex m C-s (Folder) 2564@findex wl-fldmgr-save 2565Save current folder view to the @file{wl-folders-file}. 2566(@code{wl-fldmgr-save}) 2567@end table 2568 2569[Following commands are only available on the access groups] 2570 2571@table @kbd 2572@item u 2573@itemx m u 2574@kindex u (Folder) 2575@kindex m u (Folder) 2576@findex wl-fldmgr-unsubscribe 2577Set the visibility of folder (subscribe/unsubscribe). 2578(@code{wl-fldmgr-unsubscribe}) 2579 2580@item U 2581@itemx r u 2582@kindex U (Folder) 2583@kindex r u (Folder) 2584@findex wl-fldmgr-unsubscribe-region 2585Set the visibility of the folders (subscribe/unsubscribe) in the 2586specified region. 2587(@code{wl-fldmgr-unsubscribe-region}) 2588 2589@item l 2590@itemx m l 2591@kindex l (Folder) 2592@kindex m l (Folder) 2593@findex wl-fldmgr-access-display-normal 2594List folders that are currently available. 2595(@code{wl-fldmgr-access-display-normal}) 2596 2597@item L 2598@itemx m L 2599@kindex L (Folder) 2600@kindex m L (Folder) 2601@findex wl-fldmgr-access-display-all 2602List all folders regardless of the subscription status. 2603(@code{wl-fldmgr-access-display-all}) 2604@end table 2605 2606 2607@subsection Customize variables 2608 2609@table @code 2610@item wl-interactive-save-folders 2611@vindex wl-interactive-save-folders 2612The initial setting is @code{t}. If non-nil and folder view is 2613modified, confirm saving it before Wanderlust or Emacs exits. If 2614@code{nil}, save without confirmation. 2615 2616@item wl-fldmgr-make-backup 2617@vindex wl-fldmgr-make-backup 2618The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is 2619created before saving the folder status. 2620 2621@item wl-fldmgr-sort-function 2622@vindex wl-fldmgr-sort-function 2623The initial setting is @code{wl-fldmgr-sort-standard}. A function to 2624sort folders. By default function, folders are sorted alphabetically 2625and folder group is put on top (when @code{wl-fldmgr-sort-group-first} 2626is non-nil). 2627 2628@item wl-fldmgr-sort-group-first 2629@vindex wl-fldmgr-sort-group-first 2630The initial setting is @code{t}. If non-nil, 2631@code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it 2632does not care whether it is folder group or not. 2633 2634@item wl-folder-check-async 2635@vindex wl-folder-check-async 2636The initial setting is @code{t}. If non-nil, check folder's unread 2637status asynchronously. It boosts newsgroup checking. 2638 2639@item wl-folder-check-fast 2640@vindex wl-folder-check-fast 2641The initial setting is @code{nil}. 2642If non-nil, it does not update folder status while checking. 2643@c it is obsolete? 2644@item wl-folder-notify-deleted 2645@vindex wl-folder-notify-deleted 2646The initial setting is @code{nil}. 2647@c nil means? 2648If non-nil, negative value is displayed when the message is deleted. If 2649@code{sync}, folder is synchronized when the message is deleted. If 2650@code{nil}, message deletion is ignored. 2651 2652@item wl-fldmgr-add-complete-with-current-folder-list 2653@vindex wl-fldmgr-add-complete-with-current-folder-list 2654The initial setting is @code{nil}. 2655Non-nil means call @code{elmo-folder-list-subfolders} and get completion 2656candidate for @code{wl-fldmgr-add}. 2657@end table 2658 2659@subsection Miscellanea 2660 2661Following is a note for folder editing. 2662 2663@enumerate 2664@item 2665cut or copy stacks the folder in the @code{wl-fldmgr-cut-entity-list}. 2666paste(yank) command pastes the folders on one cut or copy command 2667(If copy command is executed by region, folders in the region are pasted 2668by one paste command) 2669 2670@item 2671You cannot cut @samp{Desktop} group. 2672Also, you cannot paste folders at the outside of the @samp{Desktop}. 2673 2674@item 2675You cannot copy folder group. 2676 2677@item 2678Operations on the access group are only available for the folders 2679in the same access group. 2680 2681@item 2682You cannot create a folder which has same name with the folders already exist. 2683 2684@item 2685You cannot insert folders which have same name in one group. 2686You can insert them in the different groups. 2687You cannot put same nickname to the different folders. 2688@end enumerate 2689 2690 2691@node Summary, Message, Folder, Top 2692@chapter Summary Mode 2693 2694After you select the folder via folder mode, you enter to the summary 2695mode. 2696 2697@menu 2698* Usage of Summary Mode:: TIPS 2699* Thread Operations:: Thread operations 2700* Cache:: File cache, Buffer cache, and Prefetch 2701* Auto Refile:: Auto refile settings 2702* Sticky Summary:: Summary make sticky 2703* Summary View:: Format of summary lines 2704* Mark and Action:: Temporary marks and their effect 2705* Key Bindings of Summary:: Key bindings 2706* Variables of Summary:: Customize Summary Mode 2707@end menu 2708 2709 2710@node Usage of Summary Mode, Thread Operations, Summary, Summary 2711@section Usage (Tips) 2712 2713@subsection Summary Content 2714 2715In the summary mode, messages are displayed like following. 2716 2717@example 2718@group 2719 377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug? 2720 381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface 2721 384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2 2722 389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3 2723@end group 2724@end example 2725 2726Each line displays: 2727 2728@example 2729@var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject} 2730@end example 2731 2732@noindent 2733If you want to know how to change the format for this, please refer 2734the section format of Summary lines. 2735@xref{Summary View}. 2736 2737@var{Message number} is the message's unique number in the folder. In 2738the NNTP folder, it is article number, in the IMAP folder, it is UID and 2739in the MH folder, it is the filename of the message. 2740 2741@var{Temporal mark} and @var{Persistent mark} are described later. 2742 2743@var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week 2744Day})@var{Hour}:@var{Minute}}. Default setting displays week day in 2745Japanese, but if you want to display it in English, set the value of 2746@code{wl-summary-weekday-name-lang} as @samp{en}. 2747 2748@var{Sender}'s indentation corresponds to the depth of the thread. 2749Sender name is displayed as nickname if it is defined in the address 2750book. Set @code{wl-use-petname} as @code{nil}, if you want to quit 2751displaying with nickname. 2752 2753If number is printed at the head of @var{Sender} part like @samp{+2}, 2754that means the message have 2 follow messages. 2755 2756@var{Subject} is the @samp{Subject:} header field of the message. If 2757the message have same @samp{Subject:} with the parent message, it is not 2758displayed. Some mailing list puts its sequence number in the 2759@samp{Subject:} field, but it is 2760ignored. @code{wl-summary-no-subject-message} is displayed when the 2761message has empty subject field. 2762 2763@subsection Temporary Marks 2764@cindex Mark, Temporary 2765 2766There are seven temporary marks, 2767@samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}. 2768Temporary marks indicates message operations. 2769 2770@table @samp 2771@item * 2772Target mark. 2773You can execute a command on the all messages that have @samp{*} mark, 2774with the key bindings which begins with @kbd{m}. 2775 2776@item d 2777The mark to dispose. You can put @samp{d} by typing @kbd{d} key. 2778 2779@item D 2780The mark to force delete. You can put @samp{D} by typing @kbd{D} key. 2781 2782@item o 2783The mark to refile. 2784After you type @kbd{o} key, prompt appears to input refile destination. 2785Your answer is printed in the summary line. 2786 2787@item O 2788The mark to refile. 2789You can put this mark by typing @kbd{O} key. 2790The difference between this mark and refile mark is, 2791this mark does not delete the message while latter does. 2792 2793@item i 2794The mark to prefetch reserved. 2795You can put this mark by typing @kbd{i} key. 2796 2797@item ~ 2798The mark to resend reserved. 2799After you type @kbd{~} key, prompt appears to input address to resend. 2800Your answer is printed in the summary line. 2801@end table 2802 2803@kbd{x} key executes action for temporary marks, respectively. 2804 2805@subsection Persistent Marks 2806 2807There are ten persistent marks, @samp{!}, @samp{N}, @samp{n}, @samp{U}, 2808@samp{u}, @samp{A}, @samp{a}, @samp{F}, @samp{f} and @samp{$}. 2809 2810The persistent mark indicates the message's status and it is saved. 2811Each persistent mark indicates: 2812 2813@table @samp 2814@item N 2815It is new message. 2816@item n 2817It is new message. It differs from @samp{N} that message with @samp{n} 2818is already cached. 2819@item U 2820It is unread message. 2821@item u 2822It is unread message. It differs from @samp{U} that message with @samp{u} 2823is already cached. 2824@item ! 2825It is message already read. It differs from message without mark that 2826message with @samp{!} is not cached yet. 2827@item A 2828It is already replied message. 2829@item a 2830It is already replied message. It differs from @samp{A} that message 2831with @samp{a} is already cached. 2832@item F 2833It is already forwarded message. 2834@item f 2835It is already forwarded message. It differs from @samp{F} that message 2836with @samp{f} is already cached. 2837@item $ 2838It is a message with some global flag. It is convenient to put this 2839mark on the messages to remember (If you want to remember to write a 2840reply for the message, for example) because this mark remains after 2841you exited Emacs. Messages with the @samp{$} mark can be reviewed in 2842the @samp{'flag} folder even the message itself is deleted in the actual 2843folder. You can put global flag by typing @kbd{$} or @kbd{F} key. 2844 2845@item None 2846If the message is read and cached (or local message),there are no 2847persistent mark. 2848@end table 2849 2850@samp{N}, @samp{U}, @samp{!}, @samp{A}, @samp{F} indicates that the 2851message have no cache. Messages with the marks other than these, you 2852can read them in the offline status even they are in the IMAP folder or 2853netnews folder. 2854 2855Among messages with persistent marks, ones with marks specified by 2856@code{wl-summary-expire-reserve-marks} are excluded from the expiration 2857(as a function of wanderlust) explained later. @xref{Expire and Archive}. 2858 2859@subsection How To Read 2860 2861Basically, you can read messages only typing space key again and again. 2862 2863To update summary status to the newest status (synchronize), 2864type @kbd{s} key. 2865 2866You can jump to next unread message by typing @kbd{N} key, and @kbd{n} key 2867moves cursor to the next message. 2868Enter message buffer by typing @kbd{j} key. 2869To operate multipart, you have to enter to the message buffer. 2870@xref{Message}. 2871 2872@subsection Pack the Message Numbers 2873You can pack the message numbers in Summary by 2874@kbd{M-x wl-summary-pack-number}. Note that only MH Folder, 2875News Spool Folder and Maildir Folder are supported folder types. 2876 2877 2878@node Thread Operations, Cache, Usage of Summary Mode, Summary 2879@section Thread Operations 2880 2881For example, the following line indicates one thread (a context of a topic). 2882 2883@example 2884 384 09/17(Thu)01:32 [+1: Teranishi ] wl-0.6.2 2885@end example 2886 2887@noindent 2888If you type @kbd{/} on this line, the thread is opened and it changes 2889the appearance like following. 2890 2891@example 2892@group 2893 384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2 2894 388 09/17(Thu)22:34 +-[ Murata san ] 2895@end group 2896@end example 2897 2898(Message 388 is the replied message to the message 384.) 2899If you type @kbd{/} key once again, the thread is closed. 2900With prefix argument, @kbd{/} opens all children threads. 2901 2902If you type @kbd{[}, opens all threads in summary. @kbd{]} closes all 2903threads. 2904 2905Commands with the key binding that begins with @kbd{t} executes commands 2906on the messages in the thread. 2907@xref{Key Bindings of Summary}. 2908 2909@subsection reconstruct thread by hand 2910 2911You can reconstruct the thread manually. In Summary, @kbd{M-w} 2912(@code{wl-summary-save-current-message}) at the corresponding message, 2913and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent 2914message then you have the reconstructed thread. 2915 2916 2917@node Cache, Auto Refile, Thread Operations, Summary 2918@section Cache 2919 2920@subsection Cache File 2921 2922The messages which have to access via network (e.x. IMAP, NNTP folder) 2923are cached as a local file so as to save network traffic or to enable 2924off-line operation. The cache file is saved under the directory 2925@file{~/.elmo/cache}. To expire cache, type @kbd{M-x 2926elmo-cache-expire-by-size}. The command deletes cache files to the 2927specified size by the order of last accessed time. 2928 2929@subsection Cache Filename 2930 2931@vindex elmo-msgid-to-cache-max-length 2932@vindex elmo-msgid-to-cache-algorithm 2933A filename of cache file is generated from Message-ID with minimal 2934modification. But if Message-ID is very long, cache file can't be 2935created. To avoid it, filename's length is kept constant by hash 2936function when filename is longer than 2937@code{elmo-msgid-to-cache-max-length}'s value. When the value of this 2938variable is @code{nil}, this feature is disabled. An algorithm of hash 2939is indicated by @code{elmo-msgid-to-cache-algorithm}. 2940 2941Changing the value of these variables, existing cache files may be 2942unused. 2943 2944@subsection Buffer Cache and Prefetching 2945 2946The messages that are read are kept in the cache buffer so as to make 2947the behavior fast when you are to read the message again. It is called 2948`buffer cache'. The number of cache buffer is specified by 2949@code{wl-message-buffer-cache-size}. 2950 2951There are message prefetching mechanism in the Wanderlust that 2952prefetches next message while you are reading. 2953 2954You can control the message prefetching mechanism by these two 2955variables. 2956 2957@table @code 2958@item wl-message-buffer-prefetch-folder-type-list 2959@vindex wl-message-buffer-prefetch-folder-type-list 2960The initial setting is @code{'(imap4 nntp)}. If it is a list of folder 2961types, it specifies the folder types in which message prefetching is 2962enabled. In initial setting, messages are prefetch only in the nntp and 2963imap4 folders. In this case, multi folder that contains localdir and 2964imap4 prefetches only imap4 messages. This variable precedes the value of 2965@code{wl-message-buffer-prefetch-folder-list}. 2966To prefetch messages in all folder types, specify @code{t}. 2967 2968@item wl-message-buffer-prefetch-folder-list 2969@vindex wl-message-buffer-prefetch-folder-list 2970The initial setting is @code{nil}. 2971A list of regexp of folders to enable message prefetching. 2972 2973@item wl-message-buffer-prefetch-depth 2974@vindex wl-message-buffer-prefetch-depth 2975The initial setting is 1. The number of messages for automatical prefetch. 2976 2977@item wl-message-buffer-prefetch-idle-time 2978@vindex wl-message-buffer-prefetch-idle-time 2979The initial setting is 1 (in seconds). The period of automatical prefetch. 2980 2981@item wl-message-buffer-prefetch-threshold 2982@vindex wl-message-buffer-prefetch-threshold 2983The initial setting is 30000 (bytes). If prefetching message has larger 2984size than this value, Wanderlust does not prefetch automatically. 2985If @code{wl-message-buffer-prefetch-threshold} is @code{nil}, 2986the message is not checked for the size. 2987 2988@item wl-auto-prefetch-first 2989@vindex wl-auto-prefetch-first 2990The initial setting is @code{nil}. 2991If non-nil, first message is automatically prefetched to the buffer 2992when you enter the folder. 2993@end table 2994 2995 2996@node Auto Refile, Sticky Summary, Cache, Summary 2997@section Auto Refile 2998@vindex elmo-msgdb-extra-fields 2999@vindex wl-refile-rule-alist 3000@findex wl-summary-auto-refile 3001 3002You can refile messages automatically, by typing @kbd{C-o} 3003(@code{wl-summary-auto-refile}). It decides destination of refile by 3004the content of the message header information (information in the msgdb). 3005 3006By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is 3007available. If you want to decide destination by other header fields, 3008set the variable @code{elmo-msgdb-extra-fields} like following. 3009 3010@lisp 3011@group 3012(setq elmo-msgdb-extra-fields 3013 '("x-ml-name" 3014 "reply-to" 3015 "sender" 3016 "mailing-list" 3017 "newsgroups")) 3018@end group 3019@end lisp 3020 3021@noindent 3022By this setting, Wanderlust saves extra fields in the msgdb. You have 3023to type @kbd{s all} to get extra fields for the messages that are 3024already in the summary. 3025 3026Then, specify the refile rule. The refile target folder of auto 3027refiling is decided by the value of @code{wl-refile-rule-alist}. 3028@code{wl-refile-rule-alist} is a list of a rule: 3029 3030@example 3031@group 3032(@var{field} (@var{regexp} . @var{target}) 3033 (@var{regexp} . @var{target}) 3034 @dots{}) 3035@end group 3036@end example 3037 3038Each rule means `if @var{field} value matches @var{regexp}, 3039then refile to @var{target} folder'. 3040The rule matched first is applied. 3041 3042@var{field} is a string of field name. You can specify a list of field name 3043string, too. In this case, if one of these fields is matched, then the 3044rule is fired (i.e. OR condition). 3045 3046@var{regexp} is a regular expression for field value. @var{target} is a target 3047folder string. You can specify a rule at @var{target} part, too. In this 3048case, If the field value of the rule and the current rule is matched, 3049then the current rule is fired (i.e. AND condition). 3050 3051You can refer matched substring of @var{regexp} to specify @var{target} part. 3052To refer substring, use following keys: 3053 3054@table @samp 3055@item \& 3056means substitute original matched text. 3057 3058@item \@var{N} 3059means substitute what matched the @var{N}th `\(@dots{}\)'. 3060(@var{N} is a number.) 3061@end table 3062 3063Following is an example of @code{wl-refile-rule-alist}. 3064 3065@lisp 3066@group 3067(setq wl-refile-rule-alist 3068 '(("x-ml-name" 3069 ("^Wanderlust" . "+wl") 3070 ("^Elisp" . "+elisp")) 3071 (("To" "Cc") 3072 ("\\([a-z]+\\)@@gohome\\.org" . "+\\1")) 3073 ("From" 3074 ("me@@gohome\\.org" . ("To" ("you@@gohome\\.org" . 3075 "+from-me-to-you")))))) 3076@end group 3077@end lisp 3078 3079After these settings, refile marks are automatically put on the condition 3080matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}). 3081 3082Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped 3083auto refiling. 3084By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages 3085with these persistent marks are not automatically refiled. 3086It means Wanderlust does not execute auto refile on unread messages by 3087the default setting. 3088To execute auto refile on all messages, set following. 3089 3090@lisp 3091(setq wl-summary-auto-refile-skip-marks nil) 3092@end lisp 3093 3094 3095@node Sticky Summary, Summary View, Auto Refile, Summary 3096@section Sticky Summary 3097@cindex Summary, Sticky 3098@cindex Sticky Summary 3099 3100The buffer of the `sticky summary' does not killed by typing @kbd{q}. 3101 3102By entering the summary by typing @kbd{Shift RET} in Folder mode or 3103@kbd{G} in some summary sticky summary buffer is created. 3104Also typing @kbd{M-S} (@code{wl-summary-stick}) on the normal summary 3105makes current one sticky. 3106 3107The buffer name of the sticky summary becomes like 3108@samp{Summary:@var{folder-name}}. 3109You can visit the sticky summary at any time by @kbd{C-x b} 3110(@code{switch-to-buffer}), or you can go round summary buffers by 3111@kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p} 3112(@code{wl-summary-next-buffer}) in summary mode. 3113 3114In sticky summary, the summary buffer is preserved after @kbd{g} or 3115@kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to 3116another summary by @kbd{C-u g}. Other operations in the sticky summary 3117are same as normal summary. 3118 3119@code{wl-summary-always-sticky-folder-list} specifies the folders that 3120are automatically stuck. 3121 3122 3123@node Summary View, Mark and Action, Sticky Summary, Summary 3124@section Format of summary lines 3125@cindex Format of summary lines 3126@vindex wl-summary-line-format 3127@vindex wl-summary-line-format-spec-alist 3128@vindex wl-folder-summary-line-format-alist 3129@vindex wl-summary-default-number-column 3130@vindex wl-summary-number-column-alist 3131 3132You can alter the format of lines in Summary mode. 3133 3134Summary line format is specified by @code{wl-summary-line-format}. 3135You can use control strings defined by 3136@code{wl-summary-line-format-spec-alist}. 3137 3138An example follows. 3139 3140@lisp 3141@group 3142;; @r{number temporary-mark persistent-mark date branch} 3143;; @r{[ (number-of-children) sender ] subject} 3144(setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s") 3145@end group 3146@end lisp 3147 3148Where the number set the column number of the field. If negative value, 3149the column is filled from right. If the number begins with @samp{0}, 3150@samp{0} is used for filling columns instead of @samp{ }. 3151 3152Example: 3153 3154@example 3155@group 3156%5l -> `1 ' 3157%-05l -> `00001' 3158@end group 3159@end example 3160 3161 3162Major control strings defined by @code{wl-summary-line-format-spec-alist} 3163are displayed in the following list. 3164 3165@example 3166@group 3167%n message number 3168%T temporary mark 3169%P persistent mark 3170%Y year 3171%M month 3172%D day 3173%W day of week 3174%h hour 3175%m minute 3176%t branch of the thread 3177%[ [ (< for re-connected child) 3178%] ] (> for re-connected child) 3179%f sender 3180%s subject 3181%S size 3182%c +number-of-children: (display only for opened thread) 3183%C [+number-of-children] (display only for opened thread) 3184%# mailing list information (`(' ML-name [ ` ' ML-number ] `)') 3185%l number in the mailing list 3186%@@ `@@' only if the first MIME part is multipart/mixed 3187%~ ` ' only if previous column is not empty 3188@end group 3189@end example 3190 3191If you want to change the width of message number (@samp{%n}), modify 3192@code{wl-summary-default-number-column} or 3193@code{wl-summary-number-column-alist}. 3194 3195The temporary mark (@samp{%T}) and persistent mark (@samp{%P}) must 3196appear at the constant column. For example, if you specify @samp{%T} or 3197@samp{%P} after the @samp{%t}, which changes its length by thread 3198position, marks are not treated correctly. 3199 3200If the format string is enclosed by @samp{%number(} and @samp{%)}, the 3201column of the enclosed region is justified to the `number'. Multiple 3202level @samp{%number(} parenthesis can be defined. It is useful to 3203justify the column of the multiple control strings. For example, in the 3204above @code{wl-summary-line-format}, 3205 3206@example 3207%17(%c %f%) 3208@end example 3209 3210means ``Adjust number-of-children and sender string to the 17 column''. 3211 3212You can specify the format by each folders with 3213@code{wl-folder-summary-line-format-alist}. Please set regular 3214expression for folder names and summary line format as the following 3215example. 3216 3217@lisp 3218@group 3219(setq wl-folder-summary-line-format-alist 3220 '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s") 3221 ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s"))) 3222@end group 3223@end lisp 3224 3225@subsection on the format for sender name 3226 3227The format string @samp{%f} displays the return value of the function specified 3228by @code{wl-summary-from-function}. If you use the function 3229@code{wl-summary-default-from} (default), it displays sender name ordinarily, 3230while displays the recipient names if the folder name matches with 3231@code{wl-summary-showto-folder-regexp} and the sender is yourself. 3232If the value of @code{wl-use-petname} is Non-nil, it uses petname to display. 3233 3234For example, to display recipient names for the message in @samp{+backup} if 3235its sender is yourself, set up as follows. 3236 3237@lisp 3238(setq wl-summary-showto-folder-regexp "^\\+backup$") 3239@end lisp 3240 3241 3242@node Mark and Action, Key Bindings of Summary, Summary View, Summary 3243@section Temporary marks and their effect 3244@cindex Mark and Action 3245 3246You can define temporary marks and corresponding procedure by 3247@code{wl-summary-mark-action-list}. Initially, refile (@samp{o}), copy 3248(@samp{O}), dispose (@samp{d}), delete (@samp{D}), prefetch (@samp{i}) 3249and resend (@samp{~}) are defined. 3250 3251Each element of @code{wl-summary-mark-action-list} consists of 3252 3253@example 3254(@samp{MARK} @samp{SYMBOL} 3255 @samp{ARGUMENT-FUNCTION} @samp{SET-MARK-FUNCTION} @samp{EXEC-FUNCTION} 3256 @samp{FACE} @samp{DOC-STRING}) 3257@end example 3258 3259@samp{MARK} is a temporary mark string, and @samp{SYMBOL} is the name of 3260the action to be defined. @samp{ARGUMENT-FUNCTION} is a function to 3261generate argument to be given to @samp{SET-MARK-FUNCTION}, which will be 3262described next, and it takes arguments: 3263 3264@example 3265(@samp{ACTION} @samp{NUMBER}) 3266@end example 3267 3268Where @samp{ACTION} equals to @samp{SYMBOL}, and @samp{NUMBER} is message 3269number. @samp{SET-MARK-FUNCTION} is a function to be called when the mark 3270is put. It takes arguments: 3271 3272@example 3273(@samp{NUMBER} @samp{MARK} @samp{DATA}) 3274@end example 3275 3276Where @samp{NUMBER} is target message number, @samp{MARK} is a temporary 3277mark string, and @samp{DATA} is given by @samp{ARGUMENT-FUNCTION}. 3278 3279@samp{EXEC-FUNCTION} is a function to be called when the action is 3280executed. Its argument is a list of @samp{MARK-INFO}. Here @samp{MARK-INFO} 3281means a list consists of 3282 3283@example 3284(@samp{NUMBER} @samp{MARK} @samp{DATA}) 3285@end example 3286 3287@samp{FACE} is a face to be used for highlighting. 3288 3289 3290@node Key Bindings of Summary, Variables of Summary, Mark and Action, Summary 3291@section Key bindings 3292@cindex Keybind, Summary Mode 3293@cindex Keybind, Summary Buffer 3294 3295Key bindings of the summary mode are shown below. 3296 3297@table @kbd 3298@item @key{SPC} 3299@kindex @key{SPC} (Summary) 3300@findex wl-summary-read 3301Proceed reading a message at the current cursor point. 3302(@code{wl-summary-read}) 3303 3304@item . 3305@kindex . (Summary) 3306@findex wl-summary-redisplay 3307Redisplay a message at the current cursor point with default display 3308type. If this command is called with prefix argument, reload and redisplay 3309message regardless of the message cache. 3310If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u .}, 3311reload and redisplay message with current display type regardless of the 3312message cache. (@code{wl-summary-redisplay}) 3313 3314@item < 3315@kindex < (Summary) 3316@findex wl-summary-display-top 3317Display the top message in the folder. 3318(@code{wl-summary-display-top}) 3319 3320@item > 3321@kindex > (Summary) 3322@findex wl-summary-display-bottom 3323Display the bottom message in the folder. 3324(@code{wl-summary-display-bottom}) 3325 3326@item @key{BS} 3327@itemx @key{DEL} 3328@kindex @key{BS} (Summary) 3329@kindex @key{DEL} (Summary) 3330Display the previous page of the message at the current cursor point. 3331@findex wl-summary-prev-page 3332(@code{wl-summary-prev-page}) 3333 3334@item @key{RET} 3335@kindex @key{RET} (Summary) 3336@findex wl-summary-enter-handler 3337Display the next line of the message at the current cursor point. 3338Display the message at the current cursor point if it is not displayed 3339yet. (@code{wl-summary-next-line-content}) If prefix argument is 3340specified, message is scrolled up by one line. 3341(@code{wl-summary-prev-line-content}) If prefix argument is numeric, 3342cursor is jumped to the message with specified number. 3343 3344@item - 3345@itemx M-@key{RET} 3346@kindex - (Summary) 3347@kindex M-@key{RET} (Summary) 3348@findex wl-summary-prev-line-content 3349Display the previous line of the message at the current cursor point. 3350Display the message at the current cursor point if it is not displayed yet. 3351(@code{wl-summary-prev-line-content}) 3352 3353@item / 3354@kindex / (Summary) 3355@findex wl-thread-open-close 3356Toggle open or close the thread at the current cursor point. 3357With prefix argument, open all children threads. 3358(@code{wl-thread-open-close}) 3359 3360@item [ 3361@kindex [ (Summary) 3362Open all threads. 3363@findex wl-thread-open-all 3364(@code{wl-thread-open-all}) 3365 3366@item ] 3367@kindex ] (Summary) 3368Close all threads. 3369@findex wl-thread-close-all 3370(@code{wl-thread-close-all}) 3371 3372@item g 3373@kindex g (Summary) 3374@findex wl-summary-goto-folder 3375Go to other folder. 3376(@code{wl-summary-goto-folder}) 3377 3378@item c 3379@kindex c (Summary) 3380Mark all messages in the folder as read. 3381@findex wl-summary-mark-as-read-all 3382(@code{wl-summary-mark-as-read-all}) 3383 3384@item a 3385@kindex a (Summary) 3386@findex wl-summary-reply 3387Prepare a draft for reply the message at the current cursor point. 3388(@code{wl-summary-reply}) 3389 3390@item A 3391@kindex A (Summary) 3392@findex wl-summary-reply-with-citation 3393Prepare a draft for reply the message at the current cursor point. 3394(@code{wl-summary-reply-with-citation}) 3395 3396@item C 3397@kindex C (Summary) 3398@findex wl-summary-cancel-message 3399If the message at current cursor point is your own netnews article, 3400cancel it. 3401(@code{wl-summary-cancel-message}) 3402 3403@item E 3404@kindex E (Summary) 3405@findex wl-summary-reedit 3406Prepare a draft for re-editing the message at current cursor point. 3407If the message at current cursor point is your own netnews article, 3408a draft for `supersedes message' for the message is prepared. 3409(@code{wl-summary-reedit}) 3410 3411@item M-E 3412@kindex M-E (Summary) 3413@findex wl-summary-resend-bounced-mail 3414If the message at current cursor point is a bounced message, 3415a draft for re-sending original message is prepared. 3416(@code{wl-summary-resend-bounced-mail}) 3417 3418@item f 3419@kindex f (Summary) 3420@findex wl-summary-forward 3421A draft for forwarding the message at current cursor point is prepared. 3422(@code{wl-summary-forward}) 3423 3424@item $ 3425@kindex $ (Summary) 3426@findex wl-summary-mark-as-important 3427Put @samp{important} flag on the message at current cursor point. 3428If already flagged as @samp{important}, remove the flag. If it is 3429called with prefix argument, ask global flag to put similarly to @kbd{F}. 3430(@code{wl-summary-mark-as-important}) 3431 3432@item F 3433@kindex F (Summary) 3434@findex wl-summary-set-flags 3435Put arbitrary global flag entered in the minibuffer. If you use Emacs 343621 or later, you can specify multiple flags separated by @samp{,} 3437simultaneously. If it is called with prefix argument, remove existent 3438global flags. 3439(@code{wl-summary-set-flags}) 3440 3441@item y 3442@itemx e 3443@kindex y (Summary) 3444@kindex e (Summary) 3445Save the message at current cursor point. 3446@findex wl-summary-save 3447(@code{wl-summary-save}) 3448 3449@item n 3450@kindex n (Summary) 3451@findex wl-summary-next 3452Move cursor to the next message. 3453If message is marked with a temporal mark in 3454@code{wl-summary-skip-mark-list}, cursor is not moved to it. 3455In the offline mode, cursor is not moved to the messages which are not cached 3456yet. 3457(@code{wl-summary-next}) 3458 3459@item p 3460@kindex p (Summary) 3461@findex wl-summary-prev 3462Move cursor to the previous message. 3463If message is marked with a temporal mark in 3464@code{wl-summary-skip-mark-list}, cursor is not moved to it. 3465In the offline mode, cursor is not moved to the messages which are not cached 3466yet. 3467(@code{wl-summary-prev}) 3468 3469@item N 3470@kindex N (Summary) 3471@findex wl-summary-down 3472Move cursor to the downward message which is unread or marked 3473as @samp{$}. 3474In the offline mode, cursor is not moved to the messages which are not cached 3475yet. 3476If there are messages which have target mark @samp{*} in the summary, 3477cursor is moved to the downward message which have a target mark. 3478This behavior is changed according to the value of @code{wl-summary-move-order}. 3479(@code{wl-summary-down}) 3480 3481@item P 3482@kindex P (Summary) 3483@findex wl-summary-up 3484Move cursor to the upward message which is unread or marked 3485as @samp{$}. 3486In the offline mode, cursor is not moved to the messages which are not cached 3487yet. 3488If there are messages which have target mark @samp{*} in the summary, 3489cursor is moved to the downward message which have a target mark. 3490This behavior is changed according to the value of @code{wl-summary-move-order}. 3491(@code{wl-summary-up}) 3492 3493@item w 3494@kindex w (Summary) 3495@findex wl-summary-write 3496Prepare a new draft. 3497(@code{wl-summary-write}) 3498 3499@item W 3500@kindex W (Summary) 3501@findex wl-summary-write-current-folder 3502Prepare a new draft. If the current folder is NNTP folder, 3503@samp{Newsgroups:} field is completed. If the current folder is mailing 3504list folder (refile destination), guess @samp{To:} field and completed 3505(If @code{wl-subscribed-mailing-list} is valid list) 3506(@code{wl-summary-write-current-folder}) 3507 3508@item H 3509@kindex H (Summary) 3510@findex wl-summary-toggle-all-header 3511Toggle display type between all and partial header fields and redisplay 3512the message at current cursor point. If this command is called with 3513prefix argument, reload and redisplay message regardless of the message cache. 3514If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u H}, 3515set default display type of summary by current display type of header fields. 3516(@code{wl-summary-toggle-all-header}) 3517 3518@item M 3519@kindex M (Summary) 3520@findex wl-summary-toggle-mime 3521Toggle display type for MIME analysis and redisplay the message at 3522current cursor point. A change is performed in the order set as 3523@code{wl-summary-display-mime-mode-list}. If this command is called 3524with numeric prefix argument, it switch directly as follows. 3525 3526@example 3527@group 35281: Enable MIME analysis. 35292: Enable MIME analysis only for header fields. 35303: Disable MIME analysis. 3531@end group 3532@end example 3533 3534If this command is called with twice multiples @kbd{C-u} as @kbd{C-u C-u 3535M}, set default display type of summary by current display type of MIME 3536analysis. (@code{wl-summary-toggle-mime}) 3537 3538@item C-c C-f 3539@kindex C-c C-f (Summary) 3540@findex wl-summary-toggle-header-narrowing 3541Toggle header body narrowing of the message at current cursor point. 3542(@code{wl-summary-toggle-header-narrowing}) 3543 3544@item B 3545@kindex B (Summary) 3546@findex wl-summary-burst 3547If the message at current cursor point has 3548encapsulates multiple messages using MIME, 3549de-capsulate and extract them on the current folder. 3550If it is invoked in non-writable folder or it is called with prefix 3551argument, it asks the destination folder. 3552(@code{wl-summary-burst}) 3553 3554@item @@ 3555@kindex @@ (Summary) 3556@findex wl-summary-edit-addresses 3557Append/change/delete the message's sender information to the address 3558book @file{~/.addresses} interactively. If this command is called with 3559prefix argument, arbitrary address can be edited. 3560(@code{wl-summary-edit-petname}) 3561 3562@item Z 3563@kindex Z (Summary) 3564@findex wl-status-update 3565Sync up address book status with @file{~/.addresses}'s content. 3566(@code{wl-status-update}) 3567 3568@item | 3569@kindex | (Summary) 3570@findex wl-summary-pipe-message 3571Pipe current message's content to the external process. 3572(@code{wl-summary-pipe-message}) 3573 3574@item # 3575@kindex # (Summary) 3576@findex wl-summary-print-message 3577Print out current message's content. 3578It uses @code{ps-print} module. 3579If you don't use color printer, you might want to set 3580@code{wl-ps-print-buffer-function} to @code{ps-print-buffer}. 3581 3582@lisp 3583(setq wl-ps-print-buffer-function 'ps-print-buffer) 3584@end lisp 3585 3586(@code{wl-summary-print-message}) 3587 3588@item q 3589@kindex q (Summary) 3590@findex wl-summary-exit 3591Exit current folder. 3592(@code{wl-summary-exit}) 3593 3594@item j 3595@kindex j (Summary) 3596@findex wl-summary-jump-to-current-message 3597Jump cursor to the currently displayed message's window. 3598(@code{wl-summary-jump-to-current-message}) 3599 3600@item J 3601@kindex J (Summary) 3602Jump cursor to the other message. 3603@findex wl-summary-jump-to-msg 3604(@code{wl-summary-jump-to-msg}) 3605 3606@item I 3607@kindex I (Summary) 3608Update summary status and 3609prefetch all messages which have marks included in the 3610@code{wl-summary-incorporate-marks}. 3611@findex wl-summary-incorporate 3612(@code{wl-summary-incorporate}) 3613 3614@item M-j 3615@kindex M-j (Summary) 3616@findex wl-summary-jump-to-msg-by-message-id 3617Jump cursor to the message which have specified @samp{Message-Id:}. 3618 3619@item ^ 3620@kindex ^ (Summary) 3621Jump to parent message. 3622@findex wl-summary-jump-to-parent-message 3623(@code{wl-summary-jump-to-parent-message}) 3624 3625@item ! 3626@kindex ! (Summary) 3627@findex wl-summary-mark-as-unread 3628Mark as unread the message at current cursor point. 3629(@code{wl-summary-mark-as-unread}) 3630 3631@item s 3632@kindex s (Summary) 3633@findex wl-summary-sync 3634Synchronize summary view after prompting the update range. 3635You can specify one of the follows. 3636 3637@example 3638@group 3639all Discard present msgdb and retrieve all informations. 3640 Do not retrieve killed messages. 3641all-entirely Discard present msgdb and retrieve all informations. 3642 Retrieve killed messages, too. 3643update Update the difference between informations in present 3644 msgdb and in current folder instance. 3645 Do not retrieve killed messages. 3646update-entirely Update the difference between informations in present 3647 msgdb and in current folder instance. 3648 Retrieve killed messages, too. 3649rescan Redisplay summary by rescanning present msgdb. 3650rescan-noscore Redisplay summary by rescanning present msgdb. 3651 Display messages killed by score, too. 3652rescan-thread Redisplay summary by rescanning present msgdb. 3653 Reconstruct thread, too. 3654cache-status Sync the all marks with the real status of cache. 3655mark Update marks. 3656no-sync Do nothing. 3657first:NUM Move to the filter folder(partial filter). 3658last:NUM Move to the filter folder(partial filter). 3659@end group 3660@end example 3661 3662@noindent 3663(@code{wl-summary-sync}) 3664 3665@item S 3666@kindex S (Summary) 3667@findex wl-summary-sort 3668Sort summary order. 3669You can sort by @samp{date}, @samp{from}, @samp{number}, @samp{subject}, 3670@samp{size} and @samp{list-info}. 3671With prefix argument, sort summary lines into reverse order. 3672(@code{wl-summary-sort}) 3673 3674@item T 3675@kindex T (Summary) 3676@findex wl-summary-toggle-thread 3677Toggle the threading. The state will be preserved after exiting 3678Wanderlust. You can alter default state for newly created summary 3679by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}. 3680Threading status is displayed on the modeline. 3681@samp{@{S@}} means threading is off (Sequence) and 3682@samp{@{T@}} means threading is on (Thread). 3683(@code{wl-summary-toggle-thread}) 3684 3685@item l 3686@kindex l (Summary) 3687@findex wl-summary-toggle-disp-folder 3688Toggle displaying of folder window. 3689(@code{wl-summary-toggle-disp-folder}) 3690 3691@item v 3692@kindex v (Summary) 3693Toggle displaying of message window. 3694@findex wl-summary-toggle-disp-msg 3695(@code{wl-summary-toggle-disp-msg}) 3696 3697@item V 3698@kindex V (Summary) 3699Move to the virtual folder (filter folder) with the condition specified. 3700If called with prefix argument and current folder is virtual, exit it. 3701@findex wl-summary-virtual 3702(@code{wl-summary-virtual}) 3703 3704@item @key{TAB} 3705@kindex @key{TAB} (Summary) 3706@findex wl-summary-goto-last-displayed-msg 3707Jump to the message which is displayed last. 3708(@code{wl-summary-goto-last-displayed-msg}) 3709 3710@item ? 3711@kindex ? (Summary) 3712Put @samp{*} mark on the messages that satisfies the specified condition. 3713If messages already have @samp{*} mark, new @samp{*} marks are overridden. 3714If prefix argument is specified, current @samp{*} marks are removed and 3715new @samp{*} marks are appended. 3716 3717@findex wl-summary-pick 3718(@code{wl-summary-pick}) 3719 3720@item R 3721@kindex R (Summary) 3722@findex wl-summary-mark-as-read 3723Mark as read the message at the current cursor point. 3724(@code{wl-summary-mark-as-read}) 3725 3726@item x 3727@kindex x (Summary) 3728Execute action for all temporary marks in the summary buffer. 3729@findex wl-summary-exec 3730(@code{wl-summary-exec}) 3731 3732@item * 3733@kindex * (Summary) 3734@findex wl-summary-target-mark-line 3735Put target mark on the message at the current cursor point. 3736(@code{wl-summary-target-mark-line}) @xref{Mark and Action}. 3737 3738@item o 3739@kindex o (Summary) 3740Put refile mark on the message at the current cursor point. 3741@findex wl-summary-refile 3742(@code{wl-summary-refile}) @xref{Mark and Action}. 3743 3744@item C-o 3745@kindex C-o (Summary) 3746Execute auto refile. 3747@findex wl-summary-auto-refile 3748(@code{wl-summary-auto-refile}) 3749 3750@item O 3751@kindex O (Summary) 3752Put copy mark on the message at the current cursor point. 3753@findex wl-summary-copy 3754(@code{wl-summary-copy}) @xref{Mark and Action}. 3755 3756@item M-o 3757@kindex M-o (Summary) 3758Put refile mark on the message at the current cursor point with the destination 3759previously specified. 3760@findex wl-summary-refile-prev-destination 3761(@code{wl-summary-refile-prev-destination}) 3762 3763@item d 3764@kindex d (Summary) 3765@findex wl-summary-dispose 3766Put disposal mark on the message at the current cursor point. 3767The result of disposal is controlled by @code{wl-dispose-folder-alist}, 3768refiled to @code{wl-trash-folder} by default. 3769(@code{wl-summary-dispose}) @xref{Mark and Action}. 3770 3771@item D 3772@kindex D (Summary) 3773@findex wl-summary-delete 3774Put force deletion mark on the message at the current cursor point. 3775(@code{wl-summary-delete}) @xref{Mark and Action}. 3776 3777@item i 3778@kindex i (Summary) 3779Put prefetch reservation mark on the message at the current cursor point. 3780@findex wl-summary-prefetch 3781(@code{wl-summary-prefetch}) @xref{Mark and Action}. 3782 3783@item ~ 3784@kindex ~ (Summary) 3785@findex wl-summary-resend 3786Put resend reservation mark on the message at the current cursor point. 3787(@code{wl-summary-resend}) @xref{Mark and Action}. 3788 3789@item u 3790@kindex u (Summary) 3791@findex wl-summary-unmark 3792Unmark the temporal mark on the message at the current cursor point. 3793(@code{wl-summary-unmark}) 3794 3795@item U 3796@kindex U (Summary) 3797Unmark all the temporal marks. 3798@findex wl-summary-unmark-all 3799(@code{wl-summary-unmark-all}) 3800 3801@item r R 3802@kindex r R (Summary) 3803@findex wl-summary-mark-as-read-region 3804Mark as read messages in the specified region. 3805(@code{wl-summary-mark-as-read-region}) 3806 3807@item r $ 3808@kindex r $ (Summary) 3809@findex wl-summary-mark-as-important-region 3810Put @samp{important} flag on messages in the specified region. 3811If already flagged as @samp{important}, remove the flag. 3812(@code{wl-summary-mark-as-important-region}) 3813 3814@item r F 3815@kindex r F (Summary) 3816@findex wl-summary-set-flags-region 3817Put arbitrary global flag entered in the minibuffer on messages in 3818specified region. 3819(@code{wl-summary-set-flags-region}) 3820 3821@item r ! 3822@kindex r ! (Summary) 3823@findex wl-summary-mark-as-unread-region 3824Mark as unread messages in the specified region. 3825(@code{wl-summary-mark-as-unread-region}) 3826 3827@item r x 3828@kindex r x (Summary) 3829@findex wl-summary-exec-region 3830Execute action for each temporary marks on the messages in the 3831specified region. 3832(@code{wl-summary-exec-region}) 3833 3834@item r * 3835@kindex r * (Summary) 3836@findex wl-summary-target-mark-region 3837Put target mark on the messages in the specified region. 3838(@code{wl-summary-target-mark-region}) @xref{Mark and Action}. 3839 3840@item r o 3841@kindex r o (Summary) 3842@findex wl-summary-refile-region 3843Put refile mark on the messages in the specified region. 3844(@code{wl-summary-refile-region}) @xref{Mark and Action}. 3845 3846@item r O 3847@kindex r O (Summary) 3848@findex wl-summary-copy-region 3849Put copy mark on the messages in the specified region. 3850(@code{wl-summary-copy-region}) @xref{Mark and Action}. 3851 3852@item r d 3853@kindex r d (Summary) 3854@findex wl-summary-dispose-region 3855Put disposal mark on the messages in the specified region. 3856(@code{wl-summary-dispose-region}) @xref{Mark and Action}. 3857 3858@item r D 3859@kindex r D (Summary) 3860@findex wl-summary-delete-region 3861Put force deletion mark on the messages in the specified region. 3862(@code{wl-summary-delete-region}) @xref{Mark and Action}. 3863 3864@item r i 3865@kindex r i (Summary) 3866@findex wl-summary-prefetch-region 3867Put prefetch reservation mark on messages in the specified region. 3868(@code{wl-summary-prefetch-region}) @xref{Mark and Action}. 3869 3870@item r u 3871@kindex r u (Summary) 3872@findex wl-summary-unmark-region 3873Delete temporal mark on the messages in the specified region. 3874(@code{wl-summary-unmark-region}) 3875 3876@item r y 3877@kindex r y (Summary) 3878Save messages in the specified region. 3879@findex wl-summary-save-region 3880(@code{wl-summary-save-region}) 3881 3882@item t R 3883@kindex t R (Summary) 3884@findex wl-thread-mark-as-read 3885Mark as read messages which are the descendant of the current thread. 3886With prefix argument, it affects on the all messages in the thread tree. 3887(@code{wl-thread-mark-as-read}) 3888 3889@item t $ 3890@kindex t $ (Summary) 3891@findex wl-thread-mark-as-important 3892Put @samp{important} flag on the messages which are the descendant of 3893the current thread. If already flagged as @samp{important}, remove the 3894flag. With prefix argument, it affects on the all messages in the 3895thread tree. 3896(@code{wl-thread-mark-as-important}) 3897 3898@item t F 3899@kindex t F (Summary) 3900@findex wl-thread-set-flags 3901Put arbitrary global flag entered in the minibuffer on the messages 3902which are the descendant of the current thread. With prefix argument, 3903it affects on the all messages in the thread tree. 3904(@code{wl-thread-set-flags}) 3905 3906@item t ! 3907@kindex t ! (Summary) 3908@findex wl-thread-mark-as-unread 3909Mark as unread messages which are the descendant of the current thread. 3910With prefix argument, it affects on the all messages in the thread tree. 3911(@code{wl-thread-mark-as-unread}) 3912 3913@item t x 3914@kindex t x (Summary) 3915@findex wl-thread-exec 3916Execute action for temporary marks on the messages which are 3917the descendant of the current thread. With prefix argument, it affects 3918on the all messages in the thread tree. 3919(@code{wl-thread-exec}) 3920 3921@item t * 3922@kindex t * (Summary) 3923@findex wl-thread-target-mark 3924Put target mark @samp{*} on the messages which are the descendant of the 3925current thread. With prefix argument, it affects on the all messages in 3926the thread tree. 3927(@code{wl-thread-target-mark}) @xref{Mark and Action}. 3928 3929@item t o 3930@kindex t o (Summary) 3931@findex wl-thread-refile 3932Put refile mark on the messages which are the descendant of the current thread. 3933With prefix argument, it affects on the all messages in the thread tree. 3934(@code{wl-thread-refile}) @xref{Mark and Action}. 3935 3936@item t O 3937@kindex t O (Summary) 3938@findex wl-thread-copy 3939Put copy mark on the messages which are the descendant of the current thread. 3940With prefix argument, it affects on the all messages in the thread tree. 3941(@code{wl-thread-copy}) @xref{Mark and Action}. 3942 3943@item t d 3944@kindex t d (Summary) 3945@findex wl-thread-dispose 3946Put disposal mark on the messages which are the descendant of the current thread. 3947With prefix argument, it affects on the all messages in the thread tree. 3948(@code{wl-thread-dispose}) @xref{Mark and Action}. 3949 3950@item t D 3951@kindex t D (Summary) 3952@findex wl-thread-delete 3953Put force deletion mark on the messages which are the descendant of the 3954current thread. 3955(@code{wl-thread-delete}) @xref{Mark and Action}. 3956 3957@item t i 3958@kindex t i (Summary) 3959@findex wl-thread-prefetch 3960Put prefetch reservation mark on messages which are the descendant of 3961the current thread. 3962(@code{wl-thread-prefetch}) @xref{Mark and Action}. 3963 3964@item t u 3965@kindex t u (Summary) 3966@findex wl-thread-unmark 3967Unmark temporal mark on the messages which are the descendant of the 3968current thread. With prefix argument, it affects on the all messages in 3969the thread tree. 3970(@code{wl-thread-unmark}) 3971 3972@item t y 3973@kindex t y (Summary) 3974@findex wl-thread-save 3975Save messages which are the descendant of the current thread. 3976With prefix argument, it affects on the all messages in the thread tree. 3977(@code{wl-thread-save}) 3978 3979@item m R 3980@kindex m R (Summary) 3981@findex wl-summary-target-mark-mark-as-read 3982Mark as read all messages which have target mark @samp{*}. 3983(@code{wl-summary-target-mark-mark-as-read}) 3984 3985@item m $ 3986@kindex m $ (Summary) 3987@findex wl-summary-target-mark-mark-as-important 3988Put @samp{important} flag on all messages which have target mark @samp{*}. 3989If already flagged as @samp{important}, remove the flag. 3990(@code{wl-summary-target-mark-mark-as-important}) 3991 3992@item m F 3993@kindex m F (Summary) 3994@findex wl-summary-target-mark-set-flags 3995Put arbitrary global flag entered in the minibuffer on all messages 3996which have target mark @samp{*}. 3997(@code{wl-summary-target-mark-set-flags}) 3998 3999@item m ! 4000@kindex m ! (Summary) 4001@findex wl-summary-target-mark-mark-as-unread 4002Mark as unread all messages which have target mark @samp{*}. 4003(@code{wl-summary-target-mark-mark-as-unread}) 4004 4005@item m o 4006@kindex m o (Summary) 4007@findex wl-summary-target-mark-refile 4008Put refile mark on the messages which have target mark @samp{*}. 4009(@code{wl-summary-target-mark-refile}) @xref{Mark and Action}. 4010 4011@item m O 4012@kindex m O (Summary) 4013@findex wl-summary-target-mark-copy 4014Put copy mark on the messages which have target mark @samp{*}. 4015(@code{wl-summary-target-mark-copy}) @xref{Mark and Action}. 4016 4017@item m d 4018@kindex m d (Summary) 4019@findex wl-summary-target-mark-dispose 4020Put disposal mark on the messages which have target mark @samp{*}. 4021(@code{wl-summary-target-mark-dispose}) @xref{Mark and Action}. 4022 4023@item m D 4024@kindex m D (Summary) 4025@findex wl-summary-target-mark-delete 4026Put force deletion mark on the messages which have target mark @samp{*}. 4027(@code{wl-summary-target-mark-delete}) @xref{Mark and Action}. 4028 4029@item m i 4030@kindex m i (Summary) 4031@findex wl-summary-target-mark-prefetch 4032Put prefetch reservation mark on messages which have target mark @samp{*}. 4033(@code{wl-summary-target-mark-prefetch}) @xref{Mark and Action}. 4034 4035@item m y 4036@kindex m y (Summary) 4037@findex wl-summary-target-mark-save 4038Save messages which have target mark @samp{*}. 4039(@code{wl-summary-target-mark-save}) 4040 4041@item m u 4042@kindex m u (Summary) 4043Unmark all temporal marks. 4044(@code{wl-summary-delete-all-temp-marks}) 4045@findex wl-summary-delete-all-temp-marks 4046 4047@item m a 4048@kindex m a (Summary) 4049Put target mark @samp{*} on the all messages. 4050(@code{wl-summary-target-mark-all}) 4051@findex wl-summary-target-mark-all 4052 4053@item m t 4054@kindex m t (Summary) 4055Put target mark @samp{*} on the messages in the current thread. 4056@findex wl-summary-target-mark-thread 4057(@code{wl-summary-target-mark-thread}) 4058 4059@item m T 4060@kindex m T (Summary) 4061Put target mark @samp{*} on all the messages of the threads which 4062contain already target marked message. 4063@findex wl-summary-target-mark-threads 4064(@code{wl-summary-target-mark-threads}) 4065 4066@item m r 4067@kindex m r (Summary) 4068@findex wl-summary-target-mark-region 4069Put target mark @samp{*} on the messages in the specified region. 4070(@code{wl-summary-target-mark-region}) 4071 4072@item m A 4073@kindex m A (Summary) 4074@findex wl-summary-target-mark-reply-with-citation 4075Prepare a draft which cites all messages which have target mark @samp{*}. 4076(@code{wl-summary-target-mark-reply-with-citation}) 4077 4078@item m f 4079@kindex m f (Summary) 4080@findex wl-summary-target-mark-forward 4081Prepare a draft which forwards all messages which have target mark @samp{*}. 4082(@code{wl-summary-target-mark-forward}) 4083 4084@item m U 4085@kindex m U (Summary) 4086@findex wl-summary-target-mark-uudecode 4087Uudecode the messages which have target mark @samp{*}. 4088(@code{wl-summary-target-mark-uudecode}) 4089 4090@item m ? 4091@kindex m ? (Summary) 4092@findex wl-summary-target-mark-pick 4093Pick messages from the @samp{*} marked messages. 4094That is, @samp{*} marks on the messages are remained 4095if the specified condition is satisfied. 4096(@code{wl-summary-target-mark-pick}) 4097 4098@item m # 4099@kindex m # (Summary) 4100@findex wl-summary-target-mark-print 4101Print out all messages which have target mark @samp{*}. 4102(@code{wl-summary-target-mark-print}) 4103 4104@item m | 4105@kindex m | (Summary) 4106@findex wl-summary-target-mark-pipe 4107Pipe content of each message with target mark @samp{*} to some specified 4108external process. 4109(@code{wl-summary-target-mark-pipe}) 4110 4111@item M-t 4112@kindex M-t (Summary) 4113@findex wl-toggle-plugged 4114Toggle offline/online status of Wanderlust. 4115(@code{wl-toggle-plugged}) 4116 4117@item C-t 4118@kindex C-t (Summary) 4119Start Wanderlust's plug-status manager. 4120(@code{wl-plugged-change}) 4121 4122@item C-c C-o 4123@kindex C-c C-o (Summary) 4124@findex wl-jump-to-draft-buffer 4125Move to the draft buffer if available. If multiple draft buffer exists, 4126moved to one after another. If prefix argument is specified, load draft 4127folder's message to the draft buffer and jump to it. 4128(@code{wl-jump-to-draft-buffer}) 4129 4130@item M-w 4131@kindex M-w (Summary) 4132@findex wl-summary-save-current-message 4133Save the message at the current cursor point. 4134(@code{wl-summary-save-current-message}) 4135 4136@item C-y 4137@kindex C-y (Summary) 4138@findex wl-summary-yank-saved-message 4139Regard the message at the current cursor point as 4140parent, connect the message saved by 4141@code{wl-summary-save-current-message} 4142to the thread. 4143(@code{wl-summary-yank-saved-message}) 4144 4145@item C-x C-s 4146@kindex C-x C-s (Summary) 4147@findex wl-summary-save-status 4148Save the current summary. 4149(@code{wl-summary-save-status}) 4150@end table 4151 4152 4153@node Variables of Summary, , Key Bindings of Summary, Summary 4154@section Customiziable variables 4155 4156@table @code 4157@item wl-summary-move-order 4158@vindex wl-summary-move-order 4159The initial setting is @code{unread}. Specify cursor moving policy. If 4160you want to precede new messages, set @code{new}. If you want to 4161precede unread messages, set @code{unread}. If @code{nil}, proceed to 4162next message. 4163 4164@item wl-auto-select-first 4165@vindex wl-auto-select-first 4166The initial setting is @code{nil}. 4167If non-nil, first message is automatically displayed when you enter 4168the folder. 4169 4170@item wl-auto-select-next 4171@vindex wl-auto-select-next 4172The initial setting is @code{nil}. This controls behavior when there is 4173no unread message in current summary. 4174 4175@example 4176nil: asks whether you want to go back to folder mode 4177'unread: asks whether you want to go to next unread folder 4178 If the next one comes to be possessing no unread message 4179 by treatment of cross-posted messages or Scoring, then 4180 asks whether you want to go to next to next folder. 4181'skip-no-unread: similar as unread 4182 But does not ask before going to next to next folder. 4183otherwise: asks whether you want to go to next unread folder 4184@end example 4185 4186It might be useful to set @code{'skip-no-unread} for people who 4187want to continue reading by just pressing and pressing space key. 4188 4189@item wl-thread-insert-opened 4190@vindex wl-thread-insert-opened 4191The initial setting is @code{nil}. 4192If non-nil, thread is inserted as opened. 4193 4194@item wl-thread-open-reading-thread 4195@vindex wl-thread-open-reading-thread 4196The initial setting is @code{t}. If non-nil, reading thread is 4197automatically opened though it is closed thread. 4198 4199@item wl-summary-exit-next-move 4200@vindex wl-summary-exit-next-move 4201The initial setting is @code{t}. If non-nil, move to next folder at 4202summary exit. 4203 4204@item wl-folder-move-cur-folder 4205@vindex wl-folder-move-cur-folder 4206The initial setting is @code{nil}. If non-nil, cursor position on the 4207folder is moved. 4208 4209@item wl-summary-weekday-name-lang 4210@vindex wl-summary-weekday-name-lang 4211Specify language of the weekday. 4212@samp{en} displays English, @samp{fr} displays French, @samp{de} 4213displays Deutsch. You should rescan summary view after changing this value. 4214 4215@item wl-summary-fix-timezone 4216@vindex wl-summary-fix-timezone 4217The initial setting is @code{nil}. 4218Time zone of the date string in summary mode is adjusted using this value. 4219If @code{nil}, it is adjust to the default time zone information 4220(system's default time zone or environment variable @samp{TZ}). 4221 4222@item wl-use-petname 4223@vindex wl-use-petname 4224The initial setting is @code{t}. 4225If non-nil, sender part displays nickname. 4226 4227@item wl-break-pages 4228@vindex wl-break-pages 4229The initial setting is @code{t}. 4230If non-nil, message is split as pages by @samp{^L}. 4231 4232@item wl-summary-from-function 4233@vindex wl-summary-from-function 4234Format function to display sender in summary. 4235The initial setting is @code{wl-summary-default-from}. 4236 4237@item wl-summary-no-from-message 4238@vindex wl-summary-no-from-message 4239The initial setting is @samp{nobody@@nowhere?}. A string which is 4240displayed when there's no @samp{From:} field in the message. 4241 4242@item wl-summary-subject-function 4243@vindex wl-summary-subject-function 4244Format function to display subject in summary. 4245The initial setting is @code{wl-summary-default-subject} and 4246it will cut the list name part etc. on the top of the subject. 4247To display subject as it is, set as follows. 4248 4249@lisp 4250(setq wl-summary-subject-function 'identity) 4251@end lisp 4252 4253@item wl-summary-no-subject-message 4254@vindex wl-summary-no-subject-message 4255The initial setting is @samp{(WL:No Subject in original.)}. A string 4256which is displayed when there's no @samp{Subject:} field in the message. 4257 4258@item wl-summary-default-view 4259@vindex wl-summary-default-view 4260The initial setting is @code{'thread}. 4261The default state for newly created summary. You can set either 4262@code{'thread} for thread view or @code{'sequence} for sequential view. 4263 4264@item wl-summary-order 4265@vindex wl-summary-order 4266The initial setting is @code{'ascending}. 4267Specify order of messages in summary buffer. 4268Note that messages in a thread are always listed in ascending order 4269even if this value is @code{'descending}. 4270 4271@item wl-summary-nobreak-char-display 4272@vindex wl-summary-nobreak-char-display 4273The initial setting is @code{nil}. 4274@code{nobreak-char-display} is overridden by this value in Summary 4275buffer. 4276 4277@item wl-summary-use-frame 4278@vindex wl-summary-use-frame 4279The initial setting is @code{nil}. 4280If non-nil, use new frame for the summary. 4281 4282@item wl-use-folder-petname 4283@vindex wl-use-folder-petname 4284The initial setting is the list shown below: 4285 4286@lisp 4287@group 4288(modeline) 4289@end group 4290@end lisp 4291 4292@noindent 4293A list of display policy (symbol) of folder nickname. Available symbols 4294are: 4295 4296@table @code 4297@item modeline 4298Display folder petname on modeline. 4299@item ask-folder 4300Destination folder is notified as nickname if 4301@code{wl-auto-select-next} is non-nil. 4302@item read-folder 4303You can input folder name by nickname in the function 4304@code{wl-summary-read-folder}. 4305@end table 4306 4307@item wl-summary-move-direction-toggle 4308@vindex wl-summary-move-direction-toggle 4309The initial setting is @code{t}. If non-nil, last executed @kbd{p}, 4310@kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you 4311want to aware of reading direction, set this to @code{t}. 4312 4313@item wl-summary-width 4314@vindex wl-summary-width 4315The initial setting is 80. 4316Width of summary line. If @code{nil}, summary line's width is as is. 4317 4318@item wl-summary-print-argument-within-window 4319@vindex wl-summary-print-argument-within-window 4320The initial setting is @code{nil}. 4321If non-nil, the action argument is always printed on right side of 4322window. 4323 4324@item wl-summary-indent-length-limit 4325@vindex wl-summary-indent-length-limit 4326The initial setting is 46. 4327Specify the limit of thread indent level. @code{nil} means unlimited 4328indent level. 4329If you set this to @code{nil} you should set @code{wl-summary-width} 4330to @code{nil}, too. 4331 4332@item wl-summary-max-thread-depth 4333@vindex wl-summary-max-thread-depth 4334The initial setting is 15. 4335If thread depth of the message is larger than this value, 4336the thread is divided. 4337 4338@item wl-summary-recenter 4339@vindex wl-summary-recenter 4340The initial setting is t. 4341If non-nil, cursor point is moved to the center of the summary window. 4342 4343@item wl-summary-max-thread-depth 4344@vindex wl-summary-max-thread-depth 4345The initial setting is 30. 4346If thread depth is larger than this value, divide it. 4347 4348@item wl-summary-divide-thread-when-subject-changed 4349@vindex wl-summary-divide-thread-when-subject-changed 4350The initial setting is @code{nil}. If non-nil, thread is split if 4351the subject is changed. 4352 4353@item wl-summary-search-via-nntp 4354@vindex wl-summary-search-via-nntp 4355The initial setting is @code{confirm}. 4356 4357If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call 4358@code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message 4359from the NNTP server @code{elmo-nntp-default-server}. The value of 4360@code{elmo-nntp-default-user}, @code{elmo-nntp-default-port}, 4361@code{elmo-nntp-default-stream-type} are used. 4362 4363If @code{confirm}, server name can be specified. You can specify NNTP 4364folder format like @samp{-:username@@servername:119!}. 4365 4366@item wl-summary-keep-cursor-command 4367@vindex wl-summary-keep-cursor-command 4368The initial setting is the list shown below: 4369 4370@lisp 4371@group 4372(wl-summary-goto-folder wl-summary-goto-last-visited-folder) 4373@end group 4374@end lisp 4375 4376@noindent 4377When you entered to summary by these commands and the target summary 4378buffer already exists, summary status is not automatically updated and 4379cursor position is saved. 4380 4381@item elmo-folder-update-threshold 4382@vindex elmo-folder-update-threshold 4383The initial setting is 500. If updated message number is larger than 4384this value, confirm whether drop them or not (in the case where the value 4385of @code{elmo-folder-update-confirm} is non-nil). 4386 4387@item elmo-folder-update-confirm 4388@vindex elmo-folder-update-confirm 4389The initial setting is @code{t}. If the value is non-nil, do check with 4390@code{elmo-folder-update-threshold}. 4391 4392@item wl-summary-always-sticky-folder-list 4393@vindex wl-summary-always-sticky-folder-list 4394The initial setting is @code{nil}. 4395@code{wl-summary-always-sticky-folder-list} specifies the folders that 4396are automatically stuck. Each element is regexp of folder name. 4397 4398@item wl-summary-reserve-mark-list 4399@vindex wl-summary-reserve-mark-list 4400The initial setting is the list shown below: 4401 4402@lisp 4403@group 4404("o" "O" "D" "d" "i") 4405@end group 4406@end lisp 4407 4408@noindent 4409If a message is already marked as temporal marks in this list, the 4410message is not marked by any mark command. 4411 4412@item wl-summary-skip-mark-list 4413@vindex wl-summary-skip-mark-list 4414The initial setting is the list shown below: 4415 4416@lisp 4417@group 4418("D" "d") 4419@end group 4420@end lisp 4421 4422@noindent 4423If a message is already marked as temporal marks in this list, the 4424message is skipped at cursor move. 4425 4426@item elmo-message-fetch-threshold 4427@vindex elmo-message-fetch-threshold 4428The initial setting is 30000 (bytes). If displaying message has larger 4429size than this value, Wanderlust confirms whether fetch the message or 4430not (in the case where the value of @code{elmo-message-fetch-confirm} 4431is non-nil). 4432 4433@item elmo-message-fetch-confirm 4434@vindex elmo-message-fetch-confirm 4435The initial setting is @code{t}. If the value is non-nil, do check with 4436@code{elmo-message-fetch-threshold}. 4437 4438@item wl-prefetch-threshold 4439@vindex wl-prefetch-threshold 4440The initial setting is 30000 (bytes). If prefetching message has larger 4441size than this value and @code{wl-prefetch-confirm} is non-nil, 4442Wanderlust confirms whether prefetch the message or not. If 4443@code{wl-prefetch-threshold} is @code{nil}, the message is prefetched 4444without confirmation. 4445 4446@item wl-prefetch-confirm 4447@vindex wl-prefetch-confirm 4448The initial setting is @code{t}. If non-nil, Wanderlust confirms whether 4449prefetch the message or not if the message has larger size than 4450@code{wl-prefetch-threshold}. 4451 4452@item elmo-imap4-use-cache 4453@vindex elmo-imap4-use-cache 4454The initial setting is @code{t}. If non-nil, messages read via IMAP4 4455are cached. 4456 4457@item elmo-nntp-use-cache 4458@vindex elmo-nntp-use-cache 4459The initial setting is @code{t}. If non-nil, messages read via NNTP are 4460cached. 4461 4462@item elmo-pop3-use-cache 4463@vindex elmo-pop3-use-cache 4464The initial setting is @code{t}. If non-nil, messages read via POP3 are 4465cached. 4466 4467@item elmo-shimbun-use-cache 4468@vindex elmo-shimbun-use-cache 4469The initial setting is @code{t}. If non-nil, messages read in Shimbun 4470folders are cached. 4471 4472@item wl-summary-resend-use-cache 4473@vindex wl-summary-resend-use-cache 4474The initial setting is @code{nil}. If non-nil, messages are resend 4475using cache even in the offline status. Note that if you use cache, 4476the message identity is not guaranteed. 4477 4478@item wl-folder-process-duplicates-alist 4479@vindex wl-folder-process-duplicates-alist 4480The initial setting is @code{nil}. 4481This list determines how to deal with duplicated messages in the same folder. 4482Each item in the list is regexp of folder name and action; you can specify any 4483one of the following in the place of action: 4484 4485@example 4486@code{nil} : do nothing for duplicated messages. 4487@code{hide} : hide duplicated messages from the summary. 4488@code{read} : set duplicated messages as read. 4489@end example 4490 4491@noindent 4492Following is an example (hide duplicated messages in multi folders) 4493 4494@lisp 4495@group 4496(setq wl-folder-process-duplicates-alist 4497 '(("^\\+draft$" . nil) ("^\\+trash$" . nil) 4498 ("^\\*.*" . hide) (".*" . read))) 4499@end group 4500@end lisp 4501 4502@item wl-summary-flag-alist 4503@vindex wl-summary-flag-alist 4504The initial setting is as follows: 4505 4506@lisp 4507@group 4508((important "orange")) 4509@end group 4510@end lisp 4511 4512Specify the color and the mark of message in summary buffer with flag. 4513If the mark are omitted, the mark specified in the variable 4514@code{wl-summary-flag-mark} is assumed. If multiple global flags are on 4515one message, the former flag in this list is preferred. 4516 4517Example: 4518 4519@lisp 4520@group 4521(setq wl-summary-flag-alist 4522 '((important "purple") 4523 (todo "red") 4524 (business "green" "B") 4525 (private "blue" "X"))) 4526@end group 4527@end lisp 4528 4529@item wl-summary-display-mime-mode-list 4530@vindex wl-summary-display-mime-mode-list 4531The initial setting is the list shown below: 4532 4533@lisp 4534@group 4535(mime as-is) 4536@end group 4537@end lisp 4538 4539@noindent 4540The function @code{wl-summary-toggle-mime} switch specification of MIME 4541analysis in the order of this list. You can specify one of the follows. 4542 4543@example 4544@code{mime} : Header and body are decoded. 4545@code{header-only} : Only header is decoded. 4546@code{as-is} : Header and body are not decoded. 4547@end example 4548@end table 4549 4550 4551@node Message, Draft, Summary, Top 4552@chapter Message Buffer 4553 4554Message Buffers utilize MIME-View mode of SEMI. For operational 4555procedures and key bindings, refer to respective documents. 4556@xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}. 4557You can also see help by @kbd{?} in message buffer. 4558 4559@kbd{p} at the top of a message or @kbd{n} at the bottom of a message 4560brings you back to Summary mode. @kbd{l} toggles display of Summary 4561mode buffer. 4562 4563@section Key Bindings 4564 4565@table @kbd 4566 4567@item l 4568@kindex l (Message) 4569@findex wl-message-toggle-disp-summary 4570Toggles display of Summary buffer. 4571(@code{wl-message-toggle-disp-summary}) 4572 4573@item Button-2 4574@findex wl-message-refer-article-or-url 4575@kindex Button-2 (Message) 4576Assumes @samp{Message-ID:} at the mouse pointer, and shows the 4577corresponding message if found. 4578(@code{wl-message-refer-article-or-url}) 4579 4580@item Button-4 (upward movement of a wheel) 4581@kindex Button-4 (Message) 4582@findex wl-message-wheel-down 4583Scrolls the message backwards. When the top of the message is hit, 4584moves to the previous message. 4585(@code{wl-message-wheel-down}) 4586 4587@item Button-5 (downward movement of a wheel) 4588@kindex Button-5 (Message) 4589@findex wl-message-wheel-up 4590Scrolls the message forward. When the bottom of the message is hit, 4591moves to the next message. 4592(@code{wl-message-wheel-up}) 4593 4594@item D 4595@kindex D (Message) 4596@findex wl-message-delete-current-part 4597Delete the part under cursor. In fact it appends modified message to 4598the current folder then moves old one to trash folder. Therefore the 4599message number will be changed. 4600(@code{wl-message-delete-current-part}) 4601@end table 4602 4603@section Customizable Variables 4604 4605@table @code 4606@item wl-message-window-size 4607@vindex wl-message-window-size 4608Initial setting is @code{(1 . 4)}. It is a cons cell and the ratio of 4609its car and cdr value corresponds to the ratio of Summary and Message 4610windows. 4611 4612@item wl-message-ignored-field-list 4613@vindex wl-message-ignored-field-list 4614Initial setting is @code{nil}. 4615All fields that match this list will be hidden in message buffer. 4616Each elements are regexp of field-name. 4617If @code{nil}, the value of @code{mime-view-ignored-field-list} is used. 4618 4619@item wl-message-visible-field-list 4620@vindex wl-message-visible-field-list 4621Initial setting is @code{nil}. 4622All fields that match this list will be display in message buffer. 4623Each elements are regexp of field-name. This value precedes 4624@code{wl-message-ignored-field-list}. 4625If @code{nil}, the value of @code{mime-view-visible-field-list} is used. 4626 4627@item wl-message-sort-field-list 4628@vindex wl-message-sort-field-list 4629Initial setting is 4630'("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From"). 4631Header fields in message buffer are ordered by this value. 4632Each elements are regexp of field-name. 4633 4634@item wl-message-truncate-lines 4635@vindex wl-message-truncate-lines 4636The initial value is the value of @code{default-truncate-lines}. 4637If it is non-nil, truncate long lines in message buffer. 4638 4639@item wl-message-auto-reassemble-message/partial 4640@vindex wl-message-auto-reassemble-message/partial 4641The initial setting is @code{nil}. 4642If non-nil, automatically reassemble fragments of the message on 4643displaying when its MIME media type is message/partial. 4644@end table 4645 4646@node Draft, Disconnected Operations, Message, Top 4647@chapter Draft Buffer 4648 4649At Summary mode, pressing @kbd{w} and the like creates a new draft 4650buffer. You can edit and send mail and news articles in this buffer. 4651 4652By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer 4653with those if possible. 4654 4655@menu 4656* Usage of Draft Mode:: TIPS 4657* Key Bindings of Draft:: Key bindings 4658* Variables of Draft Mode:: Customize Draft Mode 4659@end menu 4660 4661@node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft 4662@section Tips 4663 4664Basically it is Emacs-standard mail mode. 4665 4666@menu 4667* Parameters for Sending:: 4668* Editing Header:: 4669* Editing Message Body and Sending:: 4670* Dynamical Message Re-arrangement:: 4671* Template:: 4672* POP-before-SMTP:: 4673@end menu 4674 4675@node Parameters for Sending, Editing Header, Usage of Draft Mode, Usage of Draft Mode 4676@subsection Parameters for Sending 4677 4678According to the information of servers to send messages, configure 4679following variables. 4680 4681@table @code 4682@item wl-smtp-posting-server 4683The name of the SMTP server used for mail transmission. 4684 4685@item wl-smtp-posting-port 4686The SMTP port number for mail transmission. 4687Without configuration, use default SMTP port number (25). 4688 4689@item wl-nntp-posting-server 4690The name of NNTP server used for news submission. 4691Without configuration, use @code{elmo-nntp-default-server}. 4692 4693@item wl-nntp-posting-port 4694The NNTP port number for news submission. 4695Without configuration, use @code{elmo-nntp-default-port}. 4696@end table 4697 4698You may configure following variables on demand. See section 4699Variables of Draft Mode for detail @xref{Variables of Draft Mode}. 4700 4701@table @code 4702@item wl-smtp-posting-user 4703User name for authentication by SMTP AUTH. 4704 4705@item wl-smtp-authenticate-type 4706The authentication method for SMTP AUTH. 4707Without configuration, authentication will not be carried out. 4708 4709@item wl-smtp-authenticate-realm 4710The authentication realm for SMTP AUTH. 4711Without configuration, authentication realm will not be specified. 4712 4713@item wl-smtp-connection-type 4714Specify how to establish SMTP connections. 4715 4716@item wl-nntp-posting-user 4717User name for AUTHINFO authentication on news submission. 4718 4719@item wl-nntp-posting-stream-type 4720Specify how to establish NNTP connections. 4721@end table 4722 4723@node Editing Header, Editing Message Body and Sending, Parameters for Sending, Usage of Draft Mode 4724@subsection Editing Message Header 4725 4726You can freely edit header region above @samp{--text follows this line--}, 4727until you invoke the sending operation. 4728 4729Initially, the cursor is at the @samp{To:} field. Fill in recipients 4730addresses. @kbd{@key{TAB}} completes them. 4731 4732You can use following headers to specify recipients. Add some of them 4733by yourself. Field names can be completed by @kbd{@key{TAB}}. 4734 4735@table @asis 4736@item @samp{Newsgroups:} 4737Specify newsgroups to which you post the news article. 4738 4739@item @samp{Cc:} 4740Specify addresses to send a copy (Carbon Copy) of the message. 4741@end table 4742 4743Following ones are removed from the header contents before sending. 4744 4745@table @asis 4746@item @samp{Bcc:} 4747Specify addresses to send a copy (Blind Carbon Copy) of the message. 4748 4749@item @samp{Fcc:} 4750Specify folders in which a copy of the message is saved. 4751 4752@item @samp{Ecc:} 4753Specify recipients to send encapsulated copy of the message. 4754@end table 4755 4756You can add initial headers by following variables. 4757 4758@table @code 4759 4760@item wl-fcc 4761@vindex wl-fcc 4762The initial setting is @code{nil}. 4763If non-nil, the value of this variable is inserted as a @samp{Fcc:} of 4764the draft when it is prepared. If function is specified, its return 4765value is used. 4766 4767@item wl-bcc 4768@vindex wl-bcc 4769The initial setting is @code{nil}. 4770If non-nil, the value of this variable is inserted as a @samp{Bcc:} of 4771the draft when it is prepared. 4772@end table 4773 4774@node Editing Message Body and Sending, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode 4775@subsection Editing Messages and Sending 4776 4777As a matter of course, editing message body can be performed in the same 4778way as usual writing. You may write message body under 4779@samp{--text follows this line--} line. (NOTE: Be sure to leave the line 4780@samp{--text follows this line--} intact.) 4781 4782Multi-part editing utilize MIME edit mode of SEMI. For procedures of 4783editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en, 4784a MIME user interface for GNU Emacs}. 4785You can also see help by @kbd{C-c C-x ?} in draft buffer. 4786 4787If you save the draft buffer you are editing, it is appended to the 4788draft folder specified by @code{wl-draft-folder}. You can leave draft 4789buffer after storing it for future editing by @kbd{C-c C-z} 4790(@code{wl-draft-save-and-exit}) and resume editing by pressing @kbd{E} 4791(@code{wl-summary-reedit}) in the draft folder (@pxref{Key Bindings of 4792Summary}). 4793 4794If you have finished editing, you can send message by @kbd{C-c C-c}. 4795 4796 4797@node Dynamical Message Re-arrangement, Template, Editing Message Body and Sending, Usage of Draft Mode 4798@subsection Dynamic Modification of Messages 4799@vindex wl-draft-config-alist 4800@c @cindex Change Message 4801@c @cindex Message, Change Dynamic 4802 4803You can set @code{wl-draft-config-alist} so that header and body of the 4804message will automatically modified depending on information of header 4805and others. 4806 4807The initial setting of @code{wl-draft-config-alist} is @code{nil}. 4808 4809In the example below, the header is modified when 4810@code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You 4811can set @code{wl-interactive-send} to non-nil so as to confirm changes 4812before sending the message. 4813 4814@lisp 4815@group 4816(setq wl-draft-config-alist 4817 '(((string-match "aaa\\.example\\.com$" (system-name)) 4818 ;; @r{applied if the expression is non-nil} 4819 (wl-smtp-posting-server . "mailserver-B") 4820 (wl-nntp-posting-server . "newsserver-B") 4821 ;; @r{settings of temporary variables} 4822 ) 4823 ("^To: .*user@@aaa\\.bbb\\.example\\.com" 4824 ;; @r{applied if it matches the header of the draft buffer} 4825 ("Organization" . (format "Go %s" my-webpage))) 4826 ;; @r{you can write elisp expressions here (eval only)} 4827 (top . "Hello.\n") ;; @r{inserted at the top of the body} 4828 (bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body} 4829 )) 4830@end group 4831@end lisp 4832 4833The format of @code{wl-draft-config-alist} is: 4834 4835@example 4836@group 4837'(("@var{regexp of the header}" or @var{elisp expression} 4838 ("@var{Field}" . value(@var{elisp expression})) 4839 (@var{variable} . value(@var{elisp expression})) 4840 (@var{sub-function} . value(@var{elisp expression})) 4841 @var{function} 4842 @dots{}) 4843 ("@var{regexp of the header}" or @var{elisp expression} 4844 ("@var{Field}" . value(@var{elisp expression})) 4845 @dots{})) 4846@end group 4847@end example 4848 4849Per default, there are 13 following sub-functions. 4850 4851@example 4852'header: Inserts the specified string at the bottom of the header. 4853'header-top: Inserts the specified string at the top of the header. 4854'header-file: Inserts the specified file at the bottom of the header. 4855'x-face: Inserts @samp{X-Face:} field with the content of the specified file. 4856'top: Inserts the specified string at the top of the body. 4857'top-file: Inserts the specified file at the top of the body. 4858'body: Replaces the body with the specified string. 4859 Specifying @code{nil} deletes the entire body string. 4860'body-file: Replaces the body with the content of the specified file. 4861'bottom: Inserts the specified string at the bottom of the body. 4862'bottom-file: Inserts the specified file at the top of the body. 4863'part-top: Inserts the specified string at the top of the current part. 4864'part-bottom: Inserts the specified string at the bottom of the current part. 4865'template: Applies the specified template. 4866 (refer to the next subsection) 4867@end example 4868 4869These are defined in @code{wl-draft-config-sub-func-alist} and you can 4870change them or add your own functions. If you read the code, you can 4871easily find how to write the functions. 4872 4873At the first of each item, @var{a regular expression of the header} or 4874an @var{elisp expression} should be specified. In the case of an elisp 4875expression, the item is applied when the expression is evaluated 4876non-nil. 4877 4878Per default, when multiple items match or are evaluated non-nil, all 4879such items are applied, but if you set a variable 4880@code{wl-draft-config-matchone} to @code{t}, only the first matching one 4881is applied. 4882 4883At the second of the item, a cons or a list of functions should be 4884specified. The car part of the cons should be a header field, a 4885variable, or a sub-function. When a header field is specified, the 4886field will be modified. If a variable is specified, the value of the 4887variable will be modified temporarily. 4888 4889In the cdr part of a cons, not only a variable but also an elisp 4890expression can be specified as is. If the car part is a header field 4891and the cdr part is @code{nil}, the field will be deleted. 4892 4893See the next example as well: 4894 4895@lisp 4896@group 4897(setq wl-draft-config-alist 4898 '((reply ;; @r{(1)} 4899 "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)" 4900 ;; @r{applied if it matches the header of the buffer being replied} 4901 (body . " Hello.\n") 4902 (template . "default") 4903 ))) 4904@end group 4905@end lisp 4906 4907As in the (1) above, if a header regexp is prepended with @code{reply}, 4908it is applied when the draft is prepared by @code{wl-summary-reply} for 4909example, and when it matches the header being replied. It is ignored 4910when there is no buffer being replied, like after @code{wl-draft} was 4911invoked. 4912 4913If you want to use name of parent folder, you can refer the buffer local 4914variable @code{wl-draft-parent-folder}. In the following example, Wanderlust 4915changes From according to the folder name of the summary in which the draft 4916was invoked. 4917 4918@lisp 4919@group 4920(setq wl-draft-config-alist 4921 '(((string-match \".*@@domain1$\" wl-draft-parent-folder) 4922 (\"From\" . \"user@@domain1\")) 4923 ((string-match \".*@@domain2$\" wl-draft-parent-folder) 4924 (\"From\" . \"user@@domain2\")))) 4925@end group 4926@end lisp 4927 4928 4929Note that @code{wl-draft-config-alist} is applied only once when 4930@code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. 4931Therefore, if you want to apply @code{wl-draft-config-alist} again after 4932aborting transmission, execute @kbd{C-c C-e} 4933(@code{wl-draft-config-exec}) explicitly. 4934 4935If you don't want to apply @code{wl-draft-config-alist} when 4936@code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked, 4937do the following: 4938 4939@lisp 4940(remove-hook 'wl-draft-send-hook 'wl-draft-config-exec) 4941@end lisp 4942 4943If you want to apply @code{wl-draft-config-alist} when a draft buffer is 4944prepared, do the following: 4945 4946@lisp 4947(add-hook 'wl-mail-setup-hook 'wl-draft-config-exec) 4948@end lisp 4949 4950If you want to apply @code{wl-draft-config-alist} when you re-edit a mail 4951from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the 4952following: 4953 4954@lisp 4955(add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec) 4956@end lisp 4957 4958@node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode 4959@subsection Inserting Templates 4960@cindex Template 4961@cindex Apply Template 4962 4963Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or 4964@kbd{M-x wl-template-select} in the draft buffer. 4965 4966The format of @code{wl-template-alist} is almost the same as 4967@code{wl-draft-config-alist}. 4968@xref{Dynamical Message Re-arrangement}. 4969 4970@lisp 4971@group 4972(setq wl-template-alist 4973 '(("default" 4974 ("From" . wl-from) 4975 ("Organization" . "Example Co.Ltd.") 4976 (body . "Hello.\n")) 4977 ("report" 4978 (template . "default") ;; @r{(a)} 4979 ("To" . "boss@@example.com") 4980 ("Subject" . "Report") 4981 (body-file . "~/work/report.txt") 4982 ) 4983 )) 4984@end group 4985@end lisp 4986 4987As you can see, the only difference is item (template) names such as 4988@samp{default} and @samp{report}, instead of a regexp of header. 4989Because definition of each item is the same as 4990@code{wl-draft-config-alist}, you can call another template, like (a). 4991 4992Executing the command @code{wl-template-select} results in template 4993selection, but the result differs depending on variable 4994@code{wl-template-visible-select}. 4995 4996If @code{wl-template-visible-select} is @code{t} (default), a buffer 4997window is shown below the draft buffer. You can select a template by 4998@kbd{n} and @kbd{p} seeing the buffer window. 4999 5000Press the @key{RET} key and the template is actually applied to the draft 5001buffer. If you press @kbd{q}, nothing is applied. In addition, you can 5002adjust the window size by @code{wl-template-buffer-lines}. 5003 5004If @code{wl-template-visible-select} is @code{nil}, you should type the 5005name of the template in the mini buffer. 5006 5007If @code{wl-template-select} is executed with prefix argument, 5008inversed value of @code{wl-template-visible-select} is used. 5009 5010As shown in the example in @code{wl-draft-config-alist}, you can select 5011@samp{default} template by writing: 5012 5013@lisp 5014(template . "default") 5015@end lisp 5016 5017@node POP-before-SMTP, , Template, Usage of Draft Mode 5018@subsection Sending mail by POP-before-SMTP 5019@cindex POP-before-SMTP 5020 5021You can send mail by POP-before-SMTP. Necessary setting is 5022 5023@lisp 5024(setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp) 5025@end lisp 5026 5027@noindent 5028to change mail posting function from its default value @code{wl-draft-send-mail-with-smtp}. 5029Also you would configure following variables on demand. 5030 5031@table @code 5032@item wl-pop-before-smtp-user 5033The POP user name for POP-before-SMTP authentication. 5034If unset, @code{elmo-pop3-default-user} is used. 5035 5036@item wl-pop-before-smtp-server 5037The POP server name for POP-before-SMTP authentication. 5038If unset, @code{elmo-pop3-default-server} is used. 5039 5040@item wl-pop-before-smtp-authenticate-type 5041The POP authentication method for POP-before-SMTP authentication. 5042If unset, @code{elmo-pop3-default-authenticate-type} is used. 5043 5044@item wl-pop-before-smtp-port 5045The POP port number for POP-before-SMTP authentication. 5046If unset, @code{elmo-pop3-default-port} is used. 5047 5048@item wl-pop-before-smtp-stream-type 5049If @code{ssl}, POP connection is established using SSL. If 5050@code{starttls}, STARTTLS (RFC2595) connection will be established. If 5051unset, @code{elmo-pop3-default-stream-type} is used. 5052@end table 5053 5054If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are 5055unset, settings for POP folders (@code{elmo-pop3-default-*}) are 5056used. 5057Therefore, if SMTP server and POP server are actually the same, and if 5058POP folder per default (such as @samp{&}) is available, no settings are 5059required. 5060 5061Refer to the following URL about POP-before-SMTP. 5062 5063@example 5064@group 5065@uref{http://www.iecc.com/pop-before-smtp.html} 5066@end group 5067@end example 5068 5069 5070@node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft 5071@section Key Bindings 5072@cindex Keybind, Draft Mode 5073@cindex Keybind, Draft Buffer 5074 5075@table @kbd 5076 5077@item C-c C-y 5078@kindex C-c C-y (Draft) 5079@findex wl-draft-yank-original 5080Cites the content of the current message buffer (the part under cursor). 5081If the region is active, cites the region (it affects only if 5082@code{transient-mark-mode} is Non-nil). 5083If the command is called with prefix argument, 5084the text inserted by yank command (the text content of clipboard) is cited. 5085(@code{wl-draft-yank-original}) 5086 5087@item C-c C-p 5088@kindex C-c C-p (Draft) 5089@findex wl-draft-preview-message 5090Previews the content of the current draft. 5091This is useful for previewing MIME multi-part messages. 5092(@code{wl-draft-preview-message}) 5093 5094@item C-c C-s 5095@kindex C-c C-s (Draft) 5096@findex wl-draft-send 5097Sends the content of the current draft. Does not erase the draft buffer. 5098This is useful for sending multiple messages, which are a little different 5099from each other. 5100(@code{wl-draft-send}) 5101 5102@item C-c C-c 5103@kindex C-c C-c (Draft) 5104@findex wl-draft-send-and-exit 5105Sends the content of the current draft and erases the draft buffer. 5106(@code{wl-draft-send-and-exit}) 5107 5108@item C-x C-s 5109@kindex C-x C-s (Draft) 5110@findex wl-draft-save 5111Save the current draft. 5112(@code{wl-draft-save}) 5113 5114@item C-c C-k 5115@kindex C-c C-k (Draft) 5116@findex wl-draft-kill 5117Kills the current draft. 5118(@code{wl-draft-kill}) 5119 5120@item C-x k 5121@kindex C-x k (Draft) 5122@findex wl-draft-mimic-kill-buffer 5123Kills the current draft. 5124(@code{wl-draft-mimic-kill-buffer}) 5125 5126@item C-c C-z 5127@kindex C-c C-z (Draft) 5128@findex wl-draft-save-and-exit 5129Saves the current draft, and erases the draft buffer. 5130This is useful if you want to suspend editing of the draft. 5131(@code{wl-draft-save-and-exit}) 5132 5133@item C-c C-r 5134@kindex C-c C-r (Draft) 5135@findex wl-caesar-region 5136Encodes or decodes the specified region in Caesar cipher. 5137(@code{wl-caesar-region}) 5138 5139@item C-l 5140@kindex C-l (Draft) 5141@findex wl-draft-highlight-and-recenter 5142Recenter and rehighlight current draft. 5143(@code{wl-draft-highlight-and-recenter}) 5144 5145@item M-t 5146@kindex M-t (Draft) 5147@findex wl-toggle-plugged 5148Toggles off-line/on-line states of Wanderlust. 5149(@code{wl-toggle-plugged}) 5150 5151@item C-c C-o 5152@kindex C-c C-o (Draft) 5153@findex wl-jump-to-draft-buffer 5154Jumps to the other draft buffer, if exists. 5155With prefix argument, reads a file (if any) from the draft folder when 5156there is no such buffer. 5157(@code{wl-jump-to-draft-buffer}) 5158 5159@item C-c C-e 5160@kindex C-c C-e (Draft) 5161@findex wl-draft-config-exec 5162Applies @code{wl-draft-config-alist}. 5163(@code{wl-draft-config-exec}) 5164 5165@item C-c C-j 5166@kindex C-c C-j (Draft) 5167@findex wl-template-select 5168Selects a template. 5169(@code{wl-template-select}) 5170 5171@item C-c C-a 5172@kindex C-c C-a (Draft) 5173@findex wl-addrmgr 5174Enter Address Manager. 5175@xref{Address Manager}. 5176(@code{wl-addrmgr}) 5177 5178@item C-c C-d 5179@kindex C-c C-d (Draft) 5180@findex wl-draft-elide-region 5181Elide the text between point and mark (@code{wl-draft-elide-region}). 5182The text is killed and replaced with the contents of the variable 5183@code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis 5184(@samp{[...]}). 5185@end table 5186 5187@node Variables of Draft Mode, , Key Bindings of Draft, Draft 5188@section Customizable Variables 5189@cindex SMTP AUTH 5190 5191@table @code 5192@item wl-subscribed-mailing-list 5193@vindex wl-subscribed-mailing-list 5194The initial setting is @code{nil}. Mailing lists to which you 5195subscribe. If any of these are contained in @samp{To:} or @samp{Cc:} 5196field of a reply draft, removes your own address from 5197@samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are 5198contained in @samp{To:} or @samp{Cc:} field of a message to be 5199automatically re-filed, the destination folder will be leaned in 5200connection with the address. 5201 5202Example: 5203 5204@lisp 5205@group 5206(setq wl-subscribed-mailing-list 5207 '("wl@@ml.gentei.org" 5208 "apel-ja@@m17n.org" 5209 "emacs-mime-ja@@m17n.org")) 5210@end group 5211@end lisp 5212 5213@item wl-insert-mail-followup-to 5214@vindex wl-insert-mail-followup-to 5215The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:} 5216field is automatically inserted in the draft buffer. 5217 5218@item wl-insert-mail-reply-to 5219@vindex wl-insert-mail-reply-to 5220The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:} 5221field is automatically inserted in the draft buffer. 5222 5223@item wl-auto-insert-x-face 5224@vindex wl-auto-insert-x-face 5225The initial setting is @code{t}. If non-nil and there is an encoded 5226X-Face string in a file @file{~/.xface} (the value of the variable 5227@code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the 5228draft buffer. If @code{nil}, it is not automatically inserted. 5229 5230@item wl-insert-message-id 5231@vindex wl-insert-message-id 5232The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field 5233is automatically inserted on the transmission. 5234 5235@item wl-message-id-use-message-from 5236@vindex wl-message-id-use-message-from 5237The initial setting is @code{t}. If non-nil, the value of @samp{From:} 5238field or @code{wl-from} will be used as the domain part of 5239@samp{Message-ID:}. 5240 5241@item wl-local-domain 5242@vindex wl-local-domain 5243The initial setting is @code{nil}. If @code{nil}, the return value of 5244the function @code{system-name} will be used as the domain part of 5245@samp{Message-ID:}. 5246 5247If @code{system-name} does not return FQDN (i.e. the full name of the 5248host, like @samp{smtp.gohome.org}), you @strong{must} set this variable 5249to the string of the local domain name without hostname (like 5250@samp{gohome.org}). That is, a concatenation of @code{system-name} 5251@samp{.} @code{wl-local-domain} is used as domain part of the 5252@samp{Message-ID:}. 5253 5254If your terminal does not have global IP, set the value of 5255@code{wl-message-id-domain}. (You might be beaten up on the Net News if 5256you use invalid @samp{Message-ID:}.) 5257 5258Moreover, concatenation of @code{system-name} @samp{.} 5259@code{wl-local-domain} will be used as an argument to the HELO command 5260in SMTP. 5261 5262@item wl-message-id-domain 5263@vindex wl-message-id-domain 5264The initial setting is @code{nil}. If non-nil, this value is used as a 5265domain part of the @samp{Message-ID:}. If your terminal does not have 5266global IP address, set unique string to this value (e.x. your e-mail 5267address). 5268 5269@item wl-unique-id-suffix 5270@vindex wl-unique-id-suffix 5271The initial setting is @samp{.wl}. You can specify the string in generated 5272Message-ID which appear just before @samp{@@} or @samp{%}. 5273 5274@item wl-draft-config-alist 5275@vindex wl-draft-config-alist 5276The initial setting is @code{nil}. Modifies the draft message just 5277before the transmission. The content of @code{wl-draft-config-alist} 5278will be automatically applied only once on the transmission. If you 5279want to apply it manually, use @kbd{C-c C-e}. This command can be used 5280many times. 5281 5282@item wl-template-alist 5283@vindex wl-template-alist 5284The initial setting is @code{nil}. 5285This variable specifies the template to be applied in the draft buffer. 5286 5287@item wl-draft-config-matchone 5288@vindex wl-draft-config-matchone 5289The initial setting is @code{nil}. If non-nil, only the first matching 5290item is used when @code{wl-draft-config-alist} is applied. If 5291@code{nil}, all matching items are used. 5292 5293@item wl-template-visible-select 5294@vindex wl-template-visible-select 5295The initial setting is @code{t}. 5296If non-nil, you can preview the result of the template selection in 5297another window. 5298 5299@item wl-template-confirm 5300@vindex wl-template-confirm 5301The initial setting is @code{nil}. 5302If non-nil, asks for confirmation when you press the enter key to select 5303template while previewing. 5304 5305@item wl-template-buffer-lines 5306@vindex wl-template-buffer-lines 5307The initial setting is 7. 5308If @code{wl-template-visible-select} is non-nil, this variable specifies 5309the size of the preview window. 5310 5311@item wl-draft-buffer-style 5312@vindex wl-draft-buffer-style 5313The initial setting is @code{full}. 5314Style of draft buffer window (except for replying and forwarding). 5315 5316@table @code 5317@item keep 5318is to use the current window, 5319 5320@item full 5321is to use full frame window, 5322 5323@item split 5324is to split the current window vertically and use it. 5325 5326@item msg-split 5327is to split the message window vertically and use it as if 5328replying message. 5329 5330@item split-horiz 5331is to split the current window horizontally and use it. 5332 5333@item msg-split-horiz 5334is to split the message window horizontally and use it as if 5335replying message. 5336@end table 5337 5338If some function is specified, it is called with the draft buffer 5339as an argument. 5340 5341@item wl-draft-reply-buffer-style 5342@vindex wl-draft-reply-buffer-style 5343The initial setting is @code{split}. 5344Style of draft buffer for replying and forwarding. 5345 5346@table @code 5347@item keep 5348is to use the message buffer window, 5349 5350@item full 5351is to use full frame window, 5352 5353@item split 5354is to split the message buffer window vertically and use it. 5355 5356@item split-horiz 5357is to split the message buffer window horizontally and use it. 5358@end table 5359 5360If some function is specified, it is called with the draft buffer 5361as an argument. 5362 5363@item wl-draft-use-frame 5364@vindex wl-draft-use-frame 5365The initial setting is @code{nil}. 5366If non-nil, use new frame for the draft. 5367 5368@item wl-draft-reply-default-position 5369@vindex wl-draft-reply-default-position 5370The initial setting is @code{body}. 5371Specify initial cursor position on draft buffer for reply. 5372@code{body} is to move cursor to the top of the message body, 5373@code{bottom} to the bottom of the message body, and @code{top} to the 5374top of the header. 5375 5376@item wl-draft-truncate-lines 5377@vindex wl-draft-truncate-lines 5378The initial value is the value of @code{default-truncate-lines}. 5379If it is non-nil, truncate long lines in draft buffer. 5380 5381@item wl-from 5382@vindex wl-from 5383The initial setting is the value of the variable 5384@code{user-mail-address}. The value of this variable is inserted as a 5385@samp{From:} field of the draft when it is prepared. 5386 5387@item wl-envelope-from 5388@vindex wl-envelope-from 5389The initial setting is @code{nil}. 5390The value of this variable is used for envelope from (MAIL FROM). 5391If @code{nil}, the address part of @code{wl-from} is used. 5392 5393@item wl-user-mail-address-list 5394@vindex wl-user-mail-address-list 5395The initial setting is @code{nil}. 5396This is the User's address list. If you have multiple addresses, 5397set this variable. 5398 5399@item wl-reply-subject-prefix 5400@vindex wl-reply-subject-prefix 5401The initial setting is @samp{Re: }. 5402In the @samp{Subject:} of the reply draft, this string is prepended to 5403the @samp{Subject:} of being replied. You can specify a function to be 5404message buffer of the reply target. 5405 5406@item wl-forward-subject-prefix 5407@vindex wl-forward-subject-prefix 5408The initial setting is @samp{Forward: }. 5409In the @samp{Subject:} of the forwarding draft, this string is prepended 5410to the @samp{Subject:} of being forwarded. You can specify a function 5411to be message buffer of the forward target. 5412 5413@item wl-draft-reply-use-address-with-full-name 5414@vindex wl-draft-reply-use-address-with-full-name 5415The initial setting is @code{t}. 5416If non-nil, insert her full name with address when prepare a draft for 5417reply a message. If it is @code{nil}, insert her address only. 5418 5419@item wl-draft-enable-queuing 5420@vindex wl-draft-enable-queuing 5421The initial setting is @code{t}. 5422This flag controls off-line transmission. If non-nil, the draft is 5423sent off-line. 5424 5425@item wl-draft-use-cache 5426@vindex wl-draft-use-cache 5427The initial setting is @code{nil}. If the value is non-nil and 5428@code{wl-insert-message-id} is nil, cache the message which is sent. 5429 5430@item wl-fcc-force-as-read 5431@vindex wl-fcc-force-as-read 5432The initial setting is @code{nil}. If the value is non-nil, 5433Mark as read the message saved by @samp{Fcc:}. 5434 5435@item wl-auto-flush-queue 5436@vindex wl-auto-flush-queue 5437The initial setting is t. 5438This flag controls automatic transmission of the queue when Wanderlust 5439becomes on-line. If non-nil, the queue is automatically transmitted 5440(with confirmation by @code{y-or-n-p}). If you want to transmit it 5441manually, press @kbd{F} in the folder mode. 5442 5443@item wl-ignored-forwarded-headers 5444@vindex wl-ignored-forwarded-headers 5445Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}. 5446All headers that match this regexp will be deleted when forwarding a message. 5447 5448@item wl-ignored-resent-headers 5449Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}. 5450All headers that match this regexp will be deleted when resending a message. 5451 5452@item wl-draft-always-delete-myself 5453@vindex wl-draft-always-delete-myself 5454If non-nil, always removes your own address from @samp{To:} and 5455@samp{Cc:} when you are replying to the mail addressed to you. 5456 5457@item wl-draft-delete-myself-from-bcc-fcc 5458@vindex wl-draft-delete-myself-from-bcc-fcc 5459If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:} 5460or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field. 5461 5462@item wl-draft-send-mail-function 5463@vindex wl-draft-send-mail-function 5464The initial setting is @code{wl-draft-send-mail-with-smtp}. 5465This is the function to post mails. To use POP-before-SMTP, set this to 5466@code{wl-draft-send-mail-with-pop-before-smtp}. 5467 5468@item wl-smtp-posting-server 5469@vindex wl-smtp-posting-server 5470The initial setting is @code{nil}. 5471This is the SMTP server name for mail transmission. 5472 5473@item wl-smtp-posting-port 5474@vindex wl-smtp-posting-port 5475The initial setting is @code{nil}. 5476This is the SMTP port number for mail transmission. 5477If @code{nil}, default SMTP port number (25) is used. 5478 5479@item wl-smtp-posting-user 5480@vindex wl-smtp-posting-user 5481The initial setting is @code{nil}. 5482This is the user name for SMTP AUTH authentication. 5483 5484@item wl-smtp-authenticate-type 5485@vindex wl-smtp-authenticate-type 5486The initial setting is @code{nil}. 5487This string-valued variable specifies the authentication method for SMTP 5488AUTH authentication. You may specify @code{plain}, @code{cram-md5}, 5489@code{digest-md5}, @code{login}, etc. If @code{nil}, authentication 5490will not be carried out. 5491 5492@item wl-smtp-authenticate-realm 5493@vindex wl-smtp-authenticate-realm 5494The initial setting is @code{nil}. 5495This string-valued variable specifies the authentication realm for SMTP 5496AUTH authentication. You have to set this variable for DIGEST-MD5 5497authentication and so on. 5498If @code{nil}, authentication realm is not specified in the authentication. 5499 5500@item wl-smtp-connection-type 5501@vindex wl-smtp-connection-type 5502The initial setting is @code{nil}. 5503This symbol-valued variable specifies how to establish SMTP connections. 5504If @code{nil}, use default connection type. 5505If it is @code{starttls}, use STARTTLS (RFC3207). 5506If it is @code{ssl}, use SSL. 5507 5508@item wl-nntp-posting-server 5509@vindex wl-nntp-posting-server 5510The initial setting is @code{nil}. 5511This is the NNTP server name used for news submission. 5512If @code{nil}, @code{elmo-nntp-default-server} is used. 5513 5514@item wl-nntp-posting-user 5515@vindex wl-nntp-posting-user 5516The initial setting is @code{nil}. 5517This is the user name for AUTHINFO authentication on news submission. 5518If @code{nil}, @code{elmo-nntp-default-user} is used. 5519If it is still @code{nil}, AUTHINFO authentication will not be carried out. 5520 5521@item wl-nntp-posting-port 5522@vindex wl-nntp-posting-port 5523The initial setting is @code{nil}. 5524This is the port number of the NNTP server used for news submission. 5525If @code{nil}, @code{elmo-nntp-default-port} is used. 5526 5527@item wl-nntp-posting-stream-type 5528@vindex wl-nntp-posting-stream-type 5529The initial setting is @code{nil}. 5530If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If @code{ssl}, 5531SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595) 5532connection will be established. 5533 5534@item wl-nntp-posting-function 5535@vindex wl-nntp-posting-function 5536The initial setting is @code{elmo-nntp-post}. 5537This is the function to post NNTP message. 5538 5539@item wl-nntp-posting-config-alist 5540@vindex wl-nntp-posting-config-alist 5541The initial setting is @code{nil}. 5542The value takes an alist to define NNTP server like following example. 5543It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}. 5544 5545@lisp 5546@group 5547(setq wl-nntp-posting-config-alist 5548 '((",?gmane\\." . "news.gmane.org") 5549 (",?comp\\." . 5550 ((server . "news-server") 5551 (user . "newsmaster") 5552 (port . 119) 5553 (function . elmo-nntp-post))) 5554 (".*" . "default-news-server"))) 5555@end group 5556@end lisp 5557 5558@item wl-pop-before-smtp-user 5559@vindex wl-pop-before-smtp-user 5560The initial setting is @code{nil}. 5561This is the POP user name for POP-before-SMTP. 5562If it is @code{nil}, @code{elmo-pop3-default-user} is used. 5563 5564@item wl-pop-before-smtp-server 5565@vindex wl-pop-before-smtp-server 5566The initial setting is @code{nil}. 5567This is the POP server name for POP-before-SMTP. 5568If it is @code{nil}, @code{elmo-pop3-default-server} is used. 5569 5570@item wl-pop-before-smtp-authenticate-type 5571@vindex wl-pop-before-smtp-authenticate-type 5572The initial setting is @code{nil}. 5573This is the authentication method for POP-before-SMTP authentication. 5574If it is @code{nil}, @code{elmo-pop3-default-authenticate-type} is used. 5575 5576@item wl-pop-before-smtp-port 5577@vindex wl-pop-before-smtp-port 5578The initial setting is @code{nil}. 5579This is the POP port number for POP-before-SMTP. If it is @code{nil}, 5580@code{elmo-pop3-default-port} is used. 5581 5582@item wl-pop-before-smtp-stream-type 5583@vindex wl-pop-before-smtp-stream-type 5584The initial setting is @code{nil}. 5585This flag controls the use of SSL for POP-before-SMTP. If it is 5586@code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{ssl}, 5587SSL is used. If @code{starttls}, STARTTLS (RFC2595) connection will be 5588established. 5589 5590@item wl-draft-queue-save-variables 5591@vindex wl-draft-queue-save-variables 5592Specifies a list of variable to which queued messages are saved on the 5593off-line transmission. 5594 5595@item wl-draft-sendlog 5596@vindex wl-draft-sendlog 5597The initial setting is @code{t}. 5598If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It 5599is written when: 5600 5601@itemize @minus 5602@item drafts are sent by smtp or qmail 5603@item saved into folders by fcc 5604@item saved into folders by queuing 5605@end itemize 5606 5607(it is written even if the transmission fails). 5608But transmission by @file{im-wl.el} is not written in the @file{sendlog} 5609and left to the logging function of @command{imput}. 5610 5611 5612@item wl-draft-sendlog-max-size 5613@vindex wl-draft-sendlog-max-size 5614The initial setting is 20000 (in bytes). 5615If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows 5616beyond the size specified by this variable. 5617 5618@item wl-use-ldap 5619@vindex wl-use-ldap 5620The initial setting is @code{nil}. 5621If non-nil, address completion uses LDAP. 5622 5623@item wl-ldap-server 5624@vindex wl-ldap-server 5625The initial setting is @samp{localhost}. 5626LDAP server name for address completion. 5627 5628@item wl-ldap-port 5629@vindex wl-ldap-port 5630The initial setting is @code{nil}. 5631If non-nil, the value is used as port number. 5632 5633@item wl-ldap-base 5634@vindex wl-ldap-base 5635The initial setting is @samp{c=US}. 5636LDAP search starting point (base) for address completion. 5637 5638@item wl-draft-remove-group-list-contents 5639@vindex wl-draft-remove-group-list-contents 5640The initial setting is @code{t}. 5641If non-nil, remove the group-lists' members in the recipients when 5642sending the message (group-list means the description such as 5643@samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients). 5644@end table 5645 5646@node Disconnected Operations, Expire and Archive, Draft, Top 5647@chapter Off-line Management 5648@cindex Disconnected Operations 5649 5650Wanderlust has on-line and off-line states. 5651 5652@menu 5653* Off-line State:: Wanderlust has on-line and off-line states 5654* Enable Operations:: Enable Disconnected Operations 5655* Plugged Mode:: Switching On-line/Off-line per Server/Port 5656* Off-line State settings:: Invoking Wanderlust in the Off-line State 5657* Variables of Plugged Mode:: Customize Plugged Mode 5658@end menu 5659 5660 5661@node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations 5662@section Off-line State 5663 5664Wanderlust has on-line and off-line states. In the off-line state, you 5665cannot access messages via network, unless they are cached. 5666 5667@samp{[ON]} in the mode line indicates the on-line state. @samp{[--]} 5668in the mode line indicates the off-line state. In folder or summary 5669modes, press @kbd{M-t} to switch between off- and on-line. 5670 5671You can invoke Wanderlust in the off-line state by setting 5672@code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate. 5673 5674In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode 5675ignores uncached messages. 5676 5677 5678@node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations 5679@section Enable Disconeected Operations 5680 5681Even in the off-line state, provided that relevant messages are cached, 5682and the variable @code{elmo-enable-disconnected-operation} (described 5683later) is non-nil, you can following operations: 5684@xref{Plugged Mode}, @xref{Off-line State settings}. 5685 5686@menu 5687* Send Messages off-line:: Transmit Messages 5688* Re-file and Copy queue:: Re-file and Copy (IMAP4) 5689* Creation of Folders:: Create Folders off-line (IMAP4) 5690* Marking:: Mark (IMAP4) 5691* Pre-fetching Reservations:: Pre-fetch 5692@end menu 5693 5694As soon as Wanderlust becomes on-line, such operations invoked off-line 5695are reflected in the servers via network. 5696 5697If the variable @code{elmo-enable-disconnected-operation} is @code{nil}, 5698these off-line operations are not executed and causes an error on 5699re-file or copy operations. 5700 5701@node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations 5702@subsection Transmission of Messages 5703 5704You can proceed sending operation for mail/news messages while you are 5705off-line, then it will be reserved for sending (if you are using 5706@file{im-wl.el}, it is irrelevant). 5707Messages reserved for sending while off-line are accumulated in the 5708queue folder, @samp{+queue}. These messages are transmitted at once when 5709Wanderlust becomes on-line. 5710 5711You can visit @samp{+queue} in the off-line state and confirm content of 5712messages in the queue. You can also remove messages. Removed messages 5713are not transmitted even in the on-line state. 5714 5715 5716@node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations 5717@subsection Re-file and Copy (IMAP4) 5718 5719Re-file and copy operations to IMAP folders invoked during the off-line 5720state are accumulated in the queue, and reflected in the server side 5721when Wanderlust becomes on-line. If you visit destination folders after 5722off-line re-file or copy, it looks as if messages were appended even in 5723off-line state. 5724 5725For the safety reasons, messages re-filed off-line are removed from 5726source folders only if their @samp{Message-ID:} match messages on the 5727servers. While the queue is processed, messages that failed to be 5728re-filed or copied to the specified folders are appended to the folder 5729@samp{+lost+found}. 5730 5731 5732@node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations 5733@subsection Creation of Folders (IMAP4) 5734 5735You can create IMAP folders off-line. The creation of folders are 5736reflected in the servers when Wanderlust becomes on-line. If the creation 5737of those folders fails at that time for some reasons, messages 5738to be re-filed into those are appended to the folder @samp{+lost+found} 5739instead. 5740 5741 5742@node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations 5743@subsection Marking (IMAP4) 5744 5745Off-line changes in unread/read and importance mark @samp{$} information 5746are also reflected in the servers when Wanderlust becomes on-line. 5747 5748 5749@node Pre-fetching Reservations, , Marking, Enable Operations 5750@subsection Pre-fetching 5751 5752You can make reservations for pre-fetching messages in networking 5753folders (IMAP, NNTP, POP3, shimbun). Reserved messages are marked with 5754@samp{u} but not cached yet. When Wanderlust becomes on-line, they are 5755pre-fetched from servers. 5756 5757 5758@node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations 5759@section Switching On-line/Off-line per Server/Port 5760 5761@kbd{M-t} described above switches networking states as a whole, but you 5762can switch on-line/off-line per server/port. 5763 5764Pressing @kbd{C-t} in the folder or summary modes brings you in 5765wl-plugged-mode shown below, in which you can change the plugged state 5766for each port. 5767 5768@example 5769@group 5770Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON] 5771[ON](wl-plugged) 5772 [--]hosta 5773 [--]smtp +queue: 2 msgs (1,2) @dots{}@r{sending queue} 5774 [--]nntp(119) +queue: 1 msg (3) @dots{}@r{sending queue} 5775 [ON]hostb 5776 [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1) 5777 %inbox(delete-msgids:1) @dots{}@r{dop queue} 5778 [ON]nntp(119) 5779 [ON]smtp 5780@end group 5781@end example 5782 5783The first line indicates status of the following three variables, and 5784simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled 5785column modifies the values of these variables. 5786 5787@example 5788@group 5789"Queuing" @code{wl-draft-enable-queuing} 5790"AutoFlushQueue" @code{wl-auto-flush-queue} 5791"DisconnectedOperation" @code{elmo-enable-disconnected-operation} 5792@end group 5793@end example 5794 5795where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means 5796@code{nil}. 5797 5798The second and after lines indicate on-line/off-line states of servers 5799and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for 5800off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing 5801@kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state. 5802 5803@dfn{sending queue} means messages accumulated in the folder 5804@samp{+queue} for off-line transmission, and @dfn{dop queue} means 5805off-line operations when @code{elmo-enable-disconnected-operation} is 5806@code{t}. 5807@c If the variable @code{elmo-enable-disconnected-operation} is non-nil, 5808@c off-line operations are enabled. 5809 5810They are displayed if there are any of them. In the example above, in 5811the sending queue there are two messages (the first and the second in 5812the queue folder) for smtp to hosta and one (the third) for nntp to 5813hosta, and in the dop queue there are one for @samp{%inbox} and two for 5814@samp{%#mh/wl}. 5815 5816If you change @samp{(wl-plugged)} in the second line, the variable 5817@code{wl-plugged} is changed, so that the mode line indicator and 5818plugged states of all ports are affected. If you change plugged states 5819of any servers or ports, @samp{(wl-plugged)} in the second line is 5820affected depending on @code{elmo-plugged-condition} settings and the 5821plugged state of each port. 5822 5823 5824@node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations 5825@section Invoking Wanderlust in the Off-line State 5826 5827As described before, if you set @code{wl-plugged} to @code{nil} in 5828@file{~/.wl} or anything appropriate, you can invoke Wanderlust in the 5829off-line state. You can specify off-line state on a per server or port 5830basis. Refer to @code{wl-reset-plugged-alist} also. 5831 5832Usually, when Wanderlust starts up, the plugged state of each port is 5833read from @file{~/.folders} and @code{wl-smtp-posting-server}, 5834@code{wl-nntp-posting-server} and so on. If you want to change the 5835plugged state of these ports or to add other ports, configure 5836@code{wl-make-plugged-hook} with a function. 5837 5838@lisp 5839@group 5840(add-hook 'wl-make-plugged-hook 5841 '(lambda () 5842 (elmo-set-plugged plugged-value(t/nil) server port) 5843 ;; @r{add or change plugged states of the port of the server} 5844 (elmo-set-plugged plugged-value(t/nil) server) 5845 ;; @r{if the port is omitted, all ports are affected} 5846 ;; @r{(you cannot omit the port if you newly add the server)} 5847 )) 5848@end group 5849@end lisp 5850 5851 5852@node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations 5853@section Customizable Variables 5854 5855@table @code 5856@item wl-plugged 5857@vindex wl-plugged 5858If this variable is set to @code{nil}, Wanderlust starts up in off-line 5859mode from the beginning. 5860 5861@item wl-queue-folder 5862@vindex wl-queue-folder 5863The initial setting is @samp{+queue}. 5864This is the folder in which messages in the transmission queue are 5865accumulated. 5866 5867@item wl-auto-flush-queue 5868@vindex wl-auto-flush-queue 5869The initial setting is @code{t}. 5870This flag controls automatic transmission of the queue when Wanderlust 5871becomes on-line. If non-nil, the queue is automatically transmitted 5872(with confirmation by @code{y-or-n-p}). If you want to transmit it 5873manually, press @kbd{F} in the folder mode. 5874 5875@item elmo-enable-disconnected-operation 5876@vindex elmo-enable-disconnected-operation 5877The initial setting is @code{t}. Controls off-line operations regarding 5878networking folders. If non-nil, off-line operations are carried out. 5879 5880@item elmo-lost+found-folder 5881@vindex elmo-lost+found-folder 5882The initial setting is @samp{+lost+found}. 5883This is the folder to which messages are saved when they fails to be 5884appended while the off-line re-file/copy queue is processed. 5885 5886@item elmo-plugged-condition 5887@vindex elmo-plugged-condition 5888The initial setting is @code{one}. 5889The value of @code{wl-plugged} reflects the return value of the function 5890@code{elmo-plugged-p} (without arguments). 5891This variable @code{elmo-plugged-condition} specifies the condition on 5892which the return value of @code{(elmo-plugged-p)} should be t depending on the 5893plugged state of each port. 5894 5895@example 5896'one : plugged if one or more ports are plugged. 5897'all : plugged if all ports are plugged. 5898'independent : reflects wl-plugged (elmo-plugged) regardless of plugged 5899 states of the ports. 5900@var{function} : reflects the return value of the @var{function} 5901 functions available per default 5902 'elmo-plug-on-by-servers 5903 : reflects the plugged state of the servers specified by the 5904 variable elmo-plug-on-servers. 5905 'elmo-plug-on-by-exclude-servers 5906 : reflects the plugged state of the servers that are not 5907 in elmo-plug-on-exclude-servers. 5908 elmo-plug-on-exclude-servers defaults to 5909 '("localhost" 5910 (system-name) 5911 (system-name)without the domain part) 5912@end example 5913 5914@example 5915@group 5916Example 1: 5917 (setq elmo-plugged-condition 'all) 5918Example 2: 5919 (setq elmo-plug-on-servers '("smtpserver" "newsserver")) 5920 (setq elmo-plugged-condition 'elmo-plug-on-by-servers) 5921Example 3: 5922 (setq elmo-plug-on-exclude-servers '("localhost" "myname")) 5923 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers) 5924@end group 5925@end example 5926 5927@item wl-reset-plugged-alist 5928@vindex wl-reset-plugged-alist 5929The initial setting is @code{t}. If non-nil, plugged states are 5930initialized on a per server or port basis when Wanderlust starts up. 5931 5932If @code{nil}, plugged states are retained while Emacs is running. In 5933other words, they are initialized when Emacs is restarted even if the 5934value is @code{nil}. 5935@end table 5936 5937 5938@node Expire and Archive, Scoring, Disconnected Operations, Top 5939@chapter Automatic Expiration and Archiving of Messages 5940@cindex Expire and Archive 5941 5942@menu 5943* Expire:: Expiration and Archiving 5944* Archive:: Archiving All Messages 5945@end menu 5946 5947 5948@node Expire, Archive, Expire and Archive, Expire and Archive 5949@section Expiration 5950@cindex Expire Message 5951 5952Expiration means deletion of old messages which have outlasted a 5953certain period of time. 5954 5955@code{wl-expire} supports not only simple deletion, but also moving to 5956specified archiving folders. 5957 5958@section How to Use 5959 5960Configure @code{wl-expire-alist} and press @kbd{e} in the folder mode, 5961or @kbd{M-e} in the summary mode. 5962 5963@subsection Configuring @code{wl-expire-alist} 5964 5965An example configuration of @code{wl-expire-alist} is shown below. 5966Everything in this @code{wl-expire-alist} makes a great difference in 5967expiration, so be careful. I advise you to set @code{wl-expire-use-log} 5968to @code{t}, especially in the initial stage. 5969 5970@lisp 5971@group 5972(setq wl-expire-alist 5973 '(("^\\+trash$" (date 14) remove) 5974 ;; @r{delete} 5975 ("^\\+tmp$" (date 7) trash) 5976 ;; @r{re-file to @code{wl-trash-folder}} 5977 ("^\\+outbox$" (number 300) "$outbox;lha") 5978 ;; @r{re-file to the specific folder} 5979 ("^\\+ml/tmp$" nil) 5980 ;; @r{do not expire} 5981 ("^\\+ml/wl$" (number 500 510) wl-expire-archive-number1 t) 5982 ;; @r{archive by message number (retaining numbers)} 5983 ("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t) 5984 ;; @r{archive by a fixed number (retaining numbers)} 5985 ("^\\+diary$" (date 30) wl-expire-archive-date) 5986 ;; @r{archive by year and month (numbers discarded)} 5987 )) 5988@end group 5989@end lisp 5990 5991Items in the list have the format of: 5992 5993@example 5994(@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination}) 5995@end example 5996 5997@noindent 5998The folder is examined if it matches @var{regexp-for-folders} from the 5999beginning of the list. If you invoke expiration on the folder that does 6000not match any of them, nothing will happen. And if either the second or 6001the third element of the item is @code{nil}, expiration will not take 6002place. 6003 6004You can use any one of the following for 6005@var{specification-of-messages-to-be-deleted}: 6006 6007@table @code 6008@item (number @var{n1} [@var{n2}]) 6009deletes messages depending on the number of messages in the folder. 6010 6011@var{n1} is the number of messages which should survive deletion, for example 6012if its value is 500, the newest 500 messages survive and the rests are 6013deleted. 6014 6015@var{n2} is the number of messages in the folder on which expiration should 6016take place, which defaults to @var{n1} + 1. For example if its value is 510, 6017folders with 510 or more messages are expired. 6018If you configured automatic expiration, frequently used folders may 6019expire every time it receive messages, and you may be annoyed with the 6020long delay in reading mail. 6021In that case, you can set a wide margin between @var{n2} and @var{n1}, so that 6022expiration would not take place until a certain number of messages 6023accumulate. 6024 6025Messages with marks in @code{wl-summary-expire-reserve-marks} (marked 6026with important/new/unread) are not deleted. 6027If @code{wl-expire-number-with-reserve-marks} is non-nil, the folder 6028will expire so as to have 500 messages including such ones. 6029Otherwise, it will have 500 messages except such ones. 6030 6031@item (date @var{d1}) 6032deletes messages depending on the dates. 6033 6034Messages dated @var{d1} or more days ago are deleted, for example if its 6035value is seven, messages seven days old or more are deleted. Note that 6036the date is the one in the @samp{Date:} field of the message, not when 6037the message entered the folder. 6038 6039Messages with no or invalid @samp{Date:} field does not expire; you 6040might have to delete them by hand. 6041@end table 6042 6043You can use any one of the following in the place of @var{destination}: 6044 6045@table @asis 6046@item @code{remove} 6047deletes the messages instantly. 6048 6049@item @code{hide} 6050hides the messages from summary (messages are not deleted). 6051 6052@item @code{trash} 6053moves the messages to @code{wl-trash-folder}. 6054 6055@item @var{string}(folder) 6056moves the messages to the folder specified with @var{string}. 6057 6058It would be useful for specifying an archiving folder, but because this 6059does not move important messages, it might be better to use the 6060standard functions described below. 6061 6062@item @var{function} 6063invokes the specified @var{function}. 6064 6065To the @var{function}, three arguments are passed: a folder name, a list 6066of messages to be deleted, and msgdb information of the summary. You 6067can specify function-specific arguments after the name of the 6068@var{function}. Note that the list contains messages with marks in 6069@code{wl-summary-expire-reserve-marks}, so be careful in writing your own 6070function. 6071 6072These are four standard functions; three of them move messages to an archive 6073folder in the specified way. This means old messages can be compressed 6074and saved in a file, being deleted from the original folder. 6075The last one divides messages to some MH folders. 6076 6077@table @code 6078@item wl-expire-archive-number1 6079re-files to archiving folders corresponding to the message numbers of 6080the messages being deleted. For example, a message numbered 102 will be 6081re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on. 6082If @code{wl-expire-archive-files} is 200, messages will be re-filed to 6083@file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}. 6084 6085The archiving folders to which messages are re-filed are determined by 6086the name of the folder as follows (in this case, archiving folders are 6087handled as if @code{elmo-archive-treat-file} were non-nil). 6088 6089@table @asis 6090@item If the folder type is localdir: 6091@file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip} 6092 6093For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip} 6094(@file{~/Mail/ml/wl-00100.zip}). 6095 6096@item The folder type is other than localdir: 6097@file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip} 6098 6099For example, @samp{%#mh/ml/wl} corresponds to 6100@samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}). 6101@end table 6102 6103As you can see, in the case of localdir, the folder type is not included 6104in the path name, but otherwise it is included. 6105And you can control the prefix to the archiving folder name by 6106@code{wl-expire-archive-folder-prefix}. 6107Refer to @code{wl-expire-archive-folder-prefix} for details. 6108 6109@item wl-expire-archive-number2 6110re-files every certain number of messages to archiving folders. 6111 6112This differs from @samp{wl-expire-archive-number1} in that this re-files 6113to the folder up to the specified number regardless of message numbers. 6114The archiving folders to which messages are re-filed are determined in the 6115same way as @code{wl-expire-archive-number1}. 6116 6117@code{elmo-localdir-folder-path} and @code{elmo-archive-folder-path} 6118should be different from each other when you use this function. Please 6119beware that default values are the same. 6120 6121@item wl-expire-archive-date 6122re-files messages depending on its date (year and month) to archive 6123folders. 6124 6125For example, a message dated December 1998 is re-filed to 6126@code{$folder-199812;zip}. The name of the archiving folders except the 6127date part are determined in the same way as 6128@code{wl-expire-archive-number1}. 6129 6130 6131You can set the first argument to these three standard functions to non-nil 6132in @code{wl-expire-alist} so as to retain message numbers in the folder. 6133For example, it can be specified just after the name of the function: 6134 6135@lisp 6136("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t) 6137@end lisp 6138 6139If you omit the argument, consecutive numbers from 1 are assigned for 6140each archiving folder. 6141 6142@item wl-expire-localdir-date 6143divides messages depending on their date (year and month) to MH folders 6144e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}. 6145@end table 6146@end table 6147 6148@subsection Treatment for Important or Unread Messages 6149 6150If you specify any of @code{remove}, @code{trash}, a folder name, or a 6151standard function, messages with marks in 6152@code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved 6153messages} thereafter) are retained. 6154 6155By default, this variable includes the important, new, and unread marks, 6156so that messages with these marks are not removed. 6157Note that you cannot include the temporary mark (i.e. temporary marks 6158are removed anyway), and be sure to process temporary marks before you 6159invoke expiration. 6160 6161@subsection Auto Expiration 6162 6163The following setup invokes expiration when you move into the summary 6164mode. There will be no confirmation, so make sure you made no mistake 6165in regexp and other settings before you set up this. 6166 6167@lisp 6168@group 6169(add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire) 6170@end group 6171@end lisp 6172 6173In the folder mode, you can invoke expiration per group as well as per 6174folder. Therefore, if you specify @samp{Desktop} group, all folders 6175matching @code{wl-expire-alist} expire. 6176 6177@section Tips 6178 6179@subsection Treating archive folders 6180To treat archive folders created by @code{wl-expire-archive-number1} and so on, 6181you must set non-nil value to @code{elmo-archive-treat-file}. 6182 6183@subsection Confirming 6184 6185If you are to use @code{remove}, try @code{trash} at first and see 6186messages move to @code{wl-trash-folder} as expected, then replace it 6187with @code{remove}. It would be dangerous to use @code{remove} from the 6188beginning. 6189 6190If you are to use @code{wl-expire-archive-number1} and the like, try to 6191make a folder of the archiver type (@code{zip} or @code{lha}) and see if 6192you can append messages to it. Even if settings in 6193@code{wl-expire-alist} and @code{elmo-archive} are correct, messages 6194would not be saved anywhere and disappeared in case the archiver program 6195fails. 6196 6197After you make sure you can archive to the folder correctly, you can 6198invoke expiration and utilize the log. 6199 6200If you set @code{wl-expire-use-log} to @code{t}, 6201@file{~/.elmo/expired-log} should contain the log, for example: 6202 6203@example 6204@group 6205delete +ml/wl (593 594 595 596 597 598 599) 6206move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602) 6207@end group 6208@end example 6209 6210The first column indicates the operation, i.e. @samp{delete}, 6211@samp{copy}, or @samp{move}. The next is the name of the folder that 6212expired. In the case of @samp{copy} and @samp{move}, the destination 6213folder is recorded after @samp{->}. The last is the list of message 6214numbers that are actually deleted or moved (in the case of @samp{copy} 6215and @samp{move}, the number is the one in the source folder, rather than 6216the destination folder). 6217 6218@subsection Re-filing Reserved Messages 6219 6220The three standard functions copy reserved messages to the archive 6221folder, but do not delete them from the source folder. Because 6222reserved messages and the like always remain, they are recorded in 6223@file{~/.elmo/expired-alist} so that they are not copied over and over 6224again. They are not recorded if copied by @code{wl-summary-archive}. 6225 6226If you enabled logging, usually @samp{move} is recorded for re-filing, 6227but instead @samp{copy} and @samp{delete} are recorded separately if 6228reserved messages are involved. This is because it actually copies 6229messages including reserved, then deletes ones except reserved in that 6230case. 6231 6232@section Customizable Variables 6233 6234@table @code 6235@item wl-expire-alist 6236@vindex wl-expire-alist 6237The initial setting is @code{nil}. 6238This variable specifies folders and methods to expire. For details, 6239refer to @code{wl-expire-alist} settings above. 6240 6241@item wl-summary-expire-reserve-marks 6242@vindex wl-summary-expire-reserve-marks 6243The initial setting is the list below. 6244 6245@lisp 6246@group 6247(list wl-summary-flag-mark 6248 wl-summary-new-uncached-mark 6249 wl-summary-new-cached-mark 6250 wl-summary-unread-uncached-mark 6251 wl-summary-unread-cached-mark) 6252@end group 6253@end lisp 6254 6255Messages with these marks are retained in the folder, even after 6256expiration. 6257Only permanent marks can be listed, not temporary marks. 6258 6259You can list marks one by one as in the default; you can use the 6260following settings as well: 6261 6262@table @code 6263@item all 6264All messages with permanent marks are retained, 6265i.e. @code{wl-summary-read-uncached-mark} is included in addition to the 6266defaults. 6267 6268@item none 6269All messages are handled as usual ones that are already read, no matter 6270what marks they have; even important messages are deleted. 6271@end table 6272 6273@item wl-expire-archive-files 6274@vindex wl-expire-archive-files 6275The initial setting is 100. 6276This variable specifies the number of messages to be retained in one 6277archiving folder. 6278 6279@item wl-expire-number-with-reserve-marks 6280@vindex wl-expire-number-with-reserve-marks 6281The initial setting is @code{nil}. 6282If non-nil, if expiring messages are specified by @code{number}, 6283messages with @code{wl-summary-expire-reserve-marks} are also retained. 6284 6285@item wl-expire-archive-get-folder-function 6286@vindex wl-expire-archive-get-folder-function 6287The initial setting is @code{wl-expire-archive-get-folder}. 6288 6289This variable specifies a function that returns the name of an archiving 6290folder for standard functions in the place of @var{destination}. 6291You can use the following three variables for simple modification of 6292folder names; if you want more complex settings, define your own 6293function in this variable. 6294 6295@code{wl-expire-archive-get-folder} can be customized by these 6296variables: 6297@itemize @bullet 6298@item @code{wl-expire-archive-folder-name-fmt} 6299@item @code{wl-expire-archive-folder-type} 6300@item @code{wl-expire-archive-folder-prefix} 6301@end itemize 6302 6303@item wl-expire-archive-folder-name-fmt 6304@vindex wl-expire-archive-folder-name-fmt 6305The initial setting is @samp{%s-%%05d;%s}. 6306This is a @code{format} string for archiving folders used in 6307@code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}. 6308Note that you must specify the message number by @samp{%%d}, because it 6309is parsed twice by @code{format}. 6310 6311If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as 6312well. 6313 6314@item wl-expire-archive-date-folder-name-fmt 6315@vindex wl-expire-archive-date-folder-name-fmt 6316The initial setting is @samp{%s-%%04d%%02d;%s}. 6317This is a @code{format} string for archiving folders used in 6318@code{wl-expire-archive-date}. Note that you must specify the message 6319number by @samp{%%d}, because it is parsed twice by @code{format}. 6320There should be @samp{%%d} twice, one for the year and the other for the 6321month. 6322 6323If you modify this, adjust 6324@code{wl-expire-archive-date-folder-num-regexp} as well. 6325 6326@item wl-expire-archive-folder-type 6327@vindex wl-expire-archive-folder-type 6328The initial setting is @code{zip}. 6329This variable specifies an archiver type of the archiving folders. 6330 6331@item wl-expire-archive-folder-prefix 6332@vindex wl-expire-archive-folder-prefix 6333The initial setting is @code{nil}. 6334This variable specifies the prefix (directory structure) to archiving 6335folders. 6336Exercise extreme caution in using this feature, as it has not been 6337seriously tested. 6338In the worst case, there is a fear of destructing archiving folders. 6339 6340@table @code 6341@item nil 6342There will be no prefix. 6343 6344@item short 6345For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in 6346@samp{$ml/wl-00000;zip;wl}. 6347 6348@item t 6349For example, @samp{+ml/wl} will be prefixed by prefix @samp{ml/wl}, 6350resulting in 6351 6352@samp{$ml/wl-00000;zip;ml/wl}. 6353@end table 6354 6355@item wl-expire-archive-folder-num-regexp 6356@vindex wl-expire-archive-folder-num-regexp 6357The initial setting is @samp{-\\([-0-9]+\\);}. 6358This variable specifies the regular expression to be used for getting 6359message numbers from multiple archiving folders specified by 6360@code{elmo-list-folders}. 6361Set it in accordance with @code{wl-expire-archive-folder-name-fmt}. 6362 6363@item wl-expire-archive-date-folder-num-regexp 6364@vindex wl-expire-archive-date-folder-num-regexp 6365The initial setting is @samp{-\\([-0-9]+\\);}. 6366This is the regular expression to be used for getting message numbers 6367from multiple archiving folders specified by @code{elmo-list-folders}. 6368Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}. 6369 6370@item wl-expire-delete-oldmsg-confirm 6371@vindex wl-expire-delete-oldmsg-confirm 6372The initial setting is @code{t}. 6373If non-nil, messages older than the one with the largest number will be 6374deleted with confirmation. 6375If @code{nil}, they are deleted without confirmation. 6376 6377This feature is valid only if non-nil is specified as a argument to the 6378standard functions so as to retain numbers. 6379 6380@item wl-expire-use-log 6381@vindex wl-expire-use-log 6382The initial setting is @code{nil}. 6383If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}. 6384They are appended but not truncated or rotated automatically; you might 6385need to remove it manually. 6386 6387@item wl-expire-add-seen-list 6388@vindex wl-expire-add-seen-list 6389The initial setting is @code{t}. 6390 6391If non-nil, when messages are re-filed by expiration, read/unread 6392information is passed to the destination folder. 6393 6394However if you do not read the destination folder from Wanderlust, 6395@file{seen} under @file{~/.elmo/} grows larger and larger, so you might 6396want to set this to @code{nil} if you are simply saving to some 6397archiving folders. Even if its value is @code{nil}, messages in the 6398archiving folders are simply treated as unread; it does not affect 6399expiration itself. 6400 6401@item wl-expire-folder-update-msgdb 6402@vindex wl-expire-folder-update-msgdb 6403The initial setting is @code{t}. 6404If @code{t}, in the folder mode, expiration is carried out after 6405updating summary information. If you specified a list of regular 6406expressions of folder names, summary information is updated for matching 6407folders only. 6408@end table 6409 6410 6411@node Archive, , Expire, Expire and Archive 6412@section Archiving Messages 6413 6414@subsection Archiving Messages 6415@kbd{M-x wl-summary-archive} copies the whole folder to archiving 6416folders. If there are the archiving folders already, only new messages 6417are appended. 6418 6419You can use @code{wl-archive-alist} in order to specify how messages are 6420archived according to their folder names, as in @code{wl-expire-alist}. 6421For example: 6422 6423@lisp 6424@group 6425(setq wl-archive-alist 6426 '(("^\\+tmp$" wl-archive-date) 6427 ("^\\+outbox$" wl-archive-number2) 6428 (".*" wl-archive-number1))) 6429@end group 6430@end lisp 6431 6432Each item in the list has the following format: 6433 6434@example 6435(@var{folders-regexp} @var{deleting-function}) 6436@end example 6437 6438As you can see, you can only use a function after @var{folders-regexp}. 6439Per default, there are three functions: 6440 6441@itemize @bullet 6442@item @code{wl-archive-number1} 6443@item @code{wl-archive-number2} 6444@item @code{wl-archive-date} 6445@end itemize 6446 6447As inferred from their names, they work similarly to "expire" versions, 6448other than the following points: 6449 6450@itemize @minus 6451@item No messages are deleted 6452@item Message numbers are retained even if invoked without arguments 6453@end itemize 6454 6455These functions are good to archive all messages in a folder by their 6456numbers or by their dates. 6457These are also useful for backup or confirmation purposes before 6458expiration. 6459If you try to re-file them after they are archived, they are deleted but 6460not re-filed. 6461 6462Per default, the archiving folders to which messages are copied are 6463determined automatically by @code{wl-expire-archive-get-folder-function}. 6464You can copy to a specific folder by invoking with a prefix argument, 6465i.e. @kbd{C-u M-x wl-summary-archive}. 6466 6467Note that this feature has not been seriously tested, because you can 6468simply copy to an archiving folder, for example by 6469@code{wl-summary-copy-region}. 6470 6471The archiving folders are determined by the same logic as in 6472@code{wl-summary-expire}; the following customizable variables are 6473relevant: 6474 6475@itemize @bullet 6476@item @code{wl-expire-archive-files} 6477@item @code{wl-expire-archive-get-folder-function} 6478@item @code{wl-expire-archive-folder-name-fmt} 6479@item @code{wl-expire-archive-folder-type} 6480@item @code{wl-expire-archive-folder-prefix} 6481@item @code{wl-expire-archive-folder-num-regexp} 6482@end itemize 6483 6484@subsection Customizable Variables 6485 6486@table @code 6487@item wl-archive-alist 6488@vindex wl-archive-alist 6489The initial setting is the list shown below: 6490 6491@lisp 6492@group 6493((".*" wl-archive-number1)) 6494@end group 6495@end lisp 6496 6497@noindent 6498This variable specifies a function that copies to archiving folders. 6499To the function, three arguments are passed: a folder name, a list of 6500messages in the folder, and msgdb information of the summary. 6501Needless to say, you can use your own function. 6502@end table 6503 6504 6505@node Scoring, Address Book, Expire and Archive, Top 6506@chapter Score of the Messages 6507@cindex Scoring 6508@c @cindex Kill File 6509 6510Scoring is the function that associates a score (value) with each 6511message, and marks as read or deletes from the summary according to it. 6512 6513You can put target or important marks on essential messages, or read marks 6514on the ones you do not want to read, for example spam articles. 6515 6516This scoring function has a capability and a format similar to the one 6517that Gnus has, although there are some unsupported features and 6518Wanderlust specifics. 6519@xref{Scoring, , ,gnus, Gnus Manual}. 6520 6521@menu 6522* Score Commands:: Score Commands 6523* Score File Format:: Score File Format 6524@end menu 6525 6526 6527@node Score Commands, Score File Format, Scoring, Scoring 6528@section Score Commands 6529@cindex Score Commands 6530 6531@subsection Score File Specification 6532 6533@code{wl-score-folder-alist} specifies score files or variables in which 6534scores are defined, corresponding to folder names. 6535 6536@lisp 6537@group 6538(setq wl-score-folder-alist 6539 '(("^-.*" 6540 "news.SCORE" 6541 "my.SCORE") 6542 (".*" 6543 "all.SCORE"))) 6544@end group 6545@end lisp 6546 6547If paths to the score files are omitted, the directory specified in the 6548variable @code{wl-score-files-directory} is assumed. 6549 6550No matter what you write in @code{wl-score-folder-alist}, the default 6551score file @code{wl-score-default-file} (@file{all.SCORE}) is always 6552read (it does not have to exist). 6553Therefore, in the example above, the three score files, 6554@file{news.SCORE}, @file{my.SCORE}, and @file{all.SCORE} are read for 6555the folders that matches @samp{^-.*}. 6556 6557@subsection Scored Messages 6558 6559Scores are attached to the messages that are specified by 6560@code{wl-summary-score-marks} temporarily when the summary is updated; 6561when you exit from the summary, the scores are removed and reverts to 6562the defaults. 6563 6564@subsection Creation of Score Files 6565 6566In the summary buffer, move to an appropriate message and type @kbd{L}. 6567Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer. 6568The string in Subject is presented. Edit it and press @kbd{@key{RET}}. 6569 6570This makes @minus{}1000 are scored for messages with the same 6571@samp{Subject:} as the string you entered. That is, such a score file 6572is created automatically. 6573 6574Then, try typing @kbd{h} and @kbd{e} in the same summary buffer. 6575The score file you just made appears. 6576This buffer is called @dfn{score editing buffer} thereafter. 6577When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer 6578as you are previously; type @kbd{a}. Then a score entry for "From" 6579should be inserted. 6580In this way, you can create a score file easily either in the summary 6581buffer or in the score editing buffer. 6582 6583By the way, you might be aware the numbers of key strokes are different 6584between @kbd{s s p} and @kbd{a}. 6585This is determined by @code{wl-score-header-default-entry}. 6586This variable specifies the default score entries corresponding to 6587header fields. 6588For example, for "subject" field, a type and a time limit are prompted, 6589but for "from" field, they are fixed upon automatically as substring and 6590permanent respectively. 6591However, score values can be modified by the prefix argument. 6592Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding 6593headers and types. 6594 6595At last, type @kbd{C-c C-c} in the score editing buffer. This saves the 6596score file and terminates the edit mode. Typing @kbd{C-c C-c} after 6597erasing contents of the buffer deletes the score file being edited. 6598 6599@subsection Tips 6600 6601@subsubsection Selecting Score Files 6602 6603You can change score files to which scores are appended by 6604@code{wl-summary-increase-score} and @code{wl-summary-lower-score} by 6605@code{wl-score-change-score-file}. 6606 6607@subsubsection Summing Up the Score 6608 6609If you add the same entries by @code{wl-summary-increase-score}, 6610@code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}, 6611scores for the entry is summed up. 6612 6613For example, if you create @samp{from} entry with the score of @minus{}1000 by 6614@kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of 6615@minus{}1200 will be created as a result. 6616 6617@subsubsection Creating Thread Key 6618 6619Creating @samp{Thread} key by @code{wl-summary-increase-score} or 6620@code{wl-summary-lower-score} appends @samp{Message-ID} of all children. 6621 6622@subsubsection Creating Followup Key 6623 6624Creating @samp{Followup} key by @code{wl-summary-increase-score} or 6625@code{wl-summary-lower-score} appends @samp{Message-ID} of the message 6626at the cursor to @samp{References} key. 6627If @code{wl-score-auto-make-followup-entry} is non-nil, 6628@samp{Message-ID} of all messages to be followed up within dates 6629specified by @code{wl-score-expiry-days}. 6630 6631@subsection Key Bindings 6632 6633@table @kbd 6634@item K 6635@kindex K (Summary) 6636@findex wl-summary-increase-score 6637Increases the score for the current message. 6638And the score entry is appended to the score file at the same moment. 6639You can specify the score value by a prefix argument. 6640 6641@item L 6642@kindex L (Summary) 6643@findex wl-summary-lower-score 6644Decreases the score for the current message. 6645And the score entry is appended to the score file at the same moment. 6646You can specify the score value by a prefix argument. 6647 6648@item h R 6649@kindex h R (Summary) 6650@findex wl-summary-rescore 6651Re-applies the scoring. 6652However, already scored messages are not scored anew. 6653 6654@item h c 6655@kindex h c (Summary) 6656@findex wl-score-change-score-file 6657Changes the score file currently selected. 6658 6659@item h e 6660@kindex h e (Summary) 6661@findex wl-score-edit-current-scores 6662Edits the score file currently selected. 6663If there are multiple score files, the previously specified one is 6664selected. 6665 6666@item h f 6667@kindex h f (Summary) 6668@findex wl-score-edit-file 6669Edits an arbitrary score file and selects it. 6670 6671@item h F 6672@kindex h F (Summary) 6673@findex wl-score-flush-cache 6674Erases caches associated to the score files that are read. 6675If you modified score files directly (from other than Wanderlust), you 6676need to re-read them after erasing the cache. 6677 6678@item h m 6679@kindex h m (Summary) 6680@findex wl-score-set-mark-below 6681Specifies the criterion for scores to be marked as read. 6682Messages with scores less than this value are marked as read. 6683 6684@item h x 6685@kindex h x (Summary) 6686@findex wl-score-set-expunge-below 6687Specifies the criterion for scores to be deleted from the summary. 6688Messages with scores less than this value are deleted. 6689"Deleted" means it is not shown; they are not removed from the summary 6690information or the folder. 6691The deleted messages can be shown by rescan-noscore again. 6692@end table 6693 6694@subsection Key Bindings in the Score Editing Buffer 6695 6696@table @kbd 6697@item C-c C-k 6698@kindex C-c C-k (Score Mode) 6699@findex wl-score-edit-kill 6700Abandons the file being edited. 6701 6702@item C-c C-c 6703@kindex C-c C-c (Score Mode) 6704@findex wl-score-edit-exit 6705Saves the file being edited, and quits from the edit mode. 6706 6707@item C-c C-p 6708@kindex C-c C-p (Score Mode) 6709@findex wl-score-pretty-print 6710Re-draws the score. 6711 6712@item C-c C-d 6713@kindex C-c C-d (Score Mode) 6714@findex wl-score-edit-insert-date 6715Inserts the number of dates from Dec. 31, 1 B.C. 6716It is used for creating the third factor of time-limited scores. 6717 6718@item C-c C-s 6719@kindex C-c C-s (Score Mode) 6720@findex wl-score-edit-insert-header 6721Inserts the header of the message selected in the summary buffer. 6722 6723@item C-c C-e 6724@kindex C-c C-e (Score Mode) 6725@findex wl-score-edit-insert-entry 6726Inserts the score entry of the message selected in the summary buffer. 6727@end table 6728 6729@subsection Customizable Variables 6730 6731@table @code 6732@item wl-summary-default-score 6733@vindex wl-summary-default-score 6734The initial setting is 0 (zero). 6735This variable specifies the default value of the score. 6736The score is increased or decreased based upon this value. 6737 6738@item wl-summary-important-above 6739@vindex wl-summary-important-above 6740The initial setting is @code{nil}. 6741Messages with scores larger than this value are attached with the 6742important mark (@samp{$}). 6743If @code{nil}, no important marks are attached. 6744 6745@item wl-summary-target-above 6746@vindex wl-summary-target-above 6747The initial setting is @code{nil}. 6748Messages with scores larger than this value are attached with the target 6749mark (@samp{*}). 6750If @code{nil}, no target marks are attached. 6751 6752@item wl-summary-mark-below 6753@vindex wl-summary-mark-below 6754The initial setting is 0 (zero). 6755Messages with scores smaller than this value are marked as read. 6756 6757@item wl-summary-expunge-below 6758@vindex wl-summary-expunge-below 6759The initial setting is @code{nil}. 6760Messages with scores smaller than this value are deleted from the 6761summary. 6762If @code{nil}, they are not deleted. 6763 6764@item wl-summary-score-marks 6765@vindex wl-summary-score-marks 6766The initial setting is the list shown below: 6767 6768@lisp 6769@group 6770(list wl-summary-new-uncached-mark 6771 wl-summary-new-cached-mark) 6772@end group 6773@end lisp 6774 6775@noindent 6776Messages with these marks are scored. 6777 6778@item wl-use-scoring 6779@vindex wl-use-scoring 6780The initial setting is t. 6781If non-nil, scoring is enabled. 6782 6783@item wl-score-files-directory 6784@vindex wl-score-files-directory 6785The initial setting is @file{~/.elmo/}. 6786The default directory for score files. 6787 6788@item wl-score-interactive-default-score 6789@vindex wl-score-interactive-default-score 6790The initial setting is 1000. 6791This value is used as a score when a score factor is @code{nil} in the 6792score file. It is also used in @code{wl-summary-increase-score} and 6793@code{wl-summary-lower-score}, on condition that the value of 6794@code{wl-score-header-default-entry} is @code{nil}. 6795 6796@item wl-score-expiry-days 6797@vindex wl-score-expiry-days 6798The initial setting is 7. 6799This is the number of days before time-limited scores are deleted. 6800 6801@item wl-score-update-entry-dates 6802@vindex wl-score-update-entry-dates 6803The initial setting is @code{t}. 6804If non-nil, it enables deletion of time-limited scores. 6805 6806@item wl-score-header-default-entry 6807@vindex wl-score-header-default-entry 6808Specifies the default value for each header field for score entries 6809created by @code{wl-summary-increase-score}, 6810@code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry}. 6811 6812@item wl-score-simplify-fuzzy-regexp 6813@vindex wl-score-simplify-fuzzy-regexp 6814In the case of a type of a score entry is @code{fuzzy}, this specifies a 6815regular expression to be deleted from the string. 6816Because this is usually used for Subject, the default is prefixes that 6817are attached by mailing list programs. 6818 6819@item wl-summary-rescore-partial-threshold 6820@vindex wl-summary-rescore-partial-threshold 6821The initial setting is 200. 6822When sync-all or rescan is executed, if there are messages more than 6823this value, only the last same number of messages as this value are 6824scored. 6825 6826@item wl-summary-auto-sync-marks 6827@vindex wl-summary-auto-sync-marks 6828If non-nil, unread/important marks are synchronized when the summary 6829does. 6830Unread marks reflect information on the IMAP4 server. 6831Important marks reflect information on the IMAP4 server (flagged or 6832not), and contents of @samp{'flag} folder. 6833The initial setting is @code{t}. 6834@end table 6835 6836 6837@node Score File Format, , Score Commands, Scoring 6838@section Score File Format 6839@cindex Score File Format 6840 6841The format of score files are the same as Gnus, and basically you can 6842use Gnus score files as they are. But they are not fully compatible 6843because some keys are not supported and there are Wanderlust specifics. 6844@xref{Score File Format, , ,gnus, Gnus Manual}. 6845 6846@lisp 6847@group 6848(("subject" 6849 ("for sale" -1000 nil s) 6850 ("profit" -1000 nil s)) 6851 ("from" 6852 ("spam@@spamspamspam" -10000 nil s)) 6853 ("followup" 6854 ("my@@address" 3001 nil s)) 6855 ("chars" 6856 (1000000 -10 nil >)) 6857 (important 5000) 6858 (target 3000) 6859 (mark 0) 6860 (expunge -3000)) 6861@end group 6862@end lisp 6863 6864@table @code 6865@item string 6866If the key is a string, it is the name of the header to be matched. 6867The following keys are available: 6868@code{Subject}, @code{From}, @code{Date}, @code{Message-ID}, 6869@code{References}, @code{To}, @code{Cc}, @code{Chars}, @code{Lines}, 6870@code{Xref}, @code{Extra}, @code{Followup}, @code{Thread} 6871@code{Chars} and @code{Lines} mean the size and the number of lines of 6872the message, respectively. @code{Extra}, @code{Followup}, @code{Thread} 6873are described later. 6874The rest corresponds the field of the same name. 6875 6876Arbitrary numbers of core entries are specified after the key. 6877Each score entry consists of these five factors: 6878 6879@enumerate 6880@item 6881A factor that matches header. This should be a number in the cases of 6882@code{lines} and @code{chars}, otherwise a string. 6883 6884@item 6885A score factor. When the first item matches, the score of the message 6886is increased or decreased by this value. 6887 6888@item 6889A time limiting factor. If @code{nil}, the score is permanent, and in the case 6890of a number, the score is deleted if it does not match for days 6891(@code{wl-score-expiry-days}) from the date specified by this. 6892The date is since Dec. 31, 1 B.C. 6893 6894@item 6895A type factor. This specifies the way the first factor matches. 6896Available types depend on keys. 6897 6898@table @dfn 6899@item From, Subject, References, Message-ID 6900For these keys in string, @code{r} and @code{R} (regexp), 6901@code{s} and @code{S} (substring), @code{e} and @code{E} (exact match), 6902as well as @code{f} and @code{F} (fuzzy) can be used. 6903@code{R}, @code{S}, @code{E}, and @code{F} are case sensitive. 6904 6905@item Lines, Chars 6906For these keys, the following five numerical relative operators can be 6907used: @code{<}, @code{>}, @code{=}, @code{>=}, @code{<=}. 6908 6909@item Followup 6910This key matches @code{From} header, and scores all follow-ups to the 6911message. 6912For example, it would be useful for increasing scores for follow-ups to 6913you own article. 6914 6915You can use the same types as @code{From} except for @code{f}. 6916And a @samp{Followup} entry is automatically appended to the score file. 6917 6918@item Thread 6919This key scores (sub-)threads beginning with @code{Message-ID} @var{x}. 6920A @samp{Thread} entry is automatically appended for each article that 6921has @var{x} in the @code{References} header. 6922You can make sure the whole thread including messages that does not have 6923all ancestors @code{Message-ID} in @code{References} is scored. 6924 6925You can use the same types as @code{References} except for @code{f}. 6926And a @samp{Thread} entry is automatically appended to the score file. 6927@end table 6928 6929@item 6930A factor for extension header. This is meaningful only if the key is 6931@code{Extra}. 6932This specifies headers to be matched other than standard headers like 6933@code{Subject} and @code{From}. 6934Note that you should specify the header in 6935@code{elmo-msgdb-extra-fields} also. 6936Therefore it does not work in folders where extension headers cannot be 6937retrieved. 6938 6939@end enumerate 6940 6941The sum of these scores @emph{after all factors are applied} becomes the 6942score of the message. 6943 6944@cindex Score File Atoms 6945@item mark 6946Messages with a score less than this value is marked as read. 6947The default is @code{wl-summary-mark-below}. 6948 6949@item expunge 6950Messages with a score less than this value is deleted from the summary. 6951The default is @code{wl-summary-expunge-below}. 6952 6953@item mark-and-expunge 6954Both @code{mark} and @code{expunge} are applied, 6955i.e. messages with a score less than this value is marked as read and 6956deleted from the summary. 6957 6958@item target 6959Messages with a score greater than this value is attached with temp 6960marks. 6961The default is @code{wl-summary-target-above}. 6962 6963@item important 6964Messages with a score greater than this value is attached with important 6965marks. 6966The default is @code{wl-summary-important-above}. 6967@end table 6968 6969@subsection Caveats 6970 6971Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys 6972are used, you need to set @code{elmo-msgdb-extra-fields}. 6973 6974@lisp 6975(setq elmo-msgdb-extra-fields '("lines" "xref")) 6976@end lisp 6977 6978There are other restrictions as shown below: 6979 6980@itemize @bullet 6981@item Because @samp{References} field in the summary information 6982contains only the last @samp{Message-ID}, @code{references} key matches 6983the last one only. 6984@end itemize 6985 6986Keys that can be seen by folder of types: 6987 6988@example 6989@group 6990@multitable {nntp (supporting xover)} {chars} {lines} {xref} {extra} 6991@headitem @tab chars @tab lines @tab xref @tab extra 6992@item localdir,localnews @tab Y @tab E @tab E @tab E 6993@item nntp (supporting xover) @tab Y @tab E @tab E @tab N 6994@item (otherwise) @tab N @tab E @tab E @tab E 6995@item imap4 @tab Y @tab E @tab E @tab E 6996@item pop3 @tab N @tab E @tab E @tab E 6997@end multitable 6998 6999 Y: can be seen 7000 N: cannot be seen (ignored) 7001 E: can be seen with @code{elmo-msgdb-extra-fields} settings 7002@end group 7003@end example 7004 7005 7006@node Address Book, Quick Search, Scoring, Top 7007@chapter Address Book 7008@cindex Address Book 7009 7010With address book, you can utilize address completion, and you have 7011summary displayed with nicknames. 7012 7013@menu 7014* Mail Addresses:: Definition of Address Book 7015* Address Manager:: Address Manager 7016@end menu 7017 7018 7019@node Mail Addresses, Address Manager, Address Book, Address Book 7020@section Address book 7021@cindex Address book Definition 7022@cindex .addresses 7023@cindex Alias, Address 7024 7025The file @file{~/.addresses} is a simple address book for Wanderlust. 7026Make address file @file{~/.addresses}, and edit to suit your requirement. 7027 7028The data written in @file{~/.addresses} are used for address completion 7029under draft editing mode. Furthermore, they are used when showing names 7030in summary display mode. You can safely skip this section, if you don't 7031want to customize address completion and summary display. 7032It is possible to add/change/remove addresses from @file{~/.addresses} in 7033summary buffer after Wanderlust is invoked. @refill 7034 7035The format is very simple. Like this. @refill 7036 7037@example 7038@group 7039# 7040# @r{Lines begin with @samp{#} are comment.} 7041# @r{Empty lines are ignored} 7042# 7043# @r{Format of each line:} 7044# @var{email-address} "@var{nickname} "@var{realname}" 7045# 7046teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi" 7047foo@@bar.gohome.org "Mr. Foo" "John Foo" 7048bar@@foo.gohome.org "Mr. Bar" "Michael Bar" 7049@end group 7050@end example 7051 7052@noindent 7053One line defines one persons description. 7054 7055Actually, in default setup, @var{nickname} is used in summary-mode and 7056@var{realname} is used in draft preparation mode. This behavior is 7057better understood if you try it and confirmed the function first. You 7058can write and try a small definition, so you will know the idea of the 7059address book before writing a big one. 7060 7061And, if MH alias file is specified in variable @code{wl-alias-file}, 7062it is used as an address information in the draft preparation mode. 7063 7064If variable @code{wl-use-ldap} is non-nil (initial setting is 7065@code{nil}), address completion in draft mode uses LDAP information. 7066 7067If you use LDAP, you have to set @code{wl-ldap-server}, 7068@code{wl-ldap-port} and @code{wl-ldap-base} properly. 7069You also have to set command exec @env{PATH} to 7070the program @command{ldapsearch}. 7071 7072 7073@node Address Manager, , Mail Addresses, Address Book 7074@section Address Manager 7075@cindex Address Manager 7076 7077You can type @kbd{C-c C-a} to enter address manger mode. You can edit 7078the address book and insert address to draft buffer. 7079 7080@subsection Key Bindings 7081 7082@table @kbd 7083@item t 7084@kindex t (Address Manager) 7085@findex wl-addrmgr-set-to 7086Add @samp{To:} mark. 7087 7088@item c 7089@kindex c (Address Manager) 7090@findex wl-addrmgr-set-cc 7091Add @samp{Cc:} mark. 7092 7093@item b 7094@kindex b (Address Manager) 7095@findex wl-addrmgr-set-bcc 7096Add @samp{Bcc:} mark. 7097 7098@item u 7099@kindex u (Address Manager) 7100@findex wl-addrmgr-unmark 7101Cancel the mark. 7102 7103@item x 7104@kindex x (Address Manager) 7105@findex wl-addrmgr-apply 7106 7107Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft 7108buffer and quit address manager. When no draft buffer, make new draft 7109with insert marked addresses. 7110 7111If no mark, quit address manager. 7112 7113 7114@item q 7115@kindex q (Address Manager) 7116@findex wl-addrmgr-quit 7117Quit address manager. 7118 7119@item a 7120@kindex a (Address Manager) 7121@findex wl-addrmgr-add 7122Add new entry. 7123 7124@item d 7125@kindex d (Address Manager) 7126@findex wl-addrmgr-delete 7127Delete entry. 7128 7129@item e 7130@kindex e (Address Manager) 7131@findex wl-addrmgr-edit 7132Edit entry. 7133@end table 7134 7135@node Quick Search, Spam Filter, Address Book, Top 7136@chapter Quick Search 7137@cindex Quick Search 7138 7139@code{wl-qs} provides an interface to quickly search your mail archive. 7140It can use an external search engine (@ref{Search Folder}), Gmail 7141search, or a filter folder (@ref{Filter Folder}). 7142 7143@code{wl-qs} provides the command 7144@code{wl-quicksearch-goto-search-folder}. Using it will first prompt for 7145a search, and then jump to the search results. 7146 7147@menu 7148* Setup of Quick Search:: Setup 7149* Usage of Quick Search:: Searching 7150@end menu 7151 7152@node Setup of Quick Search, Usage of Quick Search,, Quick Search 7153@section Setup of @code{wl-qs} 7154 7155To setup, configure the value of @code{wl-quicksearch-folder}. 7156This should be the name of the folder you would like to search. For 7157example, @samp{%[Gmail]/All Mail:username@@imap.gmail.com}, 7158@samp{.archive} or @samp{[]}. The latter is advised if you use a mail 7159index, such as mu, notmuch or namazu, as it is quite fast. 7160 7161@node Usage of Quick Search,, Setup of Quick Search, Quick Search 7162@section Searching 7163 7164To search your mail archive, use the command 7165@code{wl-quicksearch-goto-search-folder}, which can be called using 7166@kbd{'} in a Summary buffer or the Folder buffer. You will be prompted 7167for a search, and then will immediately jump to the search results. 7168 7169@subsection Search folder 7170 7171If you use specified @samp{[} as the value of 7172@code{wl-quicksearch-folder}, you will be accessing a search folder 7173(@ref{Search Folder}). You will be prompted for a search string. The 7174syntax of the search will depend on the value of 7175@code{elmo-search-default-engine}. Quotes will be escaped for you 7176automatically and passed on to the search program. 7177 7178(If you are using the grep search engine, you must specify a target 7179folder. Your @code{wl-quicksearch-folder} should look like 7180@samp{[]~/Mail/semi!grep}.) 7181 7182@subsection Gmail 7183 7184If you use a gmail folder as your @code{wl-quicksearch-folder}, you will be prompted for a 7185Gmail search query 7186(@uref{https://support.google.com/mail/answer/7190}). You may use 7187any Gmail search operator; the search is handled by Gmail's server. 7188 7189@subsection Filter folder 7190 7191If you are using any other type of folder, you will be prompted for a 7192query using the interactive query builder. When you have finished your 7193query, you will be directed to a filter folder for your 7194@code{wl-quicksearch-folder}. 7195 7196@node Spam Filter, Advanced Issues, Quick Search, Top 7197@chapter Spam Filter 7198@cindex Spam Filter 7199 7200@code{wl-spam} provides an frontend to external spam filtering programs. 7201You can register to or judge spam by the filtering program cooperateing 7202with messages operations on Wanderlust. 7203 7204@menu 7205* Usage of Spam Filter:: Usage of Spam Filter 7206* Spam Filter Processors:: Supported spam filters 7207@end menu 7208 7209@node Usage of Spam Filter, Spam Filter Processors, Spam Filter, Spam Filter 7210@section Usage of Spam Filter 7211 7212@subsection Initial Setting 7213 7214To use @code{wl-spam}, write in @file{~/.wl} as follows: 7215 7216@lisp 7217@group 7218;; @r{Use @samp{bogofilter} as spam back end} 7219;; @r{Set @samp{scheme} here as the spam filter you will use.} 7220;; @r{@xref{Spam Filter Processors}.} 7221(setq elmo-spam-scheme 'bogofilter) 7222(require 'wl-spam) 7223@end group 7224@end lisp 7225 7226@subsection spam mark 7227 7228The spam mark (@samp{s}) will be provided as new temporary mark. 7229Messages marked by this will be refiled into @code{wl-spam-folder} when 7230the action is called for execution. Marked messages will be skipped by 7231summary walking in ordinary way. 7232 7233The spam mark is be put on by spam judgement described later, or by 7234invoking @kbd{k m} at any time. 7235 7236@subsection spam judgment 7237 7238You can judge spam messages by following ways: 7239 7240@enumerate 7241@item 7242Make judgement on execution of auto-refile. 7243 7244Insert @code{wl-refile-guess-by-spam} to arbitrary position in 7245@code{wl-auto-refile-guess-functions} as follows. 7246 7247@lisp 7248@group 7249(setq wl-auto-refile-guess-functions 7250 '(wl-refile-guess-by-rule 7251 wl-refile-guess-by-spam)) 7252@end group 7253@end lisp 7254 7255In this example, judge spam if it could not decide refile destination by 7256@code{wl-refile-rule-alist}. 7257 7258@item 7259Make judgement on entering the summary of specified folder. 7260 7261Specify the value of @code{wl-spam-auto-check-folder-regexp-list} 7262as the list of regular expressions for folder names to be 7263automatically judged by spam filter. 7264 7265@lisp 7266(setq wl-spam-auto-check-folder-regexp-list '("\\+inbox")) 7267@end lisp 7268 7269In this example, judgement will be processed when you enter summary of 7270the folder whose name contains @samp{+inbox}. 7271 7272@item 7273Make judgement on splitting messages with @code{elmo-split}. 7274 7275It provides new function @code{spam-p} to be specified as @samp{CONDITION} 7276in @code{elmo-split-rule}. This function returns true when the message 7277is judged as spam. 7278@xref{Split messages}. 7279 7280You can also process learning by the result of judgement. (You would 7281better turn on this feature after learning to some extent) 7282 7283Example follows: 7284 7285@lisp 7286@group 7287(setq elmo-split-rule 7288 '(((spam-p) "+spam") 7289 ;; @r{to learn by the judgement, use following instead} 7290 ;((spam-p :register t) "+spam") 7291 (t "+inbox")) 7292@end group 7293@end lisp 7294@end enumerate 7295 7296@subsection spam learning 7297 7298@code{wl-spam} automatically learn spam with refiling messages. 7299 7300At first, @code{wl-spam} classifies the folders controlled by Wanderlust 7301into following 4 domains by the class of containig messages 7302 7303@table @samp 7304@item spam 7305Folders containing messages judged as spam. 7306(The folder specified by @code{wl-spam-folder}) 7307@item good 7308Folders containing messages judged as non-spam. 7309@item undecide 7310Folders containing messages not yet judged. Folders without 7311pre-distribution may belong to this domain e.g. @samp{+inbox}. 7312(specified by @code{wl-spam-undecided-folder-regexp-list}) 7313@item ignored 7314Foldes have nothing to do with spam processing e.g. 7315@code{wl-trash-folder} or @code{wl-draft-folder}. (specified by 7316@code{wl-spam-ignored-folder-regexp-list}) 7317@end table 7318 7319When you refile messages across different domains, it automatically 7320learn messages as @samp{spam} or @samp{non-spam} according to domains 7321it belongs before and after. 7322 7323To put it concretely, it will learn by following rule: 7324 7325@table @samp 7326@item undecide -> spam 7327learn as spam. 7328@item good -> spam 7329learn as spam and cancel previous study as non-spam. 7330@item undecide -> good 7331learn as non-spam. 7332@item spam -> good 7333learn as non-spam and cancel previous study as spam. 7334@end table 7335 7336It do not learn anything in other cases. 7337 7338@subsection Key Bindings 7339@cindex Keybind, spam filter 7340 7341@table @kbd 7342@item k m 7343@kindex k m (Summary) 7344@findex wl-summary-spam 7345Put spam mark (@samp{s}) on current message. 7346 7347@item k c 7348@kindex k c (Summary) 7349@findex wl-summary-test-spam 7350Test current message and put spam mark if judged as spam. 7351Remove spam mark if judged as non-spam. 7352 7353@item k C 7354@kindex k C (Summary) 7355@findex wl-summary-mark-spam 7356Test messages with the mark in @code{wl-spam-auto-check-marks}, 7357and put spam mark if judged as spam. If it is called with prefix 7358argument, test all messages regardless of their marks. 7359 7360@item k s 7361@kindex k s (Summary) 7362@findex wl-summary-register-as-spam 7363Register current message as spam and put spam mark. 7364 7365@item k S 7366@kindex k S (Summary) 7367@findex wl-summary-register-as-spam-all 7368Register all messages in the folder as spam and put spam mark. 7369 7370@item k n 7371@kindex k n (Summary) 7372@findex wl-summary-register-as-good 7373Register current message as non-spam and remove spam mark. 7374 7375@item k N 7376@kindex k N (Summary) 7377@findex wl-summary-register-as-good-all 7378Register all messages in the folder as non-spam and remove spam mark. 7379 7380@item r k m 7381@kindex r k m (Summary) 7382@findex wl-summary-spam-region 7383Put spam mark on messages in the specified region. 7384 7385@item r k c 7386@kindex r k c (Summary) 7387@findex wl-summary-test-spam-region 7388Test messages in the specified region and put spam mark if judged as spam. 7389Remove spam mark if judged as non-spam. 7390 7391@item r k s 7392@kindex r k s (Summary) 7393@findex wl-summary-register-as-spam-region 7394Register messages in the specified region as spam and put spam mark. 7395 7396@item r k n 7397@kindex r k n (Summary) 7398@findex wl-summary-register-as-good-region 7399Register messages in the specified region as non-spam and remove spam mark. 7400 7401@item t k m 7402@kindex t k m (Summary) 7403@findex wl-thread-spam 7404Put spam mark on messages which are the descendant of the current thread. 7405With prefix argument, it affects on the all messages in the thread tree. 7406 7407@item t k c 7408@kindex t k c (Summary) 7409@findex wl-thread-test-spam 7410Test messages which are the descendant of the current thread and put spam mark 7411if judged as spam. Remove spam mark if judged as non-spam. 7412With prefix argument, it affects on the all messages in the thread tree. 7413 7414@item t k s 7415@kindex t k s (Summary) 7416@findex wl-thread-register-as-spam 7417Register messages which are the descendant of the current thread as spam 7418and put spam mark. 7419With prefix argument, it affects on the all messages in the thread tree. 7420 7421@item t k n 7422@kindex t k n (Summary) 7423@findex wl-thread-register-as-good 7424Register messages which are the descendant of the current thread as non-spam 7425and remove spam mark. 7426With prefix argument, it affects on the all messages in the thread tree. 7427 7428@item m k 7429@kindex m k (Summary) 7430@findex wl-summary-target-mark-spam 7431Put spam mark (@samp{s}) on messages with the target mark @samp{*}. 7432 7433@item m s 7434@kindex m s (Summary) 7435@findex wl-summary-target-mark-register-as-spam 7436Register messages with the target mark @samp{*} as spam and put spam mark. 7437 7438@item m n 7439@kindex m n (Summary) 7440@findex wl-summary-target-mark-register-as-good 7441Register messages with the target mark @samp{*} as non-spam and remove spam mark. 7442@end table 7443 7444@subsection Customizable Variables 7445 7446@table @code 7447@item wl-spam-folder 7448@vindex wl-spam-folder 7449Specify the name of destination folder for the spam messages. 7450The initial setting is @samp{+spam}. 7451 7452@item wl-spam-undecided-folder-regexp-list 7453@vindex wl-spam-undecided-folder-regexp-list 7454Specify the list of regexp of folder names which contain messages 7455not yet decided as spam or non-spam. 7456The initial setting is @code{'("inbox")}. 7457 7458@item wl-spam-ignored-folder-regexp-list 7459@vindex wl-spam-ignored-folder-regexp-list 7460The initial setting is as follows. 7461 7462@lisp 7463@group 7464(list (regexp-opt (list wl-draft-folder 7465 wl-trash-folder 7466 wl-queue-folder))) 7467@end group 7468@end lisp 7469 7470Folders of no effect against spam judgement, specified by the list of 7471folder name regular expressions. 7472 7473@item wl-spam-auto-check-folder-regexp-list 7474@vindex wl-spam-auto-check-folder-regexp-list 7475Folders to make spam judgement on entering the summary of them, 7476specified by the list of folder name regular expressions. 7477The initial setting is @code{nil}. 7478 7479@item wl-spam-auto-check-marks 7480@vindex wl-spam-auto-check-marks 7481The initial setting is the following list: 7482 7483@lisp 7484@group 7485(list wl-summary-new-uncached-mark 7486 wl-summary-new-cached-mark) 7487@end group 7488@end lisp 7489 7490Messages with mark specified by this variable will be processed 7491by whole-folder judgement including auto test by 7492@code{wl-spam-auto-check-folder-regexp-list}. 7493Persistent marks can be used in this method, but temporary marks cannot. 7494 7495You can specify the list of marks as the initial setting, or you can 7496specify follwing symbol: 7497 7498@table @code 7499@item all 7500Process all messages regardless of persistent marks. 7501@end table 7502@end table 7503 7504 7505@node Spam Filter Processors, , Usage of Spam Filter, Spam Filter 7506@section Supported Spam Filters 7507@cindex Spam Filter, Bogofilter 7508@cindex Spam Filter, Spamfilter 7509 7510Supported spam filtering libraries are following ones. 7511 7512@menu 7513* bogofilter:: bogofilter 7514* spamfilter:: spamfilter.el 7515* bsfilter:: bsfilter 7516* SpamAssassin:: SpamAssassin 7517* SpamOracle:: SpamOracle 7518* Regular Expressions Header Matching:: Header regexp 7519@end menu 7520 7521 7522@node bogofilter, spamfilter, Spam Filter Processors, Spam Filter Processors 7523@subsection bogofilter 7524@cindex bogofilter 7525 7526bogofilter (@uref{http://bogofilter.sourceforge.net/}) is a spam filter 7527implemented by C language. 7528 7529To use spam filter with bogofilter, write following setting in 7530@file{~/.wl} or somewhere else. 7531 7532@lisp 7533@group 7534(setq elmo-spam-scheme 'bogofilter) 7535@end group 7536@end lisp 7537 7538@subsubsection Customizable Variables 7539 7540@table @code 7541@item elmo-spam-bogofilter-program 7542@vindex elmo-spam-bogofilter-program 7543The initial setting is @file{bogofilter}. 7544Specify the name of executable of bogofilter. If the executable 7545is not in your environmental variable @env{PATH}, you should 7546set this by full path. 7547 7548@item elmo-spam-bogofilter-args 7549@vindex elmo-spam-bogofilter-args 7550The initial setting is @code{nil}. 7551Specify arguments to be supplied for bogofilter executable. 7552 7553@item elmo-spam-bogofilter-database-directory 7554@vindex elmo-spam-bogofilter-database-directory 7555Specify the directory for statistical database to be used. 7556@code{nil} to use default directory (@file{~/.bogofilter}). 7557The initial setting is @code{nil}. 7558 7559@item elmo-spam-bogofilter-max-messages-per-process 7560@vindex elmo-spam-bogofilter-max-messages-per-process 7561The initial setting is 30. This variable specifies the number of 7562messages to be learned by one process. 7563 7564@item elmo-spam-bogofilter-debug 7565@vindex elmo-spam-bogofilter-debug 7566The initial setting is @code{nil}. 7567If you specify non-nil, the output from @command{bogofilter} is 7568stored in the buffer named @code{"*Debug ELMO SPAM Bogofilter*"}. 7569@end table 7570 7571 7572@node spamfilter, bsfilter, bogofilter, Spam Filter Processors 7573@subsection spamfilter.el 7574@cindex spamfilter 7575 7576@file{spamfilter.el} 7577(@uref{http://www.geocities.co.jp/SiliconValley-PaloAlto/7043/}) is a 7578spam filtering library implemented by Emacs Lisp. 7579 7580Corresponding modules will be compiled/installed, if you have 7581@file{spamfilter.el} within @code{load-path} when you are to install wl. 7582@xref{Install}. 7583 7584To use @file{spamfilter.el}, write following setting in @file{~/.wl} or 7585somewhere else. 7586(Of cource, you have to have settings for @file{spamfilter.el} itself) 7587 7588@lisp 7589@group 7590(setq elmo-spam-scheme 'spamfilter) 7591@end group 7592@end lisp 7593 7594@subsubsection Customizable Variables 7595 7596@table @code 7597@item elmo-spam-spamfilter-corpus-filename 7598@vindex elmo-spam-spamfilter-corpus-filename 7599The initial setting is @file{~/.elmo/.spamfilter}. 7600It specifies the name of corpus file. 7601@end table 7602 7603@node bsfilter, SpamAssassin, spamfilter, Spam Filter Processors 7604@subsection bsfilter 7605@cindex bsfilter 7606 7607bsfilter (@uref{http://bsfilter.org/index-e.html}) is a spam filter 7608implemented by Ruby language. 7609 7610To use spam filter with bsfilter, write following setting in 7611@file{~/.wl} or somewhere else. 7612 7613@lisp 7614@group 7615(setq elmo-spam-scheme 'bsfilter) 7616@end group 7617@end lisp 7618 7619@subsubsection Customizable Variables 7620 7621@table @code 7622@item elmo-spam-bsfilter-program 7623@vindex elmo-spam-bsfilter-program 7624The initial setting is @file{bsfilter}. 7625Specify the name of executable of @command{bsfilter}. If the executable 7626is not in your environmental variable @env{PATH}, you should 7627set this by full path. 7628 7629@item elmo-spam-bsfilter-args 7630@vindex elmo-spam-bsfilter-args 7631The initial setting is @code{nil}. 7632Specify arguments to be supplied for bsfilter executable. 7633 7634@item elmo-spam-bsfilter-database-directory 7635@vindex elmo-spam-bsfilter-database-directory 7636Specify the directory for statistical database to be used. 7637@code{nil} to use default directory (@file{~/.bsfilter}). 7638The initial setting is @code{nil}. 7639 7640@item elmo-spam-bsfilter-debug 7641@vindex elmo-spam-bsfilter-debug 7642The initial setting is @code{nil}. 7643If you specify non-nil, the output from @command{bsfilter} is 7644stored in the buffer named @code{"*Debug ELMO Bsfilter*"}. 7645 7646@item elmo-spam-bsfilter-shell-program 7647@vindex elmo-spam-bsfilter-shell-program 7648The initial setting is @file{ruby}. 7649Specify the shell to execute @command{bsfilter}. If the shell is not 7650in your environmental variable @env{PATH}, you should set this by full path. 7651 7652@item elmo-spam-bsfilter-shell-switch 7653@vindex elmo-spam-bsfilter-shell-switch 7654The initial setting is @code{nil}. 7655Specify options to give to the shell executing @command{bsfilter}. 7656 7657@item elmo-spam-bsfilter-update-switch 7658@vindex elmo-spam-bsfilter-update-switch 7659The initial setting is @code{"--auto-update"}. 7660Specify options to give to @command{bsfilter} for learning messages. 7661 7662@end table 7663 7664@node SpamAssassin, SpamOracle, bsfilter, Spam Filter Processors 7665@subsection SpamAssassin 7666@cindex SpamAssassin 7667 7668SpamAssassin (@uref{http://spamassassin.org/}) is one of the most 7669popular spam filtering program implemented on Perl. SpamAssassin 7670attempts to identify spam using text analysis and several internet-based 7671realtime blacklists. SpamAssassin also uses a Bayesian learning filter 7672which enables more accurate spam filtering. 7673 7674To use @file{SpamAssassin} on Wanderlust, write following setting 7675in @file{~/.wl} or somewhere else. 7676(Of course, you have to install SpamAssassin beforehand.) 7677 7678@lisp 7679@group 7680(setq elmo-spam-scheme 'sa) 7681@end group 7682@end lisp 7683 7684@subsubsection Customize Variables 7685 7686@table @code 7687@item elmo-spam-spamassassin-program 7688@vindex elmo-spam-spamassassin-program 7689The initial setting is @file{spamassassin}. 7690Specify the name of executable @command{spamassassin}. If the executable 7691is not in your environmental variable @env{PATH}, you should 7692set this by full path. 7693 7694@item elmo-spam-spamassassin-learn-program 7695@vindex elmo-spam-spamassassin-learn-program 7696The initial setting is @file{sa-learn}. 7697Specify the name of the SpamAssassin's Bayesian filtering learner 7698program, @command{sa-learn}. If the executable is not in your 7699environmental variable @env{PATH}, you should set this by full path. 7700 7701@item elmo-spam-spamassassin-program-arguments 7702@vindex elmo-spam-spamassassin-program-arguments 7703The initial setting is @code{'("-e")}. 7704Specify the arguments to be supplied for @command{spamassassin} executable. 7705You have to specify the argument to exit the program with an error exit code 7706when the result is spam. For example, if you want to use @command{spamc} 7707 instead of @command{spamassassin}, you should specify @code{'("-c")}. 7708 7709@item elmo-spam-spamassassin-learn-program-arguments 7710@vindex elmo-spam-spamassassin-lern-program-arguments 7711The initial setting is @code{nil}. 7712Specify the arguments to be supplied for @command{sa-learn}. 7713 7714@item elmo-spamassassin-debug 7715@vindex elmo-spamassassin-debug 7716The initial setting is @code{nil}. 7717If you specify @code{t}, the output from @command{spamassassin} is 7718stored in the buffer named @code{"*Debug ELMO SpamAssassin*"}. 7719 7720@end table 7721 7722@node SpamOracle, Regular Expressions Header Matching, SpamAssassin, Spam Filter Processors 7723@subsection SpamOracle 7724@cindex SpamOracle 7725 7726SpamOracle (@uref{http://pauillac.inria.fr/~xleroy/software.html#spamoracle}) 7727is a spam filter implemented by Objective Caml language. 7728 7729To use spam filter with @file{spamoracle}, write following setting in 7730@file{~/.wl} or somewhere else. 7731(Of course, you have to install SpamOracle beforehand.) 7732 7733@lisp 7734@group 7735(setq elmo-spam-scheme 'spamoracle) 7736@end group 7737@end lisp 7738 7739@subsubsection Customizable Variables 7740 7741@table @code 7742@item elmo-spam-spamoracle-program 7743@vindex elmo-spam-spamoracle-program 7744The initial setting is @file{spamoracle}. Specify the name of 7745executable of spamoracle. If the executable is not in your 7746environmental variable @env{PATH}, you should set this by full path. 7747 7748@item elmo-spam-spamoracle-config-filename 7749@vindex elmo-spam-spamoracle-config-filename 7750Specify the name of config file. @code{nil} to use default file 7751(@file{~/.spamoracle.conf}). The initial setting is @code{nil}. 7752 7753@item elmo-spam-spamoracle-database-filename 7754@vindex elmo-spam-spamoracle-database-filename 7755The initial setting is @file{~/.elmo/.spamoracle.db}. 7756It specifies the name of database file. 7757 7758@item elmo-spam-spamoracle-spam-header-regexp 7759@vindex elmo-spam-spamoracle-spam-header-regexp 7760The initial setting is @code{"^X-Spam: yes;"}. It specifies the regular 7761expression of the header that indicates spam mail. Use this setting 7762when you change the @code{spam_header} parameter in the config file. 7763 7764@end table 7765 7766@node Regular Expressions Header Matching, , SpamOracle, Spam Filter Processors 7767@subsection Regular Expressions Header Matching 7768@cindex Regular Expressions Header Matching 7769 7770Examine if regular expression matches corresponding field in message heaeder, 7771and decide spam or not. To use this backend, add following setting to @file{~/.wl}. 7772 7773@lisp 7774@group 7775(setq elmo-spam-scheme 'header) 7776@end group 7777@end lisp 7778 7779If you want to check fields not included in the default overview 7780information, add one into @code{elmo-msgdb-extra-fields}. Then it will 7781do examination by the overview information and avoid loading whole 7782message body as far as possible. 7783 7784@subsubsection Customize Variables 7785 7786@table @code 7787@item elmo-spam-header-good-alist 7788@vindex elmo-spam-header-good-alist 7789The initial setting is the following list: 7790 7791@lisp 7792'(("X-Spam-Flag" . "No")) 7793@end lisp 7794 7795Specify a list of regular expressions to match with header field name 7796for making non-spam decision. It takes precedence over 7797@code{elmo-spam-header-spam-alist}. 7798 7799@item elmo-spam-header-spam-alist 7800@vindex elmo-spam-header-spam-alist 7801The initial setting is the following list: 7802 7803@lisp 7804'(("X-Spam-Flag" . "Yes")) 7805@end lisp 7806 7807Specify a list of regular expressions to match with header field name 7808for making spam decision. 7809@end table 7810 7811 7812@node Advanced Issues, Migration, Spam Filter, Top 7813@chapter Advanced Issues 7814@cindex Advanced Issues 7815 7816@menu 7817* Living with other packages:: Cooperating with other packages 7818* Highlights:: Highlights 7819* Biff:: Notify Mail arrival 7820* Password Management:: Manage Passwords 7821* Split messages:: Splitting messages 7822* Batch Processing:: Invoke commands in batch mode 7823* Advanced Settings:: Advanced Settings 7824* Customizable Variables:: Customizable Variables 7825* Hooks:: Hooks 7826@end menu 7827 7828 7829@node Living with other packages, Highlights, Advanced Issues, Advanced Issues 7830@section Living with other packages 7831 7832Examples with other packages. 7833 7834@menu 7835* imput:: imput (im-wl.el) 7836* BBDB:: The Insidious Big Brother Database 7837* LSDB:: The Lovely Sister Database 7838* supercite:: supercite.el 7839* mu-cite:: mu-cite.el 7840* X-Face:: x-face,bitmap-mule 7841* dired-dd:: dired-dd.el 7842* MHC:: MHC 7843* Addrbook:: Addrbook 7844* mime-w3m:: mime-w3m.el 7845@end menu 7846 7847 7848@node imput, BBDB, Living with other packages, Living with other packages 7849@subsection imput 7850@pindex imput 7851@cindex im-wl 7852 7853Place @file{util/im-wl.el} on the @code{load-path} and do the following 7854settings. 7855 7856@lisp 7857@group 7858(autoload 'wl-draft-send-with-imput-async "im-wl") 7859(setq wl-draft-send-function 'wl-draft-send-with-imput-async) 7860@end group 7861@end lisp 7862 7863 7864@node BBDB, LSDB, imput, Living with other packages 7865@subsection bbdb.el 7866@pindex BBDB 7867 7868The Insidious Big Brother Database (@uref{http://savannah.nongnu.org/projects/bbdb/}) supports Wanderlust since 3.2. 7869Please ask details of setings to mailing list of Wanderlust of BBDB. 7870@xref{Mailing List}. 7871 7872 7873@node LSDB, supercite, BBDB, Living with other packages 7874@subsection lsdb.el 7875@pindex LSDB 7876 7877The following is an example setting to use 7878The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/}) 7879with Wanderlust. 7880 7881@lisp 7882@group 7883(require 'lsdb) 7884(lsdb-wl-insinuate) 7885(add-hook 'wl-draft-mode-hook 7886 (lambda () 7887 (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name))) 7888@end group 7889@end lisp 7890 7891In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name} 7892(complete address with LSDB). 7893 7894 7895@node supercite, mu-cite, LSDB, Living with other packages 7896@subsection sc.el(supercite), sc-register.el 7897@pindex sc 7898@pindex supercite 7899 7900The same setting as usual mailers should be OK. The following is an 7901example of settings: 7902 7903@lisp 7904@group 7905(autoload 'sc-cite-original "supercite" nil t) 7906(add-hook 'mail-citation-hook 'sc-cite-original) 7907@end group 7908@end lisp 7909 7910 7911@node mu-cite, X-Face, supercite, Living with other packages 7912@subsection mu-cite.el 7913@pindex mu-cite 7914 7915The same setting as usual mailers should be OK. The following is an 7916example of settings. 7917 7918@lisp 7919@group 7920(autoload 'mu-cite-original "mu-cite" nil t) 7921(add-hook 'mail-citation-hook (function mu-cite-original)) 7922@end group 7923@end lisp 7924 7925@node X-Face, dired-dd, mu-cite, Living with other packages 7926@subsection x-face 7927@pindex x-face 7928 7929If you have installed one of the following, you can decode 7930@samp{X-Face:} field in message buffer and you will see face image. 7931 7932@menu 7933* x-face-mule:: Emacs case 7934@end menu 7935 7936If there is an encoded X-Face string in a file @file{~/.xface} (the 7937value of the variable @code{wl-x-face-file}), it is inserted as a 7938@samp{X-Face:} field in the draft buffer (if 7939@code{wl-auto-insert-x-face} is non-nil). 7940 7941@node x-face-mule, , X-Face, X-Face 7942@subsubsection x-face-mule 7943@pindex x-face-mule 7944@pindex bitmap-mule 7945 7946If you use @file{x-face-mule.el} in bitmap-mule 7947(@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following: 7948 7949@lisp 7950@group 7951(autoload 'x-face-decode-message-header "x-face-mule") 7952(setq wl-highlight-x-face-function 'x-face-decode-message-header) 7953@end group 7954@end lisp 7955 7956@subsubsection x-face-e21 7957@pindex x-face-e21 7958 7959You can use @file{x-face-e21.el} 7960(@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el} 7961to display X-Face. In this case, bitmap-mule is not required. 7962Do as follows: 7963 7964@lisp 7965@group 7966(autoload 'x-face-decode-message-header "x-face-e21") 7967(setq wl-highlight-x-face-function 'x-face-decode-message-header) 7968@end group 7969@end lisp 7970 7971 7972@node dired-dd, MHC, X-Face, Living with other packages 7973@subsection dired-dd(Dired-DragDrop) 7974@pindex Dired-DragDrop 7975@pindex Dired-DD 7976@cindex Drag and Drop 7977 7978If you embed @file{dired-dd-mime.el} in the dired-dd package, you can 7979compose multi-part by simple Drag-and-Drop from dired to the draft 7980buffer being edited in GNU Emacs (this feature is not Wanderlust 7981specific, but general-purpose for SEMI). 7982 7983@lisp 7984@group 7985;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html 7986(add-hook 7987 'dired-load-hook 7988 (function 7989 (lambda () 7990 (load "dired-x") 7991 ;; @r{Set dired-x variables here.} 7992 ;; @r{To and flo@dots{}} 7993 (if window-system 7994 (progn (require 'dired-dd) 7995 (require 'dired-dd-mime)))))) 7996@end group 7997@end lisp 7998 7999@node MHC, Addrbook, dired-dd, Living with other packages 8000@subsection mhc.el 8001@pindex MHC 8002 8003Message Harmonized Calendaring system 8004(@uref{http://www.quickhack.net/mhc/}) 8005 8006By using MHC, you can make a calendar from the messages. 8007 8008For mhc-0.25: 8009 8010@lisp 8011@group 8012(setq mhc-mailer-package 'wl) 8013(autoload 'mhc-mode "mhc" nil t) 8014(add-hook 'wl-summary-mode-hook 'mhc-mode) 8015(add-hook 'wl-folder-mode-hook 'mhc-mode) 8016@end group 8017@end lisp 8018 8019For mhc-current: 8020 8021@lisp 8022@group 8023(autoload 'mhc-wl-setup "mhc-wl") 8024(add-hook 'wl-init-hook 'mhc-wl-setup) 8025@end group 8026@end lisp 8027 8028@node Addrbook, mime-w3m, MHC, Living with other packages 8029@subsection wl-addrbook.el 8030@pindex Addrbook 8031 8032Addrbook of Mew 8033(@uref{http://www.mew.org/}) 8034 8035Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the 8036@code{load-path} and do the following settings. 8037 8038@lisp 8039@group 8040(require 'wl-addrbook) 8041(wl-addrbook-setup) 8042@end group 8043@end lisp 8044 8045@node mime-w3m, , Addrbook, Living with other packages 8046@subsection mime-w3m.el 8047@pindex mime-w3m 8048 8049You can display html part by using @file{mime-w3m.el} 8050distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}). 8051You can find the usage in comment region at the head of @file{mime-w3m.el}. 8052If you use SEMI-EPG, no additional setting is needed. 8053 8054 8055@node Highlights, Biff, Living with other packages, Advanced Issues 8056@section Highlights 8057 8058@subsection Customizable Variables 8059 8060@table @code 8061@item wl-summary-highlight 8062@vindex wl-summary-highlight 8063The initial setting is @code{t}. 8064If non-nil, the summary is highlighted. 8065 8066@item wl-highlight-max-summary-lines 8067@vindex wl-highlight-max-summary-lines 8068The initial setting is 10000. 8069The summary is not highlighted if it has more lines than this value. 8070 8071@item wl-summary-highlight-partial-threshold 8072@vindex wl-summary-highlight-partial-threshold 8073The initial setting is 1000. 8074This is a threshold whether the whole summary is highlighted. 8075If there are more lines of messages in the summary, it is partially 8076highlighted. 8077 8078@item wl-summary-partial-highlight-above-lines 8079@vindex wl-summary-partial-highlight-above-lines 8080The initial setting is 30. If there are more lines of messages than 8081@code{wl-summary-highlight-partial-threshold} in the summary, messages 8082after the point that is the same number of lines as this value above the 8083cursor line are highlighted partially. (If this value is @code{nil}, 8084the last same number of lines as the value of 8085@code{wl-summary-highlight-partial-threshold} are highlighted.) 8086 8087@item wl-highlight-body-too 8088@vindex wl-highlight-body-too 8089The initial setting is @code{t}. 8090If non-nil, bodies of drafts and messages are also highlighted. 8091 8092@item wl-highlight-message-header-alist 8093@vindex wl-highlight-message-header-alist 8094When highlighting headers of drafts and messages, this variable 8095specifies which faces are allocated to important 8096(@code{wl-highlight-message-important-header-contents}), secondly 8097important (@code{wl-highlight-message-important-header-contents2}), and 8098unimportant (@code{wl-highlight-message-unimportant-header-contents}) 8099message headers. 8100Similarly, it can be used for allocating arbitrary faces to arbitrary 8101regular expressions. 8102 8103@item wl-highlight-citation-prefix-regexp 8104@vindex wl-highlight-citation-prefix-regexp 8105Specifies a regular expression to which quoted lines in bodies of 8106drafts and messages match. 8107Bodies matching to this regular expression are highlighted by the faces 8108specified by (@code{wl-highlight-message-cited-text-*}). 8109 8110@item wl-highlight-highlight-citation-too 8111@vindex wl-highlight-highlight-citation-too 8112The initial setting is @code{nil}. 8113If non-nil, the quoting regular expression itself given by 8114@code{wl-highlight-citation-prefix-regexp} is also highlighted. 8115 8116@item wl-highlight-citation-header-regexp 8117@vindex wl-highlight-citation-header-regexp 8118Specifies a regular expression that denotes beginning of quotation. 8119Bodies matching to this regular expression are highlighted by the face 8120specified by @code{wl-highlight-message-headers}. 8121 8122@item wl-highlight-max-header-size 8123@vindex wl-highlight-max-header-size 8124The initial setting is @code{nil}. If a header size is larger than this 8125value, it will not be highlighted. If @code{nil}, always highlighted 8126(ignore header size). 8127 8128@item wl-highlight-max-message-size 8129@vindex wl-highlight-max-message-size 8130The initial setting is 10000. 8131If a message is larger than this value, it will not be highlighted. 8132With this variable, highlight is suppressed for uuencode or huge digest 8133messages. 8134 8135@item wl-highlight-signature-separator 8136@vindex wl-highlight-signature-separator 8137Specifies regular expressions that denotes the boundary of a signature. 8138It can be a regular expression, or a list of ones. 8139Messages after the place that matches this regular expression are 8140highlighted by the face specified by 8141@code{wl-highlight-message-signature}. 8142 8143@item wl-max-signature-size 8144@vindex wl-max-signature-size 8145The initial setting is 400. 8146This is the largest size for a signature to be highlighted. 8147 8148@item wl-use-highlight-mouse-line 8149@vindex wl-use-highlight-mouse-line 8150The initial setting is @code{t}. 8151If non-nil, the line pointed by the mouse is highlighted in the folder 8152mode, summary mode, and the like. 8153@end table 8154 8155@subsection Setting Colors and Fonts of the Characters 8156 8157If you want to change colors or fonts of the characters, you need to 8158modify faces defined in Wanderlust. Use @code{set-face-font} if you 8159want to change fonts, and @code{set-face-foreground} for colors, and so 8160on. You cannot write face settings in @file{.emacs}; write in 8161@file{~/.wl}. 8162 8163For example, if you want to change the color for signatures to yellow, 8164write 8165 8166@lisp 8167(set-face-foreground 'wl-highlight-message-signature "yellow") 8168@end lisp 8169 8170@noindent 8171in @file{~/.wl}. 8172 8173Faces defined in Wanderlust: 8174 8175@table @code 8176@item wl-highlight-message-headers 8177The face for field names of message headers. 8178 8179@item wl-highlight-message-header-contents 8180The face for field bodies of message headers. 8181 8182@item wl-highlight-message-important-header-contents 8183The face for important parts of message headers. 8184Per default, this face is used for a body of @samp{Subject:} field. 8185You can change its value by editing 8186@code{wl-highlight-message-header-alist}. 8187 8188@item wl-highlight-message-important-header-contents2 8189The face for secondly important parts of message headers. 8190Per default, this face is used for bodies of @samp{From:} and @samp{To:} 8191fields. You can change its value by editing 8192@code{wl-highlight-message-header-alist}. 8193 8194@item wl-highlight-message-unimportant-header-contents 8195The face for unimportant parts of message headers. 8196Per default, this face is used for bodies of @samp{X-} fields 8197@samp{User-Agent:} fields. You can change its value by editing 8198@code{wl-highlight-message-header-alist}. 8199 8200@item wl-highlight-message-citation-header 8201The face for headers of quoted messages. 8202 8203@item wl-highlight-message-cited-text-* 8204The face for texts of quoted messages. The last @samp{*} is a 8205@var{single figure} so that 10 different colors can be used according to 8206citation levels. 8207 8208@item wl-highlight-message-signature 8209The face for signatures of messages. The initial settings are 8210@samp{khaki} for light background colors, and @samp{DarkSlateBlue} for 8211dark background colors. 8212 8213@item wl-highlight-header-separator-face 8214The face for header separators of draft messages. 8215 8216@item wl-highlight-summary-important-face 8217The face for message lines with important marks in the summary. 8218 8219@item wl-highlight-summary-new-face 8220The face for message lines with new marks in the summary. 8221 8222@item wl-highlight-summary-displaying-face 8223The face for the message line that is currently displayed. 8224This face is overlaid. 8225 8226@item wl-highlight-thread-indent-face 8227The face for the threads that is currently displayed. 8228 8229@item wl-highlight-summary-unread-face 8230The face for message lines with unread marks in the summary. 8231 8232@item wl-highlight-summary-deleted-face 8233The face for message lines with delete marks in the summary. 8234 8235@item wl-highlight-summary-refiled-face 8236The face for message lines with re-file marks in the summary. 8237 8238@item wl-highlight-refile-destination-face 8239The face for re-file information part of message lines with re-file 8240marks in the summary. 8241 8242@item wl-highlight-summary-copied-face 8243The face for message lines with copy marks in the summary. 8244 8245@item wl-highlight-summary-target-face 8246The face for message lines with target marks @samp{*} in the summary. 8247 8248@item wl-highlight-summary-thread-top-face 8249The face for message lines that are on the top of the thread in the 8250summary. 8251 8252@item wl-highlight-summary-normal-face 8253The face for message lines that are not on top of the thread in the 8254summary. 8255 8256@item wl-highlight-folder-unknown-face 8257The face for folders that are not known to have how many unsync messages 8258in the folder mode. 8259 8260@item wl-highlight-folder-zero-face 8261The face for folders that have no unsync messages in the folder mode. 8262 8263@item wl-highlight-folder-few-face 8264The face for folders that have some unsync messages in the folder mode. 8265 8266@item wl-highlight-folder-many-face 8267The face for folders that have many unsync messages in the folder mode. 8268The boundary between `some' and `many' is specified by the variable 8269@code{wl-folder-many-unsync-threshold}. 8270 8271@item wl-highlight-folder-unread-face 8272The face for folders that have no unsync but unread messages in the 8273folder mode. 8274 8275@item wl-highlight-folder-killed-face 8276The face for folders that are deleted from the access group in the 8277folder mode. 8278 8279@item wl-highlight-folder-opened-face 8280The face for open groups in the folder mode. 8281It is meaningful when @code{wl-highlight-folder-by-numbers} is 8282@code{nil} or a @var{number}. 8283 8284@item wl-highlight-folder-closed-face 8285The face for close groups in the folder mode. 8286It is meaningful when @code{wl-highlight-folder-by-numbers} is 8287@code{nil} or a @var{number}. 8288 8289@item wl-highlight-folder-path-face 8290The face for the path to the currently selected folder in the folder 8291mode. 8292 8293@item wl-highlight-logo-face 8294The face for logo in the demo. 8295 8296@item wl-highlight-demo-face 8297The face for strings (for example, a version number) in the demo. 8298@end table 8299 8300 8301@node Biff, Password Management, Highlights, Advanced Issues 8302@section Notify Mail arrival 8303@cindex Biff 8304 8305Following setting is to notify mail arrival of @samp{%inbox} 8306by the indicator on the modeline 8307 8308@lisp 8309(setq wl-biff-check-folder-list '("%inbox")) 8310@end lisp 8311 8312@subsection Customizable Variables 8313@table @code 8314@item wl-biff-check-folder-list 8315@vindex wl-biff-check-folder-list 8316The initial setting is @code{nil}. 8317This is the list of folders to check mail arrival. 8318If @code{nil}, wl doesn't check mail arrival. 8319 8320@item wl-biff-check-interval 8321@vindex wl-biff-check-interval 8322The initial setting is 40 (in seconds). 8323Check mail arrival in this period. 8324 8325@item wl-biff-check-delay 8326@vindex wl-biff-check-delay 8327The initial setting is 0 (in seconds). 8328Check mail when the time spcified by @code{wl-biff-check-interval} has 8329passed and idling time exceeds specified seconds by this variable. 8330 8331@item wl-biff-use-idle-timer 8332@vindex wl-biff-use-idle-timer 8333The initial setting is @code{nil}. 8334If it is @code{nil}, check mail arrival when the time specified by 8335@code{wl-biff-check-interval} has passed. If it is non-nil, check 8336mail arrival when idling time exceeds @code{wl-biff-check-interval}. 8337 8338@item wl-biff-notify-hook 8339@vindex wl-biff-notify-hook 8340This hook is run at the arrival of new mail. 8341To beep with mail arrival (initial setting), set as follows. 8342@lisp 8343(setq wl-biff-notify-hook '(ding)) 8344@end lisp 8345For silence, set to @code{nil}. 8346 8347@item wl-biff-unnotify-hook 8348@vindex wl-biff-unnotify-hook 8349This hook is run if there were new mails at the last check and there is 8350no new mail at the current check. 8351@end table 8352 8353 8354@node Password Management, Split messages, Biff, Advanced Issues 8355@section Manage Passwords 8356 8357If you input passwords to connect servers, they are stored in the 8358variable @code{elmo-passwd-storage} per connection. You should be careful 8359that others might read your passwords if they can touch your Emacs, 8360since encoded plain passwords are there. 8361 8362@findex elmo-passwd-alist-clear 8363@findex elmo-passwd-alist-save 8364If you invoke @kbd{M-x elmo-passwd-alist-save} while you have stored 8365passwords, then they are saved on the file, and it will save you to 8366input passwords. In this case, the risk that someone reads your 8367keystroke might decrease, but please note that plain passwords are 8368stored on a file. You should treat them very carefully. 8369To remove saved passwords on file, invoke @kbd{M-x elmo-passwd-alist-clear} 8370and then @kbd{M-x elmo-passwd-alist-save}. 8371 8372@table @code 8373@item elmo-passwd-alist-file-name 8374@vindex elmo-passwd-alist-file-name 8375The initial setting is @file{passwd}. 8376This is the name of the file in which passwords are saved. 8377@code{elmo-passwd-alist-save} saves current passwords to the file. 8378 8379@item elmo-passwd-life-time 8380@vindex elmo-passwd-life-time 8381The initial setting is @code{nil}. 8382If the value is some number, timer is set to remove password entry after 8383@code{elmo-passwd-life-time} seconds since you input the password. 8384@code{nil} means never to remove passwords. 8385@end table 8386 8387@menu 8388* Auth-source:: Using auth-source for password managament 8389@end menu 8390 8391 8392@node Auth-source, , Password Management, Password Management 8393@subsection Using auth-source for password managament 8394@cindex auth-source 8395 8396@vindex elmo-passwd-storage-type 8397If you write as @code{(setq elmo-passwd-storage-type 'auth-source)} in 8398your @file{~/.wl}, you can use auth-source (@pxref{Top, , ,auth, Emacs 8399auth-source}) for password management. 8400 8401 8402@subsubsection Limitations of using auth-source 8403 8404Thre are some limitations for auth-source. 8405 8406@itemize @bullet 8407@item password is not distinguished by protocol name nor authentication 8408mechanism. 8409@item If you have multiple accounts on the one host, 8410you have to prepare password entry before use. 8411In such case, you can't input password interactively. 8412It is due to auth-sources's bug and fixed in Emacs 28. 8413@end itemize 8414 8415@node Split messages, Batch Processing, Password Management, Advanced Issues 8416@section Message splitting 8417@cindex Split messages 8418 8419You can use @code{elmo-split} to split message in folder specified by 8420the variable @code{elmo-split-folder} a la @command{procmail} according 8421to some specified rules. To use this feature, set as follows in your 8422@file{~/.emacs} at first. 8423 8424@lisp 8425(autoload 'elmo-split "elmo-split" "Split messages on the folder." t) 8426@end lisp 8427 8428Set source folder like following. 8429 8430@lisp 8431(setq elmo-split-folder "%inbox") 8432@end lisp 8433 8434And specify the rule in the variable @code{elmo-split-rule} (its format 8435will be is described below). 8436Then you can invoke @kbd{M-x elmo-split} to split messages according to 8437@code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split} 8438to do a rehearsal and show result (do not split actually). 8439 8440 8441We will describe how to specify the rule. First of all, see following 8442example, please. 8443 8444@lisp 8445@group 8446(setq elmo-split-rule 8447 ;; @r{Store messages from spammers into @samp{+junk}} 8448 '(((or (address-equal from "i.am@@spammer") 8449 (address-equal from "dull-work@@dull-boy") 8450 (address-equal from "death-march@@software") 8451 (address-equal from "ares@@aon.at") 8452 (address-equal from "get-money@@richman")) 8453 "+junk") 8454 ;; @r{Store messages from mule mailing list into @samp{%mule}} 8455 ((equal x-ml-name "mule") "%mule") 8456 ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}} 8457 ;; @r{and continue evaluating following rules} 8458 ((equal x-ml-name "wanderlust") "%wanderlust" continue) 8459 ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}} 8460 ((match from "\\(.*\\)@@yahoo\\.com") 8461 "+yahoo-\\1") 8462 ;; @r{Store unmatched mails into @samp{+inbox}} 8463 (t "+inbox"))) 8464@end group 8465@end lisp 8466 8467The basic unit of the rule is a combination like 8468 8469@lisp 8470(@samp{CONDITION} @samp{ACTION} [@code{continue}]) 8471@end lisp 8472 8473If @samp{CONDITION} is true, @samp{ACTION} is performed. 8474The 1st element @samp{CONDITION} is a condition represented by a 8475balanced expression (sexp). Its grammar will be explained below. 8476The 2nd element @samp{ACTION} is the name of the folder to split 8477messages into, or a symbol. When the 3rd element @code{continue} is 8478specified as symbol, evaluating rules is not stopped even when the 8479condition is satisfied. 8480 8481The grammar for @samp{CONDITION} is as follows. See example above to 8482learn how to write the condition practically. 8483 8484@enumerate 8485@item 8486Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}. 8487(@samp{FIELD-NAME} is a symbol that describes the field name) 8488 8489@table @code 8490@item @code{equal} 8491True if the field value equals to @samp{VALUE}. 8492Case of the letters are ignored. 8493@item @code{match} 8494True if the field value matches to VALUE. 8495@samp{VALUE} can contain @code{\&} and @code{\N} which will substitute 8496from matching @code{\(\)} patterns in the previous @samp{VALUE}. 8497@item @code{address-equal} 8498True if one of the addresses in the field equals to 8499@samp{VALUE}. Case of the letters are ignored. 8500@item @code{address-match} 8501True if one of the addresses in the field matches to 8502@samp{VALUE}. 8503@samp{VALUE} can contain @code{\&} and @code{\N} which will substitute 8504from matching @code{\(\)} patterns in the previous @samp{VALUE}. 8505@end table 8506 8507@item 8508Functions which accept an integer argument (@samp{SIZE}). 8509 8510@table @code 8511@item @code{<} 8512True if the size of the message is less than @samp{SIZE}. 8513@item @code{>} 8514True if the size of the message is greater than @samp{SIZE}. 8515@end table 8516 8517@item 8518Functions which accept any number of arguments. 8519 8520@table @code 8521@item @code{or} 8522True if one of the argument returns true. 8523@item @code{and} 8524True if all of the arguments return true. 8525@end table 8526 8527@item 8528A symbol. 8529 8530When a symbol is specified, it is evaluated. 8531@end enumerate 8532 8533You can specify followings as 2nd @samp{ACTION}. 8534 8535@enumerate 8536@item 8537folder name 8538 8539If some string is specified, it will be regarded as the destination 8540folder, and the message will be appended to it. 8541 8542@item 8543@samp{delete} 8544 8545If the symbol @samp{delete} is specified, delete the substance of the 8546message in @code{elmo-split-folder} 8547 8548@item 8549@samp{noop} 8550 8551If the symbol @samp{noop} is specified, do nothing on the message and 8552keep it as it is. 8553 8554@item 8555function 8556 8557If some function is specified, execute it. 8558@end enumerate 8559 8560If the message passes all rules, it will be dealed along @samp{ACTION} 8561specified by @code{elmo-split-default-action}. 8562 8563 8564@node Batch Processing, Advanced Settings, Split messages, Advanced Issues 8565@section Batch Processing 8566@cindex Batch Processing 8567 8568You can request wanderlust to do some job on the command line. 8569For now, you can invoke prefetching new messages in specified folders. 8570 8571Specify target folders in @code{wl-batch-prefetch-folder-list} then 8572invoke as follows to execute prefetching: 8573 8574@example 8575@group 8576% emacs -batch -l wl-batch -f wl-batch-prefetch 8577@end group 8578@end example 8579 8580@subsection Customize Variables 8581 8582@table @code 8583@item wl-batch-prefetch-folder-list 8584@vindex wl-batch-prefetch-folder-list 8585Target folders of prefetching by @code{wl-batch-prefetch}, specified as 8586a list of folder names. 8587@end table 8588 8589 8590@node Advanced Settings, Customizable Variables, Batch Processing, Advanced Issues 8591@section Advanced Settings 8592 8593@menu 8594* Draft for Reply:: Draft for Reply 8595* Thread Format:: Appearance of Thread 8596* User-Agent Field:: @samp{User-Agent:} Header Field 8597@end menu 8598 8599 8600@node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings 8601@subsection Draft for Replay 8602@vindex wl-draft-reply-with-argument-list 8603@vindex wl-draft-reply-without-argument-list 8604 8605If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared. 8606The addressee for the draft is decided by following rules. 8607 8608For example, you can set as follows: 8609 8610@lisp 8611@group 8612(setq wl-draft-reply-without-argument-list 8613 '(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups"))) 8614 ("Followup-To" . (nil nil ("Followup-To"))) 8615 (("X-ML-Name" "Reply-To") . (("Reply-To") nil nil)) 8616 ("From" . (("From") ("To" "Cc") ("Newsgroups"))))) 8617@end group 8618@end lisp 8619 8620Where each element of the list @code{wl-draft-reply-without-argument-list} 8621is in the form 8622 8623@example 8624(key . (to-list cc-list newsgroup-list)) 8625@end example 8626 8627and if the field designated by @samp{key} exist in the parent message, 8628parent's field values designated by @samp{to-list} are copied to @samp{To:} 8629in the draft. Similarly, parent's fields designated by @samp{cc-list} and 8630@samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in 8631the draft respectively. 8632 8633Examples: 8634 8635@lisp 8636("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups"))) 8637@end lisp 8638 8639Match if the parent has @samp{Mail-Followup-To} field. 8640The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups} 8641fields are copied to @samp{To} and @samp{Newsgroups} in the draft 8642respectively. 8643 8644@lisp 8645(("X-ML-Name" "Reply-To") . (("Reply-To") nil nil)) 8646@end lisp 8647 8648Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields. 8649Parent's @samp{Reply-To} is copied to @samp{To} in the draft. 8650 8651@lisp 8652("From" . (("From") ("To" "Cc") ("Newsgroups"))) 8653@end lisp 8654 8655Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and 8656@samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups} 8657respectively. 8658 8659These are evaluated in order and first matched one is used. 8660 8661Moreover, the behavior of @kbd{a} with prefix argument can 8662be directed by @code{wl-draft-reply-with-argument-list} as well. 8663 8664 8665By the way, you can use some function (will be evaluated in the parent 8666message buffer) in the place of @samp{key} or @samp{to-list} etc. 8667 8668If you want to write a rule for replying to message written by yourself, 8669specify function @code{wl-draft-self-reply-p} as @samp{key}. 8670 8671If you only want to reply to mailing lists in 8672@code{wl-subscribed-mailing-list} if the parent has some of them, 8673set as follows: 8674 8675@lisp 8676@group 8677(defun wl-mailing-list-addresses () 8678 (let (list-addrs) 8679 (dolist (to (mapcar 8680 (lambda (addr) 8681 (nth 1 (std11-extract-address-components addr))) 8682 (wl-parse-addresses 8683 (wl-concat-list 8684 (elmo-multiple-fields-body-list (list "To" "Cc")) 8685 ",")))) 8686 (when (elmo-string-matched-member to wl-subscribed-mailing-list t) 8687 (setq list-addrs (cons to list-addrs)))) 8688 (nreverse list-addrs))) 8689 8690(setq wl-draft-reply-with-argument-list 8691 '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil)) 8692 ("Reply-To" . (("Reply-To") nil nil)) 8693 ("Mail-Reply-To" . (("Mail-Reply-To") nil nil)) 8694 ("From" . (("From") nil nil)))) 8695@end group 8696@end lisp 8697 8698 8699@node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings 8700@subsection Appearance of Threads 8701 8702@example 8703@group 8704 389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3 8705 390 09/18(Fri)07:25 +-[ Tsumura-san ] 8706 391 09/18(Fri)19:24 +-[ Murata-san ] 8707 392 09/20(Sun)21:49 +-[ Okunishi-san ] 8708 396 09/20(Sun)22:11 | +-[ Tsumura-san ] 8709 398 09/21(Mon)00:17 | +-[ Tsumura-san ] 8710 408 09/21(Mon)22:37 | +-[ Okunishi-san ] 8711 411 09/22(Tue)01:34 | +-[ Tsumura-san ] 8712 412 09/22(Tue)09:28 | +-[ Teranishi ] 8713 415 09/22(Tue)11:52 | +-[ Tsumura-san ] 8714 416 09/22(Tue)12:38 | +-[ Teranishi ] 8715 395 09/20(Sun)21:49 +-[ Okunishi-san ] 8716 397 09/21(Mon)00:15 +-[ Okunishi-san ] 8717@end group 8718@end example 8719 8720Settings to make appearance of threads like shown above: 8721 8722@lisp 8723@group 8724(setq wl-thread-indent-level 2) 8725(setq wl-thread-have-younger-brother-str "+") 8726(setq wl-thread-youngest-child-str "+") 8727(setq wl-thread-vertical-str "|") 8728(setq wl-thread-horizontal-str "-") 8729(setq wl-thread-space-str " ") 8730@end group 8731@end lisp 8732 8733If you do not want to see branches, do the following: 8734 8735@lisp 8736@group 8737(setq wl-thread-indent-level 2) 8738(setq wl-thread-have-younger-brother-str " ") 8739(setq wl-thread-youngest-child-str " ") 8740(setq wl-thread-vertical-str " ") 8741(setq wl-thread-horizontal-str " ") 8742(setq wl-thread-space-str " ") 8743@end group 8744@end lisp 8745 8746 8747@node User-Agent Field, , Thread Format, Advanced Settings 8748@subsection User-Agent Field 8749@cindex X-Mailer 8750@cindex User-Agent 8751 8752If you are eccentric enough to elaborate @samp{X-Mailer:} or 8753@samp{User-Agent:} fields, define a function that generate appropriate 8754strings as you like, and set it to variable 8755@code{wl-generate-mailer-string-function}. 8756 8757If you do not want verbose @samp{User-Agent:} field, do the following: 8758 8759@lisp 8760@group 8761(setq wl-generate-mailer-string-function 8762 'wl-generate-user-agent-string-1) 8763@end group 8764@end lisp 8765 8766The following is a example: 8767 8768@lisp 8769@group 8770(setq wl-generate-mailer-string-function nil) 8771(setq wl-draft-additional-header-alist 8772 (list 8773 (cons 'X-Mailer (lambda () (product-string-1 'wl-version))))) 8774@end group 8775@end lisp 8776 8777 8778@node Customizable Variables, Hooks, Advanced Settings, Advanced Issues 8779@section Customizable Variables 8780 8781Customizable variables that have not been described yet: 8782 8783@table @code 8784@item wl-default-folder 8785@vindex wl-default-folder 8786The initial setting is @samp{%inbox}. This is the default value for moving to 8787a folder and the like. 8788 8789@item wl-draft-folder 8790@vindex wl-draft-folder 8791The initial setting is @samp{+draft}. It is the folder to which drafts are 8792saved. It must be a writable folder. 8793You can set IMAP remote folder, Maildir and so on. 8794Note that variable settings applied by @code{wl-draft-config-exec} is saved 8795under @code{elmo-msgdb-directory}. That is to say, if you specified remote 8796folder as @code{wl-draft-folder}, variable settings which are applied by 8797@code{wl-draft-config-exec} before saving the draft will not affect on the 8798draft buffer on another host by invoking @code{wl-summary-reedit}. 8799 8800@item wl-trash-folder 8801@vindex wl-trash-folder 8802The initial setting is @samp{+trash}. It is the wastebasket folder. 8803If you changed this variable, you had better restart Wanderlust. 8804 8805@item wl-interactive-exit 8806@vindex wl-interactive-exit 8807The initial setting is @code{t}. 8808If non-nil, you are asked for confirmation when Wanderlust terminates. 8809 8810@item wl-interactive-send 8811@vindex wl-interactive-send 8812The initial setting is @code{t}. 8813If non-nil, you are asked for confirmation when mail is sent. 8814 8815@item wl-default-sync-range 8816@vindex wl-default-sync-range 8817The initial setting is @samp{update}. 8818Default update range of the summary. You can specify 8819@samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}. 8820See description of @code{wl-summary-sync} for the meaning of ranges. 8821 8822@item wl-folder-sync-range-alist 8823@vindex wl-folder-sync-range-alist 8824The initial setting is the alist shown below: 8825 8826@lisp 8827@group 8828(("^&.*$" . "all") 8829 ("^\\+draft$\\|^\\+queue$" . "all")) 8830@end group 8831@end lisp 8832 8833@noindent 8834This is an associative list of regular expressions of folder names and 8835update range of the summary. Update range is one of the @samp{all}, 8836@samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not 8837match any of them, the value of @code{wl-default-sync-range} is used 8838(@samp{update} by default). 8839See description of @code{wl-summary-sync} for the meaning of ranges. 8840 8841@item wl-ask-range 8842@vindex wl-ask-range 8843The initial setting is @code{t}. 8844If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used 8845for updating the summary when you changed folders. 8846 8847@item wl-mime-charset 8848@vindex wl-mime-charset 8849The initial setting is @code{x-ctext}. 8850This is the MIME charset for messages that are not MIME (e.g. without 8851@samp{Content-Type:}). This value also used as default charset for 8852summary. (If you want to share Summary on Nemacs and other Emacsen, set 8853this value as @code{iso-2022-jp}.) 8854 8855@item wl-highlight-folder-with-icon 8856@vindex wl-highlight-folder-with-icon 8857The default value is @code{t}. 8858 8859@item wl-strict-diff-folders 8860@vindex wl-strict-diff-folders 8861This is a list of regular expressions of folders. 8862Unread messages are checked, for example when you press @kbd{s} in 8863the folder mode, usually in a brief way (rapidly processed but not 8864accurate). 8865The folders matching this variable are seriously checked. 8866You may want to set this variable so as to match conditional filter 8867folders for IMAP4 folders. 8868The initial setting is @code{nil}. 8869 8870@item wl-folder-use-server-diff 8871@vindex wl-folder-use-server-diff 8872When unread messages are checked, for example when you press @kbd{s} in 8873the folder mode, usually (the number of messages on the server) @minus{} 8874(the number of local messages) will be the number of unread messages. 8875However, if this variable is non-nil, the number of unread messages on 8876the server is checked. This affects IMAP4 folders only, but IMAP4 8877folders in mail boxes matching 8878@code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for 8879the number of unread messages on the server, even if they matches this 8880variable. The initial setting is @code{t}. 8881 8882@item wl-auto-check-folder-name 8883@vindex wl-auto-check-folder-name 8884The initial setting is @code{nil}. 8885You can specify a folder or a group which is checked for unread message 8886at the start. You can also specify a list of folders (groups) to be checked. 8887If the value is @code{nil}, whole Desktop is checked at the start. 8888If it is @code{none}, no folders are checked. 8889 8890@item wl-auto-uncheck-folder-list 8891@vindex wl-auto-uncheck-folder-list 8892The initial setting is the list shown below: 8893 8894@lisp 8895@group 8896("\\$.*") 8897@end group 8898@end lisp 8899 8900@noindent 8901You can set a list of regular expressions to specify folders 8902which are not automatically checked even if they are included 8903in some groups assigned by @code{wl-auto-check-folder-name}. 8904 8905@item wl-auto-check-folder-list 8906@vindex wl-auto-check-folder-list 8907The initial setting is @code{nil}. 8908You can set a list of regular expressions to specify exceptions 8909for @code{wl-auto-uncheck-folder-list}. 8910 8911@item wl-no-save-folder-list 8912@vindex wl-no-save-folder-list 8913The initial setting is the list shown below: 8914 8915@lisp 8916@group 8917("^/.*$") 8918@end group 8919@end lisp 8920 8921@noindent 8922This is a list of regular expressions of folders not to be saved. 8923 8924@item wl-save-folder-list 8925@vindex wl-save-folder-list 8926The initial setting is @code{nil}. 8927This is a list of regular expressions of folders to be saved. 8928This takes precedence over @code{wl-no-save-folder-list}. 8929 8930@item wl-folder-mime-charset-alist 8931@vindex wl-folder-mime-charset-alist 8932The initial setting is the alist shown below: 8933 8934@lisp 8935@group 8936(("^-alt\\.chinese" . big5) 8937 ("^-relcom\\." . koi8-r) 8938 ("^-tw\\." . big5) 8939 ("^-han\\." . euc-kr)) 8940@end group 8941@end lisp 8942 8943@noindent 8944This is an associative list of regular expressions of folder names and 8945MIME charsets. 8946If a folder do not match, @code{wl-mime-charset} is used. 8947 8948@item wl-folder-init-load-access-folders 8949@vindex wl-folder-init-load-access-folders 8950The initial setting is @code{nil}. 8951This is a list of access groups to be loaded specifically at the start. 8952If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred. 8953 8954@item wl-folder-init-no-load-access-folders 8955@vindex wl-folder-init-no-load-access-folders 8956The initial setting is @code{nil}. 8957This is a list of access groups not to be loaded specifically at the 8958start. 8959It is ignored if @code{wl-folder-init-load-access-folders} is non-nil. 8960 8961@item wl-dispose-folder-alist 8962@vindex wl-dispose-folder-alist 8963The initial setting is the alist shown below: 8964 8965@lisp 8966@group 8967(("^-" . remove) 8968 ("^@@" . remove)) 8969@end group 8970@end lisp 8971 8972@noindent 8973This list determines disposition of messages with disposal marks. 8974Each item in the list is a folder and destination; you can specify any 8975one of the following in the place of destination: 8976 8977@example 8978@code{remove} or @code{null} : deletes the messages instantly. 8979string : moves the messages to the specific folder. 8980@code{trash} or others : moves the messages to @code{wl-trash-folder}. 8981@end example 8982 8983@item wl-x-face-file 8984@vindex wl-x-face-file 8985The initial setting is @file{~/.xface}. 8986The name of the file that contains encoded X-Face strings. 8987@xref{x-face-mule}. 8988 8989@item wl-demo-display-logo 8990@vindex wl-demo-display-logo 8991If non-nil, bitmap image is shown on the opening demo. If you set 8992@code{xpm} or @code{xbm}, (if possible) display selected image type 8993logo. 8994 8995@item elmo-nntp-list-folders-use-cache 8996@vindex elmo-nntp-list-folders-use-cache 8997The initial setting is 600 (in seconds). 8998This is period in seconds during which results of @samp{list} and 8999@samp{list active} in NNTP are cached. If it is @code{nil}, they are 9000not cached. 9001 9002@item elmo-nntp-max-number-precedes-list-active 9003@vindex elmo-nntp-max-number-precedes-list-active 9004The initial setting is @code{nil}. 9005If non-nil, the number of article obtained by @samp{list active} in NNTP 9006are used as the maximum article number of the folder. 9007Set this to @code{t} if you are using for example INN 2.3 as an NNTP server, 9008and if the number of read messages is not correct. 9009 9010@item elmo-nntp-default-use-listgroup 9011@vindex elmo-nntp-default-use-listgroup 9012The initial setting is @code{t}. 9013If non-nil, @samp{listgroup} is used for checking the total number of 9014articles. If it is @code{nil}, @samp{group} is used. In the latter 9015case, the processing will be a little faster at the sacrifice of 9016accuracy. 9017 9018@item elmo-pop3-send-command-synchronously 9019@vindex elmo-pop3-send-command-synchronously 9020The initial setting is @code{nil}. 9021If non-nil, POP3 commands are issued synchronously. Some implementation 9022of POP3 server fails to get summary information without this setting. 9023You may have to set this variable to @code{t}, if the process hangs 9024while looking up POP3. 9025 9026@item elmo-dop-flush-confirm 9027@vindex elmo-dop-flush-confirm 9028The initial setting is @code{t}. 9029If non-nil, you are asked for confirmation if accumulated off-line 9030operations are executed. 9031 9032@item elmo-network-session-idle-timeout 9033@vindex elmo-network-session-idle-timeout 9034The initial setting is @code{nil}. 9035Idle timeout of the network cache. Specified in seconds. 9036If elapsed time since last access is larger than this value, 9037cached session is not reused. If nil, network cache is reused. 9038 9039@end table 9040 9041 9042@node Hooks, , Customizable Variables, Advanced Issues 9043@section Hooks 9044 9045(Not yet written) 9046 9047 9048@node Migration, Terminology, Advanced Issues, Top 9049@chapter Switch from older version of Wanderlust 9050@cindex Migration 9051 9052This chapter explains the important thing for the upgrade, 9053or migration from the previous version. 9054It includes the changes of the setup, limitations etc. 9055 9056@menu 9057* Before 2.12.0:: From prior to the version 2.12.0 9058@end menu 9059 9060@node Before 2.12.0, , Migration, Migration 9061@section Migration from prior to the version 2.12.0 9062 9063@subsection The conversion of msgdb 9064 9065From version 2.12.0 on, the structure of msgdb is changed. 9066The msgdb for newly created folder will use this new format when created and saved. 9067But by writing following line, you may use the old format of the msgdb as it was. 9068 9069@lisp 9070@group 9071(setq elmo-msgdb-default-type 'legacy) 9072@end group 9073@end lisp 9074 9075With the default setup, the old msgdb format is converted to the new 9076format automatically. You may change this behavior by writing following 9077lines in @file{~/.wl}. 9078 9079@lisp 9080@group 9081;; @r{If the format of msgdb is different from} @code{elmo-msgdb-default-type}, 9082;; @r{the format will be converted automatically when} 9083;; @r{the msgdb is being loaded (default).} 9084(setq elmo-msgdb-convert-type 'auto) 9085 9086;; @r{Convert msgdb when hitting @kbd{s all} in Summary mode} 9087(setq elmo-msgdb-convert-type 'sync) 9088 9089;; @r{Inhibit conversion} 9090(setq elmo-msgdb-convert-type nil) 9091@end group 9092@end lisp 9093 9094As is explained in above section, you may continue to use the old format. 9095But you will have following limitations. 9096 9097@enumerate 9098@item 9099You cannot use forwarded mark (@samp{F}, @samp{f}). 9100@item 9101You may only use @samp{important} flag. The other global flags may not 9102be available. 9103@end enumerate 9104 9105@subsection Changes from @samp{'mark} folder to @samp{'flag} 9106 9107The folder @samp{'mark} will be automatically converted to @samp{'flag} 9108folder when you first start the new version of Wanderlust. 9109But there are some restrictions on this type of migrated folder. 9110 9111@enumerate 9112@item 9113@samp{important} flag attached will not be 9114removed by deleting the associated message in @samp{'flag} folder. 9115 9116@item 9117The message won't be deleted by removing 9118@samp{important} flag in @samp{'flag} folder. 9119 9120@item 9121help-echo will not show you the old message. 9122 9123@end enumerate 9124 9125If you have problem with migrating 9126from @samp{'mark} folder to the @samp{'flag} folder, 9127invoking 9128@kbd{M-x elmo-global-mark-upgrade} will transfer the message 9129from @samp{'mark} folder to the @samp{'flag} folder. 9130The duplicated message will not be processed, 9131you may issue that command repeatedly. 9132 9133 9134@node Terminology, Mailing List, Migration, Top 9135@chapter Terminology around Wanderlust 9136@cindex Terminology 9137 9138Here we explain terminologies used in this manual. 9139 9140@table @samp 9141@item folder 9142A container in which messages are stored. 9143 9144@item group 9145A set consists of some folders. 9146 9147@item access group 9148A special group consists of automatically collected folders under 9149some specified path. 9150@xref{Folder Definition}. 9151 9152@item summary buffer 9153A buffer for displaying list of messages in some folder. 9154 9155@item sticky summary 9156Compared with ordinary summary buffer which will be destroyed after 9157exiting from it, this type of summary will be remain even after exiting 9158by @kbd{q} or @kbd{g}. 9159@xref{Sticky Summary}. 9160 9161@item expire 9162To delete or put into the archive expired messages. 9163@xref{Expire}. 9164 9165@item score 9166@xref{Scoring}. 9167 9168@item prefetch 9169To cache messages beforehand in order to read messages after you will be 9170disconnected from the server. 9171@end table 9172 9173 9174@node Mailing List, Addition, Terminology, Top 9175@chapter Wanderlust Mailing List 9176@cindex Bug report 9177@cindex Backtrace 9178 9179Topics related to Wanderlust are discussed in following mailing lists. 9180The latest version is also announced there. 9181 9182@display 9183Wanderlust Mailing List @t{<wl@@ml.gentei.org>} 9184@end display 9185 9186In this list Japanese is mainly used for discussion. We also have a list 9187for discussion in English: 9188 9189@display 9190Wanderlust List in English @t{<wl-en@@ml.gentei.org>} 9191@end display 9192(Messages posted to this list are also forwarded to the former one.) 9193 9194A guide can be obtained automatically by sending mail to 9195@t{wl-ctl@@ml.gentei.org} (or to @t{wl-en-ctl@@ml.gentei.org} for 9196the English one) with the body 9197 9198@example 9199# guide 9200@end example 9201 9202Please send bug reports or patches to one of those lists. You have to 9203subscribe the mailing list to post a message. 9204 9205Alternatively, You can also use GitHub. If you send a pull request, 9206please embed unindented @file{ChangeLog} entries in commit message like 9207Emacs's. See @cite{Commit messages} section of Emacs's CONTRIBUTE file 9208@footnote{@uref{https://git.savannah.gnu.org/cgit/emacs.git/plain/CONTRIBUTE}}. 9209 9210If you send a bug report, please attach Backtrace with it. 9211@footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to 9212in Japanese.} 9213 9214I would like to express my thanks to the members of the mailing list for 9215valuable advice and many pieces of code they contributed. 9216 9217@section Archive 9218 9219You can read messages posted to the mailing list in NetNews. 9220 9221Read messages posted to @t{<wl@@ml.gentei.org>} 9222 9223@example 9224@uref{news://news.gmane.io/gmane.mail.wanderlust.general.japanese} 9225@end example 9226 9227Read messages posted to @t{<wl-en@@ml.gentei.org>} 9228 9229@example 9230@uref{news://news.gmane.io/gmane.mail.wanderlust.general} 9231@end example 9232 9233 9234@node Addition, Index, Mailing List, Top 9235@chapter Additional Information 9236 9237@section Brief History 9238 9239@example 92401998 3/05 Tried to make a prototype that displays MH messages in threads. 9241 3/10 Made a msgdb mechanism by elisp. 9242 3/26 IMAP and NNTP can be displayed in threads. 9243 4/13 Began to assemble thread display modules as elmo. 9244 5/01 Finished 0.1.0, initial version with many defects. 9245 6/12 I made a slip of the tongue and said I was writing elisp 9246 mailer supporting IMAP 9247 6/16 0.1.3 was announced at tm-ja, elisp ML. 9248 6/22 Thanks to Kitame-san, the mailing list started at northeye.org. 9249 7/01 Support for mm-backend (0.3.0). 9250 8/25 multi folder added (0.5.0). 9251 8/28 filter folder added (0.5.1). 9252 9/10 You can open/close threads (0.6.0). 9253 9/11 fldmgr by Murata-san made editing folders easy. 9254 9/18 lha folders added by Okunishi-san (0.6.3). 9255 9/24 Display of branches of threads (0.6.5). 9256 9/28 Compression folder supporting multiple archivers by Okunishi-san. 9257 10/28 Off-line operations (0.7.4). 9258 12/09 Becomes beta version. 9259 12/21 wl-expire by Murata-san. 92601999 2/03 auto-refile by Tsumura-san. 9261 4/28 wl-template by Murata-san. 9262 5/18 Released 1.0.0 stable. 9263 7/05 Scoring by Murata-san (2.1.0). 9264 9/26 New plugged system by Murata-san (2.2.2). 9265 12/20 Support Modified UTF7. 92662000 3/24 Released 1.1.0 stable. 9267 4/03 CVS development started. 9268 5/07 Thread restoration & Its speed up with Murata-san. 9269 6/12 Address completion with LDAP with Chiba-san & Goto-san. 9270 7/11 killed message feature. 9271 7/18 Use UIDL in POP3. 9272 9/12 biff feature with Satata-san & Yamaoka-san. 9273 10/17 expire-hide by Okada-san. 9274 11/08 Released 2.4.0 stable. 92752001 7/04 Released 2.6.0 stable. 9276 8/21 wl-addrmgr by Kitamoto-san. 9277 12/27 Released 2.8.1 stable. 92782002 12/11 Released 2.10.0 stable. 92792003 7/05 Released 2.10.1 stable. 9280 9/18 flag folder is added. 9281 9/20 New msgdb format (modb-standard) by H.Murata-san. 9282 10/20 Spam filter by H.Murata-san. 92832004 1/06 Background color of the demo become configurable. 9284 2/09 'file' folder is added. 9285 9/12 forwarded mark. 9286 Default value of the mark strings are changed. 9287 12/24 Released 2.12.0 stable. 9288@end example 9289 9290See @file{ChangeLog} for details. 9291 9292@section The Name 9293 9294According to a dictionary, Wanderlust has the meaning: 9295 9296@display 9297wanderlust 9298 n eager longing for or impulse towards travelling in distant lands 9299 [Ger, fr wandern to wander + lust desire, pleasure] 9300@end display 9301 9302@noindent 9303but I had no profound intention. (if farfetched, IMAP @result{} you can 9304read mail anywhere @result{} desire to wander ?) 9305 9306Elmo is the abbreviation of @samp{Elisp Library for Message 9307Orchestration}. At first I meant the red puppet in the Sesame Street, 9308but you may associate it with Wandering @result{} Drifting @result{} 9309Guidepost @result{} St.@: Elmo's fire @result{} elmo. 9310 9311@section Code Names 9312 9313Each versions has code names (they are almost jokes). 9314Currently they are picked up alphabetically from the top 40 hits of 9315U.S. Billboard magazines in 1980s. 9316 9317(@uref{http://ntl.matrix.com.br/pfilho/html/top40/}) 9318 9319@node Index, , Addition, Top 9320@unnumbered Index 9321 9322@menu 9323* Concept Index:: Concept Index 9324* Key Index:: Key Index 9325* Variable Index:: Variable Index 9326* Function Index:: Function Index 9327@end menu 9328 9329@node Concept Index, Key Index, Index, Index 9330@unnumberedsec Concept Index 9331@printindex cp 9332 9333@node Key Index, Variable Index, Concept Index, Index 9334@unnumberedsec Key Index 9335@printindex ky 9336 9337@node Variable Index, Function Index, Key Index, Index 9338@unnumberedsec Variable Index 9339@printindex vr 9340 9341@node Function Index, , Variable Index, Index 9342@unnumberedsec Function Index 9343@printindex fn 9344 9345@summarycontents 9346@contents 9347@bye 9348 9349@c Local Variables: 9350@c fill-column: 72 9351@c End: 9352