Score File Format

The format of score files are the same as Gnus, and basically you can use Gnus score files as they are. But they are not fully compatible because some keys are not supported and there are Wanderlust specifics. See section `Score File Format' in The gnus Newsreader.

(("subject"
  ("for sale" -1000 nil s)
  ("profit" -1000 nil s))
 ("from"
  ("spam@spamspamspam" -10000 nil s))
 ("followup"
  ("my@address" 3001 nil s))
 ("chars"
  (1000000 -10 nil >))
 (important 5000)
 (target 3000)
 (mark 0)
 (expunge -3000))

string

If the key is a string, it is the name of the header to be matched. The following keys are available: Subject, From, Date, Message-ID, References, To, Cc, Chars, Lines, Xref, Extra, Followup, Thread Chars and Lines mean the size and the number of lines of the message, respectively. Extra, Followup, Thread are described later. The rest corresponds the field of the same name. Arbitrary numbers of core entries are specified after the key. Each score entry consists of these five factors:

1. A factor that matches header. This should be a number in the cases of lines and chars, otherwise a string.
2. A score factor. When the first item matches, the score of the message is increased or decreased by this value.
3. A time limiting factor. If nil, the score is permanent, and in the case of a number, the score is deleted if it does not match for days (wl-score-expiry-days) from the date specified by this. The date is since Dec. 31, 1 B.C.
4. A type factor. This specifies the way the first factor matches. Available types depend on keys.

   From, Subject, References, Message-ID

   For these keys in string, r and R (regexp), s and S (substring), e and E (exact match), as well as f and F (fuzzy) can be used. R, S, E, and F are case sensitive.

   Lines, Chars

   For these keys, the following five numerical relative operators can be used: <, >, =, >=, <=.

   Followup

   This key matches From header, and scores all follow-ups to the message. For example, it would be useful for increasing scores for follow-ups to you own article. You can use the same types as From except for f. And a `Followup' entry is automatically appended to the score file.

   Thread

   This key scores (sub-)threads beginning with Message-ID x. A `Thread' entry is automatically appended for each article that has x in the References header. You can make sure the whole thread including messages that does not have all ancestors Message-ID in References is scored. You can use the same types as References except for f. And a `Thread' entry is automatically appended to the score file.

5. A factor for extension header. This is meaningful only if the key is Extra. This specifies headers to be matched other than standard headers like Subject and From. Note that you should specify the header in elmo-msgdb-extra-fields also. Therefore it does not work in folders where extension headers cannot be retrieved.

The sum of these scores after all factors are applied becomes the score of the message.

mark

Messages with a score less than this value is marked as read. The default is wl-summary-mark-below.

expunge

Messages with a score less than this value is deleted from the summary. The default is wl-summary-expunge-below.

mark-and-expunge

Both mark and expunge are applied, i.e. messages with a score less than this value is marked as read and deleted from the summary.

target

Messages with a score greater than this value is attached with temp marks. The default is wl-summary-target-above.

important

Messages with a score greater than this value is attached with important marks. The default is wl-summary-important-above.

Caveats

Not to mention the extra key, if lines or xref keys are used, you need to set elmo-msgdb-extra-fields.

(setq elmo-msgdb-extra-fields '("lines" "xref"))

There are other restrictions as shown below:

• Because `References' field in the summary information contains only the last `Message-ID', references key matches the last one only.

Keys that can be seen by folder of types:

                        chars lines xref  extra
localdir,localnews        Y     E     E     E
nntp (supporting xover)   Y     E     E     N
     (otherwise)          N     E     E     E
imap4                     Y     E     E     E
pop3                      N     E     E     E

                Y: can be seen
                N: cannot be seen (ignored)
                E: can be seen with elmo-msgdb-extra-fields settings

Go to the first, previous, next, last section, table of contents.