MailCommon::FilterImporterAbstract Class

class MailCommon::FilterImporterAbstract

The FilterImporterAbstract class. More...

Header: #include <MailCommon/FilterImporterAbstract>
CMake: find_package(KPim6MailCommon REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::MailCommon)
Inherited By:

MailCommon::FilterImporterClawsMails

Public Functions

FilterImporterAbstract(bool interactive = true)
~FilterImporterAbstract()
QStringList emptyFilter() const
QList<MailCommon::MailFilter *> importFilter() const

Protected Functions

void appendFilter(MailCommon::MailFilter *filter)
void createFilterAction(MailCommon::MailFilter *filter, const QString &actionName, const QString &value)
bool loadDomElement(QDomDocument &doc, QFile *file)

Detailed Description

Author: Laurent Montel <montel@kde.org>

Member Function Documentation

[explicit] FilterImporterAbstract::FilterImporterAbstract(bool interactive = true)

Constructs a filter importer. If interactive is true, the user may be asked to fix filter actions that refer to nonexistent entities.

[noexcept] FilterImporterAbstract::~FilterImporterAbstract()

Destroys the filter importer.

[protected] void FilterImporterAbstract::appendFilter(MailCommon::MailFilter *filter)

Purifies filter and appends it to the list of imported filters, or records its name as an empty filter.

[protected] void FilterImporterAbstract::createFilterAction(MailCommon::MailFilter *filter, const QString &actionName, const QString &value)

Creates the filter action named actionName with the arguments value and appends it to filter.

QStringList FilterImporterAbstract::emptyFilter() const

Returns the names of the filters that were empty after import and were discarded.

QList<MailCommon::MailFilter *> FilterImporterAbstract::importFilter() const

Returns the list of imported filters.

[protected] bool FilterImporterAbstract::loadDomElement(QDomDocument &doc, QFile *file)

Loads the content of file into doc. Returns true on success.