Storage/Folder/Interface.php

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Mail
0017  * @subpackage Storage
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022
0023
0024 /**
0025  * @category   Zend
0026  * @package    Zend_Mail
0027  * @subpackage Storage
0028  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0029  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0030  */
0031 interface Zend_Mail_Storage_Folder_Interface
0032 {
0033     /**
0034      * get root folder or given folder
0035      *
0036      * @param string $rootFolder get folder structure for given folder, else root
0037      * @return Zend_Mail_Storage_Folder root or wanted folder
0038      */
0039     public function getFolders($rootFolder = null);
0040
0041     /**
0042      * select given folder
0043      *
0044      * folder must be selectable!
0045      *
0046      * @param Zend_Mail_Storage_Folder|string $globalName global name of folder or instance for subfolder
0047      * @return null
0048      * @throws Zend_Mail_Storage_Exception
0049      */
0050     public function selectFolder($globalName);
0051
0052
0053     /**
0054      * get Zend_Mail_Storage_Folder instance for current folder
0055      *
0056      * @return Zend_Mail_Storage_Folder instance of current folder
0057      * @throws Zend_Mail_Storage_Exception
0058      */
0059     public function getCurrentFolder();
0060 }