Zend_Mail_Storage_Folder_Maildir Class Reference

Inheritance diagram for Zend_Mail_Storage_Folder_Maildir:

Public Member Functions
	__construct ($params)
	getFolders ($rootFolder=null)
	selectFolder ($globalName)
	getCurrentFolder ()
Public Member Functions inherited from Zend_Mail_Storage_Maildir
	countMessages ($flags=null)
	getSize ($id=null)
	getMessage ($id)
	getRawHeader ($id, $part=null, $topLines=0)
	getRawContent ($id, $part=null)
	__construct ($params)
	close ()
	noop ()
	removeMessage ($id)
	getUniqueId ($id=null)
	getNumberByUniqueId ($id)
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 ()
Protected Member Functions inherited from Zend_Mail_Storage_Maildir
	_getFileData ($id, $field=null)
	_isMaildir ($dirname)
	_openMaildir ($dirname)
	_getMaildirFiles ($dh, $dirname, $default_flags=array())

Protected Attributes
	$_rootFolder
	$_rootdir
	$_currentFolder
	$_delim
Protected Attributes inherited from Zend_Mail_Storage_Maildir
	$_messageClass = 'Zend_Mail_Message_File'
	$_files = array()
Protected Attributes inherited from Zend_Mail_Storage_Abstract
	$_has
	$_iterationPos = 0
	$_iterationMax = null
	$_messageClass = 'Zend_Mail_Message'

Additional Inherited Members
Static Protected Attributes inherited from Zend_Mail_Storage_Maildir
static	$_knownFlags

Detailed Description

Definition at line 47 of file Maildir.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$params

)

Create instance with parameters Supported parameters are:

• dirname rootdir of maildir structure
• delim delim char for folder structur, default is '.'
• 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

Definition at line 83 of file Maildir.php.

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

        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->_delim = isset($params->delim) ? $params->delim : '.';

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

Member Function Documentation

_buildFolderTree()

_buildFolderTree ( )

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.

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Zend_Mail_Storage_Exception

Zend_Mail_Storage_Exception

Definition at line 116 of file Maildir.php.

    {
        $this->_rootFolder = new Zend_Mail_Storage_Folder('/', '/', false);
        $this->_rootFolder->INBOX = new Zend_Mail_Storage_Folder('INBOX', 'INBOX', true);

        $dh = @opendir($this->_rootdir);
        if (!$dh) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception("can't read folders in maildir");
        }
        $dirs = array();
        while (($entry = readdir($dh)) !== false) {
            // maildir++ defines folders must start with .
            if ($entry[0] != '.' || $entry == '.' || $entry == '..') {
                continue;
            }
            if ($this->_isMaildir($this->_rootdir . $entry)) {
                $dirs[] = $entry;
            }
        }
        closedir($dh);

        sort($dirs);
        $stack = array(null);
        $folderStack = array(null);
        $parentFolder = $this->_rootFolder;
        $parent = '.';

        foreach ($dirs as $dir) {
            do {
                if (strpos($dir, $parent) === 0) {
                    $local = substr($dir, strlen($parent));
                    if (strpos($local, $this->_delim) !== false) {
                        #require_once 'Zend/Mail/Storage/Exception.php';
                        throw new Zend_Mail_Storage_Exception('error while reading maildir');
                    }
                    array_push($stack, $parent);
                    $parent = $dir . $this->_delim;
                    $folder = new Zend_Mail_Storage_Folder($local, substr($dir, 1), true);
                    $parentFolder->$local = $folder;
                    array_push($folderStack, $parentFolder);
                    $parentFolder = $folder;
                    break;
                } else if ($stack) {
                    $parent = array_pop($stack);
                    $parentFolder = array_pop($folderStack);
                }
            } while ($stack);
            if (!$stack) {
                #require_once 'Zend/Mail/Storage/Exception.php';
                throw new Zend_Mail_Storage_Exception('error while reading maildir');
            }
        }
    }

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 261 of file Maildir.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 187 of file Maildir.php.

    {
        if (!$rootFolder || $rootFolder == 'INBOX') {
            return $this->_rootFolder;
        }

        // rootdir is same as INBOX in maildir
        if (strpos($rootFolder, 'INBOX' . $this->_delim) === 0) {
            $rootFolder = substr($rootFolder, 6);
        }
        $currentFolder = $this->_rootFolder;
        $subname = trim($rootFolder, $this->_delim);
        while ($currentFolder) {
            @list($entry, $subname) = @explode($this->_delim, $subname, 2);
            $currentFolder = $currentFolder->$entry;
            if (!$subname) {
                break;
            }
        }

        if ($currentFolder->getGlobalName() != rtrim($rootFolder, $this->_delim)) {
            #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 226 of file Maildir.php.

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

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

        try {
            $this->_openMaildir($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 maildir 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 Maildir.php.

$_delim

$_delim

protected

Definition at line 71 of file Maildir.php.

$_rootdir

$_rootdir

protected

Definition at line 59 of file Maildir.php.

$_rootFolder

$_rootFolder

protected

Definition at line 53 of file Maildir.php.

---

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

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