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
|
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 441 of file kmfiltermgr.cpp. |
|
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 307 of file kmfiltermgr.cpp. |
|
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 318 of file kmfiltermgr.cpp. |
|
Returns whether at least one filter targets a folder on an online IMAP account.
Definition at line 329 of file kmfiltermgr.cpp. |
|
Called at the beginning of an filter list update. Currently a no-op Definition at line 147 of file kmfiltermgr.h. |
|
Clears the list of filters and deletes them.
Definition at line 60 of file kmfiltermgr.cpp. |
|
Open an edit dialog, create a new filter and preset the first rule with "field equals value".
Definition at line 408 of file kmfiltermgr.cpp. |
|
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 416 of file kmfiltermgr.cpp. |
|
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 363 of file kmfiltermgr.cpp. |
|
Output all rules to stdout.
Definition at line 493 of file kmfiltermgr.cpp. |
|
Called at the end of an filter list update.
Definition at line 504 of file kmfiltermgr.cpp. |
|
Definition at line 99 of file kmfiltermgr.h. |
|
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. |
|
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 478 of file kmfiltermgr.cpp. |
|
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 392 of file kmfiltermgr.cpp. |
|
For ad-hoc filters.
Applies Definition at line 179 of file kmfiltermgr.cpp. |
|
For ad-hoc filters.
Applies
Definition at line 145 of file kmfiltermgr.cpp. |
|
Process given message by applying the filter rules one by one. You can select which set of filters (incoming or outgoing) should be used.
Definition at line 228 of file kmfiltermgr.cpp. |
|
Reload filter rules from config file.
Definition at line 70 of file kmfiltermgr.cpp. |
|
Increment the reference count for the filter manager. Call this method before processing messages with process() Definition at line 357 of file kmfiltermgr.cpp. |
|
Replace the list of filters under control of the filter manager. The manager takes ownershipt of the filters. Definition at line 463 of file kmfiltermgr.cpp. |
|
Set the global option 'Show Download Later Messages'.
Definition at line 168 of file kmfiltermgr.h. |
|
Get the global option 'Show Download Later Messages'.
Definition at line 173 of file kmfiltermgr.h. |
|
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 379 of file kmfiltermgr.cpp. |
|
Store filter rules in config file.
Definition at line 83 of file kmfiltermgr.cpp. |
The documentation for this class was generated from the following files: