kmail

KMail::AntiSpamWizard

KMail::AntiSpamWizard Class Reference

#include <antispamwizard.h>

List of all members.

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 from a config file. The structure of the file is as following: 

    [General]
    tools=1

    [Spamtool #1]
    Ident=spamassassin
    Version=0
    Priority=1
    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
    ServerSided=0
    type=spam
The name of the config file is kmail.antispamrc and it's expected in the config dir of KDE.

Definition at line 103 of file antispamwizard.h.


Public Types

enum  WizardMode { AntiSpam, AntiVirus }

Public Member Functions

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

Protected Slots

void checkProgramsSelections ()
void checkVirusRulesSelections ()
void checkToolAvailability ()
void slotHelpClicked ()
void slotBuildSummary ()

Protected Member Functions

void accept ()

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

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.

Definition at line 111 of file antispamwizard.h.

Constructor & Destructor Documentation

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.

Definition at line 60 of file antispamwizard.cpp.

Member Function Documentation

void AntiSpamWizard::accept (   )  [protected]
 

Evaluate the settings made and create the appropriate filter rules.

Definition at line 140 of file antispamwizard.cpp.

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

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

Definition at line 445 of file antispamwizard.cpp.

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

Check if the spam tools are available via the PATH.

Definition at line 485 of file antispamwizard.cpp.

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

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

Definition at line 479 of file antispamwizard.cpp.

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

Create the summary text based on the current settings.

Definition at line 544 of file antispamwizard.cpp.

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

Show a help topic.

Definition at line 535 of file antispamwizard.cpp.

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

kmail

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys