Zend_Mail_Storage_Folder_Mbox Class Reference

Inheritance diagram for Zend_Mail_Storage_Folder_Mbox:

Public Member Functions
	__construct ($params)
	getFolders ($rootFolder=null)
	selectFolder ($globalName)
	getCurrentFolder ()
	__sleep ()
	__wakeup ()
Public Member Functions inherited from Zend_Mail_Storage_Mbox
	countMessages ()
	getSize ($id=0)
	getMessage ($id)
	getRawHeader ($id, $part=null, $topLines=0)
	getRawContent ($id, $part=null)
	__construct ($params)
	close ()
	noop ()
	removeMessage ($id)
	getUniqueId ($id=null)
	getNumberByUniqueId ($id)
	__sleep ()
	__wakeup ()
Public Member Functions inherited from Zend_Mail_Storage_Abstract
	__get ($var)
	getCapabilities ()
	countMessages ()
	getSize ($id=0)
	getMessage ($id)
	getRawHeader ($id, $part=null, $topLines=0)
	getRawContent ($id, $part=null)
	__construct ($params)
	__destruct ()
	close ()
	noop ()
	removeMessage ($id)
	getUniqueId ($id=null)
	getNumberByUniqueId ($id)
	count ()
	offsetExists ($id)
	offsetGet ($id)
	offsetSet ($id, $value)
	offsetUnset ($id)
	rewind ()
	current ()
	key ()
	next ()
	valid ()
	seek ($pos)

Protected Member Functions
	_buildFolderTree ($currentDir, $parentFolder=null, $parentGlobalName='')
Protected Member Functions inherited from Zend_Mail_Storage_Mbox
	_getPos ($id)
	_isMboxFile ($file, $fileIsString=true)
	_openMboxFile ($filename)

Protected Attributes
	$_rootFolder
	$_rootdir
	$_currentFolder
Protected Attributes inherited from Zend_Mail_Storage_Mbox
	$_fh
	$_filename
	$_filemtime
	$_positions
	$_messageClass = 'Zend_Mail_Message_File'
Protected Attributes inherited from Zend_Mail_Storage_Abstract
	$_has
	$_iterationPos = 0
	$_iterationMax = null
	$_messageClass = 'Zend_Mail_Message'

Detailed Description

Definition at line 47 of file Mbox.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$params

)

Create instance with parameters

Disallowed parameters are:

• filename use Zend_Mail_Storage_Mbox for a single file Supported parameters are:
• dirname rootdir of mbox structure
• folder intial selected folder, default is 'INBOX'

Parameters

array

$params

mail reader specific parameters

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Zend_Mail_Storage_Exception

Definition at line 79 of file Mbox.php.

    {
        if (is_array($params)) {
            $params = (object)$params;
        }

        if (isset($params->filename)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('use Zend_Mail_Storage_Mbox for a single file');
        }

        if (!isset($params->dirname) || !is_dir($params->dirname)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('no valid dirname given in params');
        }

        $this->_rootdir = rtrim($params->dirname, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;

        $this->_buildFolderTree($this->_rootdir);
        $this->selectFolder(!empty($params->folder) ? $params->folder : 'INBOX');
        $this->_has['top']      = true;
        $this->_has['uniqueid'] = false;
    }

Member Function Documentation

__sleep()

__sleep

(

)

magic method for serialize()

with this method you can cache the mbox class

Returns

array name of variables

Definition at line 247 of file Mbox.php.

    {
        return array_merge(parent::__sleep(), array('_currentFolder', '_rootFolder', '_rootdir'));
    }

__wakeup()

__wakeup

(

)

magic method for unserialize()

with this method you can cache the mbox class

Returns

null

Definition at line 259 of file Mbox.php.

    {
        // if cache is stall selectFolder() rebuilds the tree on error
        parent::__wakeup();
    }

_buildFolderTree()

_buildFolderTree (   $currentDir,   $parentFolder = null,   $parentGlobalName = ''  )

protected

find all subfolders and mbox files for folder structure

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

Parameters

string	$currentDir	call with root dir, also used for recursion.
Zend_Mail_Storage_Folder | null	$parentFolder	used for recursion
string	$parentGlobalName	used for rescursion

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Definition at line 121 of file Mbox.php.

    {
        if (!$parentFolder) {
            $this->_rootFolder = new Zend_Mail_Storage_Folder('/', '/', false);
            $parentFolder = $this->_rootFolder;
        }

        $dh = @opendir($currentDir);
        if (!$dh) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception("can't read dir $currentDir");
        }
        while (($entry = readdir($dh)) !== false) {
            // ignore hidden files for mbox
            if ($entry[0] == '.') {
                continue;
            }
            $absoluteEntry = $currentDir . $entry;
            $globalName = $parentGlobalName . DIRECTORY_SEPARATOR . $entry;
            if (is_file($absoluteEntry) && $this->_isMboxFile($absoluteEntry)) {
                $parentFolder->$entry = new Zend_Mail_Storage_Folder($entry, $globalName);
                continue;
            }
            if (!is_dir($absoluteEntry) /* || $entry == '.' || $entry == '..' */) {
                continue;
            }
            $folder = new Zend_Mail_Storage_Folder($entry, $globalName, false);
            $parentFolder->$entry = $folder;
            $this->_buildFolderTree($absoluteEntry . DIRECTORY_SEPARATOR, $folder, $globalName);
        }

        closedir($dh);
    }

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

Implements Zend_Mail_Storage_Folder_Interface.

Definition at line 235 of file Mbox.php.

    {
        return $this->_currentFolder;
    }

getFolders()

getFolders

(

$rootFolder = null

)

get root folder or given folder

Parameters

string

$rootFolder

get folder structure for given folder, else root

Returns

Zend_Mail_Storage_Folder root or wanted folder

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Folder_Interface.

Definition at line 165 of file Mbox.php.

    {
        if (!$rootFolder) {
            return $this->_rootFolder;
        }

        $currentFolder = $this->_rootFolder;
        $subname = trim($rootFolder, DIRECTORY_SEPARATOR);
        while ($currentFolder) {
            @list($entry, $subname) = @explode(DIRECTORY_SEPARATOR, $subname, 2);
            $currentFolder = $currentFolder->$entry;
            if (!$subname) {
                break;
            }
        }

        if ($currentFolder->getGlobalName() != DIRECTORY_SEPARATOR . trim($rootFolder, DIRECTORY_SEPARATOR)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception("folder $rootFolder not found");
        }
        return $currentFolder;
    }

selectFolder()

selectFolder

(

$globalName

)

select given folder

folder must be selectable!

Parameters

Zend_Mail_Storage_Folder | string

$globalName

global name of folder or instance for subfolder

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Folder_Interface.

Definition at line 200 of file Mbox.php.

    {
        $this->_currentFolder = (string)$globalName;

        // getting folder from folder tree for validation
        $folder = $this->getFolders($this->_currentFolder);

        try {
            $this->_openMboxFile($this->_rootdir . $folder->getGlobalName());
        } catch(Zend_Mail_Storage_Exception $e) {
            // check what went wrong
            if (!$folder->isSelectable()) {
                #require_once 'Zend/Mail/Storage/Exception.php';
                throw new Zend_Mail_Storage_Exception("{$this->_currentFolder} is not selectable", 0, $e);
            }
            // seems like file has vanished; rebuilding folder tree - but it's still an exception
            $this->_buildFolderTree($this->_rootdir);
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('seems like the mbox file has vanished, I\'ve rebuild the ' .
                                                         'folder tree, search for an other folder and try again', 0, $e);
        }
    }

Field Documentation

$_currentFolder

$_currentFolder

protected

Definition at line 65 of file Mbox.php.

$_rootdir

$_rootdir

protected

Definition at line 59 of file Mbox.php.

$_rootFolder

$_rootFolder

protected

Definition at line 53 of file Mbox.php.

---

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

• vendor/magento/zendframework1/library/Zend/Mail/Storage/Folder/Mbox.php