KIMAP::Term Class

A query term. More...

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

Public Types

enum BooleanSearchKey { New, Old, Recent, Seen, Draft, …, Answered }
enum DateSearchKey { Before, On, Since, SentBefore, SentOn, SentSince }
enum NumberSearchKey { Larger, Smaller }
enum Relation { And, Or }
enum SearchKey { All, Bcc, Body, Cc, From, …, Keyword }
enum SequenceSearchKey { Uid, SequenceNumber }

Public Functions

Term()
Term(KIMAP::Term::BooleanSearchKey key)
Term(KIMAP::Term::DateSearchKey key, const QDate &date)
Term(KIMAP::Term::NumberSearchKey key, int value)
Term(KIMAP::Term::Relation relation, const QList<KIMAP::Term> &subterms)
Term(KIMAP::Term::SearchKey key, const QString &value)
Term(KIMAP::Term::SequenceSearchKey key, const KIMAP::ImapSet &)
Term(const QString &header, const QString &value)
Term(const KIMAP::Term &other)
~Term()
bool isNull() const
QByteArray serialize() const
KIMAP::Term &setFuzzy(bool fuzzy)
KIMAP::Term &setNegated(bool negated)
KIMAP::Term &operator=(const KIMAP::Term &other)
bool operator==(const KIMAP::Term &other) const

Detailed Description

Refer to the IMAP RFC for the meaning of the individual terms.

Member Type Documentation

enum Term::BooleanSearchKey

ConstantValue
KIMAP::Term::New0
KIMAP::Term::Old1
KIMAP::Term::Recent2
KIMAP::Term::Seen3
KIMAP::Term::Draft4
KIMAP::Term::Deleted5
KIMAP::Term::Flagged6
KIMAP::Term::Answered7

enum Term::DateSearchKey

ConstantValue
KIMAP::Term::Before0
KIMAP::Term::On1
KIMAP::Term::Since2
KIMAP::Term::SentBefore3
KIMAP::Term::SentOn4
KIMAP::Term::SentSince5

enum Term::NumberSearchKey

ConstantValue
KIMAP::Term::Larger0
KIMAP::Term::Smaller1

enum Term::Relation

ConstantValue
KIMAP::Term::And0
KIMAP::Term::Or1

enum Term::SearchKey

ConstantValue
KIMAP::Term::All0
KIMAP::Term::Bcc1
KIMAP::Term::Body2
KIMAP::Term::Cc3
KIMAP::Term::From4
KIMAP::Term::Subject5
KIMAP::Term::Text6
KIMAP::Term::To7
KIMAP::Term::Keyword8

enum Term::SequenceSearchKey

ConstantValue
KIMAP::Term::Uid0
KIMAP::Term::SequenceNumber1

Member Function Documentation

Term::Term()

Term::Term(KIMAP::Term::BooleanSearchKey key)

Term::Term(KIMAP::Term::DateSearchKey key, const QDate &date)

Term::Term(KIMAP::Term::NumberSearchKey key, int value)

Term::Term(KIMAP::Term::Relation relation, const QList<KIMAP::Term> &subterms)

Term::Term(KIMAP::Term::SearchKey key, const QString &value)

Term::Term(KIMAP::Term::SequenceSearchKey key, const KIMAP::ImapSet &)

Term::Term(const QString &header, const QString &value)

Term::Term(const KIMAP::Term &other)

[noexcept] Term::~Term()

bool Term::isNull() const

QByteArray Term::serialize() const

KIMAP::Term &Term::setFuzzy(bool fuzzy)

KIMAP::Term &Term::setNegated(bool negated)

KIMAP::Term &Term::operator=(const KIMAP::Term &other)

bool Term::operator==(const KIMAP::Term &other) const