kmail Library API Documentation

KMSearchRule Class Reference

Incoming mail is sent through the list of mail filter rules before it is placed in the associated mail folder (usually "inbox"). This class represents one search pattern rule. More...

#include <kmsearchpattern.h>

Inheritance diagram for KMSearchRule:

KMSearchRuleNumerical KMSearchRuleString List of all members.

Public Types

enum  Function {
  FuncNone = -1, FuncContains = 0, FuncContainsNot, FuncEquals,
  FuncNotEqual, FuncRegExp, FuncNotRegExp, FuncIsGreater,
  FuncIsLessOrEqual, FuncIsLess, FuncIsGreaterOrEqual, FuncIsInAddressbook,
  FuncIsNotInAddressbook, FuncIsInCategory, FuncIsNotInCategory, FuncHasAttachment,
  FuncHasNoAttachment
}

Public Member Functions

 KMSearchRule (const QCString &field=0, Function=FuncContains, const QString &contents=QString::null)
 KMSearchRule (const KMSearchRule &other)
const KMSearchRuleoperator= (const KMSearchRule &other)
virtual bool matches (const KMMessage *msg) const =0
virtual bool matches (const DwString &str, KMMessage &msg, const DwBoyerMoore *headerField=0, int headerLen=-1) const
virtual bool isEmpty () const =0
virtual bool requiresBody () const
void writeConfig (KConfig *config, int aIdx) const
Function function () const
void setFunction (Function aFunction)
QCString field () const
void setField (const QCString &field)
QString contents () const
void setContents (const QString &aContents)
const QString asString () const

Static Public Member Functions

KMSearchRulecreateInstance (const QCString &field=0, Function function=FuncContains, const QString &contents=QString::null)
KMSearchRulecreateInstance (const QCString &field, const char *function, const QString &contents)
KMSearchRulecreateInstance (const KMSearchRule &other)
KMSearchRulecreateInstanceFromConfig (const KConfig *config, int aIdx)

Detailed Description

Incoming mail is sent through the list of mail filter rules before it is placed in the associated mail folder (usually "inbox"). This class represents one search pattern rule.

This class represents one mail filter rule. It is also used to represent a search rule as used by the search dialog and folders.

Definition at line 31 of file kmsearchpattern.h.


Member Enumeration Documentation

enum KMSearchRule::Function
 

Operators for comparison of field and contents.

If you change the order or contents of the enum: do not forget to change funcConfigNames[], sFilterFuncList and matches() in KMSearchRule, too. Also, it is assumed that these functions come in pairs of logical opposites (ie. "=" <-> "!=", ">" <-> "<=", etc.).

Definition at line 41 of file kmsearchpattern.h.

Referenced by createInstanceFromConfig(), and function().


Member Function Documentation

KMSearchRule * KMSearchRule::createInstance const QCString field = 0,
Function  function = FuncContains,
const QString contents = QString::null
[static]
 

Create a search rule of a certain type by instantiating the appro- priate subclass depending on the field.

Definition at line 71 of file kmsearchpattern.cpp.

References createInstance().

Referenced by createInstance(), and createInstanceFromConfig().

KMSearchRule * KMSearchRule::createInstanceFromConfig const KConfig *  config,
int  aIdx
[static]
 

Initialize the object from a given config file.

The group must be preset. aIdx is an identifier that is used to distinguish rules within a single config group. This function does no validation of the data obtained from the config file. You should call isEmpty yourself if you need valid rules.

Definition at line 98 of file kmsearchpattern.cpp.

References createInstance(), createInstanceFromConfig(), and Function.

Referenced by createInstanceFromConfig().

virtual bool KMSearchRule::matches const KMMessage *  msg  )  const [pure virtual]
 

Tries to match the rule against the given KMMessage.

Returns:
TRUE if the rule matched, FALSE otherwise. Must be implemented by subclasses.

Implemented in KMSearchRuleString, and KMSearchRuleNumerical.

Referenced by matches().

bool KMSearchRule::matches const DwString &  str,
KMMessage &  msg,
const DwBoyerMoore *  headerField = 0,
int  headerLen = -1
const [virtual]
 

Optimized version tries to match the rule against the given DwString.

Returns:
TRUE if the rule matched, FALSE otherwise.

Reimplemented in KMSearchRuleString.

Definition at line 145 of file kmsearchpattern.cpp.

References matches().

virtual bool KMSearchRule::isEmpty  )  const [pure virtual]
 

Determine whether the rule is worth considering.

It isn't if either the field is not set or the contents is empty. KFilter should make sure that it's rule list contains only non-empty rules, as matches doesn't check this.

Implemented in KMSearchRuleString, and KMSearchRuleNumerical.

Referenced by KMSearchPattern::readConfig().

virtual bool KMSearchRule::requiresBody  )  const [inline, virtual]
 

Returns true if the rule depends on a complete message, otherwise returns false.

Reimplemented in KMSearchRuleString.

Definition at line 99 of file kmsearchpattern.h.

void KMSearchRule::writeConfig KConfig *  config,
int  aIdx
const
 

Save the object into a given config file.

The group must be preset. aIdx is an identifier that is used to distinguish rules within a single config group. This function will happily write itself even when it's not valid, assuming higher layers to Do The Right Thing(TM).

Definition at line 134 of file kmsearchpattern.cpp.

References writeConfig().

Referenced by writeConfig().

Function KMSearchRule::function  )  const [inline]
 

Return filter function.

This can be any of the operators defined in Function.

Definition at line 111 of file kmsearchpattern.h.

References Function.

Referenced by KMSearchRuleString::matches(), KMSearchRuleNumerical::matchesInternal(), and KMSearchRuleString::matchesInternal().

void KMSearchRule::setFunction Function  aFunction  )  [inline]
 

Set filter function.

Definition at line 114 of file kmsearchpattern.h.

References setFunction().

Referenced by setFunction().

QCString KMSearchRule::field  )  const [inline]
 

Return message header field name (without the trailing ':').

There are also six pseudo-headers:

  • <message>: Try to match against the whole message.
  • <body>: Try to match against the body of the message.
  • <any>: Try to match against any header field.
  • <recipients>: Try to match against both To: and Cc: header fields.
  • <size>: Try to match against size of message (numerical).
  • <age>: Try to match against age of message (numerical).
  • <status>: Try to match against status of message (status).

Definition at line 126 of file kmsearchpattern.h.

Referenced by KMSearchRuleString::isEmpty(), KMSearchRuleNumerical::matches(), KMSearchRuleString::matches(), KMSearchRuleString::requiresBody(), KMSearchRuleWidget::setHeadersOnly(), and KMSearchRuleWidget::setRule().

void KMSearchRule::setField const QCString field  )  [inline]
 

Set message header field name (make sure there's no trailing colon ':').

Definition at line 130 of file kmsearchpattern.h.

References setField().

Referenced by setField().

QString KMSearchRule::contents  )  const [inline]
 

Return the value.

This can be either a substring to search for in or a regexp pattern to match against the header.

Definition at line 134 of file kmsearchpattern.h.

Referenced by KMSearchRuleNumerical::isEmpty(), KMSearchRuleString::isEmpty(), KMSearchRuleNumerical::matches(), KMSearchRuleNumerical::matchesInternal(), and KMSearchRuleString::matchesInternal().

void KMSearchRule::setContents const QString aContents  )  [inline]
 

Set the value.

Definition at line 136 of file kmsearchpattern.h.

References setContents().

Referenced by setContents().

const QString KMSearchRule::asString  )  const
 

Returns the rule as string.

For debugging.

Definition at line 155 of file kmsearchpattern.cpp.

Referenced by KMSearchRuleNumerical::matches(), and KMSearchRuleString::matches().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 21 19:46:52 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003