• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • EmailSearchTerm
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Akonadi::EmailSearchTerm Class Reference

#include <searchquery.h>

Inheritance diagram for Akonadi::EmailSearchTerm:
Inheritance graph
[legend]

Public Types

enum  EmailSearchField {
  Unknown, Subject, Body, Message,
  Headers, HeaderFrom, HeaderTo, HeaderCC,
  HeaderBCC, HeaderReplyTo, HeaderOrganization, HeaderListId,
  HeaderResentFrom, HeaderXLoop, HeaderXMailingList, HeaderXSpamFlag,
  HeaderDate, HeaderOnlyDate, MessageStatus, ByteSize,
  Attachment, MessageTag
}
 
- Public Types inherited from Akonadi::SearchTerm
enum  Condition {
  CondEqual, CondGreaterThan, CondGreaterOrEqual, CondLessThan,
  CondLessOrEqual, CondContains
}
 
enum  Relation { RelAnd, RelOr }
 

Public Member Functions

 EmailSearchTerm (EmailSearchField field, const QVariant &value, SearchTerm::Condition condition=SearchTerm::CondEqual)
 
- Public Member Functions inherited from Akonadi::SearchTerm
 SearchTerm (SearchTerm::Relation relation=SearchTerm::RelAnd)
 
 SearchTerm (const QString &key, const QVariant &value, SearchTerm::Condition condition=SearchTerm::CondEqual)
 
 SearchTerm (const SearchTerm &other)
 
void addSubTerm (const SearchTerm &term)
 
SearchTerm::Condition condition () const
 
bool isNegated () const
 
bool isNull () const
 
QString key () const
 
SearchTerm & operator= (const SearchTerm &other)
 
bool operator== (const SearchTerm &other) const
 
SearchTerm::Relation relation () const
 
void setIsNegated (bool negated)
 
QList< SearchTerm > subTerms () const
 
QVariant value () const
 

Static Public Member Functions

static EmailSearchField fromKey (const QString &key)
 
static QString toKey (EmailSearchField)
 

Detailed Description

A search term for an email field.

This class can be used to create queries that akonadi email search backends understand.

Since
4.13

Definition at line 194 of file searchquery.h.

Member Enumeration Documentation

enum Akonadi::EmailSearchTerm::EmailSearchField

All fields expect a search string unless noted otherwise.

Definition at line 201 of file searchquery.h.

Constructor & Destructor Documentation

EmailSearchTerm::EmailSearchTerm ( EmailSearchTerm::EmailSearchField  field,
const QVariant &  value,
SearchTerm::Condition  condition = SearchTerm::CondEqual 
)

Constructs an email end term.

Definition at line 336 of file searchquery.cpp.

Member Function Documentation

EmailSearchTerm::EmailSearchField EmailSearchTerm::fromKey ( const QString &  key)
static

Translates key to field.

Definition at line 347 of file searchquery.cpp.

QString EmailSearchTerm::toKey ( EmailSearchTerm::EmailSearchField  field)
static

Translates field to key.

Definition at line 342 of file searchquery.cpp.


The documentation for this class was generated from the following files:
  • searchquery.h
  • searchquery.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:04 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal