Akonadi::Search::PIM::EmailQuery Class Reference

#include <emailquery.h>

Inheritance diagram for Akonadi::Search::PIM::EmailQuery:

Public Types
enum	OpType : uint8_t { OpAnd = 0 , OpOr }

Public Member Functions
void	addBcc (const QString &bcc)
void	addCc (const QString &cc)
void	addCollection (Akonadi::Collection::Id id)
void	addFrom (const QString &from)
void	addInvolves (const QString &email)
void	addTo (const QString &to)
void	bodyMatches (const QString &bodyMatch)
ResultIterator	exec () override
int	limit () const
void	matches (const QString &match)
void	setAttachment (bool hasAttachment=true)
void	setBcc (const QStringList &bcc)
void	setCc (const QStringList &cc)
void	setCollection (const QList< Akonadi::Collection::Id > &collections)
void	setFrom (const QString &from)
void	setImportant (bool important=true)
void	setInvolves (const QStringList &involves)
void	setLimit (int limit)
void	setRead (bool read=true)
void	setSearchType (OpType op)
void	setSplitSearchMatchString (bool split)
void	setTo (const QStringList &to)
void	subjectMatches (const QString &subjectMatch)
Public Member Functions inherited from Akonadi::Search::PIM::Query

Additional Inherited Members
Static Public Member Functions inherited from Akonadi::Search::PIM::Query
static QString	defaultLocation (const QString &dbName)
static Query *	fromJSON (const QByteArray &json)

Detailed Description

Email query.

Definition at line 28 of file emailquery.h.

Member Enumeration Documentation

OpType

enum Akonadi::Search::PIM::EmailQuery::OpType : uint8_t

Definition at line 34 of file emailquery.h.

Constructor & Destructor Documentation

EmailQuery()

EmailQuery::EmailQuery

(

)

Definition at line 55 of file emailquery.cpp.

Member Function Documentation

addBcc()

void EmailQuery::addBcc

(

const QString &

bcc

)

Definition at line 83 of file emailquery.cpp.

addCc()

void EmailQuery::addCc

(

const QString &

cc

)

Definition at line 113 of file emailquery.cpp.

addCollection()

void EmailQuery::addCollection

(

Akonadi::Collection::Id

id

)

Definition at line 123 of file emailquery.cpp.

addFrom()

void EmailQuery::addFrom

(

const QString &

from

)

Definition at line 118 of file emailquery.cpp.

addInvolves()

void EmailQuery::addInvolves

(

const QString &

email

)

Definition at line 73 of file emailquery.cpp.

addTo()

void EmailQuery::addTo

(

const QString &

to

)

Definition at line 103 of file emailquery.cpp.

bodyMatches()

void EmailQuery::bodyMatches

(

const QString &

bodyMatch

)

Matches the string bodyMatch specifically in the body email.

Definition at line 153 of file emailquery.cpp.

exec()

ResultIterator EmailQuery::exec ( )

nodiscardoverridevirtual

Execute the query and return an iterator to fetch the results.

Implements Akonadi::Search::PIM::Query.

Definition at line 173 of file emailquery.cpp.

limit()

int EmailQuery::limit ( ) const

nodiscard

Definition at line 133 of file emailquery.cpp.

matches()

void EmailQuery::matches

(

const QString &

match

)

Matches the string match anywhere in the entire email body.

Definition at line 143 of file emailquery.cpp.

setAttachment()

void EmailQuery::setAttachment

(

bool

hasAttachment = true

)

By default the attachment status is ignored.

Definition at line 158 of file emailquery.cpp.

setBcc()

void EmailQuery::setBcc

(

const QStringList &

bcc

)

Definition at line 88 of file emailquery.cpp.

setCc()

void EmailQuery::setCc

(

const QStringList &

cc

)

Definition at line 93 of file emailquery.cpp.

setCollection()

void EmailQuery::setCollection

(

const QList< Akonadi::Collection::Id > &

collections

)

Definition at line 128 of file emailquery.cpp.

setFrom()

void EmailQuery::setFrom

(

const QString &

from

)

Definition at line 98 of file emailquery.cpp.

setImportant()

void EmailQuery::setImportant

(

bool

important = true

)

By default the importance is ignored.

Definition at line 163 of file emailquery.cpp.

setInvolves()

void EmailQuery::setInvolves

(

const QStringList &

involves

)

Definition at line 78 of file emailquery.cpp.

setLimit()

void EmailQuery::setLimit

(

int

limit

)

Definition at line 138 of file emailquery.cpp.

setRead()

void EmailQuery::setRead

(

bool

read = true

)

By default the read status is ignored.

Definition at line 168 of file emailquery.cpp.

setSearchType()

void EmailQuery::setSearchType

(

EmailQuery::OpType

op

)

Definition at line 68 of file emailquery.cpp.

setSplitSearchMatchString()

void EmailQuery::setSplitSearchMatchString

(

bool

split

)

Definition at line 63 of file emailquery.cpp.

setTo()

void EmailQuery::setTo

(

const QStringList &

to

)

Definition at line 108 of file emailquery.cpp.

subjectMatches()

void EmailQuery::subjectMatches

(

const QString &

subjectMatch

)

Matches the string subjectMatch specifically in the email subject.

Definition at line 148 of file emailquery.cpp.

---

The documentation for this class was generated from the following files:

• emailquery.h
• emailquery.cpp