interface/modules/zend_modules/library/Zend/Mail/Storage/Folder/FolderInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Mail\Storage\Folder;
  11
  12 interface FolderInterface
  13 {
  14     /**
  15      * get root folder or given folder
  16      *
  17      * @param string $rootFolder get folder structure for given folder, else root
  18      * @return FolderInterface root or wanted folder
  19      */
  20     public function getFolders($rootFolder = null);
  21
  22     /**
  23      * select given folder
  24      *
  25      * folder must be selectable!
  26      *
  27      * @param FolderInterface|string $globalName global name of folder or instance for subfolder
  28      * @throws \Zend\Mail\Storage\Exception\ExceptionInterface
  29      */
  30     public function selectFolder($globalName);
  31
  32
  33     /**
  34      * get Zend\Mail\Storage\Folder instance for current folder
  35      *
  36      * @return FolderInterface instance of current folder
  37      * @throws \Zend\Mail\Storage\Exception\ExceptionInterface
  38      */
  39     public function getCurrentFolder();
  40 }