Documentation

Horde_ActiveSync_Interface_ImapFactory

Horde_ActiveSync_Interface_ImapFactory:: Defines an interface for a factory object that knows how to provide an appropriate Horde_ActiveSync_Imap_Adapter object and mailbox lists.

Tags
license

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

copyright

2012-2020 Horde LLC (http://www.horde.org)

author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

getImapOb()  : mixed
Return an imap client object.
getMailboxes()  : array<string|int, mixed>
Return the list of IMAP mailboxes
getSpecialMailboxes()  : array<string|int, mixed>
Return the list of "special" mailboxes such as Trash/Sent

Methods

getImapOb()

Return an imap client object.

public getImapOb() : mixed
Return values
mixed

An object capable of communicating with an IMAP server.

getMailboxes()

Return the list of IMAP mailboxes

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

If true, force a refresh of the list.

Return values
array<string|int, mixed>

An array of mailbox names.

getSpecialMailboxes()

Return the list of "special" mailboxes such as Trash/Sent

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

An array of mailbox names, keyed by the special type.

Search results