* If 2, forces addition of preview info.
* DEFAULT: No preview information.
* 'structure' - (boolean) Get structure information from server.
- * Contained in the 'strucutre' entry.
+ * Contained in the 'structure' entry.
* DEFAULT: false
* </pre>
*
* @return array An array with the following keys:
* <pre>
- * 'overview' - (array) The overview information. Contains the following:
- * 'envelope' - (array) Envelope information returned from
- * the IMAP server. See
- * Horde_Imap_Client::fetch() for format.
- * 'flags' - (array) The list of IMAP flags returned from
- * the server. See Horde_Imap_Client::fetch() for
- * the format.
- * 'headers' - (array) Any headers requested in
- * $options['headers']. Horde_Mime_Headers objects
- * are returned. See Horde_Imap_Client::fetch()
- * for the format.
- * 'mailbox' - (string) The mailbox containing the message.
- * 'preview' - (string) If requested in $options['preview'],
- * the preview text.
- * 'previewcut'- (boolean) Has the preview text been cut?
- * 'size' - (integer) The size of the message in bytes.
- * 'structure'- (array) The structure of the message. Only
- * set if $options['structure'] is true. See
- * Horde_Imap_Client::fetch() for format.
- * 'uid' - (string) The unique ID of the message.
- *
- * 'uids' - (IMP_Indices) An indices object.
+ * overview - (array) The overview information. Contains the following:
+ * envelope - (array) Envelope information returned from the IMAP
+ * server. See Horde_Imap_Client::fetch() for format.
+ * flags - (array) The list of IMAP flags returned from the server.
+ * See Horde_Imap_Client::fetch() for the format.
+ * headers - (array) Any headers requested in $options['headers'].
+ * Horde_Mime_Headers objects are returned. See
+ * Horde_Imap_Client::fetch() for the format.
+ * mailbox - (string) The mailbox containing the message.
+ * preview - (string) If requested in $options['preview'], the preview
+ * text.
+ * previewcut - (boolean) Has the preview text been cut?
+ * size - (integer) The size of the message in bytes.
+ * structure - (array) The structure of the message. Only set if
+ * $options['structure'] is true. See
+ * Horde_Imap_Client::fetch() for format.
+ * uid - (string) The unique ID of the message.
+ * uids - (IMP_Indices) An indices object.
* </pre>
*/
public function getMailboxArray($msgnum, $options = array())
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
class IMP_Search_Element_Or extends IMP_Search_Element
{
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
- *
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
}
/**
- * Adds the current query item to the query object.
- *
- * @param Horde_Imap_Client_Search_Query The query object.
- *
- * @return Horde_Imap_Client_Search_Query The query object.
*/
public function createQuery($queryob)
{
}
/**
- * Return search query text representation.
- *
- * @return array The textual description of this search element.
*/
public function queryText()
{
class IMP_Search_Filter extends IMP_Search_Query
{
/**
- * Get object properties.
- *
- * @see __get()
*/
public function __get($name)
{
abstract class IMP_Search_Filter_Builtin extends IMP_Search_Filter
{
/**
- * Can this query be edited?
- *
- * @var boolean
*/
protected $_canEdit = false;
/**
- * List of serialize entries not to save.
- *
- * @var array
*/
protected $_nosave = array('c', 'i', 'l');
}
/**
- * Initialization tasks.
*/
abstract protected function _init();
/**
- * Unserialization.
- *
- * @param string $data Serialized data.
- *
- * @throws Exception
*/
public function unserialize($data)
{
class IMP_Search_Filter_Bulk extends IMP_Search_Filter_Builtin
{
/**
- * Initialization tasks.
*/
protected function _init()
{
class IMP_Search_Filter_Mailinglist extends IMP_Search_Filter_Builtin
{
/**
- * Initialization tasks.
*/
protected function _init()
{
class IMP_Search_Filter_Personal extends IMP_Search_Filter_Builtin
{
/**
- * Initialization tasks.
*/
protected function _init()
{
*
* @param string $name Available properties:
* <pre>
- * 'canEdit' - (boolean)
- * 'id' - (string)
- * 'label' - (string)
- * 'mboxes' - (array)
- * 'mid' - (string)
- * 'query' - (Horde_Imap_Client_Search_Query)
- * 'querytext' - (string)
+ * 'canEdit' - (boolean) Can this query be edited?
+ * 'id' - (string) The query ID.
+ * 'label' - (string) The query label.
+ * 'mboxes' - (array) The list of mailboxes to query.
+ * 'mid' - (string) The query ID with the search mailbox prefix.
+ * 'query' - (Horde_Imap_Client_Search_Query) The IMAP query object.
+ * 'querytext' - (string) The textual representation of the query.
* </pre>
*
* @return mixed Property value.
projects / horde.git / commitdiff