MailImporter::FilterImporterBase Class

class MailImporter::FilterImporterBase

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

Header: #include <MailImporter/FilterImporterBase>
CMake: find_package(KPim6MailImporter REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::MailImporter)

Public Functions

FilterImporterBase(MailImporter::FilterInfo *info)
virtual ~FilterImporterBase()
virtual void clear()
virtual void clearCountDuplicate()
virtual int countDuplicates() const
virtual bool importMessage(const KArchiveFile *file, const QString &folderPath, int &nbTotal, int &fileDone)
virtual bool importMessage(const QString &folderName, const QString &msgPath, bool duplicateCheck, const MailImporter::MessageStatus &status)
virtual QString topLevelFolder() const

Protected Variables

MailImporter::FilterInfo *const mInfo

Detailed Description

Member Function Documentation

[explicit] FilterImporterBase::FilterImporterBase(MailImporter::FilterInfo *info)

Constructs a FilterImporterBase. info The FilterInfo object for logging progress

[virtual noexcept] FilterImporterBase::~FilterImporterBase()

Destructor for FilterImporterBase.

[virtual] void FilterImporterBase::clear()

Clears import state.

[virtual] void FilterImporterBase::clearCountDuplicate()

Clears the duplicate message count.

[virtual] int FilterImporterBase::countDuplicates() const

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

[virtual] bool FilterImporterBase::importMessage(const KArchiveFile *file, const QString &folderPath, int &nbTotal, int &fileDone)

Imports a message from an archive file. file The archive file folderPath The destination folder path nbTotal Total number of messages fileDone Number of files processed Returns True if the message was imported successfully

[virtual] bool FilterImporterBase::importMessage(const QString &folderName, const QString &msgPath, bool duplicateCheck, const MailImporter::MessageStatus &status)

Imports a single message from the file system. 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

[virtual] QString FilterImporterBase::topLevelFolder() const

Returns the top-level folder path for imported messages. Returns The top-level folder path

Member Variable Documentation

MailImporter::FilterInfo *const FilterImporterBase::mInfo

This variable holds the FilterInfo object for logging progress.