KSieveCore::SieveImapAccountSettings Class

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

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

Public Functions

SieveImapAccountSettings()
KSieveCore::SieveImapAccountSettings::AuthenticationMode authenticationType() const
KSieveCore::SieveImapAccountSettings::EncryptionMode encryptionMode() const
QString identifier() const
bool isValid() const
QString password() const
int port() const
QString serverName() const
void setAuthenticationType(KSieveCore::SieveImapAccountSettings::AuthenticationMode type)
void setEncryptionMode(KSieveCore::SieveImapAccountSettings::EncryptionMode encryptionMode)
void setPassword(const QString &password)
void setPort(int port)
void setServerName(const QString &serverName)
void setUserName(const QString &userName)
QString userName() const
bool operator==(const KSieveCore::SieveImapAccountSettings &other) const

Detailed Description

Member Function Documentation

SieveImapAccountSettings::SieveImapAccountSettings()

Constructs a default SieveImapAccountSettings.

KSieveCore::SieveImapAccountSettings::AuthenticationMode SieveImapAccountSettings::authenticationType() const

Returns the authentication type. Returns The authentication mode.

See also setAuthenticationType().

KSieveCore::SieveImapAccountSettings::EncryptionMode SieveImapAccountSettings::encryptionMode() const

Returns the encryption mode. Returns The encryption mode.

See also setEncryptionMode().

QString SieveImapAccountSettings::identifier() const

Returns the account identifier. Returns The identifier string.

bool SieveImapAccountSettings::isValid() const

Checks if the settings are valid for a connection. Returns true if all required settings are configured.

QString SieveImapAccountSettings::password() const

Returns the password. Returns The password.

See also setPassword().

int SieveImapAccountSettings::port() const

Returns the port number. Returns The server port number.

See also setPort().

QString SieveImapAccountSettings::serverName() const

Returns the server name. Returns The server hostname.

See also setServerName().

void SieveImapAccountSettings::setAuthenticationType(KSieveCore::SieveImapAccountSettings::AuthenticationMode type)

Sets the authentication type/mode. type The authentication mode.

See also authenticationType().

void SieveImapAccountSettings::setEncryptionMode(KSieveCore::SieveImapAccountSettings::EncryptionMode encryptionMode)

Sets the encryption mode. encryptionMode The encryption mode to use.

See also encryptionMode().

void SieveImapAccountSettings::setPassword(const QString &password)

Sets the password for authentication. password The password.

See also password().

void SieveImapAccountSettings::setPort(int port)

Sets the port number. port The server port number.

See also port().

void SieveImapAccountSettings::setServerName(const QString &serverName)

Sets the server name/hostname. serverName The server hostname.

See also serverName().

void SieveImapAccountSettings::setUserName(const QString &userName)

Sets the username for authentication. userName The username.

See also userName().

QString SieveImapAccountSettings::userName() const

Returns the username. Returns The username.

See also setUserName().

[noexcept default] bool SieveImapAccountSettings::operator==(const KSieveCore::SieveImapAccountSettings &other) const

Compares this settings object with another. other The other SieveImapAccountSettings. Returns true if the settings are identical.