Class Zend_Mail_Folder

Description

Implements interfaces:

  • RecursiveIterator (internal interface)

Located in /Mail/Folder.php (line 31)


	
			
Method Summary
 Zend_Mail_Folder __construct (string $localName, [string $globalName = ''], [bool $selectable = true], [ $folders = array()])
 string getGlobalName ()
 string getLocalName ()
 bool hasChildren ()
 bool isLeaf ()
 bool isSelectable ()
 string key ()
 void next ()
 void rewind ()
 bool valid ()
 Zend_Mail_Folder __get (string $name)
 void __set (string $name, Zend_Mail_Folder $folder)
 string __toString ()
Methods
Constructor __construct (line 61)

create a new mail folder instance

  • access: public
Zend_Mail_Folder __construct (string $localName, [string $globalName = ''], [bool $selectable = true], [ $folders = array()])
  • string $localName: name of folder in current subdirectory
  • string $globalName: absolute name of folder
  • bool $selectable: if true folder holds messages, if false it's just a parent for subfolders
  • array $folders: init with given instances of Zend_Mail_Folder as subfolders
current (line 123)

implements Iterator::current()

  • return: current folder
  • access: public
Zend_Mail_Folder current ()

Implementation of:
RecursiveIterator::current
getChildren (line 85)

implements RecursiveIterator::getChildren()

  • return: same as self::current()
  • access: public
Zend_Mail_Folder getChildren ()

Implementation of:
RecursiveIterator::getChildren
getGlobalName (line 188)

get global name

  • return: global name
  • access: public
string getGlobalName ()
getLocalName (line 178)

get local name

  • return: local name
  • access: public
string getLocalName ()
hasChildren (line 74)

implements RecursiveIterator::hasChildren()

  • return: current element has children
  • access: public
bool hasChildren ()

Implementation of:
RecursiveIterator::hasChildren
isLeaf (line 208)

check if folder has no subfolder

  • return: true if no subfolders
  • access: public
bool isLeaf ()
isSelectable (line 198)

is this folder selectable?

  • return: selectable
  • access: public
bool isSelectable ()
key (line 113)

implements Iterator::key()

  • return: key/local name of current element
  • access: public
string key ()

Implementation of:
RecursiveIterator::key
next (line 103)

implements Iterator::next()

  • access: public
void next ()

Implementation of:
RecursiveIterator::next
rewind (line 131)

implements Iterator::rewind()

  • access: public
void rewind ()

Implementation of:
RecursiveIterator::rewind
valid (line 95)

implements Iterator::valid()

  • return: check if there's a current element
  • access: public
bool valid ()

Implementation of:
RecursiveIterator::valid
__get (line 143)

get subfolder named $name

  • return: folder named $folder
  • access: public
  • throws: Zend_Mail_Exception
Zend_Mail_Folder __get (string $name)
  • string $name: wanted subfolder
__set (line 158)

add or replace subfolder named $name

  • access: public
void __set (string $name, Zend_Mail_Folder $folder)
  • string $name: local name of subfolder
  • Zend_Mail_Folder $folder: instance for new subfolder
__toString (line 168)

magic method for easy output of global name

  • return: global name of folder
  • access: public
string __toString ()

Documentation generated on Thu, 18 Jan 2007 10:00:52 -0800 by phpDocumentor 1.3.1