737. Class

737.1. Zend\Mail\Storage\Folder\Mbox

737.1.1. Methods

737.1.1.1. __construct

__construct()

Create instance with parameters

Disallowed parameters are:

• filename use ZendMailStorageMbox for a single file

Supported parameters are:

• dirname rootdir of mbox structure
• folder intial selected folder, default is ‘INBOX’

Parameters:$params – mail reader specific parameters Throws ZendMailStorageExceptionInvalidArgumentException:  

737.1.1.2. _buildFolderTree

_buildFolderTree()

find all subfolders and mbox files for folder structure

Result is save in ZendMailStorageFolder instances with the root in $this->rootFolder. $parentFolder and $parentGlobalName are only used internally for recursion.

Parameters:

• string – call with root dir, also used for recursion.
• ZendMailStorageFolder|null – used for recursion
• string – used for recursion

Throws ZendMailStorageExceptionInvalidArgumentException:  

737.1.1.3. getFolders

getFolders()

get root folder or given folder

Parameters:string – get folder structure for given folder, else root Throws ZendMailStorageExceptionInvalidArgumentException:   Return type:ZendMailStorageFolder root or wanted folder

737.1.1.4. selectFolder

selectFolder()

select given folder

folder must be selectable!

Parameters:ZendMailStorageFolder|string – global name of folder or instance for subfolder Throws ZendMailStorageExceptionRuntimeException:  

737.1.1.5. getCurrentFolder

getCurrentFolder()

get ZendMailStorageFolder instance for current folder

Return type:ZendMailStorageFolder instance of current folder Throws :ZendMailStorageExceptionExceptionInterface

737.1.1.6. __sleep

__sleep()

magic method for serialize()

with this method you can cache the mbox class

Return type:array name of variables

737.1.1.7. __wakeup

__wakeup()

magic method for unserialize(), with this method you can cache the mbox class