HeaderFilter Class Reference

This is the mail header filter. Call check() with some header data of the mail to get the configured action for this mail. If the settings was changed by the config GUI you have to call load(). More...

#include <headerfilter.h>

List of all members.

Public Member Functions

 HeaderFilter ()
 ~HeaderFilter ()
FilterAction_Type check (QString from, QString to, uint size, QString subject, QStringList header, QString account, QString &mailboxName, QString &filterName) const
void load ()
void print ()
bool isActive ()

Private Attributes

KSharedConfigPtr config
bool active
FilterAction_Type defaultAction
QString mailbox
uint numberFilterItems
SenderListFilter senderlist
QList< FilterItem * > filters

Detailed Description

This is the mail header filter. Call check() with some header data of the mail to get the configured action for this mail. If the settings was changed by the config GUI you have to call load().

Author:
Ulrich Weigelt <ulrich.weigelt@gmx.de>

Definition at line 44 of file headerfilter.h.


Constructor & Destructor Documentation

HeaderFilter::HeaderFilter (  ) 

Constructor

Definition at line 20 of file headerfilter.cpp.

HeaderFilter::~HeaderFilter (  ) 

Destructor

Definition at line 30 of file headerfilter.cpp.


Member Function Documentation

FilterAction_Type HeaderFilter::check ( QString  from,
QString  to,
uint  size,
QString  subject,
QStringList  header,
QString  account,
QString &  mailboxName,
QString &  filterName 
) const

Checks the given mail header.

Parameters:
from Sender
Parameters:
to Addressee
Parameters:
size Size
Parameters:
subject Subject
Parameters:
header Header
Parameters:
account Account
Parameters:
mailboxName contains the mailbox name after call, if filter action is MOVE
Parameters:
filterName after the call it contains the name of the filter which has caught the mail
Returns:
recommend action

Definition at line 41 of file headerfilter.cpp.

bool HeaderFilter::isActive (  ) 

Returns the filter active state.

Returns:
TRUE - filter is active

Definition at line 176 of file headerfilter.cpp.

void HeaderFilter::load (  ) 

Loads the settings from the application config file.

Definition at line 93 of file headerfilter.cpp.

void HeaderFilter::print (  ) 

Prints the settings

Definition at line 135 of file headerfilter.cpp.


Member Data Documentation

bool HeaderFilter::active [private]

TRUE - filter is active

Definition at line 98 of file headerfilter.h.

KSharedConfigPtr HeaderFilter::config [private]

Connector to the configuration file

Definition at line 93 of file headerfilter.h.

Default action, if no filter matches

Definition at line 103 of file headerfilter.h.

QList<FilterItem*> HeaderFilter::filters [private]

This list holds the filter items

Definition at line 123 of file headerfilter.h.

QString HeaderFilter::mailbox [private]

mailbox name if default action is MOVE

Definition at line 108 of file headerfilter.h.

Number of filter items

Definition at line 113 of file headerfilter.h.

Black and White lists

Definition at line 118 of file headerfilter.h.


The documentation for this class was generated from the following files:
Generated on Sun Mar 13 15:27:10 2011 for KShowmail by  doxygen 1.6.3