KIMAP::Term

Search for usage in LXR

KIMAP::Term Class Reference

#include <searchjob.h>

Public Types

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

Public Member Functions

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

Detailed Description

A query term.

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

Since
4.13

Definition at line 31 of file searchjob.h.

Member Enumeration Documentation

◆ BooleanSearchKey

enum KIMAP::Term::BooleanSearchKey

Definition at line 38 of file searchjob.h.

◆ DateSearchKey

enum KIMAP::Term::DateSearchKey

Definition at line 40 of file searchjob.h.

◆ NumberSearchKey

enum KIMAP::Term::NumberSearchKey

Definition at line 41 of file searchjob.h.

◆ Relation

enum KIMAP::Term::Relation

Definition at line 34 of file searchjob.h.

◆ SearchKey

enum KIMAP::Term::SearchKey

Definition at line 36 of file searchjob.h.

◆ SequenceSearchKey

enum KIMAP::Term::SequenceSearchKey

Definition at line 42 of file searchjob.h.

Constructor & Destructor Documentation

◆ Term() [1/9]

KIMAP::Term::Term ( )

Definition at line 55 of file searchjob.cpp.

◆ ~Term()

KIMAP::Term::~Term ( )

Definition at line 237 of file searchjob.cpp.

◆ Term() [2/9]

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

Definition at line 61 of file searchjob.cpp.

◆ Term() [3/9]

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

Definition at line 90 of file searchjob.cpp.

◆ Term() [4/9]

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

Definition at line 135 of file searchjob.cpp.

◆ Term() [5/9]

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

Definition at line 172 of file searchjob.cpp.

◆ Term() [6/9]

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

Definition at line 202 of file searchjob.cpp.

◆ Term() [7/9]

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

Definition at line 216 of file searchjob.cpp.

◆ Term() [8/9]

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

Definition at line 127 of file searchjob.cpp.

◆ Term() [9/9]

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

Definition at line 231 of file searchjob.cpp.

Member Function Documentation

◆ isNull()

bool KIMAP::Term::isNull ( ) const
nodiscard

Definition at line 276 of file searchjob.cpp.

◆ operator=()

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

Definition at line 241 of file searchjob.cpp.

◆ operator==()

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

Definition at line 247 of file searchjob.cpp.

◆ serialize()

QByteArray KIMAP::Term::serialize ( ) const
nodiscard

Definition at line 252 of file searchjob.cpp.

◆ setFuzzy()

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

Definition at line 264 of file searchjob.cpp.

◆ setNegated()

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

Definition at line 270 of file searchjob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 12 2024 11:52:06 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.