KMail::AntiSpamWizard Class Reference

KMail anti-spam wizard. More...

#include <antispamwizard.h>

Inherits KWizard.

List of all members.

Public Types

enum WizardMode { AntiSpam, AntiVirus }

Public Member Functions

AntiSpamWizard (WizardMode mode, QWidget *parent, KMFolderTree *mainFolderTree)

Protected Slots

Protected Member Functions

void accept ()
int checkForProgram (const QString &executable)

Classes

class ConfigReader
Instances of this class control reading the configuration of the anti-spam tools from global and user config files as well as the merging of different config versions. More...
class SpamToolConfig
Instances of this class store the settings for one tool as read from the config file. More...

Detailed Description

KMail anti-spam wizard.

Author:: Andreas Gungl <a.gungl@gmx.de>

The wizard helps to create filter rules to let KMail operate with external anti-spam tools. The wizard tries to detect the tools, but the user can overide the preselections. Then the user can decide what funtionality shall be supported by the created filter rules. The wizard will append the created filter rules after the last existing rule to keep possible conflicts with existing filter configurations minimal.

Anti-virus support was added by Fred Emmott <fred87@users.sf.net>

The configuration for the tools to get checked and set up is read fro a config file. The structure of the file is as following:

    [General]
    tools=1

    [Spamtool #1]
    Ident=spamassassin
    Version=0
    VisibleName=&Spamassassin
    Executable=spamassassin -V
    URL=http://spamassassin.org
    PipeFilterName=SpamAssassin Check
    PipeCmdDetect=spamassassin -L
    ExecCmdSpam=sa-learn --spam --no-rebuild --single
    ExecCmdHam=sa-learn --ham --no-rebuild --single
    DetectionHeader=X-Spam-Flag
    DetectionPattern=yes
    DetectionPattern2=
    DetectionOnly=0
    UseRegExp=0
    SupportsBayes=1
    SupportsUnsure=0
    type=spam

The name of the config file is kmail.antispamrc and it's expected in the config dir of KDE.

Member Enumeration Documentation

enum KMail::AntiSpamWizard::WizardMode

The wizard can be used for setting up anti-spam tools and for setting up anti-virus tools.

Constructor & Destructor Documentation

KMail::AntiSpamWizard::AntiSpamWizard	(	WizardMode	mode,
		QWidget *	parent,
		KMFolderTree *	mainFolderTree
	)

Constructor that needs to initialize from the main folder tree of KMail.

Parameters:

	mode	The mode the wizard should run in.
	parent	The parent widget for the wizard.
	mainFolderTree	The main folder tree from which the folders are copied to allow the selection of a spam folder in a tree within one of the wizard pages.

Member Function Documentation

void AntiSpamWizard::accept ( ) [protected]

Evaluate the settings made and create the appropriate filter rules.

int AntiSpamWizard::checkForProgram ( const QString & executable ) [protected]

Check for the availability of an executible along the PATH.

void AntiSpamWizard::checkProgramsSelections ( ) [protected, slot]

Modify the status of the wizard to reflect the selection of spam tools.

void AntiSpamWizard::checkSpamRulesSelections ( ) [protected, slot]

Modify the status of the wizard to reflect the selected functionality.

void AntiSpamWizard::checkVirusRulesSelections ( ) [protected, slot]

Modify the status of the wizard to reflect the selected functionality.

void AntiSpamWizard::checkToolAvailability ( ) [protected, slot]

Check if the spam tools are available via the PATH.

void AntiSpamWizard::slotHelpClicked ( ) [protected, slot]

Show a help topic.

The documentation for this class was generated from the following files:

antispamwizard.h
antispamwizard.cpp

kmail

API Docs