kmail

KMail::AntiSpamConfig Class Reference

Singleton to manage loading the kmail.antispamrc file. More...

#include <antispamconfig.h>

List of all members.


Public Member Functions

SpamAgents agents ()
const SpamAgents agents () const
const SpamAgents uniqueAgents () const
 ~AntiSpamConfig ()

Static Public Member Functions

static AntiSpamConfiginstance ()

Detailed Description

Singleton to manage loading the kmail.antispamrc file.

Author:
Patrick Audley <paudley@blackcat.ca>
Use of this config-manager class is straight forward. Since it is a singleton object, all you have to do is obtain an instance by calling SpamConfig::instance() and use any of the public member functions.

Definition at line 87 of file antispamconfig.h.


Constructor & Destructor Documentation

KMail::AntiSpamConfig::~AntiSpamConfig (  )  [inline]

Definition at line 94 of file antispamconfig.h.


Member Function Documentation

SpamAgents KMail::AntiSpamConfig::agents (  )  [inline]

Definition at line 103 of file antispamconfig.h.

const SpamAgents KMail::AntiSpamConfig::agents (  )  const [inline]

Returns a list of all agents found on the system.

This might list SA twice, if both the C and the Perl version are present.

Definition at line 102 of file antispamconfig.h.

AntiSpamConfig * AntiSpamConfig::instance (  )  [static]

Definition at line 46 of file antispamconfig.cpp.

const SpamAgents AntiSpamConfig::uniqueAgents (  )  const

Returns a list of unique agents, found on the system.

SpamAssassin will only be listed once, even if both the C and the Perl version are installed.

Definition at line 84 of file antispamconfig.cpp.


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