@settitle Wanderlust -- Yet Another Message Interface On Emacsen --
@c %**end of header
@documentlanguage en
-@documentencoding us-ascii
@include version.texi
@synindex pg cp
@finalout
* Disconnected Operations:: Off-Line management
* Expire and Archive:: Automatic expiration and archiving of messages
* Scoring:: Score of the messages
+* Split messages:: Splitting messages
* Address Book:: Management of Address Book
* Customization:: Customizing Wanderlust
+* Terminology:: Terminologies
* Mailing List:: Wanderlust mailing list
* Addition:: Additional Information
* Index:: Key index
@item Manages unread messages.
@item Interactive thread display.
@item Folder Mode shows the list of subscribed folders.
-@item Message Cache, Disconnected Operation (Read Only).
-@item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
+@item Message Cache, Disconnected Operation.
+@item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
@item MIME compliant (by SEMI).
@item Transmission of news and mail are unified by Message transmitting draft.
@item Graphical list of folders (XEmacs and Emacs 21).
@section Environment
-Wanderlust is supposed to run on following Emacsen:
+We confirm Wanderlust works on following Emacsen:
@itemize @bullet
@item Mule 2.3 based on Emacs 19.34
* Minimal Settings:: @file{.emacs} setup
* Folder Definition:: Folder definition
* Start Wanderlust:: Starting Wanderlust
+* Overview:: Basic components of Wanderlust
@end menu
@pindex FLIM
@pindex SEMI
-SEMI must be installed to make Wanderlust work correctly.
+You must install SEMI beforehand to use Wanderlust.
-SEMI can be downloaded from these sites:
+SEMI can be downloaded from following site:
@example
@group
Recommended combination of APEL, FLIM and SEMI are following:
@itemize @minus
-@item APEL 10.3, FLIM 1.14.3 and SEMI 1.14.3
+@item APEL 10.6, FLIM 1.14.6 and SEMI 1.14.6
@end itemize
You can also use many other FLIM/SEMI variants. Combination of the
confirmed to work.
@itemize @minus
-@item APEL 10.2, Chao 1.14.1, REMI 1.14.2
-@item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
+@item APEL 10.6, SLIM 1.14.9, SEMI 1.14.5
+@item APEL 10.6, CLIME 1.14.5, EMIKO 1.14.1
@end itemize
You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
@example
@group
-ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
+@c ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
http://www.jpl.org/elips/wl/
http://www.ring.gr.jp/archives/text/elisp/wl/
ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
-ftp://opaopa.org/pub/mirror/elisp/wl/
-@c ftp://roguelife.org/pub/tsumura/wl/
@end group
@end example
and SEMI to environmental variable @env{EMACSLOADPATH}, or define
@code{load-path} in @file{WL-CFG} in extracted directory.
-If you want to use BBDB, then the necessary modules are byte-compiled
-and installed when BBDB directory is added to @code{load-path}.
-@xref{BBDB}.
+If you want to handle shimbun folders or to use BBDB, add directory
+where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
+modules will be byte-compiled and installed.
+@xref{Shimbun Folder}, @xref{BBDB}.
@subsection @file{WL-CFG}
@lisp
@group
-;; @r{The setting to use SEMI}
-(require 'mime-setup)
-
;; @r{autoload configuration}
-;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
+;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
(autoload 'wl "wl" "Wanderlust" t)
+(autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
(autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
;; @r{Directory where icons are placed.}
;; @r{Default: the peculiar value to the running version of Emacs.}
-;; @r{(This is not required if the default value has been set properly)}
+;; @r{(Not required if the default value points properly)}
(setq wl-icon-directory "~/work/wl/etc")
;; @r{SMTP server for mail posting. Default: @code{nil}}
(if you write it to @file{.emacs}, you'll get an error).
@xref{Highlights}.
-All above described settings except @samp{(require 'mime-setup)} and autoload
-configuration can be written in
-@file{~/.wl}).
+All above described settings except autoload configuration can be written
+in @file{~/.wl}).
@subsection @code{mail-user-agent}
@cindex Default Mailer
@vindex mail-user-agent
@findex compose-mail
-If you write following setting in you @file{.emacs}, you can
+If you write following setting in your @file{~/.emacs}, you can
start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
This means it enables you to run Wanderlust as a default mail composer
of Emacsen.
It is effective only when your Emacs can define @code{mail-user-agent}.
-@xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
+@xref{Mail Methods, , ,emacs, The Emacs Editor}.
@lisp
@group
example which the user chooses his favorite folders as a group.
The other one is @dfn{access group} like @samp{+ /} from above example.
-It makes all the sub-folders in a folder to a group. (It differs from
-the type of the folder. For example, @samp{+} followed by @samp{/}
-makes entire MH sub-directories to one group)
+It collects all sub-folders in the folder to make a group. (Its
+behavior differs by the type of the folder. For example, @samp{+}
+followed by @samp{/} makes entire MH sub-directories to one group)
This behavior is better understood if you try it and confirmed the
function first. You can write and try a small folder definition, so you
will know the idea of the folder function before writing the real one.
-@node Start Wanderlust, , Folder Definition, Start Me Up
+@node Start Wanderlust, Overview, Folder Definition, Start Me Up
@section Start Wanderlust
@cindex Start Wanderlust
@end example
@noindent
-After initialization, Folder Mode which shows the list of folders will appear.
-That means the folders you defined in the @file{~/.folders} are listed
+After initialization, Folder Mode which shows the list of folders will
+appear. That means the folders you defined in the @file{~/.folders} are
+listed.
+
If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
can skip folder checking.
+
+@node Overview, , Start Wanderlust, Start Me Up
+@section Overview
+@cindex Overview
+
Basically, you will handle messages in wanderlust while you come and go
-from/to each of the following buffers.
+from/to each of the following buffers. Details of each ones are
+explained in following chapters.
@table @samp
@item Folder Buffer
You can see the list of folders. You can select some folder and go into the summary
of it. You can subscribe new folder or edit subscription list.
@item Summary Buffer
-You can see the list of messages in the folder. You can select message and view its
-contents, and reply to some message. You can delete ones or move ones to another
-folder.
+You can see the list of messages in the folder. You can select message
+and view its contents, and reply to some message. You can delete ones or
+move ones to another folder.
@item Message Buffer
-You can see the contents of the message. You can save part to disk or open in external
-programs.
+You can see the contents of the message. You can save part to disk or
+open in external programs.
@item Draft Buffer
You can edit message.
@end table
-Details of each ones are explained later.
-
@node Folders, Folder, Start Me Up, Top
@chapter Wanderlust's folders
This chapter describes the folder types which Wanderlust is able to handle.
-Wanderlust uses ELMO as it's interface, so every folder types supported
-by ELMO is usable in Wanderlust.
+Wanderlust uses ELMO as it's interface, so you can use every folder types
+supported by ELMO.
-As of version @value{VERSION}, 11 types of folders are predefined. These are
-IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
-Pipe and Internal folder types.
+As of version @value{VERSION}, 13 types of folders are predefined. These
+are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
+Shimbun, Namazu, Multi, Filter, Pipe and Internal folder types.
@menu
* IMAP Folder:: @samp{%} -- IMAP folder
@pindex ucs-conv
You can use international mailbox names in @var{mailbox} part, if you
-are using Emacs which can treat unicode and
+are using Emacs with UTF-7 support and
@code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
value is @code{nil}).
-Currently, following Emacsen can treat unicode.
+Currently, Mule-UCS package is required to use UTF-7.
+Mule-UCS works on following Emacsen.
@itemize @bullet
-@item Emacs 20.3 or later + Mule-UCS
+@item Emacs 20.3 or later
+@item XEmacs 21.2.37 or later
+@end itemize
-If you installed Mule-UCS package, Emacs can treat unicode.
You can obtain Mule-UCS package from following URL.
@example
ftp://ftp.m17n.org/pub/mule/Mule-UCS/
@end example
-@item XEmacs 21.2.13 or later + ucs-conv package
-
-By default, XEmacs 21 cannot treat unicodes, but if you installed
-ucs-conv package, it can.
-You can obtain ucs-conv package from following anonymous CVS.
-
-@example
-@group
-cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
-Password: @var{NULL} (Just enter return key)
-cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
-@end group
-@end example
-
-You also need utf7 conversion programs, @command{u7tou8} and
-@command{u8tou7} to use international mailbox name in the current
-XEmacs. These programs are included in the UTF7 package which can be
-obtained from following URL.
-
-@example
-ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
-@end example
-@end itemize
-
-
@node NNTP Folder, MH Folder, IMAP Folder, Folders
@section NNTP Folder
@cindex @samp{-}
$bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
$/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
$d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
+$ml;zip/ -> Access group consists of archive folders
+ under @file{~/Mail/ml}
@end group
@end example
@end example
@noindent
-and access it, messages are downloaded automatically from
-@samp{&username@@popserver} to @samp{+inbox}.
+and access it, Wanderlust downloads messages from
+@samp{&username@@popserver} to @samp{+inbox} automatically.
On the other hand, if you put @samp{|:} instead of second @samp{|},
then messages are copied to the destination folder (not deleted from
-source-folder). At the next time you access that folder, only new
-messages will be copied.
+source-folder). At the next time you access that folder, copies new
+messages only.
@example
@samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
@example
@group
-'mark
-'sendlog
-'cache/00 - 1F
+@samp{'flag} [@samp{/} @var{global-flag}]
+@samp{'sendlog}
+@samp{'cache/00} - @samp{'cache/1F}
@end group
@end example
-A folder named @samp{'mark} is a special virtual folder which collects
-messages which have important mark @samp{$}.
-
-You can review important messages at once after you put important marks
-on the messages in the different folders.
+A folder named @samp{'flag} is a special virtual folder which collects
+messages which have @var{global-flag}.
-In this folder, if you delete message, important mark @samp{$} put on
-the message is removed. If you append messages to this folder, the
-message will have @samp{$} mark.
+Now, @samp{important} flag is supported as @var{global-flag}. You can
+review important messages at once after you put important marks on the
+messages in the different folders.
-(Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
-folder. If you want IMAP folder's message remove from @samp{'mark}
-folder, remove important mark at IMAP Folder.)
+In this folder, if you delete message, @var{global-flag} put on the
+message is removed. If you append messages to this folder, the message
+will have @var{global-flag}.
A folder named @samp{'sendlog} is a virtual folder which collects
@kindex @key{RET} (Folder)
@findex wl-folder-jump-to-current-entity
Enter to the summary mode of the folder at the current cursor point.
+With prefix argument, enter the sticky summary.
If the cursor is on the top of folder group line,
the folder group is opened or closed.
When the cursor is on the access group and this command is called
Empty trash.
(@code{wl-folder-empty-trash})
+@item F
+@kindex F (Folder)
+@findex wl-folder-flush-queue
+Flush queue.
+(@code{wl-folder-flush-queue})
+
+@item V
+@kindex V (Folder)
+@findex wl-folder-virtual
+Move to the virtual folder (filter folder) with the condition specified.
+(@code{wl-folder-virtual})
+
+@item ?
+@kindex ? (Folder)
+@findex wl-folder-pick
+Search the folders with the condition specified.
+(@code{wl-folder-pick})
+
@item o
@kindex o (Folder)
@findex wl-folder-open-all-unread-folder
@lisp
@group
-("-" "-alt")
+("^-$" "^-alt$")
@end group
@end lisp
@noindent
-A list of access groups which creates children folder list hierarchically.
+A list of regular expressions for access groups which creates children
+folder list hierarchically.
For example, if you specify
@code{wl-folder-hierarchy-access-folders} like following,
@lisp
@group
(setq wl-folder-hierarchy-access-folders
- '("-" "-alt" "-japan" "-comp" "-comp.unix"))
+ '("^-$" "^-alt$" "^-japan$" "^-comp$" "^-comp.unix$"))
@end group
@end lisp
@noindent
-such access group hierarchy is obtained.
+you obtain the access group hierarchy as follows.
@example
@group
(after you create folder group by typing @kbd{m g}),
firstly open it, then execute append command in the next line.
If it is closed, folder is appended on the same level with
-the above folder group. It is difficult to explain by words so try it.
+the folder group above. It is difficult to explain by words so try it.
In other words, appended position depends on the
-above folder group's open/close status.
+open/close status of the upper one.
@subsubsection Charset of the Folders File.
* Cache:: File cache, Buffer cache, and Prefetch
* Auto Refile:: Auto refile settings
* Sticky Summary:: Summary make sticky
+* Summary View:: Format of summary lines
* Key Bindings of Summary:: Key bindings
* Variables of Summary:: Customize Summary Mode
@end menu
@end example
@noindent
-You cannot change this in the current version.
+If you want to know how to change the format for this, please refer
+the section format of Summary lines.
+@xref{Summary View}.
@var{Message number} is the message's unique number in the folder. In
the NNTP folder, it is article number, in the IMAP folder, it is UID and
@cindex Mark, Temporary
There are four temporary marks,
-@samp{*}, @samp{D}, @samp{o} and @samp{O}.
+@samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}.
Temporary marks indicates message operations.
@table @samp
You can execute a command on the all messages that have @samp{*} mark,
with the key bindings which begins with @kbd{m}.
+@item d
+The mark to dispose. You can put @samp{d} by typing @kbd{d} key.
+
@item D
-The mark to delete. You can put @samp{D} by typing @kbd{d} key.
+The mark to force delete. You can put @samp{D} by typing @kbd{D} key.
@item o
The mark to refile.
You can put this mark by typing @kbd{O} key.
The difference between this mark and refile mark is,
this mark does not delete the message while latter does.
+
+@item i
+The mark to prefetch reserved.
+You can put this mark by typing @kbd{i} key.
+
+@item ~
+The mark to resend reserved.
+After you type @kbd{~} key, prompt appears to input address to resend.
+Your answer is printed in the summary line.
@end table
-@kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks.
+@kbd{x} key executes action for temporary marks, respectively.
@subsection Persistent Marks
-There are five persistent marks,
-@samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}.
+There are five persistent marks, @samp{N}, @samp{?}, @samp{U}, @samp{!},
+@samp{u}, @samp{A}, @samp{&} and @samp{$}.
The persistent mark indicates the message's status and it is saved.
Each persistent mark indicates:
@table @samp
@item N
It is new message.
+@item ?
+It is new but cached message.
@item U
It is unread message.
@item !
It is unread but cached message.
@item u
It is read but it is not cached.
+@item A
+It is already replied message.
+@item &
+It is already replied but cached message.
@item $
It is important message. You can put @samp{$} mark by typing @kbd{$}
key (if already exists, the mark is deleted). It is convenient to put
persistent mark.
@end table
-@samp{N}, @samp{U} and @samp{u} indicates that the message have no
-cache. Messages with the marks other than these, you can read them in
-the offline status even they are in the IMAP folder or netnews folder.
+@samp{N}, @samp{U}, @samp{u}, @samp{A} indicates that the message have
+no cache. Messages with the marks other than these, you can read them
+in the offline status even they are in the IMAP folder or netnews
+folder.
Among messages with persistent marks, ones with marks specified by
@code{wl-summary-expire-reserve-marks} are excluded from the expiration
@subsection Cache File
The messages which have to access via network (e.x. IMAP, NNTP folder)
-are cached as a local file. The cache file is saved under the directory
+are cached as a local file so as to save network traffic or to enable
+off-line operation. The cache file is saved under the directory
@file{~/.elmo/cache}. To expire cache, type @kbd{M-x
elmo-cache-expire-by-size}. The command deletes cache files to the
specified size by the order of last accessed time.
@subsection Buffer Cache and Prefetching
-The messages that are read are kept in the cache buffer. It is called
+The messages that are read are kept in the cache buffer so as to make
+the behavior fast when you are to read the message again. It is called
`buffer cache'. The number of cache buffer is specified by
@code{wl-message-buffer-cache-size}.
@item wl-message-buffer-prefetch-depth
@vindex wl-message-buffer-prefetch-depth
-The initial setting is 5. The number of messages to prefetch.
+The initial setting is 3. The number of messages for automatical prefetch.
@item wl-message-buffer-prefetch-idle-time
@vindex wl-message-buffer-prefetch-idle-time
-The initial setting is 0.2 (in seconds). The period of prefetching.
+The initial setting is 0.2 (in seconds). The period of automatical prefetch.
+
+@item wl-message-buffer-prefetch-threshold
+@vindex wl-message-buffer-prefetch-threshold
+The initial setting is 30000 (bytes). If prefetching message has larger
+size than this value, Wanderlust does not prefetch automatically.
+If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
+the message is not checked for the size.
+
+@item wl-auto-prefetch-first
+@vindex wl-auto-prefetch-first
+The initial setting is @code{nil}.
+If non-nil, first message is automatically prefetched to the buffer
+when you enter the folder.
@end table
case, If the field value of the rule and the current rule is matched,
then the current rule is fired (i.e. AND condition).
-In @var{target} part, you can refer matched substring of @var{regexp}.
-To refer substring, specify following in @var{target}:
+You can refer matched substring of @var{regexp} to specify @var{target} part.
+To refer substring, use following keys:
@table @samp
@item \&
@end lisp
-@node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
+@node Sticky Summary, Summary View, Auto Refile, Summary
@section Sticky Summary
@cindex Summary, Sticky
@cindex Sticky Summary
The buffer of the `sticky summary' does not killed by typing @kbd{q}.
-Sticky buffer is created by entering the summary by typing @kbd{C-u g}
-or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
+By entering the summary by typing @kbd{Shift RET} in Folder mode or
+@kbd{G} in some suummary sticky summary buffer is created.
+Also typing @kbd{M-s} (@code{wl-summary-stick}) on the normal summary
+makes current one sticky.
The buffer name of the sticky summary becomes like
@samp{Summary:@var{folder-name}}.
-
You can visit the sticky summary at any time by @kbd{C-x b}
-(@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
-q}. Other operations in the sticky summary are same as normal summary.
+(@code{switch-to-buffer}), or you can go round summary buffers by
+@kbd{C-c C-n} (@code{wl-summary-previous-buffer}) and @kbd{C-c C-p}
+(@code{wl-summary-next-buffer}) in summary mode.
+
+In sticky summary, the summary buffer is preserved after @kbd{g} or
+@kbd{q}. To delete sticky summary, type @kbd{C-u q} to exit or move to
+another summary by @kbd{C-u g}. Other operations in the sticky summary
+are same as normal summary.
@code{wl-summary-always-sticky-folder-list} specifies the folders that
are automatically stuck.
-@node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
+@node Summary View, Key Bindings of Summary, Sticky Summary, Summary
+@section Format of summary lines
+@cindex Format of summary lines
+You can alter the format of lines in Summary mode.
+
+Summary line format is specified by @code{wl-summary-line-format}.
+You can use control strings defined by
+@code{wl-summary-line-format-spec-alist}.
+
+An example follows.
+
+@lisp
+@group
+;; @r{number temporary-mark persistent-mark date branch}
+;; @r{[ (number-of-children) sender ] subject}
+(setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")
+@end group
+@end lisp
+
+Where the number set the column number of the field (for negative value,
+filled from right)
+
+Major control strings defined by @code{wl-summary-line-format-spec-alist}
+are displayed in the following list.
+
+@example
+@group
+%n message number
+%Y year
+%M month
+%D day
+%W day of week
+%h hour
+%m minute
+%t branch of the thread
+%[ [ (< for re-connected child)
+%] ] (> for re-connected child)
+%f sender
+%s subject
+%S size
+%c +number-of-children: (display only for opened thread)
+%C [+number-of-children] (display only for opened thread)
+%T temporary mark (mandatory)
+%P persistent mark (mandatory)
+@end group
+@end example
+
+@code{wl-summary-line-format} must contain temporary mark (@samp{%T})
+and persistent mark (@samp{%P}). Furthermore, these marks must appear at
+the constant column. For example, if you specify @samp{%T} or
+@samp{%P} after the @samp{%t}, which changes its length by thread
+position, marks are not treated correctly.
+
+If the format string is enclosed by @samp{%number(} and @samp{%)}, the
+column of the enclosed region is justified to the `number'. Multiple
+level @samp{%number(} parenthesis can be defined. It is useful to
+justify the column of the multiple control strings. For example, in the
+above @code{wl-summary-line-format},
+
+@example
+%17(%c %f%)
+@end example
+
+means ``Adjust number-of-children and sender string to the 17 column''.
+
+You can specify the format by each folders with
+@code{wl-folder-summary-line-format-alist}. Please set regular
+expression for folder names and summary line format as the following
+example.
+
+@lisp
+@group
+(setq wl-folder-summary-line-format-alist
+ '(("^%" . "%T%P%M/%D(%W)%h:%m %t%[%17(%c %f%) %] %s")
+ ("^+" . "%n%T%P%M/%D %[ %17f %] %t%C%s")))
+@end group
+@end lisp
+
+@subsection on the format for sender name
+
+The format string @samp{%f} displays the return value of the function specified
+by @code{wl-summary-from-function}. If you use the function
+@code{wl-summary-default-from} (default), it displays sender name ordinarily,
+while displays the recipient names if the folder name matches with
+@code{wl-summary-showto-folder-regexp} and the sender is yourself.
+If the value of @code{wl-use-petname} is Non-nil, it uses petname to display.
+
+For example, to display recipient names for the message in @samp{+backup} if
+its sender is yourself, set up as follows.
+
+@lisp
+(setq wl-summary-showto-folder-regexp "^\\+backup$")
+@end lisp
+
+
+@node Key Bindings of Summary, Variables of Summary, Summary View, Summary
@section Key bindings
@cindex Keybind, Summary Mode
@cindex Keybind, Summary Buffer
a draft for `supersedes message' for the message is prepared.
(@code{wl-summary-reedit})
-@item M-e
-@kindex M-e (Summary)
+@item M-E
+@kindex M-E (Summary)
@findex wl-summary-resend-bounced-mail
If the message at current cursor point is a bounced message,
a draft for re-sending original message is prepared.
@kindex $ (Summary)
@findex wl-summary-mark-as-important
Put @samp{$} mark on the message at current cursor point.
-If already marked as @samp{$}, delete it.
+If already marked as @samp{$}, remove the mark.
(@code{wl-summary-mark-as-important})
@item y
If the message at current cursor point has
encapsulates multiple messages using MIME,
de-capsulate and extract them on the current folder.
+If it is invoked in non-writable folder or it is called with prefix
+argument, it asks the destination folder.
(@code{wl-summary-burst})
@item @@
@item s
@kindex s (Summary)
@findex wl-summary-sync
-Synchronize summary view after prompting the update range
-(@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
+Synchronize summary view after prompting the update range.
+You can specify one of the follows.
@example
@group
-all ...Discard current summary and update all message.
-update ...Update the difference between summary and the folder itself.
-rescan ...Rescan the msgdb and display again.
-rescan-noscore ...Rescan the msgdb and display again (without scoring).
-first, last ...Move to the filter folder(partial filter).
+all Discard present msgdb and retrieve all informations.
+ Do not retrieve killed messages.
+all-entirely Discard present msgdb and retrieve all informations.
+ Retrieve killed messages, too.
+update Update the difference between informations in present
+ msgdb and in current folder instance.
+ Do not retrieve killed messages.
+update-entirely Update the difference between informations in present
+ msgdb and in current folder instance.
+ Retrieve killed messages, too.
+rescan Redisplay summary by rescanning present msgdb.
+rescan-noscore Redisplay summary by rescanning present msgdb.
+ Display messages killed by score, too.
+cache-status Sync the all marks with the real status of cache.
+mark Update marks.
+no-sync Do nothing.
+first:NUM Move to the filter folder(partial filter).
+last:NUM Move to the filter folder(partial filter).
@end group
@end example
@item T
@kindex T (Summary)
@findex wl-summary-toggle-thread
-Toggle the threading.
+Toggle the threading. The state will be preserved after exiting
+Wanderlust. You can alter default state for newly created summary
+by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}.
Threading status is displayed on the modeline.
@samp{@{S@}} means threading is off (Sequence) and
@samp{@{T@}} means threading is on (Thread).
@item V
@kindex V (Summary)
-Move to the virtual folder with the condition specified.
+Move to the virtual folder (filter folder) with the condition specified.
If called with prefix argument and current folder is virtual, exit it.
@findex wl-summary-virtual
(@code{wl-summary-virtual})
Mark as read the message at the current cursor point.
(@code{wl-summary-mark-as-read})
-@item i
-@kindex i (Summary)
-Prefetch the message at the current cursor point.
-With prefix argument, prefetch the message even if it is cached.
-@findex wl-summary-prefetch
-(@code{wl-summary-prefetch})
-
@item x
@kindex x (Summary)
-Execute @samp{D}, @samp{o} and @samp{O} marks.
+Execute action for all temporary marks in the summary buffer.
@findex wl-summary-exec
(@code{wl-summary-exec})
@item d
@kindex d (Summary)
+@findex wl-summary-dispose
+Put disposal mark on the message at the current cursor point.
+The result of disposal is controlled by @code{wl-dispose-folder-alist},
+refiled to @code{wl-trash-folder} by default.
+(@code{wl-summary-dispose})
+
+@item D
+@kindex D (Summary)
@findex wl-summary-delete
-Put delete mark on the message at the current cursor point.
+Put force deletion mark on the message at the current cursor point.
(@code{wl-summary-delete})
+@item i
+@kindex i (Summary)
+Put prefetch reservation mark on the message at the current cursor point.
+@findex wl-summary-prefetch
+(@code{wl-summary-prefetch})
+
+@item ~
+@kindex ~ (Summary)
+@findex wl-summary-resend
+Put resend reservation mark on the message at the current cursor point.
+(@code{wl-summary-resend})
+
@item u
@kindex u (Summary)
@findex wl-summary-unmark
@kindex r $ (Summary)
@findex wl-summary-mark-as-important-region
Mark as important @samp{$} messages in the specified region.
-If @samp{$} already exists, it is deleted.
+If @samp{$} mark already exists, remove the mark.
(@code{wl-summary-mark-as-important-region})
@item r !
Mark as unread messages in the specified region.
(@code{wl-summary-mark-as-unread-region})
-@item r i
-@kindex r i (Summary)
-@findex wl-summary-prefetch-region
-Prefetch messages in the specified region.
-(@code{wl-summary-prefetch-region})
-
@item r x
@kindex r x (Summary)
@findex wl-summary-exec-region
-Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the
+Execute action for each temporary marks on the messages in the
specified region.
(@code{wl-summary-exec-region})
@item r d
@kindex r d (Summary)
-@findex wl-summary-delete-region
-Put delete mark on the messages in the specified region.
-(@code{wl-summary-delete-region})
+@findex wl-summary-dispose-region
+Put disposal mark on the messages in the specified region.
+(@code{wl-summary-dispose-region})
+
+@item r i
+@kindex r i (Summary)
+@findex wl-summary-prefetch-region
+Put prefetch reservation mark on messages in the specified region.
+(@code{wl-summary-prefetch-region})
@item r u
@kindex r u (Summary)
@findex wl-thread-mark-as-important
Put important mark @samp{$} on the messages which are the
descendant of the current thread.
-If @samp{$} mark exists, it is deleted.
+If @samp{$} mark exists, remove the mark.
With prefix argument, it affects on the all messages in the thread tree.
(@code{wl-thread-mark-as-important})
With prefix argument, it affects on the all messages in the thread tree.
(@code{wl-thread-mark-as-unread})
-@item t i
-@kindex t i (Summary)
-@findex wl-thread-prefetch
-Prefetch messages which are the descendant of the current thread.
-With prefix argument, it affects on the all messages in the thread tree.
-(@code{wl-thread-prefetch})
-
@item t x
@kindex t x (Summary)
@findex wl-thread-exec
-Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are
+Execute action for temporary marks on the messages which are
the descendant of the current thread. With prefix argument, it affects
on the all messages in the thread tree.
(@code{wl-thread-exec})
@item t d
@kindex t d (Summary)
-@findex wl-thread-delete
-Put delete mar on the messages which are the descendant of the current thread.
+@findex wl-thread-dispose
+Put disposal mark on the messages which are the descendant of the current thread.
With prefix argument, it affects on the all messages in the thread tree.
-(@code{wl-thread-delete})
+(@code{wl-thread-dispose})
+
+@item t i
+@kindex t i (Summary)
+@findex wl-thread-prefetch
+Put prefetch reservation mark on messages which are the descendant of
+the current thread.
+(@code{wl-thread-prefetch})
@item t u
@kindex t u (Summary)
With prefix argument, it affects on the all messages in the thread tree.
(@code{wl-thread-save})
-@item m i
-@kindex m i (Summary)
-@findex wl-summary-target-mark-prefetch
-Prefetch all messages which have target mark @samp{*}.
-With prefix argument, prefetch all targets even if some of them are cached.
-(@code{wl-summary-target-mark-prefetch})
-
@item m R
@kindex m R (Summary)
@findex wl-summary-target-mark-mark-as-read
@kindex m $ (Summary)
@findex wl-summary-target-mark-mark-as-important
Mark as important all messages which have target mark @samp{*}.
-If already marked as @samp{$}, it is deleted.
+If already marked as @samp{$}, remove the mark.
(@code{wl-summary-target-mark-mark-as-important})
@item m !
@item m d
@kindex m d (Summary)
-@findex wl-summary-target-mark-delete
-Put delete mark on the messages which have target mark @samp{*}.
-(@code{wl-summary-target-mark-delete})
+@findex wl-summary-target-mark-dispose
+Put disposal mark on the messages which have target mark @samp{*}.
+(@code{wl-summary-target-mark-dispose})
+
+@item m i
+@kindex m i (Summary)
+@findex wl-summary-target-mark-prefetch
+Put prefetch reservation mark on messages which have target mark @samp{*}.
+(@code{wl-summary-target-mark-prefetch})
@item m y
@kindex m y (Summary)
if the specified condition is satisfied.
(@code{wl-summary-target-mark-pick})
+@item m #
+@kindex m # (Summary)
+@findex wl-summary-target-mark-print
+Print out all messages which have target mark @samp{*}.
+(@code{wl-summary-target-mark-print})
+
+@item m |
+@kindex m | (Summary)
+@findex wl-summary-target-mark-pipe
+Pipe content of each message with target mark @samp{*} to some specified
+external process.
+(@code{wl-summary-target-mark-pipe})
+
@item M-t
@kindex M-t (Summary)
@findex wl-toggle-plugged
@code{wl-summary-save-current-message}
to the thread.
(@code{wl-summary-yank-saved-message})
+
+@item C-x C-s
+@kindex C-x C-s (Summary)
+@findex wl-summary-save-status
+Save the current summary.
+(@code{wl-summary-save-status})
@end table
@item wl-auto-select-first
@vindex wl-auto-select-first
The initial setting is @code{nil}.
-If non-nil, first message is automatically displayed.
+If non-nil, first message is automatically displayed when you enter
+the folder.
@item wl-auto-select-next
@vindex wl-auto-select-next
@item wl-summary-weekday-name-lang
@vindex wl-summary-weekday-name-lang
-The initial setting is @samp{ja}. Specify language of the weekday.
+Specify language of the weekday.
@samp{en} displays English, @samp{fr} displays French, @samp{de}
displays Deutsch. You should rescan summary view after changing this value.
A cons cell to specify the rate of summary and message window.
car:cdr corresponds summary:message.
+@item wl-summary-from-function
+@vindex wl-summary-from-function
+Format function to display sender in summary.
+The initial setting is @code{wl-summary-default-from}.
+
@item wl-summary-no-from-message
@vindex wl-summary-no-from-message
The initial setting is @samp{nobody@@nowhere?}. A string which is
displayed when there's no @samp{From:} field in the message.
+@item wl-summary-subject-function
+@vindex wl-summary-subject-function
+Format function to display subject in summary.
+The initial setting is @code{wl-summary-default-subject} and
+it will cut the list name part etc. on the top of the subject.
+To display subject as it is, set as follows.
+
+@lisp
+(setq wl-summary-subject-function 'identity)
+@end lisp
+
@item wl-summary-no-subject-message
@vindex wl-summary-no-subject-message
The initial setting is @samp{(WL:No Subject in original.)}. A string
which is displayed when there's no @samp{Subject:} field in the message.
+@item wl-summary-default-view
+@vindex wl-summary-default-view
+The initial setting is @code{'thread}.
+The default state for newly created summary. You can set either
+@code{'thread} for thread view or @code{'sequence} for sequential view.
+
@item wl-summary-use-frame
@vindex wl-summary-use-frame
The initial setting is @code{nil}.
The initial setting is 80.
Width of summary line. If @code{nil}, summary line's width is as is.
+@item wl-summary-print-argument-within-window
+@vindex wl-summary-print-argument-within-window
+The initial setting is @code{nil}.
+If non-nil, the action argument is always printed on right side of
+window.
+
@item wl-summary-from-width
@vindex wl-summary-from-width
The initial setting is 17.
Width of sender part of summary line.
-@item wl-summary-subject-length-limit
-@vindex wl-summary-subject-length-limit
-The initial setting is @code{nil}. Specify the limit for the length of
-subject parts in summary. @code{nil} means unlimited.
-
@item wl-summary-indent-length-limit
@vindex wl-summary-indent-length-limit
The initial setting is 46.
If you set this to @code{nil} you should set @code{wl-summary-width}
to @code{nil}, too.
+@item wl-summary-max-thread-depth
+@vindex wl-summary-max-thread-depth
+The initial setting is 15.
+If thread depth of the message is larger than this value,
+the thread is divided.
+
@item wl-summary-recenter
@vindex wl-summary-recenter
The initial setting is t.
@lisp
@group
-("o" "O" "D")
+("o" "O" "D" "d" "i")
@end group
@end lisp
@lisp
@group
-("D")
+("D" "d")
@end group
@end lisp
@item l
@kindex l (Message)
@findex wl-message-toggle-disp-summary
-Toggles display of Summary mode buffer.
+Toggles display of Summary buffer.
(@code{wl-message-toggle-disp-summary})
@item Button-2
Scrolls the message forward. When the bottom of the message is hit,
moves to the next message.
(@code{wl-message-wheel-up})
+
+@item D
+@kindex D (Message)
+@findex wl-message-delete-current-part
+Delete the part under cursor. In fact it appends modified message to
+the current folder then moves old one to trash folder. Therefore the
+message number will be changed.
+(@code{wl-message-delete-current-part})
@end table
@section Customizable Variables
At Summary mode, pressing @kbd{w} and the like creates a new draft
buffer. You can edit and send mail and news articles in this buffer.
+By pressing @kbd{W}, Wanderlust guess addressees and prepare draft buffer
+with those if possible.
+
+@menu
+* Usage of Draft Mode:: TIPS
+* Key Bindings of Draft:: Key bindings
+* Variables of Draft Mode:: Customize Draft Mode
+@end menu
+
+@node Usage of Draft Mode, Key Bindings of Draft, Draft, Draft
@section Tips
Basically it is Emacs-standard mail mode.
-@subsection Address Completion
+@menu
+* Editing Header::
+* Editing Message Body::
+* Dynamical Message Re-arrangement::
+* Template::
+* POP-before-SMTP::
+@end menu
+
+@node Editing Header, Editing Message Body, Usage of Draft Mode, Usage of Draft Mode
+@subsection Editing Message Header
+
+You can freely edit header region above @samp{--text follows this line--},
+until you invoke the sending operation.
Initially, the cursor is at the @samp{To:} field. Fill in recipients
addresses. @kbd{@key{TAB}} completes them.
-If you want to submit a news article, add @samp{Newsgroups:} field by
-yourself. Field names can be completed by @kbd{@key{TAB}}.
+You can use following headers to specify recipients. Add some of them
+by yourself. Field names can be completed by @kbd{@key{TAB}}.
-If you save the draft buffer you are editing, it is appended to the
-folder specified by @code{wl-draft-folder}.
+@table @asis
+@item @samp{Newsgroups:}
+Specify newsgroups to which you post the news article.
+
+@item @samp{Cc:}
+Specify addresses to send a copy (Carbon Copy) of the message.
+@end table
+
+Following ones are removed from the header contents before sending.
+
+@table @asis
+@item @samp{Bcc:}
+Specify addresses to send a copy (Blind Carbon Copy) of the message.
+
+@item @samp{Fcc:}
+Specify folders in which a copy of the message is saved.
+
+@item @samp{Ecc:}
+Specify recipients to send encapsulated copy of the message.
+@end table
+
+You can add initial headers by following variables.
+
+@table @code
+
+@item wl-fcc
+@vindex wl-fcc
+The initial setting is @code{nil}.
+If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
+the draft when it is prepared. If function is specified, its return
+value is used.
-Using @samp{FCC:} field, you can specify the folder to which a copy of
-the message is saved when it is sent.
+@item wl-bcc
+@vindex wl-bcc
+The initial setting is @code{nil}.
+If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
+the draft when it is prepared.
+@end table
+@node Editing Message Body, Dynamical Message Re-arrangement, Editing Header, Usage of Draft Mode
@subsection Editing Messages
+As a matter of course, editing message body can be performed in the same
+way as usual writing. You may write message body under
+@samp{--text follows this line--} line. (NOTE: Be sure to leave the line
+@samp{--text follows this line--} intact.)
+
Multi-part editing utilize MIME edit mode of SEMI. For procedures of
editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
a MIME user interface for GNU Emacs}.
You can also see help by @kbd{C-c C-x ?} in draft buffer.
+If you save the draft buffer you are editing, it is appended to the
+folder specified by @code{wl-draft-folder}.
+
+@node Dynamical Message Re-arrangement, Template, Editing Message Body, Usage of Draft Mode
@subsection Dynamic Modification of Messages
@vindex wl-draft-config-alist
@c @cindex Change Message
@end group
@end example
-Per default, there are 10 following sub-functions.
+Per default, there are 13 following sub-functions.
@example
'header: Inserts the specified string at the bottom of the header.
expression can be specified as is. If the car part is a header field
and the cdr part is @code{nil}, the field will be deleted.
-If you want to use name of parent folder, you can refer the buffer local
-variable @code{wl-draft-parent-folder}.
-
See the next example as well:
@lisp
when there is no buffer being replied, like after @code{wl-draft} was
invoked.
+If you want to use name of parent folder, you can refer the buffer local
+variable @code{wl-draft-parent-folder}. In the following example, Wanderlust
+changes From according to the folder name of the summary in which the draft
+was invoked.
+
+@lisp
+@group
+(setq wl-draft-config-alist
+ '(((string-match \".*@@domain1$\" wl-draft-parent-folder)
+ (\"From\" . \"user@@domain1\"))
+ ((string-match \".*@@domain2$\" wl-draft-parent-folder)
+ (\"From\" . \"user@@domain2\"))))
+@end group
+@end lisp
+
+
Note that @code{wl-draft-config-alist} is applied only once when
@code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
Therefore, if you want to apply @code{wl-draft-config-alist} again after
(add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
@end lisp
+@node Template, POP-before-SMTP, Dynamical Message Re-arrangement, Usage of Draft Mode
@subsection Inserting Templates
@cindex Template
@cindex Apply Template
(setq wl-template-alist
'(("default"
("From" . wl-from)
- ("Organization" . "~/.wl sample")
+ ("Organization" . "Example Co.Ltd.")
(body . "Hello.\n"))
("report"
(template . "default") ;; @r{(a)}
(template . "default")
@end lisp
+@node POP-before-SMTP, , Template, Usage of Draft Mode
@subsection Sending mail by POP-before-SMTP
@cindex POP-before-SMTP
@end group
@end example
+
+@node Key Bindings of Draft, Variables of Draft Mode, Usage of Draft Mode, Draft
@section Key Bindings
@cindex Keybind, Draft Mode
@cindex Keybind, Draft Buffer
@item C-c C-y
@kindex C-c C-y (Draft)
@findex wl-draft-yank-original
-Cites the content of the current message buffer.
+Cites the content of the current message buffer (the part under cursor).
+If the region is active, cites the region (it affects only if
+@code{transient-mark-mode} (on GNU Emacs) or @code{zmacs-regions}
+(on XEmacs) is Non-nil).
(@code{wl-draft-yank-original})
@item C-c C-p
(@samp{[...]}).
@end table
+@node Variables of Draft Mode, , Key Bindings of Draft, Draft
@section Customizable Variables
@table @code
If @code{wl-template-visible-select} is non-nil, this variable specifies
the size of the preview window.
+@item wl-draft-buffer-style
+@vindex wl-draft-buffer-style
+The initial setting is @code{full}.
+Style of draft buffer window (except for replying and forwarding).
+@code{keep} is to use current window,
+@code{full} is to use full frame window,
+@code{split} is to split current window and use it.
+If some function is specified, it is called with the draft buffer
+as an argument.
+
@item wl-draft-reply-buffer-style
@vindex wl-draft-reply-buffer-style
-The initial setting is @code{split}. @code{split} or @code{full} can be
-specified. In the case of @code{full}, the whole frame will be used for
-a reply draft buffer when it is prepared.
+The initial setting is @code{split}.
+Style of draft buffer for replying and forwarding.
+@code{keep} is to use message buffer window,
+@code{full} is to use full frame window,
+@code{split} is to split message buffer window and use it.
+If some function is specified, it is called with the draft buffer
+as an argument.
@item wl-draft-use-frame
@vindex wl-draft-use-frame
This is the User's address list. If you have multiple addresses,
set this variable.
-@item wl-fcc
-@vindex wl-fcc
-The initial setting is @code{nil}.
-If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
-the draft when it is prepared. If function is specified, its return
-value is used.
-
-@item wl-bcc
-@vindex wl-bcc
-The initial setting is @code{nil}.
-If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
-the draft when it is prepared.
-
@item wl-reply-subject-prefix
@vindex wl-reply-subject-prefix
The initial setting is @samp{Re: }.
In the @samp{Subject:} of the reply draft, this string is prepended to
the @samp{Subject:} of being replied.
+@item wl-forward-subject-prefix
+@vindex wl-forward-subject-prefix
+The initial setting is @samp{Forward: }.
+In the @samp{Subject:} of the forwarding draft, this string is prepended
+to the @samp{Subject:} of being forwarded.
+
@item wl-draft-reply-use-address-with-full-name
@vindex wl-draft-reply-use-address-with-full-name
The initial setting is @code{t}.
@item wl-draft-delete-myself-from-bcc-fcc
@vindex wl-draft-delete-myself-from-bcc-fcc
If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
-or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
+or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{Fcc:} field.
@item wl-smtp-posting-server
@vindex wl-smtp-posting-server
The initial setting is @code{nil}.
This is the SMTP server name for mail transmission.
+@item wl-smtp-posting-port
+@vindex wl-smtp-posting-port
+The initial setting is @code{nil}.
+This is the SMTP port number for mail transmission.
+If @code{nil}, default SMTP port number (25) is used.
+
@item wl-smtp-posting-user
@vindex wl-smtp-posting-user
The initial setting is @code{nil}.
SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
connection will be established.
+@item wl-nntp-posting-function
+@vindex wl-nntp-posting-function
+The initial setting is @code{elmo-nntp-post}.
+This is the function to post NNTP message.
+
+@item wl-nntp-posting-config-alist
+@vindex wl-nntp-posting-config-alist
+The initial setting is @code{nil}.
+The value takes an alist to define NNTP server like following example.
+It takes precedence over @code{wl-nntp-posting-@{server|user|port|function@}}.
+
+@lisp
+@group
+(setq wl-nntp-posting-config-alist
+ '((",?gmane\\." . "news.gmane.org")
+ (",?comp\\." .
+ ((server . "news-server")
+ (user . "newsmaster")
+ (port . 119)
+ (function . elmo-nntp-post)))
+ (".*" . "default-news-server")))
+@end group
+@end lisp
+
@item wl-pop-before-smtp-user
@vindex wl-pop-before-smtp-user
The initial setting is @code{nil}.
@node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
@subsection Transmission of Messages
-You can send mail/news messages off-line (if you are using
-@file{im-wl.el}, it is irrelevant). Messages sent off-line are
-accumulated in the queue folder, @samp{+queue}. These messages are
-transmitted at once when Wanderlust becomes on-line.
+You can proceed sending operation for mail/news messages while you are
+off-line, then it will be reserved for sending (if you are using
+@file{im-wl.el}, it is irrelevant).
+Messages reserved for sending while off-line are accumulated in the
+queue folder, @samp{+queue}. These messages are transmitted at once when
+Wanderlust becomes on-line.
You can visit @samp{+queue} in the off-line state and confirm content of
messages in the queue. You can also remove messages. Removed messages
@subsection Creation of Folders (IMAP4)
You can create IMAP folders off-line. The creation of folders are
-reflected in the servers when Wanderlust becomes on-line. At that time,
-if folders failed to be created on the servers for any reasons, messages
-re-filed to such folders are appended to the folder @samp{+lost+found}.
+reflected in the servers when Wanderlust becomes on-line. If the creation
+of those folders fails at that time for some reasons, messages
+to be re-filed into those are appended to the folder @samp{+lost+found}
+instead.
@node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
@item elmo-enable-disconnected-operation
@vindex elmo-enable-disconnected-operation
-The initial setting is @code{nil}. Controls off-line operations
+The initial setting is @code{t}. Controls off-line operations
regarding IMAP4. If non-nil, off-line operations are carried out.
@item elmo-lost+found-folder
@lisp
@group
(list wl-summary-important-mark
- wl-summary-new-mark
+ wl-summary-new-uncached-mark
+ wl-summary-new-cached-mark
wl-summary-unread-mark
wl-summary-unread-uncached-mark
wl-summary-unread-cached-mark)
@end table
-@node Scoring, Address Book, Expire and Archive, Top
+@node Scoring, Split messages, Expire and Archive, Top
@chapter Score of the Messages
@cindex Scoring
@c @cindex Kill File
@lisp
@group
-(list wl-summary-new-mark)
+(list wl-summary-new-uncached-mark
+ wl-summary-new-cached-mark)
@end group
@end lisp
@end example
-@node Address Book, Customization, Scoring, Top
+@node Split messages, Address Book, Scoring, Top
+@chapter Message splitting
+@cindex Split messages
+
+You can use @code{elmo-split} to split message in folder specified by
+the variable @code{elmo-split-folder} a la @command{procmail} according
+to some specified rules. To use this feature, set as follows in your
+@file{~/.emacs} at first.
+
+@lisp
+(autoload 'elmo-split "elmo-split" "Split messages on the folder." t)
+@end lisp
+
+Set source folder like following.
+
+@lisp
+(setq elmo-split-folder "%inbox")
+@end lisp
+
+And specify the rule in the variable @code{elmo-split-rule} (its format
+will be is described below).
+Then you can invoke @kbd{M-x elmo-split} to split messages according to
+@code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split}
+to do a rehearsal and show result (do not split actually).
+
+
+We will describe how to specify the rule. First of all, see following
+example, please.
+
+@lisp
+@group
+(setq elmo-split-rule
+ ;; @r{Store messages from spammers into @samp{+junk}}
+ '(((or (address-equal from "i.am@@spammer")
+ (address-equal from "dull-work@@dull-boy")
+ (address-equal from "death-march@@software")
+ (address-equal from "ares@@aon.at")
+ (address-equal from "get-money@@richman"))
+ "+junk")
+ ;; @r{Store messages from mule mailing list into @samp{%mule}}
+ ((equal x-ml-name "mule") "%mule")
+ ;; @r{Store messages from wanderlust mailing list into @samp{%wanderlust}}
+ ;; @r{and continue evaluating following rules}
+ ((equal x-ml-name "wanderlust") "%wanderlust" continue)
+ ;; @r{Store messages from Yahoo user into @samp{+yahoo-@{username@}}}
+ ((match from "\\(.*\\)@@yahoo\\.com")
+ "+yahoo-\\1")
+ ;; @r{Store unmatched mails into @samp{+inbox}}
+ (t "+inbox")))
+@end group
+@end lisp
+
+The basic unit of the rule is a combination like
+
+@lisp
+(@samp{CONDITION} @samp{ACTION} [@code{continue}])
+@end lisp
+
+If @samp{CONDITION} is true, @samp{ACTION} is performed.
+The 1st element @samp{CONDITION} is a condition represented by a
+balanced expression (sexp). Its grammar will be explained below.
+The 2nd element @samp{ACTION} is the name of the folder to split
+messages into, or a symbol. When the 3rd element @code{continue} is
+specified as symbol, evaluating rules is not stopped even when the
+condition is satisfied.
+
+The grammar for @samp{CONDITION} is as follows. See example above to
+learn how to write the condition practically.
+
+@enumerate
+@item
+Functions which accept arguments @samp{FIELD-NAME} and @samp{VALUE}.
+(@samp{FIELD-NAME} is a symbol that describes the field name)
+
+@table @code
+@item @code{equal}
+True if the field value equals to @samp{VALUE}.
+Case of the letters are ignored.
+@item @code{match}
+True if the field value matches to VALUE.
+@samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
+from matching @code{\(\)} patterns in the previous @samp{VALUE}.
+@item @code{address-equal}
+True if one of the addresses in the field equals to
+@samp{VALUE}. Case of the letters are ignored.
+@item @code{address-match}
+True if one of the addresses in the field matches to
+@samp{VALUE}.
+@samp{VALUE} can contain @code{\&} and @code{\N} which will substitute
+from matching @code{\(\)} patterns in the previous @samp{VALUE}.
+@end table
+
+@item
+Functions which accept an integer argument (@samp{SIZE}).
+
+@table @code
+@item @code{<}
+True if the size of the message is less than @samp{SIZE}.
+@item @code{>}
+True if the size of the message is greater than @samp{SIZE}.
+@end table
+
+@item
+Functions which accept any number of arguments.
+
+@table @code
+@item @code{or}
+True if one of the argument returns true.
+@item @code{and}
+True if all of the arguments return true.
+@end table
+
+@item
+A symbol.
+
+When a symbol is specified, it is evaluated.
+@end enumerate
+
+You can specify followings as 2nd @samp{ACTION}.
+
+@enumerate
+@item
+folder name
+
+If some string is specified, it will be regarded as the destination
+folder, and the message will be appended to it.
+
+@item
+@samp{delete}
+
+If the symbol @samp{delete} is specified, delete the substance of the
+message in @code{elmo-split-folder}
+
+@item
+@samp{noop}
+
+If the symbol @samp{noop} is specified, do nothing on the message and
+keep it as it is.
+
+@item
+function
+
+If some function is specified, execute it.
+@end enumerate
+
+If the message passes all rules, it will be dealed along @samp{ACTION}
+specified by @code{elmo-split-default-action}.
+
+
+@node Address Book, Customization, Split messages, Top
@chapter Address Book
@cindex Address Book
* Address Manager:: Address Manager
@end menu
+
@node Mail Addresses, Address Manager, Address Book, Address Book
@section Address book
@cindex Address book Definition
@end table
-@node Customization, Mailing List, Address Book, Top
+@node Customization, Terminology, Address Book, Top
@chapter Customizing Wanderlust
@cindex Customization
@menu
* imput:: imput (im-wl.el)
-* BBDB:: BBDB
+* BBDB:: The Insidious Big Brother Database
+* LSDB:: The Lovely Sister Database
* supercite:: supercite.el
* mu-cite:: mu-cite.el
* X-Face:: x-face,bitmap-mule
@end lisp
-@node BBDB, supercite, imput, Living with other packages
+@node BBDB, LSDB, imput, Living with other packages
@subsection bbdb.el
@pindex BBDB
-Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
-settings.
+To use The Insidious Big Brother Database (@uref{http://bbdb.sourceforge.net/})
+with Wanderlust, place @file{util/bbdb-wl.el} on the @code{load-path}
+and do the following settings.
If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
byte-compiled and installed.
in draft buffer.
-@node supercite, mu-cite, BBDB, Living with other packages
+@node LSDB, supercite, BBDB, Living with other packages
+@subsection lsdb.el
+@pindex LSDB
+
+The following is an example setting to use
+The Lovely Sister Database (@uref{http://sourceforge.jp/projects/lsdb/})
+with Wanderlust.
+
+@lisp
+@group
+(require 'lsdb)
+(lsdb-wl-insinuate)
+(add-hook 'wl-draft-mode-hook
+ (lambda ()
+ (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
+@end group
+@end lisp
+
+In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
+(complete address with LSDB).
+
+
+@node supercite, mu-cite, LSDB, Living with other packages
@subsection sc.el(supercite), sc-register.el
@pindex sc
@pindex supercite
@vindex wl-draft-reply-myself-with-argument-list
@vindex wl-draft-reply-myself-without-argument-list
-If you want, when you replying to articles in mailing lists, the address
-in Reply-To field of the original message to be prepared to To field of
-the reply draft by simply pressing @kbd{a} in the summary mode, try the
-following settings:
+If you type @kbd{a} in the Summary Buffer, a draft for reply is prepared.
+The addressee for the draft is decided by following rules.
+
+For example, you can set as follows:
@lisp
@group
@end group
@end lisp
-@noindent
-(Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
-in the original message, @samp{Reply-To:} field in the original is
-copied to @samp{To:} field.)
+Where each element of the list @code{wl-draft-reply-without-argument-list}
+is in the form
+
+@example
+(key . (to-list cc-list newsgroup-list))
+@end example
+
+and if the field designated by @samp{key} exist in the parent message,
+parent's field values designated by @samp{to-list} are copied to @samp{To:}
+in the draft. Similarly, parent's fields designated by @samp{cc-list} and
+@samp{newsgroup-list} are copied to @samp{Cc:} and @samp{Newsgroups:} in
+the draft respectively.
+
+Examples:
+
+@lisp
+("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
+@end lisp
+
+Match if the parent has @samp{Mail-Followup-To} field.
+The components of parent's @samp{Mail-Followup-To} and @samp{Newsgroups}
+fields are copied to @samp{To} and @samp{Newsgroups} in the draft
+respectively.
+
+@lisp
+(("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
+@end lisp
+
+Match if the parent has both @samp{X-ML-Name} and @samp{Reply-To} fields.
+Parent's @samp{Reply-To} is copied to @samp{To} in the draft.
+
+@lisp
+("From" . (("From") ("To" "Cc") ("Newsgroups")))
+@end lisp
+
+Copy parent's @samp{From} to @samp{To} in the draft, parent's @samp{To} and
+@samp{Cc} to @samp{Cc}, parent's @samp{Newsgroups} to @samp{Newsgroups}
+respectively.
+
+These are evaluated in order and first matched one is used.
Moreover, the behavior of @kbd{a} with prefix argument can
be directed by @code{wl-draft-reply-with-argument-list} as well.
-Note: To set the behavior when you reply to the message written by yourself, use
-@code{wl-draft-reply-myself-without-argument-list} and
-@code{wl-draft-reply-myself-with-argument-list}
-instead of them.
+By the way, you can use some function (will be evaluated in the parent
+message buffer) in the place of @samp{key} or @samp{to-list} etc.
+For example, if you only want to reply to mailing lists in
+@code{wl-subscribed-mailing-list} if the parent has some of them,
+set as follows:
+
+@lisp
+@group
+(defun wl-mailing-list-addresses ()
+ (let (list-addrs)
+ (dolist (to (mapcar
+ (lambda (addr)
+ (nth 1 (std11-extract-address-components addr)))
+ (wl-parse-addresses
+ (wl-concat-list
+ (elmo-multiple-fields-body-list (list "To" "Cc"))
+ ","))))
+ (when (elmo-string-matched-member to wl-subscribed-mailing-list t)
+ (setq list-addrs (cons to list-addrs))))
+ (nreverse list-addrs)))
+
+(setq wl-draft-reply-with-argument-list
+ '((wl-mailing-list-addresses . (wl-mailing-list-addresses nil nil))
+ ("Reply-To" . (("Reply-To") nil nil))
+ ("Mail-Reply-To" . (("Mail-Reply-To") nil nil))
+ ("From" . (("From") nil nil))))
+@end group
+@end lisp
+
+
+Note: To set the behavior when you reply to the message written by yourself,
+use @code{wl-draft-reply-myself-without-argument-list} and
+@code{wl-draft-reply-myself-with-argument-list} instead of them.
@node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
@subsection Appearance of Threads
@lisp
@group
(setq wl-generate-mailer-string-function
- (function
- (lambda ()
- (concat "User-Agent: "
- (wl-generate-user-agent-string-1 nil)))))
+ 'wl-generate-user-agent-string-1)
@end group
@end lisp
@lisp
@group
-(setq mime-edit-insert-user-agent-field nil)
-(setq wl-generate-mailer-string-function
- (function
- (lambda ()
- (format "X-Mailer: %s" (product-string-1 'wl-version)))))
+(setq wl-generate-mailer-string-function nil)
+(setq wl-draft-additional-header-alist
+ (list
+ (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
@end group
@end lisp
The initial setting is @code{t}.
If non-nil, you are asked for confirmation when mail is sent.
+@item wl-default-sync-range
+@vindex wl-default-sync-range
+The initial setting is @samp{update}.
+Default update range of the summary. You can specify
+@samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}.
+See description of @code{wl-summary-sync} for the meaning of ranges.
+
@item wl-folder-sync-range-alist
@vindex wl-folder-sync-range-alist
The initial setting is the alist shown below:
@noindent
This is an associative list of regular expressions of folder names and
update range of the summary. Update range is one of the @samp{all},
-@samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
-@samp{last}. If a folder do not match, @samp{update} is used.
+@samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not
+match any of them, the value of @code{wl-default-sync-range} is used
+(@samp{update} by default).
+See description of @code{wl-summary-sync} for the meaning of ranges.
@item wl-ask-range
@vindex wl-ask-range
(Not yet written)
+@node Terminology, Mailing List, Customization, Top
+@chapter Terminology around Wanderlust
+@cindex Terminology
+
+Here we explain terminologies used in this manual.
+
+@table @samp
+@item folder
+A container in which messages are stored.
+
+@item group
+A set consists of some folders.
+
+@item access group
+A special group consists of automatically collected folders under
+some specified path.
+@xref{Folder Definition}.
+
+@item summary buffer
+A buffer for displaying list of messages in some folder.
+
+@item sticky summary
+Compared with ordinary summary buffer which will be destroyed after
+exiting from it, this type of summary will be remain even after exiting
+by @kbd{q} or @kbd{g}.
+@xref{Sticky Summary}.
-@node Mailing List, Addition, Customization, Top
+@item expire
+To delete or put into the archive expired messages.
+@xref{Expire}.
+
+@item score
+@xref{Scoring}.
+
+@item prefetch
+To cache messages beforehand in order to read messages after you will be
+disconnected from the server.
+@end table
+
+
+@node Mailing List, Addition, Terminology, Top
@chapter Wanderlust Mailing List
@cindex Bug report
@cindex Backtrace
+Topics related to Wanderlust are discussed in following mailing lists.
+The latest version is also announced there.
+
@display
Wanderlust Mailing List @t{<wl@@lists.airs.net>}
@end display
-Topics related to Wanderlust are discussed in the mailing list.
-The latest version is also announced there (in Japanese, sorry).
+In this list Japanese is mainly used for discussion. We also have a list
+for discussion in English:
+
+@display
+Wanderlust List in English @t{<wl-en@@lists.airs.net>}
+@end display
+(Messages posted to this list are also forwarded to the former one.)
A guide can be obtained automatically by sending mail to
-@t{wl-ctl@@lists.airs.net} with the body
+@t{wl-ctl@@lists.airs.net} (or to @t{wl-en-ctl@@lists.airs.net} for
+the English one) with the body
@example
# guide
@end example
-Please send bug reports or patches to the mailing list. You can post to
+
+Please send bug reports or patches to one of those lists. You can post to
the mailing list even though you are not a member of it.
If you send a bug report, please attach Backtrace with it.
2001 7/04 Released 2.6.0 stable.
8/21 wl-addrmgr by Kitamoto-san.
12/27 Released 2.8.1 stable.
+2002 12/11 Released 2.10.0 stable.
@end example
See @file{ChangeLog} for details.
projects / elisp / wanderlust.git / blobdiff