Introduction

This file, ui.html, defines the look-and-feel of the user interface of the SpamBayes Server. The various pieces of HTML defined here are extracted and manipulated at runtime to dynamically produce the HTML that the SpamBayes Server serves up - this file acts as a palette of HTML components. PyMeldLite is the module that provides the HTML-to-object mapping layer that makes all this possible. Each piece of HTML that needs to be manipulated has an id tag, and becomes a Python object at runtime.

As an example of how this works, here is an editbox with an id of examplebox: PyMeldLite lets you manipulate the HTML programmatically:

    >>> import PyMeldLite
    >>> html = open("ui.html", "rt").read()
    >>> doc = PyMeldLite.Container(html)
    >>> print doc.examplebox
    <input id="examplebox" size="10" type="text" value="example"/>
    >>> doc.examplebox.value = "Changed"
    >>> print doc.examplebox
    <input id="examplebox" size="10" type="text" value="Changed"/>
    

So the Python code to build the HTML user interface pages doesn't need to faff about pasting strings together, or building HTML components from scratch in code. And the look-and-feel is controlled solely by this one HTML file - changing the stylesheet, translating into other languages, adding a new piece of user interface - all of these things are very easy.

Below are all the user interface components along with their ids.


headedBox

Headed box
  This is a "headedBox". Most of the user interfaces pieces are presented in one of these. The pieces aren't presented in these boxes here in ui.html to avoid duplication of HTML.
 

The help page

SpamBayes Help
  Sorry, there isn't any specific help available for that section.
  If you believe you may have found a bug in SpamBayes, or are at a loss as to how you can proceed, you can ask the SpamBayes mailing list for assistance. Note that the members of this list are volunteers that answer questions in their free time, so an answer to your question might take a little while to appear. If you are quite certain that you have found a bug, then you're probably better off submitting this via the SourceForge tracking system, as sometimes things get lost on the list, particularly in busy times or when the latest virus is flooding the net with bogus messages.
 
There is certain information which people need to know in order to suggest how you might fix any problems. To help make sure that you have all this information, SpamBayes can create a help message for you. If you choose to email the list without using this, please ensure that you have all the pertinent information. (Otherwise your response is likely to be "please tell us ...").

A pre-filled-in 'help' message

Send Help Message
From:
Subject:
Message:
Attach Log file:

status

POP3 proxy running on 1110, proxying to example.com.
Active POP3 conversations: 0.
POP3 conversations this session: 0.
Emails classified this session: 0 spam, 0 ham, 0 unsure.
Total emails trained: Spam: 0 Ham: 0
More statistics...
          You can configure your SpamBayes
      system using the Configuration page.
Warning: please insert warning message here!

reviewText

The SpamBayes proxy stores all the messages it sees. You can train the classifier based on those messages using the Review messages page.


reviewTable

These are emails that you can use to train the classifier. Check the appropriate button for each email, then click 'Train' below. 'Defer' leaves the message here, to be trained on later. Click one of the Discard / Defer / Ham / Spam headers to check all of the buttons in that section in one go. Click one of the other headers to sort messages (within their classification) by that header (note that sorting will lose any changes you have made to the page).

          
 
Messages classified as TYPE:
Subject Received: Discard / Defer / Ham / Spam Score:
Richie Hindle <richie@entrian.com> Sat, 11 Sep 2003 19:03:11                  0.00% Clues | Tokens
   
    

upload

Either upload a message, mbox or dbx file:
Or paste one whole message (including headers) here:

(The upload form gets used for both training and classifying - the inappropriate pieces are removed at runtime.)


wordQuery


Basic Query
Wildcard Query
Regular Expression Query
Ignore Case
Maximum results

findMessage

Search in...
SpamBayes ID
Subject
Message headers
Message body
Ignore Case
Maximum results

wordStats

Number of spam messages: 123.
Number of ham messages: 456.
Probability that a message containing this word is spam: 0.789.
Word # Spam # Ham Probability
spambayes 123 436 .789

classifyResults

Spam probability: 0.123. Original probability: 0.125.

(The table of clues goes here, like this but in a headedBox):
Word Probability Times in ham Times in spam
Example word 0.123 1 2

Return Home or classify another:

(The Classify form goes here)

configForm

This page allows you to change the options that control how SpamBayes processes your email. Your options are stored in /example/pathname.

Label      

(Help text goes here.)

Label
Value Label 
     

(Help text goes here.)

Current Value:  (value)
Current Value:  (value)
 
Folder name

(Help text goes here.)


shutdownMessage

Shutdown. Goodbye.