1 | <?php |
---|
2 | /** |
---|
3 | * Zend Framework |
---|
4 | * |
---|
5 | * LICENSE |
---|
6 | * |
---|
7 | * This source file is subject to the new BSD license that is bundled |
---|
8 | * with this package in the file LICENSE.txt. |
---|
9 | * It is also available through the world-wide-web at this URL: |
---|
10 | * http://framework.zend.com/license/new-bsd |
---|
11 | * If you did not receive a copy of the license and are unable to |
---|
12 | * obtain it through the world-wide-web, please send an email |
---|
13 | * to license@zend.com so we can send you a copy immediately. |
---|
14 | * |
---|
15 | * @category Zend |
---|
16 | * @package Zend_Mail |
---|
17 | * @subpackage Storage |
---|
18 | * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
---|
19 | * @license http://framework.zend.com/license/new-bsd New BSD License |
---|
20 | * @version $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $ |
---|
21 | */ |
---|
22 | |
---|
23 | |
---|
24 | /** |
---|
25 | * @category Zend |
---|
26 | * @package Zend_Mail |
---|
27 | * @subpackage Storage |
---|
28 | * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
---|
29 | * @license http://framework.zend.com/license/new-bsd New BSD License |
---|
30 | */ |
---|
31 | interface Zend_Mail_Storage_Folder_Interface |
---|
32 | { |
---|
33 | /** |
---|
34 | * get root folder or given folder |
---|
35 | * |
---|
36 | * @param string $rootFolder get folder structure for given folder, else root |
---|
37 | * @return Zend_Mail_Storage_Folder root or wanted folder |
---|
38 | */ |
---|
39 | public function getFolders($rootFolder = null); |
---|
40 | |
---|
41 | /** |
---|
42 | * select given folder |
---|
43 | * |
---|
44 | * folder must be selectable! |
---|
45 | * |
---|
46 | * @param Zend_Mail_Storage_Folder|string $globalName global name of folder or instance for subfolder |
---|
47 | * @return null |
---|
48 | * @throws Zend_Mail_Storage_Exception |
---|
49 | */ |
---|
50 | public function selectFolder($globalName); |
---|
51 | |
---|
52 | |
---|
53 | /** |
---|
54 | * get Zend_Mail_Storage_Folder instance for current folder |
---|
55 | * |
---|
56 | * @return Zend_Mail_Storage_Folder instance of current folder |
---|
57 | * @throws Zend_Mail_Storage_Exception |
---|
58 | */ |
---|
59 | public function getCurrentFolder(); |
---|
60 | } |
---|