Overview

Packages

  • Imap
    • Client

Classes

  • Horde_Imap_Client
  • Horde_Imap_Client_Auth_DigestMD5
  • Horde_Imap_Client_Base
  • Horde_Imap_Client_Cache
  • Horde_Imap_Client_Data_Acl
  • Horde_Imap_Client_Data_AclCommon
  • Horde_Imap_Client_Data_AclNegative
  • Horde_Imap_Client_Data_AclRights
  • Horde_Imap_Client_Data_Envelope
  • Horde_Imap_Client_Data_Fetch
  • Horde_Imap_Client_Data_Fetch_Pop3
  • Horde_Imap_Client_Data_Thread
  • Horde_Imap_Client_DateTime
  • Horde_Imap_Client_Exception
  • Horde_Imap_Client_Exception_NoSupportExtension
  • Horde_Imap_Client_Fetch_Query
  • Horde_Imap_Client_Ids
  • Horde_Imap_Client_Ids_Pop3
  • Horde_Imap_Client_Mailbox
  • Horde_Imap_Client_Search_Query
  • Horde_Imap_Client_Socket
  • Horde_Imap_Client_Socket_Pop3
  • Horde_Imap_Client_Sort
  • Horde_Imap_Client_Translation
  • Horde_Imap_Client_Utf7imap
  • Horde_Imap_Client_Utils
  • Horde_Imap_Client_Utils_Pop3
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Imap_Client_Mailbox

An object that provides a way to switch between UTF7-IMAP and human-readable representations of a mailbox name.

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

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Horde_Imap_Client_Mailbox implements Serializable
Package: Imap\Client
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Imap/Client/Mailbox.php
Methods summary
public static Horde_Imap_Client_Mailbox
# get( string $mbox, mixed $utf7imap = false )

Shortcut to obtaining mailbox object.

Shortcut to obtaining mailbox object.

Parameters

$mbox
The mailbox name.
$utf7imap
<p>Is mailbox UTF7-IMAP encoded (true), UTF-8 encoded (false), or should it be auto-determined (null). NOTE: auto-determination is not 100% accurate.</p>

Returns

Horde_Imap_Client_Mailbox
A mailbox object.
public
# __construct( string $mbox, mixed $utf7imap = false )

Constructor.

Constructor.

Parameters

$mbox
The mailbox name.
$utf7imap
<p>Is mailbox UTF7-IMAP encoded (true). Otherwise, mailbox is taken as UTF-8 encoded.</p>
public
# __get( mixed $name )
public
# __toString( )
public boolean
# equals( mixed $mbox )

Compares this mailbox to another mailbox string.

Compares this mailbox to another mailbox string.

Returns

boolean
True if the items are equal.
public
# serialize( )

Implementation of

Serializable::serialize()
public
# unserialize( mixed $data )

Implementation of

Serializable::unserialize()
Magic properties summary
public string $utf7imap

Mailbox in UTF7-IMAP.

public string $utf8

Mailbox in UTF-8.

API documentation generated by ApiGen