PHP Class Horde_Imap_Client_Mailbox, horde

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.
Author: Michael Slusarz ([email protected])
Inheritance: implements Serializable
Datei anzeigen Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_utf7imap mixed If boolean true, it is identical to UTF-8 representation.
$_utf8 string UTF8 representation of mailbox.

Public Methods

Method Description
__construct ( string $mbox, boolean $utf7imap = false ) Constructor.
__get ( $name )
__toString ( )
equals ( $mbox ) : boolean Compares this mailbox to another mailbox string.
get ( string $mbox, boolean $utf7imap = false ) : Horde_Imap_Client_Mailbox Shortcut to obtaining mailbox object.
serialize ( )
unserialize ( $data )

Method Details

__construct() public method

Constructor.
public __construct ( string $mbox, boolean $utf7imap = false )
$mbox string The mailbox name.
$utf7imap boolean Is mailbox UTF7-IMAP encoded (true). Otherwise, mailbox is assumed to be UTF-8 encoded.

__get() public method

public __get ( $name )

__toString() public method

public __toString ( )

equals() public method

Compares this mailbox to another mailbox string.
public equals ( $mbox ) : boolean
return boolean True if the items are equal.

get() public static method

Shortcut to obtaining mailbox object.
public static get ( string $mbox, boolean $utf7imap = false ) : Horde_Imap_Client_Mailbox
$mbox string The mailbox name.
$utf7imap boolean Is mailbox UTF7-IMAP encoded? Otherwise, mailbox is assumed to be UTF-8.
return Horde_Imap_Client_Mailbox A mailbox object.

serialize() public method

public serialize ( )

unserialize() public method

public unserialize ( $data )

Property Details

$_utf7imap protected_oe property

If boolean true, it is identical to UTF-8 representation.
protected mixed $_utf7imap
return mixed

$_utf8 protected_oe property

UTF8 representation of mailbox.
protected string $_utf8
return string