rcube_imap_search

Class to control search jobs on multiple IMAP folders.

package

Framework

subpackage

Storage

author

Thomas Bruederli roundcube@gmail.com

Methods

Default constructor

__construct( $options,  $conn) 

Arguments

$options

$conn

Invoke search request to IMAP server

exec(array $folders, string $str, string $charset = null, string $sort_field = null, boolean $threading = null) 

Arguments

$folders

array

List of IMAP folders to search in

$str

string

Search criteria

$charset

string

Search charset

$sort_field

string

Header field to sort by

$threading

boolean

True if threaded listing is active

Get connection to the IMAP server (used for single-thread mode)

get_imap() 

Setter for previous (potentially incomplete) search results

set_results( $res) 

Arguments

$res

Setter for timelimt property

set_timelimit( $seconds) 

Arguments

$seconds

Properties

options

options : 

Type(s)

jobs

jobs : 

Type(s)

timelimit

timelimit : 

Type(s)

results

results : 

Type(s)

conn

conn : 

Type(s)