Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
Zend_Mail_Storage_Folder_Interface Interface Reference
Inheritance diagram for Zend_Mail_Storage_Folder_Interface:
Zend_Mail_Storage_Folder_Maildir Zend_Mail_Storage_Folder_Mbox Zend_Mail_Storage_Imap Zend_Mail_Storage_Writable_Maildir

Public Member Functions

 getFolders ($rootFolder=null)
 
 selectFolder ($globalName)
 
 getCurrentFolder ()
 

Detailed Description

Definition at line 31 of file Interface.php.

Member Function Documentation

◆ getCurrentFolder()

getCurrentFolder ( )

get Zend_Mail_Storage_Folder instance for current folder

Returns
Zend_Mail_Storage_Folder instance of current folder
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Folder_Maildir, and Zend_Mail_Storage_Folder_Mbox.

◆ getFolders()

getFolders (   $rootFolder = null)

get root folder or given folder

Parameters
string$rootFolderget folder structure for given folder, else root
Returns
Zend_Mail_Storage_Folder root or wanted folder

Implemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Folder_Maildir, and Zend_Mail_Storage_Folder_Mbox.

◆ selectFolder()

selectFolder (   $globalName)

select given folder

folder must be selectable!

Parameters
Zend_Mail_Storage_Folder | string$globalNameglobal name of folder or instance for subfolder
Returns
null
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Folder_Maildir, and Zend_Mail_Storage_Folder_Mbox.


The documentation for this interface was generated from the following file: