IMP_Search_Filter_Autogenerated
extends IMP_Search_Filter_Builtin
in package
Filter for automatically generated messages.
Tags
Table of Contents
Constants
Properties
- $all : bool
- $canEdit : bool
- $enabled : bool
- Is this query enabled?
- $formid : string
- $id : string
- $label : string
- $mbox_list : array<string|int, mixed>
- $mbox_ob : IMP_Mailbox
- $mboxes : array<string|int, mixed>
- $mid : string
- $prefDisplay : bool
- Display this filter in the preferences screen?
- $query : array<string|int, mixed>
- $querytext : string
- $subfolder_list : array<string|int, mixed>
- $_cache : array<string|int, mixed>
- Cache results.
- $_canEdit : bool
- Can this query be edited?
- $_criteria : array<string|int, mixed>
- The search criteria (IMP_Search_Element objects).
- $_id : string
- The search ID.
- $_label : string
- The virtual folder label.
- $_mboxes : array<string|int, mixed>
- The mailbox list.
- $_nosave : array<string|int, mixed>
- List of serialize entries not to save.
Methods
- __construct() : mixed
- Constructor.
- __get() : mixed
- __serialize() : array<string|int, mixed>
- __toString() : string
- String representation of this object: the mailbox ID.
- __unserialize() : void
- add() : mixed
- Add a search query element.
- replace() : mixed
- Replace the search query with the given query.
- runElementCallbacks() : array<string|int, mixed>
- Reduce the sorted return ID list by running search element callbacks.
- serialize() : string
- Serialization.
- toQuery() : IMP_Search_Query
- Creates a query object from this filter.
- unserialize() : mixed
- Unserialization.
- _init() : mixed
Constants
ALLSEARCH
public
mixed
ALLSEARCH
= "all\x00"
SUBFOLDER
public
mixed
SUBFOLDER
= "sub\x00"
VERSION
public
mixed
VERSION
= 1
Properties
$all
public
bool
$all
Does this query search all mailboxes?
$canEdit
public
bool
$canEdit
Can this query be edited?
$enabled
Is this query enabled?
public
bool
$enabled
= \true
$formid
public
string
$formid
The mailbox ID to use in forms.
$id
public
string
$id
The query ID.
$label
public
string
$label
The query label.
$mbox_list
public
array<string|int, mixed>
$mbox_list
The list of individual mailboxes to query (no subfolder mailboxes).
$mbox_ob
public
IMP_Mailbox
$mbox_ob
The IMP_Mailbox object for this query.
$mboxes
public
array<string|int, mixed>
$mboxes
The list of mailboxes to query. This list automatically expands subfolder searches.
$mid
public
string
$mid
The query ID with the search mailbox prefix.
$prefDisplay
Display this filter in the preferences screen?
public
bool
$prefDisplay
= \true
$query
public
array<string|int, mixed>
$query
The list of IMAP queries that comprise this search. Keys are mailbox names, values are Horde_Imap_Client_Search_Query objects.
$querytext
public
string
$querytext
The textual representation of the query.
$subfolder_list
public
array<string|int, mixed>
$subfolder_list
The list of mailboxes to do subfolder queries for. The subfolders are not expanded.
$_cache
Cache results.
protected
array<string|int, mixed>
$_cache
= array()
$_canEdit
Can this query be edited?
protected
bool
$_canEdit
= \true
$_criteria
The search criteria (IMP_Search_Element objects).
protected
array<string|int, mixed>
$_criteria
= array()
$_id
The search ID.
protected
string
$_id
$_label
The virtual folder label.
protected
string
$_label
$_mboxes
The mailbox list.
protected
array<string|int, mixed>
$_mboxes
= array()
$_nosave
List of serialize entries not to save.
protected
array<string|int, mixed>
$_nosave
= array()
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $opts = array() ]) : mixed
Parameters
- $opts : array<string|int, mixed> = array()
__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__toString()
String representation of this object: the mailbox ID.
public
__toString() : string
Return values
string —Mailbox ID.
__unserialize()
public
__unserialize(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
add()
Add a search query element.
public
add(IMP_Search_Element $elt) : mixed
Parameters
- $elt : IMP_Search_Element
-
The search element to add.
replace()
Replace the search query with the given query.
public
replace([array<string|int, mixed> $criteria = array() ]) : mixed
Parameters
- $criteria : array<string|int, mixed> = array()
-
A list of criteria to add (Horde_Search_Element objects).
runElementCallbacks()
Reduce the sorted return ID list by running search element callbacks.
public
runElementCallbacks(IMP_Mailbox $mbox, array<string|int, mixed> $ids) : array<string|int, mixed>
.
Parameters
- $mbox : IMP_Mailbox
-
Mailbox.
- $ids : array<string|int, mixed>
-
Sorted ID list.
Return values
array<string|int, mixed> —Sorted ID list.
serialize()
Serialization.
public
serialize() : string
Return values
string —Serialized data.
toQuery()
Creates a query object from this filter.
public
toQuery(array<string|int, mixed> $mboxes[, string $id = null ]) : IMP_Search_Query
Parameters
- $mboxes : array<string|int, mixed>
-
The list of mailboxes to apply the filter to.
- $id : string = null
-
The query ID to use.
Return values
IMP_Search_Query —A query object.
unserialize()
Unserialization.
public
unserialize(string $data) : mixed
Parameters
- $data : string
-
Serialized data.
Tags
_init()
protected
_init() : mixed