[Spambayes-checkins] spambayes/Outlook2000/docs welcome.html, NONE,
1.1 troubleshooting.html, 1.13, 1.14
Mark Hammond
mhammond at users.sourceforge.net
Fri Aug 29 00:24:51 EDT 2003
Update of /cvsroot/spambayes/spambayes/Outlook2000/docs
In directory sc8-pr-cvs1:/tmp/cvs-serv9463/docs
Modified Files:
troubleshooting.html
Added Files:
welcome.html
Log Message:
Re-structed the docs for the Outlook plugin to reflect the new wizard.
--- NEW FILE: welcome.html ---
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type"
content="text/html; charset=ISO-8859-1">
<title>Welcome To SpamBayes</title>
</head>
<body style="background-image: url(about:blank);">
<img src="file:///e:/src/spambayes/Outlook2000/docs/images/sblogo.jpg"
title="" alt="Logo" style="width: 380px; height: 77px;">
<h1>Welcome to SpamBayes <br>
</h1>
<p>SpamBayes is an Outlook plugin that provides a spam filter based on
statistical analysis of
your personal mail. Unlike many other spam detection systems,
SpamBayes
actually learns what you consider spam, and continually adapts as both
your regular email and spam patterns change.</p>
<p>When you first start Outlook after SpamBayes has been installed, the
SpamBayes Installation Wizard will appear. This Wizard will guide
you through the configuration process and allow you to quickly have
SpamBayes filtering your mail, howver this document contains additional
information which will help make SpamBayes effective from the first
time you use it.</p>
<p>Please remember that this is free software; please be patient, and
note that there are plenty of things to improve. There are ways
you can help, even if you aren't a programmer - you could help with
this documentation, or <a
href="http://www.spambayes.org/donations.html">make a donation</a>, or
any number of other ways - please see the <a
href="http://www.spambayes.org">main project
page</a> for information. The list of <a
href="http://www.spambayes.org/faq.html">Frequently Asked Questions</a>
may also answer some of yours.</p>
<p>For more information on SpamBayes, including links to the rest of
the documentation, see <a href="../About.html">About SpamBayes</a>.</p>
<h3>Training</h3>
SpamBayes has no builtin
rules, so anything you consider spam will be treated as spam by this
system, even if it does not conform to the traditional definitions of
spam. This means that SpamBayes requires <span
style="font-style: italic;">training </span>before it will be
effective. There are two ways that this training can be done:<br>
<ul>
<li>Allow SpamBayes to learn as it goes. Initially, SpamBayes
will consider all mail items <span style="font-style: italic;">unsure</span>,
and each item will be used to
train. In this scenario, SpamBayes will take some time to become
effective. It will rarely make mistakes, but will continue to be
unsure about items until the training information grows.<br>
</li>
<li>Pre-sorting mail into two folders; one containing only examples
of good messages, and another containing only examples of spam.
SpamBayes will then process all these messages gathering the clues it
uses to filter mail.. Depending on how many messages you train
on, SpamBayes will be immediately effective at correctly classifying
your mail.</li>
</ul>
<p>The Installation Wizard will guide you through these options.</p>
<p>It is important to note that even when SpamBayes has little training
information, it rarely gets things wrong - the worst it generally does
is to classify a message as <span style="font-style: italic;">unsure</span>.
However, as mentioned, the more training information SpamBayes has, the
less it is unsure about new messages. See using the plugin below
for more information.</p>
<h3>Using the Plugin</h3>
<table cellpadding="2" cellspacing="2" border="0"
style="text-align: left; width: 100%;">
<tbody>
<tr>
<td style="vertical-align: top;">This section describes how the
plugin operates once it is configured.
You can access the SpamBayes features from the SpamBayes toolbar (shown
to the right), but
in general, SpamBayes will simply and silently filter your mail.<br>
<br>
</td>
<td style="vertical-align: top;"><img
src="images/manager-select.jpg" title="" alt="SpamBayes Toolbar"
style="width: 354px; height: 138px;"><br>
</td>
</tr>
</tbody>
</table>
<br>
<p>As messages arrive, they are given a <span
style="font-style: italic;">spam score</span>. This score is
the measure of how "spammy" the system has decided a mail is, with 100%
being certain spam, and 0% meaning the message is certainly not
spam. The SpamBayes addin uses these scores to classify mail into
one of three categories -
<span style="font-style: italic;">certain spam</span>, <span
style="font-style: italic;">unsure</span>, and good messages.
Good messages are often
known in the anti-spam community as <span style="font-style: italic;">ham</span>.</p>
<p>Mail that is classified as good is never touched by this plugin -
they
will remain in your inbox, or be filtered normally by Outlook's builtin
rules. Mail that is classified as either <span
style="font-style: italic;">unsure</span> or <span
style="font-style: italic;">certain spam</span>
is moved into different folders for future review.</p>
<p>Outlook does not allow us to automatically add the <span
style="font-style: italic;">spam score</span> to your Outlook folder
views - but you can <a
href="file:///e:/src/spambayes/Outlook2000/about.html#Field">do it
manually by following these instructions</a>.<br>
</p>
There are three ways in which the system can get things wrong:
<ul>
<li>A spam stays in your inbox. This is known as a <span
style="font-style: italic;">false negative</span>. In this case
you can either drag the message to the Spam folder or click on the <span
style="font-style: italic;">Delete as Spam</span> button on the
Outlook
toolbar. In both cases, the message will be trained as spam and
will be moved to the spam folder.</li>
<li>Any message is moved to the unsure folder. In this case,
the system is simply unsure about the message, and moves it to the
possible spam folder for human review. All unsure messages should
be manually classified; good messages can either be dragged back to the
inbox, or have the <span style="font-style: italic;">Recover from Spam</span>
toolbar button clicked, while spam messages can either be dragged to
the
Spam folder or have the <span style="font-style: italic;">Delete as
Spam</span>
toobar button (shown above) clicked. In all cases, the system
will
automatically
be trained appropriately.</li>
<li>A wanted (ham) message is moved to the Spam folder. This is known
as a <span style="font-style: italic;">false positive</span>.<span
style="font-style: italic;"></span><span style="font-style: italic;"></span> In
this case you can either drag the message back to the folder from which
it came (generally the inbox), or click on the <span
style="font-style: italic;">Recover from Spam</span> button. In
both cases the message will be trained as good, and moved back to the
original folder.</li>
</ul>
Note that in all cases, as you take corrective action on the mail, the
system is also trained. This makes it less likely that another
similar mail will be incorrectly classified in the future.<br>
<br>
<br>
</body>
</html>
Index: troubleshooting.html
===================================================================
RCS file: /cvsroot/spambayes/spambayes/Outlook2000/docs/troubleshooting.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** troubleshooting.html 27 Jul 2003 11:15:22 -0000 1.13
--- troubleshooting.html 29 Aug 2003 06:24:48 -0000 1.14
***************
*** 12,18 ****
the following problems listed:<br>
<ul>
<li><a href="#Addin_doesnt_load">Addin doesn't load</a></li>
- <li><a href="#NoToolbar">Addin loads, but no toolbar items can be
- seen</a></li>
<li><a href="#Messages_fail_to_filter">Messages fail to filter</a></li>
<li><a href="#Messages_have_incorrect_or_unexpected">Messages have
--- 12,18 ----
the following problems listed:<br>
<ul>
+ <li><a href="#NoToolbar">Toolbar items appear, but fail to work</a></li>
+ <li><a href="#Error_during_load">Addin loads with an error message</a></li>
<li><a href="#Addin_doesnt_load">Addin doesn't load</a></li>
<li><a href="#Messages_fail_to_filter">Messages fail to filter</a></li>
<li><a href="#Messages_have_incorrect_or_unexpected">Messages have
***************
*** 28,52 ****
href="#mail">please read this first</a>.<br>
<hr style="width: 100%; height: 2px;">
<h2><a name="Addin_doesnt_load"></a>Addin doesn't load</h2>
! When you start Outlook, there is no SpamBayes item in the
! toolbar, and no filtering occurs. To resolve this:<br>
! <br>
<ul>
<li><a href="#CheckLog">Check the log file</a>. If a log file
for this session exists, then see if it contains an error. If
! not, then the addin may be operating, but simply not displaying the
! toolbar items. <a href="#NoToolbar">Follow this procedure to
! restore the toolbar</a>. If there is an error in the log file,
! please <a href="#ReportABug">report
! a bug</a>. If no log file for this session exists, continue the
! following steps.</li>
</ul>
<ul>
! <li><a href="#InstallationType">Determine your
! installation type</a>. <br>
! </li>
! <li>If you are running a binary version (ie, you downloaded a single
! installation program), then perform the following
! steps:</li>
</ul>
<ol>
--- 28,86 ----
href="#mail">please read this first</a>.<br>
<hr style="width: 100%; height: 2px;">
+ <h2><a name="NoToolbar"></a>Toolbar items appear, but fail to work</h2>
+ If the toolbar items fail to work, we are faciing one of two problems.<br>
+ <ul>
+ <li>The addin has failed to load. In this case, along with the
+ toolbars failing to work, SpamBayes will not be filtering or scoring
+ any messages. To fix this, see the <a href="#Addin_doesnt_load">Addin
+ doesn't load instructions</a>.</li>
+ </ul>
+ <ul>
+ <li>If the addin has loaded (ie, is filtering and scoring mail) but
+ the toolbar items don't, we have struck a common problem with the
+ toolbars. Follow the instructions below.<br>
+ </li>
+ </ul>
+ First we will try deleting the toolbar, and if that fails, completely
+ reset all Outlook toolbars. Perform the following steps.<br>
+ <ul>
+ <li>Right-click on any Outlook toolbar, and select Customize.</li>
+ <li>In the dialog that appears, locate SpamBayes in the list of
+ toolbars, and select it.</li>
+ <li>Click on the Delete button. Outlook will ask for
+ confirmation that you want to delete the SpamBayes toolbar.
+ Select OK.</li>
+ <li>Close the customize dialog. The SpamBayes toolbar no longer
+ appear.</li>
+ <li>Restart Outlook. SpamBayes will re-create the toolbar.</li>
+ </ul>
+ If all else fails, you can completely reset the Outlook toolbars by
+ removing the file <span style="font-style: italic;">\Documents and
+ Settings\{username}\Application Data\Microsoft\Outlook\outcmd.dat</span>.
+ Although this is undocumented by Microsoft, we have never heard reports
+ of problems. If you are paranoid, simply rename this file so that
+ you have a copy. This has solved all toolbar problems for
+ everyone who has reported one!<br>
+ <h2><a name="Error_during_load"></a>Addin loads with an error message</h2>
+ In this case, when you start Outlook you receive a message indicating
+ that SpamBayes could not be initialized.<br>
+ This means that SpamBayes has loaded, but struck an error during
+ initialization. If the information in the error message does not
+ indicate the nature of the error, please <a href="#ReportABug">report
+ a bug</a> (making sure you <a href="#CheckLog">attach the log file</a>)<br>
<h2><a name="Addin_doesnt_load"></a>Addin doesn't load</h2>
! If you start Outlook but there was no error message, the SpamBayes
! toolbar items do not work and new messages have no Spam score or
! filtering applied, then the plugin has probably become disabled.<br>
<ul>
<li><a href="#CheckLog">Check the log file</a>. If a log file
for this session exists, then see if it contains an error. If
! not, check the date and time of the log - it is probably a log from the
! last time it did work, so is no help to us. If a log does exist,
! please <a href="#ReportABug">report a bug.</a><br>
! </li>
</ul>
<ul>
! <li>Check that Outlook shows the addin as enabled.</li>
</ul>
<ol>
***************
*** 85,91 ****
</ol>
</ol>
<ul>
- <li>If you are running from source code, please re-register the
- addin, as per the README.txt file.</li>
</ul>
If none of that works, I am stumped!
--- 119,126 ----
</ol>
</ol>
+ If you are running from source code, the addin will not appear in the
+ above steps. Please re-register the
+ addin, as per the README.txt file.
<ul>
</ul>
If none of that works, I am stumped!
***************
*** 94,138 ****
</ol>
</ol>
- <h2><a name="NoToolbar"></a>Addin loads, but no toolbar items can be
- seen</h2>
- If it appears the addin has loaded and is working correctly (ie, <a
- href="#CheckLog">checking the log file</a> indicates normal operation)
- but you can not see any toolbar items for the addin, try the
- following:.
- <ul>
- <li>Make sure that you are displaying the 'SpamBayes' toolbar -
- select
- View -> Toolbars, and ensure that "SpamBayes" is selected.<br>
- </li>
- <li>Try resetting the toolbars:
- <ol>
- <li>Select <span style="font-style: italic;">View</span>-> <span
- style="font-style: italic;">Toolbars</span>-> <span
- style="font-style: italic;">Customize</span> to display
- the toolbar options dialog</li>
- <li>Select the tab labelled <span style="font-style: italic;">Toolbars</span>,
- select the 'Standard' toolbar,
- and click <span style="font-style: italic;">Reset</span></li>
- <li>Restart Outlook </li>
- </ol>
- </li>
- <li>Try deleting the SpamBayes toolbar</li>
- <ol>
- <li>Select <span style="font-style: italic;">View</span>-> <span
- style="font-style: italic;">Toolbars</span>-> <span
- style="font-style: italic;">Customize</span> to display
- the toolbar options dialog</li>
- <li>Select the tab labelled <span style="font-style: italic;">Toolbars</span>,
- select the 'SpamBayes' toolbar,
- and click <span style="font-style: italic;">Delete</span></li>
- <li><span style="font-style: italic;">Restart Outlook<br>
- </span></li>
- </ol>
- </ul>
- If all else fails, you can completely reset the Outlook toolbars by
- removing the file <span style="font-style: italic;">\Documents and
- Settings\{username}\Application Data\Microsoft\Outlook\outcmd.dat</span>.
- Although this is undocumented by Microsoft, we have never heard reports
- of problems - but you may like to make a copy of the file just in case.<br>
<ul>
</ul>
--- 129,132 ----
More information about the Spambayes-checkins
mailing list