Documentation

IMP_Search_Element_Contacts extends IMP_Search_Element
in package

Search query for messages sent from a contact located in a user's addressbook.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2011-2017 Horde LLC

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

Constants

VERSION  = 1

Properties

$not  : bool
Allow NOT search on this element?
$_data  : object
Data for this element.

Methods

__construct()  : mixed
Constructor.
__serialize()  : array<string|int, mixed>
__unserialize()  : void
createQuery()  : Horde_Imap_Client_Search_Query
Adds the current query item to the query object.
getCriteria()  : object
Returns the criteria data for the element.
queryText()  : array<string|int, mixed>
Return search query text representation.
serialize()  : string
Serialization.
unserialize()  : mixed
Unserialization.

Constants

Properties

$not

Allow NOT search on this element?

public bool $not = \true

$_data

Data for this element.

protected object $_data

Methods

__construct()

Constructor.

public __construct([bool $not = false ]) : mixed
Parameters
$not : bool = false

If true, do a 'NOT' search.

__serialize()

public __serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

__unserialize()

public __unserialize(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

createQuery()

Adds the current query item to the query object.

public createQuery(mixed $mbox, mixed $queryob) : Horde_Imap_Client_Search_Query
Parameters
$mbox : mixed

The mailbox to create the query for.

$queryob : mixed

The query object.

Return values
Horde_Imap_Client_Search_Query

The altered query object.

getCriteria()

Returns the criteria data for the element.

public getCriteria() : object
Return values
object

The criteria (see each class for the available properties).

queryText()

Return search query text representation.

public queryText() : array<string|int, mixed>
Return values
array<string|int, mixed>

The textual description of this search element.

serialize()

Serialization.

public serialize() : string
Return values
string

Serialized data.

unserialize()

Unserialization.

public unserialize(string $data) : mixed
Parameters
$data : string

Serialized data.

Tags
throws
Exception

        
On this page

Search results