Methods summary
public
|
|
public
|
#
init( )
Initialize session search data.
Initialize session search data.
|
public
IMP_Search_Query
|
#
createQuery( array $criteria, array $opts = array() )
Creates the IMAP search query.
Creates the IMAP search query.
Parameters
- $criteria
- The search criteria array.
- $opts
- <p>Additional options:
- id: (string) Use as the mailbox ID.
- label: (string) The label to use for the search results.
- mboxes: (array) The list of mailboxes to directly search. If this
contains the IMP_Search_Query::ALLSEARCH constant, all
mailboxes will be searched.
- subfolders: (array) The list of mailboxes to do subfolder searches
on.
- type: (integer) Query type.</p>
Returns
Throws
InvalidArgumentException
|
public
|
#
setFilters( array $filters )
Saves the list of filters for the current user.
Saves the list of filters for the current user.
Parameters
- $filters
- The filter list.
|
public
|
#
isFilter( string $id, boolean $editable = false )
Is a mailbox a filter query?
Is a mailbox a filter query?
Parameters
- $id
- The mailbox ID.
- $editable
- <p>Is this an editable (i.e. not built-in)
filter query?</p>
|
public
IMP_Search_Query
|
#
applyFilter( string $id, array $mboxes, string $mid = null )
Converts a filter to a search query and stores it in the local
session.
Converts a filter to a search query and stores it in the local
session.
Parameters
- $id
- The mailbox ID of the filter.
- $mboxes
- The list of mailboxes to apply the filter on.
- $mid
- Use as the mailbox ID.
Returns
Throws
InvalidArgumentException
|
public
|
#
setVFolders( array $vfolders )
Saves the list of virtual folders for the current user.
Saves the list of virtual folders for the current user.
Parameters
- $vfolders
- The virtual folder list.
|
public
boolean
|
#
isVFolder( string $id, boolean $editable = false )
Is a mailbox a virtual folder?
Is a mailbox a virtual folder?
Parameters
- $id
- The mailbox ID.
- $editable
- <p>Is this an editable (i.e. not built-in)
virtual folder?</p>
Returns
boolean
Whether the mailbox ID is a virtual folder.
|
public
boolean
|
#
isVTrash( string $id )
Determines whether a mailbox ID is the Virtual Trash Folder.
Determines whether a mailbox ID is the Virtual Trash Folder.
Parameters
Returns
boolean
True if the ID is the Virtual Trash folder.
|
public
boolean
|
#
isVinbox( string $id )
Determines whether a mailbox ID is the Virtual INBOX Folder.
Determines whether a mailbox ID is the Virtual INBOX Folder.
Parameters
Returns
boolean
True if the ID is the Virtual INBOX folder.
|
public
boolean
|
#
isQuery( string $id, boolean $editable = false )
Is a mailbox a search query?
Is a mailbox a search query?
Parameters
- $id
- The mailbox ID.
- $editable
- <p>Is this an editable (i.e. not built-in)
search query?</p>
Returns
boolean
True if a search query.
|
public
boolean
|
#
isSystemQuery( string $id )
Is a mailbox a system (built-in) search query?
Is a mailbox a system (built-in) search query?
Parameters
Returns
boolean
True if a system search query.
|
public
Horde_Url
|
#
editUrl( string $id )
Returns a link to edit a given search query.
Returns a link to edit a given search query.
Parameters
Returns
Horde_Url
The URL to the search page.
|
public
boolean
|
#
isSearchMbox( string $id )
Is the given mailbox a search mailbox?
Is the given mailbox a search mailbox?
Parameters
Returns
boolean
Whether the given mailbox name is a search mailbox.
|
public
string
|
#
createSearchId( string $id )
Create the canonical search ID for a given search query.
Create the canonical search ID for a given search query.
Parameters
- $id
- The mailbox query ID.
Returns
string
The canonical search query ID.
|
public
|
#
offsetExists( mixed $offset )
Implementation of
ArrayAccess::offsetExists()
|
public
|
#
offsetGet( mixed $offset )
Implementation of
ArrayAccess::offsetGet()
|
public
|
#
offsetSet( string $offset, IMP_Search_Query $value )
Alter the current IMAP search query.
Alter the current IMAP search query.
Parameters
- $offset
- The search query id.
- $value
- The query object.
Throws
InvalidArgumentException
Implementation of
ArrayAccess::offsetSet()
|
public
|
#
offsetUnset( string $offset )
Deletes an IMAP search query.
Deletes an IMAP search query.
Parameters
- $offset
- The search query id.
Implementation of
ArrayAccess::offsetUnset()
|
public
|
#
getIterator( )
Implementation of
IteratorAggregate::getIterator()
|
public
string
|
#
serialize( )
Serialize.
Returns
string
Serialized representation of this object.
Implementation of
Serializable::serialize()
|
public
|
#
unserialize( string $data )
Unserialize.
Parameters
Throws
Exception
Implementation of
Serializable::unserialize()
|