Summary

Fully Qualified Name:	Laminas\Mail\Storage\Folder\Mbox
Extends:	Mbox
Implements:	FolderInterface

Description

Methods

Name	Description	Defined By
__construct()	Create instance with parameters	Mbox
__sleep()	magic method for serialize()	Mbox
__wakeup()	magic method for unserialize(), with this method you can cache the mbox class	Mbox
getCurrentFolder()	get Storage\Folder instance for current folder	Mbox
getFolders()	get root folder or given folder	Mbox
selectFolder()	select given folder	Mbox

Method Details

__construct()

Create instance with parameters

Disallowed parameters are:

• filename use \Laminas\Mail\Storage\Mbox for a single file

Supported parameters are:

• dirname rootdir of mbox structure
• folder initial selected folder, default is 'INBOX'

Parameter Name	Type	Description
	$params	mail
$params

Returns:

__sleep()

magic method for serialize()

with this method you can cache the mbox class

Returns: array name of variables

__wakeup()

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

Returns:

getCurrentFolder()

get Storage\Folder instance for current folder

Returns: \Storage\Folder instance of current folder

getFolders()

get root folder or given folder

Parameter Name	Type	Description
$rootFolder	string	get

Returns: \Storage\Folder root or wanted folder

selectFolder()

select given folder

folder must be selectable!

Parameter Name	Type	Description
$globalName	\Storage\Folder|string	global

Returns: