MailImporter::Filter Class

class MailImporter::Filter

The Filter class. Author: Laurent Montel <montel@kde.org>. More...

Public Functions

Filter(const QString &name, const QString &author, const QString &info = QString())
virtual ~Filter()
QString author() const
void clear()
void clearCountDuplicate()
int countDuplicates() const
MailImporter::FilterImporterBase *filterImporter() const
MailImporter::FilterInfo *filterInfo() const
virtual void import() = 0
QString info() const
QString mailDir() const
QString name() const
void setAuthor(const QString &)
void setFilterImporter(MailImporter::FilterImporterBase *importer)
void setFilterInfo(MailImporter::FilterInfo *info)
void setInfo(const QString &)
void setMailDir(const QString &mailDir)
void setName(const QString &)

Protected Functions

bool importMessage(const QString &folderName, const QString &msgPath, bool duplicateCheck, const MailImporter::MessageStatus &status = MailImporter::MessageStatus())

Static Protected Members

int countDirectory(const QDir &dir, bool searchHiddenDirectory)

Detailed Description

Member Function Documentation

[explicit] Filter::Filter(const QString &name, const QString &author, const QString &info = QString())

Constructs a Filter with name, author, and optional info. name The filter name author The filter author info Optional information about the filter

[virtual noexcept] Filter::~Filter()

Destructor for Filter.

QString Filter::author() const

Returns the author of the filter. Returns The author name

See also setAuthor().

void Filter::clear()

Clears all filter data.

void Filter::clearCountDuplicate()

Clears the duplicate message count.

[static protected] int Filter::countDirectory(const QDir &dir, bool searchHiddenDirectory)

Counts the number of files in a directory. dir The directory to count files in searchHiddenDirectory Whether to search hidden directories Returns The number of files found

int Filter::countDuplicates() const

Returns the count of duplicate messages found. Returns The number of duplicates

MailImporter::FilterImporterBase *Filter::filterImporter() const

Returns the FilterImporterBase object associated with this filter. Returns The FilterImporterBase object

See also setFilterImporter().

MailImporter::FilterInfo *Filter::filterInfo() const

Returns the FilterInfo object associated with this filter. Returns The FilterInfo object

See also setFilterInfo().

[pure virtual] void Filter::import()

Pure virtual method to perform the mail import.

[protected] bool Filter::importMessage(const QString &folderName, const QString &msgPath, bool duplicateCheck, const MailImporter::MessageStatus &status = MailImporter::MessageStatus())

Imports a single message from the specified path. folderName The destination folder name msgPath The path to the message file duplicateCheck Whether to check for duplicate messages status The message status Returns True if the message was imported successfully

QString Filter::info() const

Returns information about the filter. Returns The filter information

See also setInfo().

QString Filter::mailDir() const

Returns the mail directory being imported. Returns The mail directory path

See also setMailDir().

QString Filter::name() const

Returns the name of the filter. Returns The filter name

See also setName().

void Filter::setAuthor(const QString &)

Sets the author of the filter. author The author name

See also author().

void Filter::setFilterImporter(MailImporter::FilterImporterBase *importer)

Sets the FilterImporterBase object used by this filter. importer The FilterImporterBase object

See also filterImporter().

void Filter::setFilterInfo(MailImporter::FilterInfo *info)

Sets the FilterInfo object used by this filter. info The FilterInfo object

See also filterInfo().

void Filter::setInfo(const QString &)

Sets the information about the filter. info The filter information

See also info().

void Filter::setMailDir(const QString &mailDir)

Sets the mail directory to be imported. mailDir The path to the mail directory

See also mailDir().

void Filter::setName(const QString &)

Sets the name of the filter. name The filter name

See also name().