Wanderlust User’s Manual ¶

1.1 Environment ¶

It expected that Wanderlust works on Emacs 24.5 and later. Furthermore, Wide int feature is required on 32-bit machines.

IMAP4 connectivity with following imapd are confirmed to work with Wanderlust:

• UW imapd 4.1–4.7, 4.7a, 4.7b, 4.7c, 2000 or later
• Cyrus imapd 1.4, 1.5.19, 1.6.22–1.6.24, 2.0.5 or later
• Courier-IMAP 1.3.2 or later
• AIR MAIL (AIRC imapd release 2.00)
• Express Mail
• Microsoft Exchange Server 5.5
• Sun Internet Mail Server 3.5, 3.5.alpha, 4.0

LDAP connectivity with following LDAPd are confirmed to work with Wanderlust:

• OpenLDAP 2.0.6 or later

2.1 Installing MIME modules ¶

You must install packages named APEL-LB, FLIM-LB and SEMI-EPG, which are variants of APEL, FLIM and SEMI, beforehand to use Wanderlust.

APEL-LB:  https://github.com/wanderlust/apel
FLIM-LB:  https://github.com/wanderlust/flim
SEMI-EPG: https://github.com/wanderlust/semi

You can download original APEL, FLIM and SEMI from following URLs:

APEL:   http://git.chise.org/elisp/dist/semi/
FLIM:   http://git.chise.org/elisp/dist/apel/
SEMI:   http://git.chise.org/elisp/dist/semi/

You have to install APEL-LB, FLIM-LB and SEMI-EPG in this order. Generally, ‘make install’ will do the job.

Refer to the documents of each package for detailed installation procedure.

You have to re-install Wanderlust if you upgraded APEL-LB, FLIM-LB or SEMI-EPG.

2.2 Download and Extract the Package ¶

You can download Wanderlust package from following sites:

Original site:

https://github.com/wanderlust/wanderlust

Mirrored ftp/http sites:

http://www.jpl.org/ftp/pub/github-snapshots/

Extract the obtained package to your working directory:

% cd ~/work
% tar zxvf wl-version.tar.gz
% cd wl-version

• To use SSL (Secure Socket Layer)

ftp://opaopa.org/pub/elisp/

2.3 Byte-compile and install ¶

• Installation
• WL-CFG
• Run in place
• Manual

% make
% make install

(setq ELMO_PREFIX "elmo")

(add-to-list 'load-path "~/work/wl-version/wl")
(add-to-list 'load-path "~/work/wl-version/elmo")

% make info
% make install-info

http://wanderlust.github.io/wl-docs/wl.html

2.4 Set up .emacs ¶

The Wanderlust package contains two module groups.

‘ELMO (elmo-*.el)’

These modules show everything as folders. This is the back-end for WL.

‘WL (wl-*.el)’

These modules controls the behavior of main body of Wanderlust. They are also the front-end for ELMO.

You can customize the behavior of Wanderlust by changing the value of environmental variables which begins with elmo- and wl-.

The minimal requirement for settings is as the following.

;; autoload configuration
(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)

;; Directory where icons are placed.
;; Default: the peculiar value to the running version of Emacs.
;; (Not required if the default value points properly)
(setq wl-icon-directory "~/work/wl/etc")

;; SMTP server for mail posting. Default: nil
(setq wl-smtp-posting-server "your.smtp.example.com")
;; NNTP server for news posting. Default: nil
(setq wl-nntp-posting-server "your.nntp.example.com")

~/.wl is automatically loaded when Wanderlust starts up (if such a file exists). So it is convenient to gather Wanderlust specific settings in ~/.wl. Settings for "face" must be written in ~/.wl, because you can’t write them in .emacs (if you write it to .emacs, you’ll get an error). See Highlights.

All above described settings except autoload configuration can be written in ~/.wl).

• mail-user-agent

(autoload 'wl-user-agent-compose "wl-draft" nil t)
(if (boundp 'mail-user-agent)
    (setq mail-user-agent 'wl-user-agent))
(if (fboundp 'define-mail-user-agent)
    (define-mail-user-agent
      'wl-user-agent
      'wl-user-agent-compose
      'wl-draft-send
      'wl-draft-kill
      'mail-send-hook))

2.5 Folder Definition ¶

You can skip this section because it is possible to add/edit the subscribe folders from the buffer for list of folders. See Editing Folders.

Define the folders you want to subscribe in file ~/.folders. The contents written in ~/.folders become the folders which you subscribe to as it is.

Format for ~/.folders is very simple. Here is an example:

#
# Lines begin with ‘#’ are comment.
# Empty lines are ignored
#
# folder name  "folder nickname"
# (nicknames are not necessary)
#
%inbox  "Inbox"
+trash  "Trash"
+draft  "Drafts"
%#mh/Backup@my.imap.example.com
# Nickname can be defined in another line
= %#mh/Backup@my.imap.example.com "Sent"
# Folder Group
Emacsen{
    %#mh/spool/wl            "Wanderlust ML"
    %#mh/spool/elips         "ELIPS ML"
    %#mh/spool/apel-ja       "APEL Japanese ML"
    %#mh/spool/xemacs-beta   "XEmacs beta"
    -fj.news.reader.gnus@other.nntp.example.com "Gnus Net news"
    *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
}
#
# If folder name ends with ‘/’, that means an ‘access group’,
# all subfolders automatically included in one folder group.
#
%#mh/expire@localhost /
# All MH folders are included in one folder group.
+ /
# Define nickname for access group
= + "Mails"

Each line contains one folder you want to read. The definition of folders will be explained in detail in the next section.

The part surrounded by ‘group name{’ and ‘}’ will become one folder group. One folder group is treated as a directory which can be opened and closed in folder mode. It is convenient for collecting some folders and putting them in order.

Please note that ‘group name{’ and ‘}’ occupies one line and you have to write it that way (It is because the parser sucks).

There are two types of groups. One is like ‘Emacsen’ from above example which the user chooses his favorite folders as a group.

The other one is access group like ‘+ /’ from above example. It collects all sub-folders in the folder to make a group. (Its behavior differs by the type of the folder. For example, ‘+’ followed by ‘/’ makes entire MH sub-directories to one group) If you want nickname access group, you need define it in another line. You can’t define in a line as normal folder.

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.

2.6 Start Wanderlust ¶

If installation and configuration worked well, you can invoke Wanderlust by typing following command in Emacs.

M-x wl

After initialization, Folder Mode which shows the list of folders will appear. That means the folders you defined in the ~/.folders are listed.

If you start Wanderlust with prefix argument like C-u M-x wl, you can skip folder checking.

2.7 Overview ¶

Basically, you will handle messages in wanderlust while you come and go from/to each of the following buffers. Details of each ones are explained in following chapters.

‘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.

‘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.

‘Message Buffer’

You can see the contents of the message. You can save part to disk or open in external programs.

‘Draft Buffer’

You can edit message.

3.1 IMAP Folder ¶

A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).

Format:

‘%’ mailbox [‘:’ username [‘/’ authenticate-type]][‘@’ hostname][‘:’ port][‘!’]

You can specify login (encoded password transmission), cram-md5 (CRAM-MD5 authentication), digest-md5 (DIGEST-MD5 authentication) or clear (or nil, plain password transmission) as authenticate-type.

default:

username  -> The value of elmo-imap4-default-user.
             Initial setting is USER environment variable or
             LOGNAME environment variable or return value of
             (user-login-name).
authenticate-type -> The value of elmo-imap4-default-authenticate-type.
             Initial setting is "auth".
hostname  -> The value of elmo-imap4-default-server.
             Initial setting is "localhost".
port -> The value of elmo-imap4-default-port.
             Initial setting is 143.

You can omit the hostname from folder names if you set elmo-imap4-default-server as your main IMAP server. For example, you can specify a folder as ‘foo%imap@gateway’ even if you have to go through a firewall.

;; Example: imap4.exaple.org as main IMAP server
(setq elmo-imap4-default-server "imap4.example.org")

SSL (Secure Socket Layer) connection will be used if a folder name ends with ‘!’. If a folder name ends with ‘!!’, STARTTLS connection will be established.

If the value of elmo-imap4-default-stream-type is ssl, SSL will be the default connection, i.e. you can omit ‘!’. If it is is starttls, STARTTLS will be the default connection. To use normal connection in these cases, add ‘!direct’ at the end of folder name.

;; Example: Use SSL connection
(setq elmo-imap4-default-stream-type 'ssl)

If you specify login, cram-md5 or digest-md5 as authentication method, the password is sent in encoded form. But, if your server is unable to receive an encoded password, authentication will fall back to clear (that is, sending password in raw format) after confirmation to user. If elmo-imap4-force-login is non-nil, authentication will fall back to clear without confirmation (default value is nil).

;; Example: password in raw format
(setq elmo-imap4-default-authenticate-type 'clear)

Example:

%inbox     -> IMAP mailbox "inbox"
%#mh/inbox -> IMAP mailbox "#mh/inbox"

%inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
%inbox:hoge/clear@server1
            -> server1's IMAP mailbox "inbox"
               of user "hoge", with plain password authentication
               ('clear).

• International mailbox names (Modified UTF7)

3.2 NNTP Folder ¶

A folder to access USENET news via NNTP protocol (RFC 977). One newsgroup is treated as a folder.

Format:

‘-’ newsgroup [‘:’ username][‘@’ hostname][‘:’ port][‘!’]

default:

hostname  -> The value of elmo-nntp-default-server.
             Initial setting is ‘localhost’.
username  -> The value of elmo-nntp-default-user.
             Initial setting is nil.
port      -> The value of elmo-nntp-default-port.
             Initial setting is 119.

AUTHINFO is used as authentication method if the username is non-nil. SSL connection will be used if a folder name ends with ‘!’. If a folder name ends with ‘!!’, STARTTLS connection will be established.

If the value of elmo-nntp-default-stream-type is ssl, SSL will be the default connection, i.e. you can omit ‘!’. If it is is starttls, STARTTLS will be the default connection. To use normal connection in these cases, add ‘!direct’ at the end of folder name.

Example:

-fj.rec.tv            -> Newsgroup ‘fj.rec.tv’.
-fj.rec.tv@newsserver -> Newsgroup ‘fj.rec.tv’ on ‘newsserver’.

3.3 MH Folder ¶

A folder to access MH format mail (1 file is 1 mail).

Format:

‘+’ directory-name

Normally, directory-name is an relative path to the variable elmo-localdir-folder-path (default is ~/Mail), but if it starts with ‘/’ or ‘~’, then it is treated as an absolute path (this is also true for drive-letters).

Message number is used for the name of the message file.

Example:

+inbox         -> ~/Mail/inbox
+from/teranisi -> ~/Mail/from/teranisi
+~/test        -> ~/test

• Variables About MH Folder

3.4 Maildir Folder ¶

A folder to access Maildir format (1 file is 1 mail).

Format:

‘.’ [directory-name]

Normally, directory-name is a relative path to the variable elmo-maildir-folder-path (default is ~/Maildir), but if it starts with ‘/’ or ‘~’, then it is treated as an absolute path (this is also true for drive-letters).

Maildir contains cur, new and tmp subdirectories. Messages are contained in the cur directory. All message files in the new directory are moved to cur directory when you access the folder. All message files contained in the tmp directory and not accessed for 36 hours are deleted.

This behavior conforms to the http://cr.yp.to/proto/maildir.html.

Example:

.              -> ~/Maildir
.inbox         -> ~/Maildir/inbox
.from/teranisi -> ~/Maildir/from/teranisi
.~/test        -> ~/test

3.5 News Spool Folder ¶

This folder handles locally saved news articles which are proposed by Mew/IM. You can also read articles directly from a spool-file which is retrieved by an utility like gnspool.

Format:

‘=’ directory-name

directory-name is a sub-directory to the directory defined by variable elmo-localnews-folder-path (default is ~/News) You can use ‘.’ as directory delimiter as well as ‘/’.

Example:

=fj/os/os2         -> ~/News/fj/os/os2
=fj.os.bsd.freebsd -> ~/News/fj/os/bsd/freebsd

3.6 Archive Folder ¶

This method can handle archive files, which are compressed by utilities such as Info-ZIP or LHA, as one folder.

Format:

‘$’ path-name [‘;’ archiver-type ‘;’ prefix]

path-name is the relative path from elmo-archive-folder-path (initial setting is ~/Mail). If path-name begins with ‘/’ or ‘~’ or ‘drive-letter of DOS’, path-name is treated as absolute path. ange-ftp format is also permitted under the environment of ange-ftp, efs.

The actual file name of the archive folder is elmo-archive-basename (Initial setting is elmo-archive) under the path-name. If a file named path-name exists, it is treated as folder. The suffix is automatically decided for archiver-type.

If archiver-type is omitted, elmo-archive-default-type (Initial setting is zip) is referred.

prefix specifies the internal directory structure of the archive. For example, if the ML server is fml, msend.tar.gz has a structure like spool/1, so you have to specify ‘spool’ as prefix.

Example:

$teranisi         -> ~/Mail/teranisi/elmo-archive.zip
$bsd/freebsd;lha  -> ~/Mail/bsd/freebsd/elmo-archive.lzh
$/foo@server:~/bar;zoo     -> ~/bar/elmo-archive.zoo on ftp server
$d:/msend.tar.gz;tgz;spool -> d:/msend.tar.gz
$ml;zip/        -> Access group consists of archive folders
                   under ~/Mail/ml

• Supported Archives
• OS specific information about archiver
• TIPS
• Variables About Archive Folder

        LHA, Info-ZIP/UNZIP, ZOO, RAR  ;; full-access
        GNU TAR('tgz, 'tar)            ;; read-only

[OS/2]  Warp4.0J(w/o VoiceType)+Fx00505/emx0.9c(fix04)/PMMule,EmacsPM
         LHA  OS/2 version Rel.2.06b    Feb 18, 1998
        *UnZip 5.32 of 3 November 1997, by Info-ZIP.
        *Zip 2.2 (November 3rd 1997).
         Zoo archiver, zoo 2.1 $Date: 91/07/09 02:10:34 $
         GNU tar version 1.10 - AK 2.58 (DBCS/SJIS) 981216(homy) version
         gzip 1.2.4 (18 Aug 93) + bzip2 patch(by Iida-san)

[UN|X]  FreeBSD 2.2.7-RELEASE, Linux 2.0.30, Solaris2.6, HP-UX 9.07
         LHa for UNIX  V 1.14c
         UnZip 5.32 of 3 November 1997
         Zip 2.2 (November 3rd 1997)
         GNU tar 1.12 (1.11.x is no good)
         gzip 1.2.4 (18 Aug 93)

[Win32] Win.98/Meadow
         Lha32 version 1.28
         Zip 2.2
         UnZip 5.40
         GNU tar 1.11.8 + 1.5(WIN32)
         GZIP 1.2.4
         RAR 2.06

(setq wl-fcc "$backup")
(setq wl-trash-folder "$trash;lha")

3.7 POP Folder ¶

A folder to access e-mails via POP3 protocol (RFC 1939).

Format:

‘&’ [username][‘/’ authenticate-type][‘:’ numbering-method][‘@’ hostname][‘:’ port][‘!’]

You can specify ‘user’ (plain password transmission) or ‘apop’ (APOP authentication) as authenticate-type.

You can specify ‘uidl’ (use UIDL command for message numbering) or ‘list’ (use LIST command for message numbering) as ‘numbering-method’.

default:

username   -> The value of elmo-pop3-default-user.
              Initial setting is USER environment variable or
             LOGNAME environment variable or return value of
             (user-login-name).
authenticate-type -> The value of elmo-pop3-default-authenticate-type.
              Initial setting is ‘user’.
numbering-method -> Follow the value of elmo-pop3-default-use-uidl.
              If t, use UIDL for numbering. Initial setting is t.
hostname   -> The value of elmo-pop3-default-server.
              Initial setting is ‘localhost’.
port       -> The value of elmo-pop3-default-port.
              Initial setting is 110.

Example:

&hoge@localhost     -> access localhost as user ‘hoge’.
&hoge@popserver:109 -> access the server "popserver" on port 109
                        as user ‘hoge’.

If the last character of the folder name is ‘!’, Wanderlust connects to the POP server via SSL (Secure Socket Layer). If a folder name ends with ‘!!’, STARTTLS connection will be established.

If the value of elmo-pop3-default-stream-type is ssl, SSL will be the default connection, i.e. you can omit ‘!’. If it is is starttls, STARTTLS will be the default connection. To use normal connection in these cases, add ‘!direct’ at the end of folder name.

3.8 Shimbun Folder ¶

A folder for watching "shimbun" (means "newspaper" in Japanese), news site and mailing list archives on WWW by using emacs-w3m (http://emacs-w3m.namazu.org/).

You should possess w3m and emacs-w3m to use this.

Format:

‘@’ module-name ‘.’ folder-name

Admissible values of module-name and folder-name are described in README.shimbun.ja distributed with emacs-w3m.

Example:

@airs.wl  -> archive of wanderlust ML (using module sb-airs.el)
@asahi/   -> access group of all folders in module sb-asahi.el

• Variables About Shimbun Folder

3.9 RSS Folder ¶

An RSS folder presents the messages contained in an RSS or Atom feed:

Format:

‘rss:’ URL for RSS or Atom

Example:

rss:https://github.com/wanderlust/wanderlust/commits/master.atom

This folder type attempts to automatically handle all known versions of RSS and Atom. Should you need more configurability, please use a Shimbun folder (see Shimbun Folder) instead.

Since this folder doesn’t do any persistent caching, messages will disappear as soon as they expire from the feed. Should you want persistent messages, combine this with a pipe folder (see Pipe Folder):

|rss:http://lwn.net/headlines/newrss|+lwn

You may also use an RSS, Atom or OPML feed as an access group, in which case related feeds will appear as subfolders.

3.10 Search Folder ¶

A folder to access messages found by an external program with some condition.

Format:

‘[’ search condition ‘]’ [ search target [ ‘!’ search engine ] ]

The format of the search condition and search target depend on the search engine.

• Supported search engines
• namazu
• grep
• rgrep
• mu
• notmuch

[wanderlust]           -> search messages matched with
                       "wanderlust" from the default index
[semi flim]~/Mail/semi -> search "semi flim" from the index
                       in the directory "~/Mail/semi"

(setq elmo-search-namazu-index-alias-alist
      '(("cache" . "~/.elmo/cache")
        ("docs" . "~/documents")))

[wanderlust]cache

(setq elmo-search-namazu-index-alias-alist
      '(("all" . ("~/.elmo/cache" "~/documents"))
        ("cache" . "~/.elmo/cache")))

[wanderlust]all

[wanderlust]~/Mail/inbox!grep
    -> search messages matched with "wanderlust"
       from the directory "~/Mail/inbox"

["[sr]emi"]~/Mail/semi!grep
    -> If ‘]’ is included in regular expression,
       search condition should be enclosed with ‘"’.

(eval-after-load "elmo-search"
  '(elmo-search-register-engine
    'grep 'local-file
    :prog "find"
    :args '(elmo-search-rgrep-target
            "-maxdepth" "1" "-type" "f" "-exec" "grep" "-l" "-e"
            pattern "{}" "+")))

[wanderlust]~/Mail/inbox!rgrep
    -> search messages matched with "wanderlust"
       from the directory "~/Mail/inbox" including subdirectories.

[Helsinki]
    -> messages about Helsinki (in message body, subject, sender, ...)

[to:Jack subject:jellyfish tumbleweed]
    -> messages to Jack with subject jellyfish containing the word tumbleweed

[size:2k..2m date:20091201..20093112 flag:attach from:bill]
    -> messages between 2 kilobytes and a 2Mb,
       written in December 2009 with an attachment from Bill

[subject:soc* flag:unread]
    -> unread messages about things starting with 'soc'
       (soccer, society, socrates, ...)

[mime:image/*]
    -> messages with images as attachment

['foo bar']
    -> search for messages with the phrase "foo bar"

[term1]
    -> messages that contain 'term1'

[-term1]
    -> messages that DO NOT contain 'term1'

[term1 term2]
    -> messages containing term1 and term2

['foo bar']
    -> search for messages with the phrase "foo bar"

3.11 Multi Folder ¶

A folder to access virtual folder which collects messages from multiple folders.

Format:

‘*’ folder-1 [‘,’ folder-2] ... [‘,’ folder-N]

After ‘*’ character, specify multiple folders you want to collect separated by ‘,’ like ‘folder-1,folder-2,…,folder-N’.

Example:

*-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
-> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
   treated as one folder.

*+inbox,-fj.rec.tv,%inbox
-> +inbox, -fj.rec.tv and %inbox are treated as one folder.

3.12 Filter Folder ¶

A folder to access virtual folder which collects all messages that satisfy a condition.

Format:

‘/’ condition ‘/’ target-folder

In the condition part, you can specify following.

1. Partial filter: ‘first:number’, ‘last:number’

   first: number messages are picked from top of folder. last: number messages are picked from bottom of folder.

   Example:

   /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
   /first:20/%inbox      -> First 20 messages from %inbox are picked.
   

2. Date filter: ‘since:date’, ‘before:date’

   since: only messages arrived since date are picked (date is included). before: only messages arrived before date are picked (date is not included).

   You can specify following as date.

   yesterday   ->  a day before today.
   lastweek    ->  same day of last week.
   lastmonth   ->  same day of last month.
   lastquarter ->  same day of last quarter.
   lastyear    ->  same day of last year.
   numberdaysago -> number days ago. (e.x. '3daysago')
   day-month-year -> specify date directly (ex. 1-Nov-1998)
   

   Example:

   /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
                             are picked.
   /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
                             are picked.
   

3. Field filter: ‘field:value’

   All messages that have field and its value is value are picked. field and value are case insensitive.

   Example:

   /from:teranisi/+inbox -> In +inbox, messages which have From: field
                            and its value includes "teranisi" string are picked.
   /body:foo/%inbox      -> In %inbox, messages which have "foo" text
                            are picked.
   

4. Flag filter: ‘flag:flag-name’

   Pick up messages with flag specified by flag-name.

   You can specify following flag names:

   unread    -> unread
   important -> important
   answered  -> replied
   forwarded -> forwarded
   digest    -> unread or important
   any       -> unread or replied or forwarded or global-flag.
   

   You can also use flags which you have set as ‘global-flag’. global-flag is a flag which has arbitrary name. You can put global-flag on messages by invoking wl-summary-set-flags (Key F). By default, ‘important’ flag is prepared. You can view messages with global-flag by visiting the subfolder of ‘'flag’ folder.

   See Internal folder.

   Example:

   /flag:digest/%inbox     -> a folder consist of unread or important
                              message in %inbox.
   /flag:wl/+ML/Wanderlust -> a folder consist of messages with global flag
                              wl in +ML/Wanderlust.
   

5. Compound condition

   A condition starting with ‘!’ indicates a negation. If you combine conditions by character ‘|’, it is considered as OR condition. ‘&’ is considered as AND condition, likewise. Condition can be grouped by parentheses (‘(’, and ‘)’).

   ‘/tocc:xxxx/’ is an abbreviation of ‘/to:xxxx|cc:xxxx/’. ‘/!tocc:xxxx/’ is an abbreviation of ‘/!to:xxxx&!cc:xxxx/’.

   Example:

   /from:teranisi&!to:teranisi/+inbox
                         -> In +inbox, messages are picked if the message's
                            From: field includes "teranisi" and
                            To: field doesn't include "teranisi".
   
   /tocc:"Yuuichi Teranishi"/+inbox
                         -> In +inbox, messages are picked if the
                            message's To: field or Cc: field includes
                            "Yuuichi Teranishi".
   
   /(from:yt|from:teranisi)&subject:report/+inbox
                         -> In +inbox, messages are picked if the message's
                            From: field includes "yt" or "teranisi", and
                           Subject includes "report".
   

Tip for string description:

Space character, ‘"’, ‘/’,‘)’,‘|’ and ‘&’ should be enclosed with ‘"’ in value string. (‘"’ should be escaped with ‘\’ in it). You can enclose the string with ‘"’ even it does not contain these characters.

Advanced example:

*%inbox,/from:teranisi/%inbox@server
       -> Messages in %inbox or
          message is in the %inbox@server folder and it's From field
          includes "teranisi" are collected.

/last:100//to:teranisi/*+inbox,%inbox
       -> Latest 100 messages which is in the +inbox or %inbox folder
          and To: field matches "teranisi".

/from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@localhost
       -> Pick messages which have From: field and it includes "hogehoge"
          from latest 20 messages in the %#mh/inbox@localhost
          and To: or Cc: field includes "teranisi".

3.13 Pipe Folder ¶

In the pipe folder, messages are automatically transferred from the source folder to destination folder.

Format:

‘|’ source-folder ‘|’ destination-folder

When you access the pipe folder, messages are automatically transferred from source-folder to destination-folder. It is convenient if you want to download messages to local disk via POP. For example, if you specify following

|&username@popserver|+inbox

and access it, Wanderlust downloads messages from ‘&username@popserver’ to ‘+inbox’ automatically.

On the other hand, if you put ‘|:’ instead of second ‘|’, then messages are copied to the destination folder (not deleted from source-folder). At the next time you access that folder, copies new messages only.

‘|’ source-folder ‘|:’ destination-folder

If you want to copy messages from POP server and view them, specify the folder as follows:

|&username@popserver|:+inbox

where messages will be kept on the server.

Example:

|%inbox|%myinbox   -> Download %inbox to %myinbox.
|*&user@popserver1,&user@popserver2|+inbox
         -> Download from &user@popserver1 and &user@popserver2 to +inbox.
|-gnu.emacs.sources|:+sources
         -> Copy messages from -gnu.emacs.sources to +sources.

After messages are moved, a hook elmo-pipe-drained-hook is called.

3.14 Internal folder ¶

A folder to access internal messages of Wanderlust.

Format:

‘'flag’ [‘/’ global-flag]
‘'sendlog’
‘'cache/00’ - ‘'cache/1F’

A folder named ‘'flag’ is a special virtual folder which collects messages which have global-flag.

There is ‘important’ flag defined as global-flag by default. You can review important messages at once after you put important marks on the messages in the different folders. If global-flag is omitted, it is treated as ‘important’ flag is specified.

In addition, in summary mode, to be described later, you can freely define global flags and put them on messages. See Usage (Tips).

In this folder, if you delete message, global-flag put on the message is removed. If you append messages to this folder, the message will have global-flag.

A folder named ‘'sendlog’ is a virtual folder which collects cached messages which are recoded on ~/.elmo/sendlog. It might be useful when you forgot to add cc for yourself. To use this, you should set wl-draft-use-cache to non-nil so that sent messages are cached.

You can access cached messages fetched via network by accessing folders named ‘'cache/00’ - ‘'cache/1F’. 00 - 1F are the name of the subdirectories of the cache directory (~/.elmo/cache).

3.15 File folder ¶

File Folder gives the view for local file system. The one File Folder corresponds to the one directory.

Format:

‘file:’ Path-of-the-directory

Example:

file:~/work     -> ~/work
file:/etc       -> /etc

3.16 Access folder ¶

A folder to access virtual folder which collects messages from a root folder and subfolders of one. The add and remove of the subfolder is automatically reflected.

Format:

‘access:’ root-folder

Example:

access:%INBOX -> All subfolders of IMAP mailbox "inbox".
access:'cache -> All of 'cache folder

4.1 Selecting Folder ¶

• Usage (TIPS)
• Key bindings
• Customize variables

[-]Desktop:14186/35580/67263
   Inbox:3/10/10
   Trash:2/7/10
   Drafts:0/0/3
   Sent:0/9/348
   [-]Emacsen:0/34/4837
     Wanderlust ML:0/0/558
     ELIPS ML:0/0/626
     tm:0/0/821
     XEmacs Beta:0/29/255
     Mew:0/0/998
     Mule-Win32:0/0/1491
     fj's Emacsen:0/5/88

folder-name:new-number/unread-number/all-number

4.2 Editing Folders ¶

As described before, subscribed folder list is saved in ~/.folders file. But you don’t have to edit ~/.folders directly. You can append, delete, edit folders from folder mode.

• Usage (Tips)
• Key bindings
• Customize variables
• Miscellanea

5.1 Usage (Tips) ¶

• Summary Content
• Temporary Marks
• Persistent Marks
• How To Read
• Pack the Message Numbers

  377  09/16(Wed)11:57 [+1: Takuro Kitame  ] Bug?
  381  09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
  384  09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
  389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3

Message number, Temporal mark, Persistent mark, Date, Sender, Subject

5.2 Thread Operations ¶

For example, the following line indicates one thread (a context of a topic).

  384  09/17(Thu)01:32 [+1: Teranishi       ] wl-0.6.2

If you type / on this line, the thread is opened and it changes the appearance like following.

  384  09/17(Thu)01:32 [ Teranishi          ] wl-0.6.2
  388  09/17(Thu)22:34 +-[ Murata san         ]

(Message 388 is the replied message to the message 384.) If you type / key once again, the thread is closed. With prefix argument, / opens all children threads.

If you type [, opens all threads in summary. ] closes all threads.

Commands with the key binding that begins with t executes commands on the messages in the thread. See Key bindings.

• reconstruct thread by hand

5.3 Cache ¶

• Cache File
• Cache Filename
• Buffer Cache and Prefetching

5.4 Auto Refile ¶

You can refile messages automatically, by typing C-o (wl-summary-auto-refile). It decides destination of refile by the content of the message header information (information in the msgdb).

By default, ‘From:’, ‘Subject:’, ‘To:’ and ‘Cc:’ is available. If you want to decide destination by other header fields, set the variable elmo-msgdb-extra-fields like following.

(setq elmo-msgdb-extra-fields
      '("x-ml-name"
        "reply-to"
        "sender"
        "mailing-list"
        "newsgroups"))

By this setting, Wanderlust saves extra fields in the msgdb. You have to type s all to get extra fields for the messages that are already in the summary.

Then, specify the refile rule. The refile target folder of auto refiling is decided by the value of wl-refile-rule-alist. wl-refile-rule-alist is a list of a rule:

(field (regexp . target)
       (regexp . target)
       ...)

Each rule means ‘if field value matches regexp, then refile to target folder’. The rule matched first is applied.

field is a string of field name. You can specify a list of field name string, too. In this case, if one of these fields is matched, then the rule is fired (i.e. OR condition).

regexp is a regular expression for field value. target is a target folder string. You can specify a rule at target part, too. In this case, If the field value of the rule and the current rule is matched, then the current rule is fired (i.e. AND condition).

You can refer matched substring of regexp to specify target part. To refer substring, use following keys:

‘\&’

means substitute original matched text.

‘\N’

means substitute what matched the Nth ‘\(…\)’. (N is a number.)

Following is an example of wl-refile-rule-alist.

(setq wl-refile-rule-alist
      '(("x-ml-name"
         ("^Wanderlust" . "+wl")
         ("^Elisp" . "+elisp"))
        (("To" "Cc")
         ("\\([a-z]+\\)@gohome\\.org" . "+\\1"))
        ("From"
         ("me@gohome\\.org" . ("To" ("you@gohome\\.org" .
                                    "+from-me-to-you"))))))

After these settings, refile marks are automatically put on the condition matched messages by typing C-o (wl-summary-auto-refile).

Messages which have wl-summary-auto-refile-skip-marks is skipped auto refiling. By default, ‘N’, ‘U’ and ‘!’ is specified, so the messages with these persistent marks are not automatically refiled. It means Wanderlust does not execute auto refile on unread messages by the default setting. To execute auto refile on all messages, set following.

(setq wl-summary-auto-refile-skip-marks nil)

5.5 Sticky Summary ¶

The buffer of the ‘sticky summary’ does not killed by typing q.

By entering the summary by typing Shift RET in Folder mode or G in some summary sticky summary buffer is created. Also typing M-S (wl-summary-stick) on the normal summary makes current one sticky.

The buffer name of the sticky summary becomes like ‘Summary:folder-name’. You can visit the sticky summary at any time by C-x b (switch-to-buffer), or you can go round summary buffers by C-c C-n (wl-summary-previous-buffer) and C-c C-p (wl-summary-next-buffer) in summary mode.

In sticky summary, the summary buffer is preserved after g or q. To delete sticky summary, type C-u q to exit or move to another summary by C-u g. Other operations in the sticky summary are same as normal summary.

wl-summary-always-sticky-folder-list specifies the folders that are automatically stuck.

5.6 Format of summary lines ¶

You can alter the format of lines in Summary mode.

Summary line format is specified by wl-summary-line-format. You can use control strings defined by wl-summary-line-format-spec-alist.

An example follows.

;; number temporary-mark persistent-mark date branch
;; [ (number-of-children) sender ] subject
(setq wl-summary-line-format "%n%T%P%M/%D(%W) %t%[%17(%c %f%) %] %s")

Where the number set the column number of the field. If negative value, the column is filled from right. If the number begins with ‘0’, ‘0’ is used for filling columns instead of ‘ ’.

Example:

%5l   -> `1    '
%-05l -> `00001'

Major control strings defined by wl-summary-line-format-spec-alist are displayed in the following list.

%n  message number
%T  temporary mark
%P  persistent mark
%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)
%#  mailing list information (`(' ML-name [ ` ' ML-number ] `)')
%l  number in the mailing list
%@ `@' only if the first MIME part is multipart/mixed
%~  ` ' only if previous column is not empty

If you want to change the width of message number (‘%n’), modify wl-summary-default-number-column or wl-summary-number-column-alist.

The temporary mark (‘%T’) and persistent mark (‘%P’) must appear at the constant column. For example, if you specify ‘%T’ or ‘%P’ after the ‘%t’, which changes its length by thread position, marks are not treated correctly.

If the format string is enclosed by ‘%number(’ and ‘%)’, the column of the enclosed region is justified to the ‘number’. Multiple level ‘%number(’ parenthesis can be defined. It is useful to justify the column of the multiple control strings. For example, in the above wl-summary-line-format,

%17(%c %f%)

means “Adjust number-of-children and sender string to the 17 column”.

You can specify the format by each folders with wl-folder-summary-line-format-alist. Please set regular expression for folder names and summary line format as the following example.

(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")))

• on the format for sender name

(setq wl-summary-showto-folder-regexp "^\\+backup$")

5.7 Temporary marks and their effect ¶

You can define temporary marks and corresponding procedure by wl-summary-mark-action-list. Initially, refile (‘o’), copy (‘O’), dispose (‘d’), delete (‘D’), prefetch (‘i’) and resend (‘~’) are defined.

Each element of wl-summary-mark-action-list consists of

(‘MARK’ ‘SYMBOL’
 ‘ARGUMENT-FUNCTION’ ‘SET-MARK-FUNCTION’ ‘EXEC-FUNCTION’
 ‘FACE’ ‘DOC-STRING’)

‘MARK’ is a temporary mark string, and ‘SYMBOL’ is the name of the action to be defined. ‘ARGUMENT-FUNCTION’ is a function to generate argument to be given to ‘SET-MARK-FUNCTION’, which will be described next, and it takes arguments:

(‘ACTION’ ‘NUMBER’)

Where ‘ACTION’ equals to ‘SYMBOL’, and ‘NUMBER’ is message number. ‘SET-MARK-FUNCTION’ is a function to be called when the mark is put. It takes arguments:

(‘NUMBER’ ‘MARK’ ‘DATA’)

Where ‘NUMBER’ is target message number, ‘MARK’ is a temporary mark string, and ‘DATA’ is given by ‘ARGUMENT-FUNCTION’.

‘EXEC-FUNCTION’ is a function to be called when the action is executed. Its argument is a list of ‘MARK-INFO’. Here ‘MARK-INFO’ means a list consists of

(‘NUMBER’ ‘MARK’ ‘DATA’)

‘FACE’ is a face to be used for highlighting.

5.8 Key bindings ¶

Key bindings of the summary mode are shown below.

SPC ¶

Proceed reading a message at the current cursor point. (wl-summary-read)

. ¶

Redisplay a message at the current cursor point with default display type. If this command is called with prefix argument, reload and redisplay message regardless of the message cache. If this command is called with twice multiples C-u as C-u C-u ., reload and redisplay message with current display type regardless of the message cache. (wl-summary-redisplay)

< ¶

Display the top message in the folder. (wl-summary-display-top)

> ¶

Display the bottom message in the folder. (wl-summary-display-bottom)

BS ¶

DEL

Display the previous page of the message at the current cursor point. (wl-summary-prev-page)

RET ¶

Display the next line of the message at the current cursor point. Display the message at the current cursor point if it is not displayed yet. (wl-summary-next-line-content) If prefix argument is specified, message is scrolled up by one line. (wl-summary-prev-line-content) If prefix argument is numeric, cursor is jumped to the message with specified number.

- ¶

M-RET

Display the previous line of the message at the current cursor point. Display the message at the current cursor point if it is not displayed yet. (wl-summary-prev-line-content)

/ ¶

Toggle open or close the thread at the current cursor point. With prefix argument, open all children threads. (wl-thread-open-close)

[ ¶

Open all threads. (wl-thread-open-all)

] ¶

Close all threads. (wl-thread-close-all)

g ¶

Go to other folder. (wl-summary-goto-folder)

c ¶

Mark all messages in the folder as read. (wl-summary-mark-as-read-all)

a ¶

Prepare a draft for reply the message at the current cursor point. (wl-summary-reply)

A ¶

Prepare a draft for reply the message at the current cursor point. (wl-summary-reply-with-citation)

C ¶

If the message at current cursor point is your own netnews article, cancel it. (wl-summary-cancel-message)

E ¶

Prepare a draft for re-editing the message at current cursor point. If the message at current cursor point is your own netnews article, a draft for ‘supersedes message’ for the message is prepared. (wl-summary-reedit)

M-E ¶

If the message at current cursor point is a bounced message, a draft for re-sending original message is prepared. (wl-summary-resend-bounced-mail)

f ¶

A draft for forwarding the message at current cursor point is prepared. (wl-summary-forward)

$ ¶

Put ‘important’ flag on the message at current cursor point. If already flagged as ‘important’, remove the flag. If it is called with prefix argument, ask global flag to put similarly to F. (wl-summary-mark-as-important)

F ¶

Put arbitrary global flag entered in the minibuffer. If you use Emacs 21 or later, you can specify multiple flags separated by ‘,’ simultaneously. If it is called with prefix argument, remove existent global flags. (wl-summary-set-flags)

y ¶

e

Save the message at current cursor point. (wl-summary-save)

n ¶

Move cursor to the next message. If message is marked with a temporal mark in wl-summary-skip-mark-list, cursor is not moved to it. In the offline mode, cursor is not moved to the messages which are not cached yet. (wl-summary-next)

p ¶

Move cursor to the previous message. If message is marked with a temporal mark in wl-summary-skip-mark-list, cursor is not moved to it. In the offline mode, cursor is not moved to the messages which are not cached yet. (wl-summary-prev)

N ¶

Move cursor to the downward message which is unread or marked as ‘$’. In the offline mode, cursor is not moved to the messages which are not cached yet. If there are messages which have target mark ‘*’ in the summary, cursor is moved to the downward message which have a target mark. This behavior is changed according to the value of wl-summary-move-order. (wl-summary-down)

P ¶

Move cursor to the upward message which is unread or marked as ‘$’. In the offline mode, cursor is not moved to the messages which are not cached yet. If there are messages which have target mark ‘*’ in the summary, cursor is moved to the downward message which have a target mark. This behavior is changed according to the value of wl-summary-move-order. (wl-summary-up)

w ¶

Prepare a new draft. (wl-summary-write)

W ¶

Prepare a new draft. If the current folder is NNTP folder, ‘Newsgroups:’ field is completed. If the current folder is mailing list folder (refile destination), guess ‘To:’ field and completed (If wl-subscribed-mailing-list is valid list) (wl-summary-write-current-folder)

H ¶

Toggle display type between all and partial header fields and redisplay the message at current cursor point. If this command is called with prefix argument, reload and redisplay message regardless of the message cache. If this command is called with twice multiples C-u as C-u C-u H, set default display type of summary by current display type of header fields. (wl-summary-toggle-all-header)

M ¶

Toggle display type for MIME analysis and redisplay the message at current cursor point. A change is performed in the order set as wl-summary-display-mime-mode-list. If this command is called with numeric prefix argument, it switch directly as follows.

1: Enable MIME analysis.
2: Enable MIME analysis only for header fields.
3: Disable MIME analysis.

If this command is called with twice multiples C-u as C-u C-u M, set default display type of summary by current display type of MIME analysis. (wl-summary-toggle-mime)

C-c C-f ¶

Toggle header body narrowing of the message at current cursor point. (wl-summary-toggle-header-narrowing)

B ¶

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. (wl-summary-burst)

@ ¶

Append/change/delete the message’s sender information to the address book ~/.addresses interactively. If this command is called with prefix argument, arbitrary address can be edited. (wl-summary-edit-addresses)

Z ¶

Sync up address book status with ~/.addresses’s content. (wl-status-update)

| ¶

Pipe current message’s content to the external process. (wl-summary-pipe-message)

# ¶

Print out current message’s content. It uses ps-print module. If you don’t use color printer, you might want to set wl-ps-print-buffer-function to ps-print-buffer.

(setq wl-ps-print-buffer-function 'ps-print-buffer)

(wl-summary-print-message)

q ¶

Exit current folder. (wl-summary-exit)

j ¶

Jump cursor to the currently displayed message’s window. (wl-summary-jump-to-current-message)

J ¶

Jump cursor to the other message. (wl-summary-jump-to-msg)

I ¶

Update summary status and prefetch all messages which have marks included in the wl-summary-incorporate-marks. (wl-summary-incorporate)

M-j ¶

Jump cursor to the message which have specified ‘Message-Id:’.

^ ¶

Jump to parent message. (wl-summary-jump-to-parent-message)

! ¶

Mark as unread the message at current cursor point. (wl-summary-mark-as-unread)

s ¶

Synchronize summary view after prompting the update range. You can specify one of the follows.

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.
rescan-thread    Redisplay summary by rescanning present msgdb.
                 Reconstruct thread, 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).

(wl-summary-sync)

S ¶

Sort summary order. You can sort by ‘date’, ‘from’, ‘number’, ‘subject’, ‘size’ and ‘list-info’. With prefix argument, sort summary lines into reverse order. (wl-summary-sort)

T ¶

Toggle the threading. The state will be preserved after exiting Wanderlust. You can alter default state for newly created summary by wl-summary-default-view or wl-summary-default-view-alist. Threading status is displayed on the modeline. ‘{S}’ means threading is off (Sequence) and ‘{T}’ means threading is on (Thread). (wl-summary-toggle-thread)

l ¶

Toggle displaying of folder window. (wl-summary-toggle-disp-folder)

v ¶

Toggle displaying of message window. (wl-summary-toggle-disp-msg)

V ¶

Move to the virtual folder (filter folder) with the condition specified. If called with prefix argument and current folder is virtual, exit it. (wl-summary-virtual)

TAB ¶

Jump to the message which is displayed last. (wl-summary-goto-last-displayed-msg)

? ¶

Put ‘*’ mark on the messages that satisfies the specified condition. If messages already have ‘*’ mark, new ‘*’ marks are overridden. If prefix argument is specified, current ‘*’ marks are removed and new ‘*’ marks are appended.

(wl-summary-pick)

R ¶

Mark as read the message at the current cursor point. (wl-summary-mark-as-read)

x ¶

Execute action for all temporary marks in the summary buffer. (wl-summary-exec)

* ¶

Put target mark on the message at the current cursor point. (wl-summary-target-mark-line) See Temporary marks and their effect.

o ¶

Put refile mark on the message at the current cursor point. (wl-summary-refile) See Temporary marks and their effect.

C-o ¶

Execute auto refile. (wl-summary-auto-refile)

O ¶

Put copy mark on the message at the current cursor point. (wl-summary-copy) See Temporary marks and their effect.

M-o ¶

Put refile mark on the message at the current cursor point with the destination previously specified. (wl-summary-refile-prev-destination)

d ¶

Put disposal mark on the message at the current cursor point. The result of disposal is controlled by wl-dispose-folder-alist, refiled to wl-trash-folder by default. (wl-summary-dispose) See Temporary marks and their effect.

D ¶

Put force deletion mark on the message at the current cursor point. (wl-summary-delete) See Temporary marks and their effect.

i ¶

Put prefetch reservation mark on the message at the current cursor point. (wl-summary-prefetch) See Temporary marks and their effect.

~ ¶

Put resend reservation mark on the message at the current cursor point. (wl-summary-resend) See Temporary marks and their effect.

u ¶

Unmark the temporal mark on the message at the current cursor point. (wl-summary-unmark)

U ¶

Unmark all the temporal marks. (wl-summary-unmark-all)

r R ¶

Mark as read messages in the specified region. (wl-summary-mark-as-read-region)

r $ ¶

Put ‘important’ flag on messages in the specified region. If already flagged as ‘important’, remove the flag. (wl-summary-mark-as-important-region)

r F ¶

Put arbitrary global flag entered in the minibuffer on messages in specified region. (wl-summary-set-flags-region)

r ! ¶

Mark as unread messages in the specified region. (wl-summary-mark-as-unread-region)

r x ¶

Execute action for each temporary marks on the messages in the specified region. (wl-summary-exec-region)

r * ¶

Put target mark on the messages in the specified region. (wl-summary-target-mark-region) See Temporary marks and their effect.

r o ¶

Put refile mark on the messages in the specified region. (wl-summary-refile-region) See Temporary marks and their effect.

r O ¶

Put copy mark on the messages in the specified region. (wl-summary-copy-region) See Temporary marks and their effect.

r d ¶

Put disposal mark on the messages in the specified region. (wl-summary-dispose-region) See Temporary marks and their effect.

r D ¶

Put force deletion mark on the messages in the specified region. (wl-summary-delete-region) See Temporary marks and their effect.

r i ¶

Put prefetch reservation mark on messages in the specified region. (wl-summary-prefetch-region) See Temporary marks and their effect.

r u ¶

Delete temporal mark on the messages in the specified region. (wl-summary-unmark-region)

r y ¶

Save messages in the specified region. (wl-summary-save-region)

t R ¶

Mark as read messages which are the descendant of the current thread. With prefix argument, it affects on the all messages in the thread tree. (wl-thread-mark-as-read)

t $ ¶

Put ‘important’ flag on the messages which are the descendant of the current thread. If already flagged as ‘important’, remove the flag. With prefix argument, it affects on the all messages in the thread tree. (wl-thread-mark-as-important)

t F ¶

Put arbitrary global flag entered in the minibuffer on the messages which are the descendant of the current thread. With prefix argument, it affects on the all messages in the thread tree. (wl-thread-set-flags)

t ! ¶

Mark as unread messages which are the descendant of the current thread. With prefix argument, it affects on the all messages in the thread tree. (wl-thread-mark-as-unread)

t x ¶

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. (wl-thread-exec)

t * ¶

Put target 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. (wl-thread-target-mark) See Temporary marks and their effect.

t o ¶

Put refile 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. (wl-thread-refile) See Temporary marks and their effect.

t O ¶

Put copy 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. (wl-thread-copy) See Temporary marks and their effect.

t d ¶

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. (wl-thread-dispose) See Temporary marks and their effect.

t D ¶

Put force deletion mark on the messages which are the descendant of the current thread. (wl-thread-delete) See Temporary marks and their effect.

t i ¶

Put prefetch reservation mark on messages which are the descendant of the current thread. (wl-thread-prefetch) See Temporary marks and their effect.

t u ¶

Unmark temporal 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. (wl-thread-unmark)

t y ¶

Save messages which are the descendant of the current thread. With prefix argument, it affects on the all messages in the thread tree. (wl-thread-save)

m R ¶

Mark as read all messages which have target mark ‘*’. (wl-summary-target-mark-mark-as-read)

m $ ¶

Put ‘important’ flag on all messages which have target mark ‘*’. If already flagged as ‘important’, remove the flag. (wl-summary-target-mark-mark-as-important)

m F ¶

Put arbitrary global flag entered in the minibuffer on all messages which have target mark ‘*’. (wl-summary-target-mark-set-flags)

m ! ¶

Mark as unread all messages which have target mark ‘*’. (wl-summary-target-mark-mark-as-unread)

m o ¶

Put refile mark on the messages which have target mark ‘*’. (wl-summary-target-mark-refile) See Temporary marks and their effect.

m O ¶

Put copy mark on the messages which have target mark ‘*’. (wl-summary-target-mark-copy) See Temporary marks and their effect.

m d ¶

Put disposal mark on the messages which have target mark ‘*’. (wl-summary-target-mark-dispose) See Temporary marks and their effect.

m D ¶

Put force deletion mark on the messages which have target mark ‘*’. (wl-summary-target-mark-delete) See Temporary marks and their effect.

m i ¶

Put prefetch reservation mark on messages which have target mark ‘*’. (wl-summary-target-mark-prefetch) See Temporary marks and their effect.

m y ¶

Save messages which have target mark ‘*’. (wl-summary-target-mark-save)

m u ¶

Unmark all temporal marks. (wl-summary-delete-all-temp-marks)

m a ¶

Put target mark ‘*’ on the all messages. (wl-summary-target-mark-all)

m t ¶

Put target mark ‘*’ on the messages in the current thread. (wl-summary-target-mark-thread)

m T ¶

Put target mark ‘*’ on all the messages of the threads which contain already target marked message. (wl-summary-target-mark-threads)

m r ¶

Put target mark ‘*’ on the messages in the specified region. (wl-summary-target-mark-region)

m A ¶

Prepare a draft which cites all messages which have target mark ‘*’. (wl-summary-target-mark-reply-with-citation)

m f ¶

Prepare a draft which forwards all messages which have target mark ‘*’. (wl-summary-target-mark-forward)

m U ¶

Uudecode the messages which have target mark ‘*’. (wl-summary-target-mark-uudecode)

m ? ¶

Pick messages from the ‘*’ marked messages. That is, ‘*’ marks on the messages are remained if the specified condition is satisfied. (wl-summary-target-mark-pick)

m # ¶

Print out all messages which have target mark ‘*’. (wl-summary-target-mark-print)

m | ¶

Pipe content of each message with target mark ‘*’ to some specified external process. (wl-summary-target-mark-pipe)

M-t ¶

Toggle offline/online status of Wanderlust. (wl-toggle-plugged)

C-t ¶

Start Wanderlust’s plug-status manager. (wl-plugged-change)

C-c C-o ¶

Move to the draft buffer if available. If multiple draft buffer exists, moved to one after another. If prefix argument is specified, load draft folder’s message to the draft buffer and jump to it. (wl-jump-to-draft-buffer)

M-w ¶

Save the message at the current cursor point. (wl-summary-save-current-message)

C-y ¶

Regard the message at the current cursor point as parent, connect the message saved by wl-summary-save-current-message to the thread. (wl-summary-yank-saved-message)

C-x C-s ¶

Save the current summary. (wl-summary-save-status)

5.9 Customiziable variables ¶

wl-summary-move-order ¶

The initial setting is unread. Specify cursor moving policy. If you want to precede new messages, set new. If you want to precede unread messages, set unread. If nil, proceed to next message.

wl-auto-select-first ¶

The initial setting is nil. If non-nil, first message is automatically displayed when you enter the folder.

wl-auto-select-next ¶

The initial setting is nil. This controls behavior when there is no unread message in current summary.

nil: asks whether you want to go back to folder mode
'unread: asks whether you want to go to next unread folder
  If the next one comes to be possessing no unread message
  by treatment of cross-posted messages or Scoring, then
  asks whether you want to go to next to next folder.
'skip-no-unread: similar as unread
  But does not ask before going to next to next folder.
otherwise: asks whether you want to go to next unread folder

It might be useful to set 'skip-no-unread for people who want to continue reading by just pressing and pressing space key.

wl-thread-insert-opened ¶

The initial setting is nil. If non-nil, thread is inserted as opened.

wl-thread-open-reading-thread ¶

The initial setting is t. If non-nil, reading thread is automatically opened though it is closed thread.

wl-summary-exit-next-move ¶

The initial setting is t. If non-nil, move to next folder at summary exit.

wl-folder-move-cur-folder ¶

The initial setting is nil. If non-nil, cursor position on the folder is moved.

wl-summary-weekday-name-lang ¶

Specify language of the weekday. ‘en’ displays English, ‘fr’ displays French, ‘de’ displays Deutsch. You should rescan summary view after changing this value.

wl-summary-fix-timezone ¶

The initial setting is nil. Time zone of the date string in summary mode is adjusted using this value. If nil, it is adjust to the default time zone information (system’s default time zone or environment variable ‘TZ’).

wl-use-petname ¶

The initial setting is t. If non-nil, sender part displays nickname.

wl-break-pages ¶

The initial setting is t. If non-nil, message is split as pages by ‘^L’.

wl-summary-from-function ¶

Format function to display sender in summary. The initial setting is wl-summary-default-from.

wl-summary-no-from-message ¶

The initial setting is ‘nobody@nowhere?’. A string which is displayed when there’s no ‘From:’ field in the message.

wl-summary-subject-function ¶

Format function to display subject in summary. The initial setting is 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.

(setq wl-summary-subject-function 'identity)

wl-summary-no-subject-message ¶

The initial setting is ‘(WL:No Subject in original.)’. A string which is displayed when there’s no ‘Subject:’ field in the message.

wl-summary-default-view ¶

The initial setting is 'thread. The default state for newly created summary. You can set either 'thread for thread view or 'sequence for sequential view.

wl-summary-order ¶

The initial setting is 'ascending. Specify order of messages in summary buffer. Note that messages in a thread are always listed in ascending order even if this value is 'descending.

wl-summary-nobreak-char-display ¶

The initial setting is nil. nobreak-char-display is overridden by this value in Summary buffer.

wl-summary-use-frame ¶

The initial setting is nil. If non-nil, use new frame for the summary.

wl-use-folder-petname ¶

The initial setting is the list shown below:

(modeline)

A list of display policy (symbol) of folder nickname. Available symbols are:

modeline

Display folder petname on modeline.

ask-folder

Destination folder is notified as nickname if wl-auto-select-next is non-nil.

read-folder

You can input folder name by nickname in the function wl-summary-read-folder.

wl-summary-move-direction-toggle ¶

The initial setting is t. If non-nil, last executed p, P, n, N toggles the direction of cursor move. If you want to aware of reading direction, set this to t.

wl-summary-width ¶

The initial setting is 80. Width of summary line. If nil, summary line’s width is as is.

wl-summary-print-argument-within-window ¶

The initial setting is nil. If non-nil, the action argument is always printed on right side of window.

wl-summary-indent-length-limit ¶

The initial setting is 46. Specify the limit of thread indent level. nil means unlimited indent level. If you set this to nil you should set wl-summary-width to nil, too.

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.

wl-summary-recenter ¶

The initial setting is t. If non-nil, cursor point is moved to the center of the summary window.

wl-summary-max-thread-depth ¶

The initial setting is 30. If thread depth is larger than this value, divide it.

wl-summary-divide-thread-when-subject-changed ¶

The initial setting is nil. If non-nil, thread is split if the subject is changed.

wl-summary-search-via-nntp ¶

The initial setting is confirm.

If non-nil and wl-summary-jump-to-msg-by-message-id failed, call wl-summary-jump-to-msg-by-message-id-via-nntp and search message from the NNTP server elmo-nntp-default-server. The value of elmo-nntp-default-user, elmo-nntp-default-port, elmo-nntp-default-stream-type are used.

If confirm, server name can be specified. You can specify NNTP folder format like ‘-:username@servername:119!’.

wl-summary-keep-cursor-command ¶

The initial setting is the list shown below:

(wl-summary-goto-folder wl-summary-goto-last-visited-folder)

When you entered to summary by these commands and the target summary buffer already exists, summary status is not automatically updated and cursor position is saved.

elmo-folder-update-threshold ¶

The initial setting is 500. If updated message number is larger than this value, confirm whether drop them or not (in the case where the value of elmo-folder-update-confirm is non-nil).

elmo-folder-update-confirm ¶

The initial setting is t. If the value is non-nil, do check with elmo-folder-update-threshold.

wl-summary-always-sticky-folder-list ¶

The initial setting is nil. wl-summary-always-sticky-folder-list specifies the folders that are automatically stuck. Each element is regexp of folder name.

wl-summary-reserve-mark-list ¶

The initial setting is the list shown below:

("o" "O" "D" "d" "i")

If a message is already marked as temporal marks in this list, the message is not marked by any mark command.

wl-summary-skip-mark-list ¶

The initial setting is the list shown below:

("D" "d")

If a message is already marked as temporal marks in this list, the message is skipped at cursor move.

elmo-message-fetch-threshold ¶

The initial setting is 30000 (bytes). If displaying message has larger size than this value, Wanderlust confirms whether fetch the message or not (in the case where the value of elmo-message-fetch-confirm is non-nil).

elmo-message-fetch-confirm ¶

The initial setting is t. If the value is non-nil, do check with elmo-message-fetch-threshold.

wl-prefetch-threshold ¶

The initial setting is 30000 (bytes). If prefetching message has larger size than this value and wl-prefetch-confirm is non-nil, Wanderlust confirms whether prefetch the message or not. If wl-prefetch-threshold is nil, the message is prefetched without confirmation.

wl-prefetch-confirm ¶

The initial setting is t. If non-nil, Wanderlust confirms whether prefetch the message or not if the message has larger size than wl-prefetch-threshold.

elmo-imap4-use-cache ¶

The initial setting is t. If non-nil, messages read via IMAP4 are cached.

elmo-nntp-use-cache ¶

The initial setting is t. If non-nil, messages read via NNTP are cached.

elmo-pop3-use-cache ¶

The initial setting is t. If non-nil, messages read via POP3 are cached.

elmo-shimbun-use-cache ¶

The initial setting is t. If non-nil, messages read in Shimbun folders are cached.

wl-summary-resend-use-cache ¶

The initial setting is nil. If non-nil, messages are resend using cache even in the offline status. Note that if you use cache, the message identity is not guaranteed.

wl-folder-process-duplicates-alist ¶

The initial setting is nil. This list determines how to deal with duplicated messages in the same folder. Each item in the list is regexp of folder name and action; you can specify any one of the following in the place of action:

nil : do nothing for duplicated messages.
hide : hide duplicated messages from the summary.
read : set duplicated messages as read.

Following is an example (hide duplicated messages in multi folders)

(setq wl-folder-process-duplicates-alist
                 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
                   ("^\\*.*" . hide) (".*" . read)))

wl-summary-flag-alist ¶

The initial setting is as follows:

((important "orange"))

Specify the color and the mark of message in summary buffer with flag. If the mark are omitted, the mark specified in the variable wl-summary-flag-mark is assumed. If multiple global flags are on one message, the former flag in this list is preferred.

Example:

(setq wl-summary-flag-alist
      '((important "purple")
        (todo "red")
        (business "green" "B")
        (private "blue" "X")))

wl-summary-display-mime-mode-list ¶

The initial setting is the list shown below:

(mime as-is)

The function wl-summary-toggle-mime switch specification of MIME analysis in the order of this list. You can specify one of the follows.

mime        : Header and body are decoded.
header-only : Only header is decoded.
as-is       : Header and body are not decoded.

6.1 Key Bindings ¶

l ¶

Toggles display of Summary buffer. (wl-message-toggle-disp-summary)

mouse-2 ¶

Assumes ‘Message-ID:’ at the mouse pointer, and shows the corresponding message if found. (wl-message-button-refer-article)

mouse-4 or wheel-up ¶

Scrolls the message backwards. When the top of the message is hit, moves to the previous message. Actual bindings are customizable via wl-scroll-function-events. (wl-message-wheel-down)

mouse-5 or wheel-down ¶

Scrolls the message forward. When the bottom of the message is hit, moves to the next message. Actual bindings are customizable via wl-scroll-function-events. (wl-message-wheel-up)

D ¶

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. (wl-message-delete-current-part)

6.2 Customizable Variables ¶

wl-message-window-size ¶

Initial setting is (1 . 4). It is a cons cell and the ratio of its car and cdr value corresponds to the ratio of Summary and Message windows.

wl-message-ignored-field-list ¶

Initial setting is nil. All fields that match this list will be hidden in message buffer. Each elements are regexp of field-name. If nil, the value of mime-view-ignored-field-list is used.

wl-message-visible-field-list ¶

Initial setting is nil. All fields that match this list will be display in message buffer. Each elements are regexp of field-name. This value precedes wl-message-ignored-field-list. If nil, the value of mime-view-visible-field-list is used.

wl-message-sort-field-list ¶

Initial setting is ’("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From"). Header fields in message buffer are ordered by this value. Each elements are regexp of field-name.

wl-message-truncate-lines ¶

The initial value is the value of default-truncate-lines. If it is non-nil, truncate long lines in message buffer.

wl-message-auto-reassemble-message/partial ¶

The initial setting is nil. If non-nil, automatically reassemble fragments of the message on displaying when its MIME media type is message/partial.

7.1 Tips ¶

Basically it is Emacs-standard mail mode.

• Parameters for Sending
• Editing Message Header
• Editing Messages and Sending
• Dynamic Modification of Messages
• Inserting Templates
• Sending mail by POP-before-SMTP

(setq wl-draft-config-alist
      '(((string-match "aaa\\.example\\.com$" (system-name))
         ;; applied if the expression is non-nil
         (wl-smtp-posting-server . "mailserver-B")
         (wl-nntp-posting-server . "newsserver-B")
         ;; settings of temporary variables
         )
        ("^To: .*user@aaa\\.bbb\\.example\\.com"
         ;; applied if it matches the header of the draft buffer
         ("Organization" . (format "Go %s" my-webpage)))
                       ;; you can write elisp expressions here (eval only)
         (top . "Hello.\n")    ;; inserted at the top of the body
         (bottom . "\nBye.\n") ;; inserted at the bottom of the body
        ))

'(("regexp of the header" or elisp expression
  ("Field" . value(elisp expression))
   (variable . value(elisp expression))
   (sub-function . value(elisp expression))
   function
   ...)
  ("regexp of the header" or elisp expression
   ("Field" . value(elisp expression))
   ...))

'header:      Inserts the specified string at the bottom of the header.
'header-top:  Inserts the specified string at the top of the header.
'header-file: Inserts the specified file at the bottom of the header.
'x-face:      Inserts ‘X-Face:’ field with the content of the specified file.
'top:         Inserts the specified string at the top of the body.
'top-file:    Inserts the specified file at the top of the body.
'body:        Replaces the body with the specified string.
              Specifying nil deletes the entire body string.
'body-file:   Replaces the body with the content of the specified file.
'bottom:      Inserts the specified string at the bottom of the body.
'bottom-file: Inserts the specified file at the top of the body.
'part-top:  Inserts the specified string at the top of the current part.
'part-bottom: Inserts the specified string at the bottom of the current part.
'template:    Applies the specified template.
              (refer to the next subsection)

(setq wl-draft-config-alist
      '((reply                         ;; (1)
         "X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
         ;; applied if it matches the header of the buffer being replied
         (body . "  Hello.\n")
         (template . "default")
         )))

(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\"))))

(remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)

(add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)

(add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)

(setq wl-template-alist
      '(("default"
         ("From" . wl-from)
         ("Organization" . "Example Co.Ltd.")
         (body . "Hello.\n"))
        ("report"
         (template . "default")                 ;; (a)
         ("To" . "boss@example.com")
         ("Subject" . "Report")
         (body-file . "~/work/report.txt")
         )
        ))

(template . "default")

(setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)

http://www.iecc.com/pop-before-smtp.html

7.2 Key Bindings ¶

C-c C-y ¶

Cites the content of the current message buffer (the part under cursor). If the region is active, cites the region (it affects only if transient-mark-mode is Non-nil). If the command is called with prefix argument, the text inserted by yank command (the text content of clipboard) is cited. (wl-draft-yank-original)

C-c C-p ¶

Previews the content of the current draft. This is useful for previewing MIME multi-part messages. (wl-draft-preview-message)

C-c C-s ¶

Sends the content of the current draft. Does not erase the draft buffer. This is useful for sending multiple messages, which are a little different from each other. (wl-draft-send)

C-c C-c ¶

Sends the content of the current draft and erases the draft buffer. (wl-draft-send-and-exit)

C-x C-s ¶

Save the current draft. (wl-draft-save)

C-c C-k ¶

Kills the current draft. (wl-draft-kill)

C-x k ¶

Kills the current draft. (wl-draft-mimic-kill-buffer)

C-c C-z ¶

Saves the current draft, and erases the draft buffer. This is useful if you want to suspend editing of the draft. (wl-draft-save-and-exit)

C-c C-r ¶

Encodes or decodes the specified region in Caesar cipher. (wl-caesar-region)

C-l ¶

Recenter and rehighlight current draft. (wl-draft-highlight-and-recenter)

M-t ¶

Toggles off-line/on-line states of Wanderlust. (wl-toggle-plugged)

C-c C-o ¶

Jumps to the other draft buffer, if exists. With prefix argument, reads a file (if any) from the draft folder when there is no such buffer. (wl-jump-to-draft-buffer)

C-c C-e ¶

Applies wl-draft-config-alist. (wl-draft-config-exec)

C-c C-j ¶

Selects a template. (wl-template-select)

C-c C-a ¶

Enter Address Manager. See Address Manager. (wl-addrmgr)

C-c C-d ¶

Elide the text between point and mark (wl-draft-elide-region). The text is killed and replaced with the contents of the variable wl-draft-elide-ellipsis. The default value is to use an ellipsis (‘[...]’).

7.3 Customizable Variables ¶

wl-subscribed-mailing-list ¶

The initial setting is nil. Mailing lists to which you subscribe. If any of these are contained in ‘To:’ or ‘Cc:’ field of a reply draft, removes your own address from ‘Mail-Followup-To:’ and ‘Cc:’. And if any of these are contained in ‘To:’ or ‘Cc:’ field of a message to be automatically re-filed, the destination folder will be leaned in connection with the address.

Example:

(setq wl-subscribed-mailing-list
      '("wl@ml.gentei.org"
        "apel-ja@m17n.org"
        "emacs-mime-ja@m17n.org"))

wl-insert-mail-followup-to ¶

The initial setting is nil. If non-nil, ‘Mail-Followup-To:’ field is automatically inserted in the draft buffer.

wl-insert-mail-reply-to ¶

The initial setting is nil. If non-nil, ‘Mail-Reply-To:’ field is automatically inserted in the draft buffer.

wl-auto-insert-x-face ¶

The initial setting is t. If non-nil and there is an encoded X-Face string in a file ~/.xface (the value of the variable wl-x-face-file), inserts it as an ‘X-Face:’ field in the draft buffer. If nil, it is not automatically inserted.

wl-insert-message-id ¶

The initial setting is t. If non-nil, ‘Message-ID:’ field is automatically inserted on the transmission.

wl-message-id-use-message-from ¶

The initial setting is t. If non-nil, the value of ‘From:’ field or wl-from will be used as the domain part of ‘Message-ID:’.

wl-local-domain ¶

The initial setting is nil. If nil, the return value of the function system-name will be used as the domain part of ‘Message-ID:’.

If system-name does not return FQDN (i.e. the full name of the host, like ‘smtp.gohome.org’), you must set this variable to the string of the local domain name without hostname (like ‘gohome.org’). That is, a concatenation of system-name ‘.’ wl-local-domain is used as domain part of the ‘Message-ID:’.

If your terminal does not have global IP, set the value of wl-message-id-domain. (You might be beaten up on the Net News if you use invalid ‘Message-ID:’.)

Moreover, concatenation of system-name ‘.’ wl-local-domain will be used as an argument to the HELO command in SMTP.

wl-message-id-domain ¶

The initial setting is nil. If non-nil, this value is used as a domain part of the ‘Message-ID:’. If your terminal does not have global IP address, set unique string to this value (e.x. your e-mail address).

wl-unique-id-suffix ¶

The initial setting is ‘.wl’. You can specify the string in generated Message-ID which appear just before ‘@’ or ‘%’.

wl-draft-config-alist ¶

The initial setting is nil. Modifies the draft message just before the transmission. The content of wl-draft-config-alist will be automatically applied only once on the transmission. If you want to apply it manually, use C-c C-e. This command can be used many times.

wl-template-alist ¶

The initial setting is nil. This variable specifies the template to be applied in the draft buffer.

wl-draft-config-matchone ¶

The initial setting is nil. If non-nil, only the first matching item is used when wl-draft-config-alist is applied. If nil, all matching items are used.

wl-template-visible-select ¶

The initial setting is t. If non-nil, you can preview the result of the template selection in another window.

wl-template-confirm ¶

The initial setting is nil. If non-nil, asks for confirmation when you press the enter key to select template while previewing.

wl-template-buffer-lines ¶

The initial setting is 7. If wl-template-visible-select is non-nil, this variable specifies the size of the preview window.

wl-draft-buffer-style ¶

The initial setting is full. Style of draft buffer window (except for replying and forwarding).

keep

is to use the current window,

full

is to use full frame window,

split

is to split the current window vertically and use it.

msg-split

is to split the message window vertically and use it as if replying message.

split-horiz

is to split the current window horizontally and use it.

msg-split-horiz

is to split the message window horizontally and use it as if replying message.

If some function is specified, it is called with the draft buffer as an argument.

wl-draft-reply-buffer-style ¶

The initial setting is split. Style of draft buffer for replying and forwarding.

keep

is to use the message buffer window,

full

is to use full frame window,

split

is to split the message buffer window vertically and use it.

split-horiz

is to split the message buffer window horizontally and use it.

If some function is specified, it is called with the draft buffer as an argument.

wl-draft-use-frame ¶

The initial setting is nil. If non-nil, use new frame for the draft.

wl-draft-reply-default-position ¶

The initial setting is body. Specify initial cursor position on draft buffer for reply. body is to move cursor to the top of the message body, bottom to the bottom of the message body, and top to the top of the header.

wl-draft-truncate-lines ¶

The initial value is the value of default-truncate-lines. If it is non-nil, truncate long lines in draft buffer.

wl-from ¶

The initial setting is the value of the variable user-mail-address. The value of this variable is inserted as a ‘From:’ field of the draft when it is prepared.

wl-envelope-from ¶

The initial setting is nil. The value of this variable is used for envelope from (MAIL FROM). If nil, the address part of wl-from is used.

wl-user-mail-address-list ¶

The initial setting is nil. This is the User’s address list. If you have multiple addresses, set this variable.

wl-reply-subject-prefix ¶

The initial setting is ‘Re: ’. In the ‘Subject:’ of the reply draft, this string is prepended to the ‘Subject:’ of being replied. You can specify a function to be message buffer of the reply target.

wl-forward-subject-prefix ¶

The initial setting is ‘Forward: ’. In the ‘Subject:’ of the forwarding draft, this string is prepended to the ‘Subject:’ of being forwarded. You can specify a function to be message buffer of the forward target.

wl-draft-reply-use-address-with-full-name ¶

The initial setting is t. If non-nil, insert her full name with address when prepare a draft for reply a message. If it is nil, insert her address only.

wl-draft-enable-queuing ¶

The initial setting is t. This flag controls off-line transmission. If non-nil, the draft is sent off-line.

wl-draft-use-cache ¶

The initial setting is nil. If the value is non-nil and wl-insert-message-id is nil, cache the message which is sent.

wl-fcc-force-as-read ¶

The initial setting is nil. If the value is non-nil, Mark as read the message saved by ‘Fcc:’.

wl-auto-flush-queue ¶

The initial setting is t. This flag controls automatic transmission of the queue when Wanderlust becomes on-line. If non-nil, the queue is automatically transmitted (with confirmation by y-or-n-p). If you want to transmit it manually, press F in the folder mode.

wl-ignored-forwarded-headers ¶

Initial setting is ‘\\(received\\|return-path\\|x-uidl\\)’. All headers that match this regexp will be deleted when forwarding a message.

wl-ignored-resent-headers

Initial setting is ‘\\(return-receipt\\|[bdf]cc\\)’. All headers that match this regexp will be deleted when resending a message.

wl-draft-always-delete-myself ¶

If non-nil, always removes your own address from ‘Cc:’ when you are replying to the mail addressed to you.

wl-draft-delete-myself-from-bcc-fcc ¶

If any of wl-subscribed-mailing-list are contained in ‘To:’ or ‘Cc:’ field, do not insert ‘Bcc:’ or ‘Fcc:’ field.

wl-draft-send-mail-function ¶

The initial setting is wl-draft-send-mail-with-smtp. This is the function to post mails. To use POP-before-SMTP, set this to wl-draft-send-mail-with-pop-before-smtp.

wl-smtp-posting-server ¶

The initial setting is nil. This is the SMTP server name for mail transmission.

wl-smtp-posting-port ¶

The initial setting is nil. This is the SMTP port number for mail transmission. If nil, default SMTP port number (25) is used.

wl-smtp-posting-user ¶

The initial setting is nil. This is the user name for SMTP AUTH authentication.

wl-smtp-authenticate-type ¶

The initial setting is nil. This string-valued variable specifies the authentication method for SMTP AUTH authentication. You may specify plain, cram-md5, digest-md5, login, etc. If nil, authentication will not be carried out.

wl-smtp-authenticate-realm ¶

The initial setting is nil. This string-valued variable specifies the authentication realm for SMTP AUTH authentication. You have to set this variable for DIGEST-MD5 authentication and so on. If nil, authentication realm is not specified in the authentication.

wl-smtp-connection-type ¶

The initial setting is nil. This symbol-valued variable specifies how to establish SMTP connections. If nil, use default connection type. If it is starttls, use STARTTLS (RFC3207). If it is ssl, use SSL.

wl-nntp-posting-server ¶

The initial setting is nil. This is the NNTP server name used for news submission. If nil, elmo-nntp-default-server is used.

wl-nntp-posting-user ¶

The initial setting is nil. This is the user name for AUTHINFO authentication on news submission. If nil, elmo-nntp-default-user is used. If it is still nil, AUTHINFO authentication will not be carried out.

wl-nntp-posting-port ¶

The initial setting is nil. This is the port number of the NNTP server used for news submission. If nil, elmo-nntp-default-port is used.

wl-nntp-posting-stream-type ¶

The initial setting is nil. If nil, elmo-nntp-default-stream-type is evaluated. If ssl, SSL is used for news submission. If starttls, STARTTLS (RFC2595) connection will be established.

wl-nntp-posting-function ¶

The initial setting is elmo-nntp-post. This is the function to post NNTP message.

wl-nntp-posting-config-alist ¶

The initial setting is nil. The value takes an alist to define NNTP server like following example. It takes precedence over wl-nntp-posting-{server|user|port|function}.

(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")))

wl-pop-before-smtp-user ¶

The initial setting is nil. This is the POP user name for POP-before-SMTP. If it is nil, elmo-pop3-default-user is used.

wl-pop-before-smtp-server ¶

The initial setting is nil. This is the POP server name for POP-before-SMTP. If it is nil, elmo-pop3-default-server is used.

wl-pop-before-smtp-authenticate-type ¶

The initial setting is nil. This is the authentication method for POP-before-SMTP authentication. If it is nil, elmo-pop3-default-authenticate-type is used.

wl-pop-before-smtp-port ¶

The initial setting is nil. This is the POP port number for POP-before-SMTP. If it is nil, elmo-pop3-default-port is used.

wl-pop-before-smtp-stream-type ¶

The initial setting is nil. This flag controls the use of SSL for POP-before-SMTP. If it is nil, elmo-pop3-default-stream-type is used. If ssl, SSL is used. If starttls, STARTTLS (RFC2595) connection will be established.

wl-draft-queue-save-variables ¶

Specifies a list of variable to which queued messages are saved on the off-line transmission.

wl-draft-sendlog ¶

The initial setting is t. If t, transmission log is written in ~/.elmo/sendlog. It is written when:

• drafts are sent by smtp or qmail
• saved into folders by fcc
• saved into folders by queuing

(it is written even if the transmission fails). But transmission by im-wl.el is not written in the sendlog and left to the logging function of imput.

wl-draft-sendlog-max-size ¶

The initial setting is 20000 (in bytes). If wl-draft-sendlog is t, the log is rotated when it grows beyond the size specified by this variable.

wl-use-ldap ¶

The initial setting is nil. If non-nil, address completion uses LDAP.

wl-ldap-server ¶

The initial setting is ‘localhost’. LDAP server name for address completion.

wl-ldap-port ¶

The initial setting is nil. If non-nil, the value is used as port number.

wl-ldap-base ¶

The initial setting is ‘c=US’. LDAP search starting point (base) for address completion.

wl-draft-remove-group-list-contents ¶

The initial setting is t. If non-nil, remove the group-lists’ members in the recipients when sending the message (group-list means the description such as ‘Group: foo@gohome.org, bar@gohome.org;’ in the recipients).

8.1 Off-line State ¶

Wanderlust has on-line and off-line states. In the off-line state, you cannot access messages via network, unless they are cached.

‘[ON]’ in the mode line indicates the on-line state. ‘[--]’ in the mode line indicates the off-line state. In folder or summary modes, press M-t to switch between off- and on-line.

You can invoke Wanderlust in the off-line state by setting wl-plugged to nil in ~/.wl or anything appropriate.

In the off-line mode, n and p command in the summary mode ignores uncached messages.

8.2 Enable Disconeected Operations ¶

Even in the off-line state, provided that relevant messages are cached, and the variable elmo-enable-disconnected-operation (described later) is non-nil, you can following operations: See Switching On-line/Off-line per Server/Port, See Invoking Wanderlust in the Off-line State.

As soon as Wanderlust becomes on-line, such operations invoked off-line are reflected in the servers via network.

If the variable elmo-enable-disconnected-operation is nil, these off-line operations are not executed and causes an error on re-file or copy operations.

• Transmission of Messages
• Re-file and Copy (IMAP4)
• Creation of Folders (IMAP4)
• Marking (IMAP4)
• Pre-fetching

8.3 Switching On-line/Off-line per Server/Port ¶

M-t described above switches networking states as a whole, but you can switch on-line/off-line per server/port.

Pressing C-t in the folder or summary modes brings you in wl-plugged-mode shown below, in which you can change the plugged state for each port.

Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
[ON](wl-plugged)
  [--]hosta
    [--]smtp        +queue: 2 msgs (1,2)        ...sending queue
    [--]nntp(119)   +queue: 1 msg (3)           ...sending queue
  [ON]hostb
    [--]imap4/cram-md5(143) %#mh/wl(prefetch-msgs:3,mark-as-important:1)
                            %inbox(delete-msgids:1)    ...dop queue
    [ON]nntp(119)
    [ON]smtp

The first line indicates status of the following three variables, and simply pressing SPC or RET in each labeled column modifies the values of these variables.

"Queuing"               wl-draft-enable-queuing
"AutoFlushQueue"        wl-auto-flush-queue
"DisconnectedOperation" elmo-enable-disconnected-operation

where ‘[ON]’ means its value is t, and ‘[--]’ means nil.

The second and after lines indicate on-line/off-line states of servers and ports, where ‘[ON]’ stands for on-line and ‘[--]’ for off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing SPC or RET in each line switches its state.

sending queue means messages accumulated in the folder ‘+queue’ for off-line transmission, and dop queue means off-line operations when elmo-enable-disconnected-operation is t.

They are displayed if there are any of them. In the example above, in the sending queue there are two messages (the first and the second in the queue folder) for smtp to hosta and one (the third) for nntp to hosta, and in the dop queue there are one for ‘%inbox’ and two for ‘%#mh/wl’.

If you change ‘(wl-plugged)’ in the second line, the variable wl-plugged is changed, so that the mode line indicator and plugged states of all ports are affected. If you change plugged states of any servers or ports, ‘(wl-plugged)’ in the second line is affected depending on elmo-plugged-condition settings and the plugged state of each port.

8.4 Invoking Wanderlust in the Off-line State ¶

As described before, if you set wl-plugged to nil in ~/.wl or anything appropriate, you can invoke Wanderlust in the off-line state. You can specify off-line state on a per server or port basis. Refer to wl-reset-plugged-alist also.

Usually, when Wanderlust starts up, the plugged state of each port is read from ~/.folders and wl-smtp-posting-server, wl-nntp-posting-server and so on. If you want to change the plugged state of these ports or to add other ports, configure wl-make-plugged-hook with a function.

(add-hook 'wl-make-plugged-hook
          '(lambda ()
             (elmo-set-plugged plugged-value(t/nil) server port)
                 ;; add or change plugged states of the port of the server
             (elmo-set-plugged plugged-value(t/nil) server)
                 ;; if the port is omitted, all ports are affected
                 ;; (you cannot omit the port if you newly add the server)
             ))

8.5 Customizable Variables ¶

wl-plugged ¶

If this variable is set to nil, Wanderlust starts up in off-line mode from the beginning.

wl-queue-folder ¶

The initial setting is ‘+queue’. This is the folder in which messages in the transmission queue are accumulated.

wl-auto-flush-queue ¶

The initial setting is t. This flag controls automatic transmission of the queue when Wanderlust becomes on-line. If non-nil, the queue is automatically transmitted (with confirmation by y-or-n-p). If you want to transmit it manually, press F in the folder mode.

elmo-enable-disconnected-operation ¶

The initial setting is t. Controls off-line operations regarding networking folders. If non-nil, off-line operations are carried out.

elmo-lost+found-folder ¶

The initial setting is ‘+lost+found’. This is the folder to which messages are saved when they fails to be appended while the off-line re-file/copy queue is processed.

elmo-plugged-condition ¶

The initial setting is one. The value of wl-plugged reflects the return value of the function elmo-plugged-p (without arguments). This variable elmo-plugged-condition specifies the condition on which the return value of (elmo-plugged-p) should be t depending on the plugged state of each port.

'one         : plugged if one or more ports are plugged.
'all         : plugged if all ports are plugged.
'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
               states of the ports.
function     : reflects the return value of the function
 functions available per default
 'elmo-plug-on-by-servers
             : reflects the plugged state of the servers specified by the
               variable elmo-plug-on-servers.
 'elmo-plug-on-by-exclude-servers
             : reflects the plugged state of the servers that are not
               in elmo-plug-on-exclude-servers.
                  elmo-plug-on-exclude-servers defaults to
                   '("localhost"
                     (system-name)
                     (system-name)without the domain part)

Example 1:
 (setq elmo-plugged-condition 'all)
Example 2:
 (setq elmo-plug-on-servers '("smtpserver" "newsserver"))
 (setq elmo-plugged-condition 'elmo-plug-on-by-servers)
Example 3:
 (setq elmo-plug-on-exclude-servers '("localhost" "myname"))
 (setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)

wl-reset-plugged-alist ¶

The initial setting is t. If non-nil, plugged states are initialized on a per server or port basis when Wanderlust starts up.

If nil, plugged states are retained while Emacs is running. In other words, they are initialized when Emacs is restarted even if the value is nil.

9.1 Expiration ¶

Expiration means deletion of old messages which have outlasted a certain period of time.

wl-expire supports not only simple deletion, but also moving to specified archiving folders.

9.2 How to Use ¶

Configure wl-expire-alist and press e in the folder mode, or M-e in the summary mode.

• Configuring wl-expire-alist
• Treatment for Important or Unread Messages
• Auto Expiration

(setq wl-expire-alist
      '(("^\\+trash$"   (date 14) remove)
                                  ;; delete
        ("^\\+tmp$"     (date 7) trash)
                                  ;; re-file to wl-trash-folder
        ("^\\+outbox$"  (number 300) "$outbox;lha")
                                  ;; re-file to the specific folder
        ("^\\+ml/tmp$"  nil)
                           ;; do not expire
        ("^\\+ml/wl$"   (number 500 510) wl-expire-archive-number1 t)
                           ;; archive by message number (retaining numbers)
        ("^\\+ml/.*"    (number 300 310) wl-expire-archive-number2 t)
                           ;; archive by a fixed number (retaining numbers)
        ("^\\+diary$"   (date 30) wl-expire-archive-date)
                           ;; archive by year and month (numbers discarded)
        ))

(regexp-for-folders specification-of-messages-to-be-deleted destination)

(add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)

9.3 Tips ¶

• Treating archive folders
• Confirming
• Re-filing Reserved Messages

delete  +ml/wl  (593 594 595 596 597 598 599)
move    +ml/wl -> $ml/wl-00600;tgz;wl  (600 601 602)

9.4 Customizable Variables ¶

wl-expire-alist ¶

The initial setting is nil. This variable specifies folders and methods to expire. For details, refer to wl-expire-alist settings above.

wl-summary-expire-reserve-marks ¶

The initial setting is the list below.

(list wl-summary-flag-mark
      wl-summary-new-uncached-mark
      wl-summary-new-cached-mark
      wl-summary-unread-uncached-mark
      wl-summary-unread-cached-mark)

Messages with these marks are retained in the folder, even after expiration. Only permanent marks can be listed, not temporary marks.

You can list marks one by one as in the default; you can use the following settings as well:

all

All messages with permanent marks are retained, i.e. wl-summary-read-uncached-mark is included in addition to the defaults.

none

All messages are handled as usual ones that are already read, no matter what marks they have; even important messages are deleted.

wl-expire-archive-files ¶

The initial setting is 100. This variable specifies the number of messages to be retained in one archiving folder.

wl-expire-number-with-reserve-marks ¶

The initial setting is nil. If non-nil, if expiring messages are specified by number, messages with wl-summary-expire-reserve-marks are also retained.

wl-expire-archive-get-folder-function ¶

The initial setting is wl-expire-archive-get-folder.

This variable specifies a function that returns the name of an archiving folder for standard functions in the place of destination. You can use the following three variables for simple modification of folder names; if you want more complex settings, define your own function in this variable.

wl-expire-archive-get-folder can be customized by these variables:

• wl-expire-archive-folder-name-fmt
• wl-expire-archive-folder-type
• wl-expire-archive-folder-prefix

wl-expire-archive-folder-name-fmt ¶

The initial setting is ‘%s-%%05d;%s’. This is a format string for archiving folders used in wl-expire-archive-number1 and wl-expire-archive-number2. Note that you must specify the message number by ‘%%d’, because it is parsed twice by format.

If you modify this, adjust wl-expire-archive-folder-num-regexp as well.

wl-expire-archive-date-folder-name-fmt ¶

The initial setting is ‘%s-%%04d%%02d;%s’. This is a format string for archiving folders used in wl-expire-archive-date. Note that you must specify the message number by ‘%%d’, because it is parsed twice by format. There should be ‘%%d’ twice, one for the year and the other for the month.

If you modify this, adjust wl-expire-archive-date-folder-num-regexp as well.

wl-expire-archive-folder-type ¶

The initial setting is zip. This variable specifies an archiver type of the archiving folders.

wl-expire-archive-folder-prefix ¶

The initial setting is nil. This variable specifies the prefix (directory structure) to archiving folders. Exercise extreme caution in using this feature, as it has not been seriously tested. In the worst case, there is a fear of destructing archiving folders.

nil

There will be no prefix.

short

For example, ‘+ml/wl’ will be prefixed by ‘wl’, resulting in ‘$ml/wl-00000;zip;wl’.

t

For example, ‘+ml/wl’ will be prefixed by prefix ‘ml/wl’, resulting in

‘$ml/wl-00000;zip;ml/wl’.

wl-expire-archive-folder-num-regexp ¶

The initial setting is ‘-\\([-0-9]+\\);’. This variable specifies the regular expression to be used for getting message numbers from multiple archiving folders specified by elmo-list-folders. Set it in accordance with wl-expire-archive-folder-name-fmt.

wl-expire-archive-date-folder-num-regexp ¶

The initial setting is ‘-\\([-0-9]+\\);’. This is the regular expression to be used for getting message numbers from multiple archiving folders specified by elmo-list-folders. Set it in accordance with wl-expire-archive-date-folder-name-fmt.

wl-expire-delete-oldmsg-confirm ¶

The initial setting is t. If non-nil, messages older than the one with the largest number will be deleted with confirmation. If nil, they are deleted without confirmation.

This feature is valid only if non-nil is specified as a argument to the standard functions so as to retain numbers.

wl-expire-use-log ¶

The initial setting is nil. If non-nil, expiration logs are recorded in ~/.elmo/expired-log. They are appended but not truncated or rotated automatically; you might need to remove it manually.

wl-expire-add-seen-list ¶

The initial setting is t.

If non-nil, when messages are re-filed by expiration, read/unread information is passed to the destination folder.

However if you do not read the destination folder from Wanderlust, seen under ~/.elmo/ grows larger and larger, so you might want to set this to nil if you are simply saving to some archiving folders. Even if its value is nil, messages in the archiving folders are simply treated as unread; it does not affect expiration itself.

wl-expire-folder-update-msgdb ¶

The initial setting is t. If t, in the folder mode, expiration is carried out after updating summary information. If you specified a list of regular expressions of folder names, summary information is updated for matching folders only.

9.5 Archiving Messages ¶

• Archiving Messages
• Customizable Variables

(setq wl-archive-alist
      '(("^\\+tmp$"     wl-archive-date)
        ("^\\+outbox$"  wl-archive-number2)
        (".*"           wl-archive-number1)))

(folders-regexp  deleting-function)

10.1 Score Commands ¶

• Score File Specification
• Scored Messages
• Creation of Score Files
• Tips
• Key Bindings
• Key Bindings in the Score Editing Buffer
• Customizable Variables

(setq wl-score-folder-alist
      '(("^-.*"
         "news.SCORE"
         "my.SCORE")
        (".*"
         "all.SCORE")))