KIMAP::SelectJob Class

Select Job. More...

Header: #include <KIMAP/SelectJob>
CMake: find_package(KPim6IMAP REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::IMAP)
Inherits: KIMAP::Job

Public Functions

SelectJob(KIMAP::Session *session)
virtual ~SelectJob() override
bool condstoreEnabled() const
qint64 firstUnseenIndex() const
QList<QByteArray> flags() const
quint64 highestModSequence() const
bool isOpenReadOnly() const
QString mailBox() const
int messageCount() const
qint64 nextUid() const
QList<QByteArray> permanentFlags() const
int recentCount() const
void setCondstoreEnabled(bool enable)
void setMailBox(const QString &mailBox)
void setOpenReadOnly(bool readOnly)
void setQResync(qint64 lastUidvalidity, quint64 lastModseq, const KIMAP::ImapSet &knownUids = ImapSet{})
qint64 uidValidity() const

Signals

void modified(const QMap<qint64, KIMAP::Message> &messages)
void vanished(const KIMAP::ImapSet &set)

Detailed Description

Member Function Documentation

[explicit] SelectJob::SelectJob(KIMAP::Session *session)

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

bool SelectJob::condstoreEnabled() const

Returns whether the CONDSTORE parameter will be appended to SELECT command

See also setCondstoreEnabled().

qint64 SelectJob::firstUnseenIndex() const

QList<QByteArray> SelectJob::flags() const

quint64 SelectJob::highestModSequence() const

Returns Highest mod-sequence value of all messages in the mailbox or 0 if the server does not have CONDSTORE capability (RFC4551) or does not support persistent storage of mod-sequences.

bool SelectJob::isOpenReadOnly() const

Returns whether the mailbox is opened in read-only mode. Note that this can return true even if setOpenReadOnly() was set to false, as the mailbox may be read-only on the server.

QString SelectJob::mailBox() const

See also setMailBox().

int SelectJob::messageCount() const

[signal] void SelectJob::modified(const QMap<qint64, KIMAP::Message> &messages)

Emitted when the server provides a list of messages that have changed or appeared in the mailbox since the last sync.

This feature requires that the QRESYNC parameters have been provided to the SELECT command. The signal may not be emitted if no messages have been modified or appended to the mailbox.

See also setQResync().

qint64 SelectJob::nextUid() const

QList<QByteArray> SelectJob::permanentFlags() const

int SelectJob::recentCount() const

void SelectJob::setCondstoreEnabled(bool enable)

Whether to append CONDSTORE parameter to the SELECT command.

This option is false by default and can be enabled only when server has CONDSTORE capability (RFC4551), otherwise the SELECT command will fail.

See also condstoreEnabled().

void SelectJob::setMailBox(const QString &mailBox)

See also mailBox().

void SelectJob::setOpenReadOnly(bool readOnly)

See also isOpenReadOnly().

void SelectJob::setQResync(qint64 lastUidvalidity, quint64 lastModseq, const KIMAP::ImapSet &knownUids = ImapSet{})

Set Quick Resynchronization parameters.

Requires that the server supports the QRESYNC extension as defined in RFC5162 and the QRESYNC extension has been enabled via EnableJob.

Using this option implies enabling CONDSTORE.

lastUidvalidity Last UIDValidity value known to the client

lastModseq Last modification sequence number known to the client

knownUids List of all UIDs known to the client (optional).

See also KIMAP::EnableJob.

qint64 SelectJob::uidValidity() const

[signal] void SelectJob::vanished(const KIMAP::ImapSet &set)

Emitted when the server provides a list of UIDs that have vanished since last sync.

This feature requires that the QRESYNC parameters have been provided to the SELECT command. This signal may not be emitted if no messages have been expunged since the last check.

See also setQResync().