KIMAP::SearchJob Class

Search Job. More...

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

Public Functions

SearchJob(KIMAP::Session *session)
QByteArray charset() const
QList<qint64> expunged() const
bool isUidBased() const
QList<qint64> results() const
void setCharset(const QByteArray &charSet)
void setTerm(const KIMAP::Term &term)
void setUidBased(bool uidBased)

Detailed Description

Member Function Documentation

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

QByteArray SearchJob::charset() const

See also setCharset().

QList<qint64> SearchJob::expunged() const

Get the sequence numbers of messages that have been expunged from the mailbox since the search was started.

bool SearchJob::isUidBased() const

QList<qint64> SearchJob::results() const

Get the search result, as a list of sequence numbers or UIDs, based on the isUidBased status

Returns the found items

void SearchJob::setCharset(const QByteArray &charSet)

Sets the charset to be used to charSet. Note that RFCs 9051 and 9755 both restrict charset support to UTF8, which effectively deprecates setCharset() since the argument is then ignored.

See also charset().

void SearchJob::setTerm(const KIMAP::Term &term)

Sets the search term.

term The search term.

void SearchJob::setUidBased(bool uidBased)

See also isUidBased().