vendor/zendframework/zend-mail/src/Storage/Folder/FolderInterface.php

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