kmail

KMFilterMgr Class Reference

List of all members.

Detailed Description

Definition at line 34 of file kmfiltermgr.h.


Public Types

enum  FilterSet {
  NoSet = 0x0, Inbound = 0x1, Outbound = 0x2, Explicit = 0x4,
  All = Inbound|Outbound|Explicit
}

Public Slots

void slotFolderRemoved (KMFolder *aFolder)

Signals

void filterListUpdated ()

Public Member Functions

 KMFilterMgr (bool popFilter=false)
virtual ~KMFilterMgr ()
void clear ()
void readConfig (void)
void writeConfig (bool withSync=TRUE)
void openDialog (QWidget *parent, bool checkForEmptyFilterList=true)
void createFilter (const QCString &field, const QString &value)
bool beginFiltering (KMMsgBase *msgBase) const
int moveMessage (KMMessage *msg) const
void endFiltering (KMMsgBase *msgBase) const
bool atLeastOneFilterAppliesTo (unsigned int accountID) const
bool atLeastOneIncomingFilterAppliesTo (unsigned int accountID) const
bool atLeastOneOnlineImapFolderTarget ()
const QString createUniqueName (const QString &name)
void appendFilters (const QValueList< KMFilter * > &filters, bool replaceIfNameExists=false)
void setFilters (const QValueList< KMFilter * > &filters)
const QValueList< KMFilter * > & filters () const
int process (KMMessage *msg, FilterSet aSet=Inbound, bool account=false, uint accountId=0)
int process (KMMessage *msg, const KMFilter *filter)
int process (Q_UINT32 serNum, const KMFilter *filter)
void cleanup ()
void ref ()
void deref (bool force=false)
int tempOpenFolder (KMFolder *aFolder)
void beginUpdate ()
void endUpdate ()
void dump () const
bool folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder)
void folderCreated (KMFolder *)
void setShowLaterMsgs (bool show)
bool showLaterMsgs () const

Member Function Documentation

void KMFilterMgr::clear (  ) 

Clears the list of filters and deletes them.

Definition at line 58 of file kmfiltermgr.cpp.

void KMFilterMgr::readConfig ( void   ) 

Reload filter rules from config file.

Definition at line 68 of file kmfiltermgr.cpp.

void KMFilterMgr::writeConfig ( bool  withSync = TRUE  ) 

Store filter rules in config file.

Definition at line 103 of file kmfiltermgr.cpp.

void KMFilterMgr::openDialog ( QWidget *  parent,
bool  checkForEmptyFilterList = true 
)

Open an edit dialog.

If checkForEmptyFilterList is true, an empty filter is created to improve the visibility of the dialog in case no filter has been defined so far.

Definition at line 445 of file kmfiltermgr.cpp.

void KMFilterMgr::createFilter ( const QCString &  field,
const QString &  value 
)

Open an edit dialog, create a new filter and preset the first rule with "field equals value".

Definition at line 461 of file kmfiltermgr.cpp.

bool KMFilterMgr::atLeastOneFilterAppliesTo ( unsigned int  accountID  )  const

Returns whether at least one filter applies to this account, which means that mail must be downloaded in order to be filtered, for example;.

Definition at line 360 of file kmfiltermgr.cpp.

bool KMFilterMgr::atLeastOneIncomingFilterAppliesTo ( unsigned int  accountID  )  const

Returns whether at least one incoming filter applies to this account, which means that mail must be downloaded in order to be filtered, for example;.

Definition at line 371 of file kmfiltermgr.cpp.

bool KMFilterMgr::atLeastOneOnlineImapFolderTarget (  ) 

Returns whether at least one filter targets a folder on an online IMAP account.

Definition at line 382 of file kmfiltermgr.cpp.

const QString KMFilterMgr::createUniqueName ( const QString &  name  ) 

Check for existing filters with the &p name and extend the "name" to "name (i)" until no match is found for i=1.

.n

Definition at line 469 of file kmfiltermgr.cpp.

void KMFilterMgr::appendFilters ( const QValueList< KMFilter * > &  filters,
bool  replaceIfNameExists = false 
)

Append the list of filters to the current list of filters and write everything back into the configuration.

The filter manager takes ownership of the filters in the list.

Definition at line 494 of file kmfiltermgr.cpp.

void KMFilterMgr::setFilters ( const QValueList< KMFilter * > &  filters  ) 

Replace the list of filters under control of the filter manager.

The manager takes ownershipt of the filters.

Definition at line 516 of file kmfiltermgr.cpp.

const QValueList<KMFilter*>& KMFilterMgr::filters (  )  const [inline]

Returns:
the list of filters managed by this object

Definition at line 99 of file kmfiltermgr.h.

int KMFilterMgr::process ( KMMessage msg,
FilterSet  aSet = Inbound,
bool  account = false,
uint  accountId = 0 
)

Process given message by applying the filter rules one by one.

You can select which set of filters (incoming or outgoing) should be used.

Parameters:
msg The message to process.
aSet Select the filter set to use.
account true if an account id is specified else false
accountId The id of the KMAccount that the message was retrieved from
Returns:
2 if a critical error occurred (eg out of disk space) 1 if the caller is still owner of the message and 0 otherwise. If the caller does not any longer own the message he *must* not delete the message or do similar stupid things. ;-)

Definition at line 281 of file kmfiltermgr.cpp.

int KMFilterMgr::process ( KMMessage msg,
const KMFilter filter 
)

For ad-hoc filters.

Applies filter to msg. Return codes are as with the above method.

Deprecated:
Use int process( quint32, const KMFilter * )

Definition at line 190 of file kmfiltermgr.cpp.

int KMFilterMgr::process ( Q_UINT32  serNum,
const KMFilter filter 
)

For ad-hoc filters.

Applies filter to message with serNum . Return codes are as with the above method.

Definition at line 224 of file kmfiltermgr.cpp.

void KMFilterMgr::ref (  ) 

Increment the reference count for the filter manager.

Call this method before processing messages with process()

Definition at line 410 of file kmfiltermgr.cpp.

void KMFilterMgr::deref ( bool  force = false  ) 

Decrement the reference count for the filter manager.

Call this method after processing messages with process(). Shall be called after all messages are processed. If the reference count is zero then this method closes all folders that have been temporarily opened with tempOpenFolder().

Definition at line 416 of file kmfiltermgr.cpp.

int KMFilterMgr::tempOpenFolder ( KMFolder aFolder  ) 

Open given folder and mark it as temporarily open.

The folder will be closed upon next call of cleanip(). This method is usually only called from within filter actions during process(). Returns returncode from KMFolder::open() call.

Definition at line 432 of file kmfiltermgr.cpp.

void KMFilterMgr::beginUpdate (  )  [inline]

Called at the beginning of an filter list update.

Currently a no-op

Definition at line 147 of file kmfiltermgr.h.

void KMFilterMgr::endUpdate (  ) 

Called at the end of an filter list update.

Definition at line 554 of file kmfiltermgr.cpp.

void KMFilterMgr::dump (  )  const

Output all rules to stdout.

Definition at line 543 of file kmfiltermgr.cpp.

bool KMFilterMgr::folderRemoved ( KMFolder aFolder,
KMFolder aNewFolder 
)

Called from the folder manager when a folder is removed.

Tests if the folder aFolder is used in any action. Changes to aNewFolder folder in this case. Returns TRUE if a change occurred.

Definition at line 528 of file kmfiltermgr.cpp.

void KMFilterMgr::folderCreated ( KMFolder  )  [inline]

Called from the folder manager when a new folder has been created.

Forwards this to the filter dialog if that is open.

Definition at line 165 of file kmfiltermgr.h.

void KMFilterMgr::setShowLaterMsgs ( bool  show  )  [inline]

Set the global option 'Show Download Later Messages'.

Definition at line 168 of file kmfiltermgr.h.

bool KMFilterMgr::showLaterMsgs (  )  const [inline]

Get the global option 'Show Download Later Messages'.

Definition at line 173 of file kmfiltermgr.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys