Documentation

Horde_Core_ActiveSync_Imap_Factory
in package
implements Horde_ActiveSync_Interface_ImapFactory

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.

Tags
license

http://www.horde.org/licenses/gpl GPLv2

copyright

2010-2017 Horde LLC (http://www.horde.org/)

author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

Interfaces

Horde_ActiveSync_Interface_ImapFactory

Properties

$_adapter  : mixed
$_mailboxlist  : mixed
$_specialMailboxlist  : mixed

Methods

getImapOb()  : Horde_Imap_Client_Base
Return a Horde_Imap_Client
getMailboxes()  : array<string|int, mixed>
Return an array of email folders.
getMsgFlags()  : array<string|int, mixed>
Return a list of user-defined flags.
getSpecialMailboxes()  : array<string|int, mixed>
Return a list of the special mailboxes available on this server.

Properties

$_mailboxlist

protected mixed $_mailboxlist

$_specialMailboxlist

protected mixed $_specialMailboxlist

Methods

getImapOb()

Return a Horde_Imap_Client

public getImapOb() : Horde_Imap_Client_Base
Tags
throws
Horde_ActiveSync_Exception
Return values
Horde_Imap_Client_Base

getMailboxes()

Return an array of email folders.

public getMailboxes([bool $force = false ]) : array<string|int, mixed>
Parameters
$force : bool = false

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

Tags
throws
Horde_ActiveSync_Exception
Return values
array<string|int, mixed>

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.

getMsgFlags()

Return a list of user-defined flags.

public getMsgFlags() : array<string|int, mixed>
Return values
array<string|int, mixed>

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

getSpecialMailboxes()

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

public getSpecialMailboxes() : array<string|int, mixed>
Tags
throws
Horde_ActiveSync_Exception
Return values
array<string|int, mixed>

An array of special mailboxes.


        
On this page

Search results