API Documentation
\

\Horde_Core_ActiveSync_Imap_Factory

Horde_Core_ActiveSync_Imap_Factory implements a factory/builder for providing a Horde_ActiveSync_Imap_Adapter object as well as building a tree of available mailboxes.

Summary

Methods
Properties
Constants
getImapOb()
getMailboxes()
getSpecialMailboxes()
getMsgFlags()
No public properties found
No constants found
No protected methods found
$_adapter
$_mailboxlist
$_specialMailboxlist
N/A
No private methods found
No private properties found
N/A

Properties

$_adapter

$_adapter :

Type

$_mailboxlist

$_mailboxlist :

Type

$_specialMailboxlist

$_specialMailboxlist :

Type

Methods

getImapOb()

getImapOb() : \Horde_Imap_Client_Base

Return a Horde_Imap_Client

Throws

\Horde_ActiveSync_Exception

Returns

\Horde_Imap_Client_Base

getMailboxes()

getMailboxes(boolean  $force = false) : array

Return an array of email folders.

Parameters

boolean $force

If true, will force a refresh of the folder list.

Throws

\Horde_ActiveSync_Exception

Returns

array —

An array of folder information. Each entry is keyed by the mailbox UTF-8 name and contains:

  • level: How many parents a folder has, 0 is the root.
  • label: The display label for the mailbox.
  • d: The delimiter.

getSpecialMailboxes()

getSpecialMailboxes() : array

Return a list of the special mailboxes available on this server.

Throws

\Horde_ActiveSync_Exception

Returns

array —

An array of special mailboxes.

getMsgFlags()

getMsgFlags() : array

Return a list of user-defined flags.

Returns

array —

An array of flag arrays keyed by the RFC 3501 flag name.