KSieveCore::FindAccountInfoJob Class

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

Header: #include <KSieveCore/FindAccountInfoJob>
CMake: find_package(KPim6KSieveCore REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::KSieveCore)
Inherits: QObject

Public Functions

FindAccountInfoJob(QObject *parent = nullptr)
virtual ~FindAccountInfoJob() override
bool canStart() const
QString identifier() const
KSieveCore::SieveImapPasswordProvider *provider() const
void setCustomImapSettingsInterface(KSieveCore::AbstractAkonadiImapSettingInterface *newCustomImapSettingsInterface)
void setIdentifier(const QString &newIdentifier)
void setProvider(KSieveCore::SieveImapPasswordProvider *newProvider)
void setWithVacationFileName(bool newWithVacationFileName)
void start()
bool withVacationFileName() const

Signals

void findAccountInfoFinished(const KSieveCore::Util::AccountInfo &info)

Detailed Description

Member Function Documentation

[explicit] FindAccountInfoJob::FindAccountInfoJob(QObject *parent = nullptr)

Constructs a FindAccountInfoJob with the given parent object. parent The parent object.

[override virtual noexcept] FindAccountInfoJob::~FindAccountInfoJob()

Destroys the FindAccountInfoJob.

bool FindAccountInfoJob::canStart() const

Checks if the job can be started. Returns true if all required information is set.

[signal] void FindAccountInfoJob::findAccountInfoFinished(const KSieveCore::Util::AccountInfo &info)

Emitted when account information has been found. info The account information.

QString FindAccountInfoJob::identifier() const

Returns the account identifier. Returns The account identifier.

See also setIdentifier().

KSieveCore::SieveImapPasswordProvider *FindAccountInfoJob::provider() const

Returns the password provider used by this job. Returns The SieveImapPasswordProvider instance.

See also setProvider().

void FindAccountInfoJob::setCustomImapSettingsInterface(KSieveCore::AbstractAkonadiImapSettingInterface *newCustomImapSettingsInterface)

Sets a custom IMAP settings interface. newCustomImapSettingsInterface The custom interface.

void FindAccountInfoJob::setIdentifier(const QString &newIdentifier)

Sets the account identifier to look up. newIdentifier The identifier to set.

See also identifier().

void FindAccountInfoJob::setProvider(KSieveCore::SieveImapPasswordProvider *newProvider)

Sets the password provider for this job. newProvider The new password provider instance.

See also provider().

void FindAccountInfoJob::setWithVacationFileName(bool newWithVacationFileName)

Sets whether to include vacation filename information. newWithVacationFileName true to include vacation filename.

See also withVacationFileName().

void FindAccountInfoJob::start()

Starts the job to find account information.

bool FindAccountInfoJob::withVacationFileName() const

Checks if the vacation filename should be included. Returns true if vacation filename information should be retrieved.

See also setWithVacationFileName().