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

#include <emailquery.h>

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

Public Types
enum	OpType { 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)

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 Function Documentation

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 ( )

overridevirtual

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

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

Definition at line 173 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.

setImportant()

void EmailQuery::setImportant

(

bool

important = true

)

By default the importance is ignored.

Definition at line 163 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.

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