Inheritance diagram for Zend_Mail_Storage_Maildir:

Public Member Functions
	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
	_getFileData ($id, $field=null)

	_isMaildir ($dirname)

	_openMaildir ($dirname)

	_getMaildirFiles ($dh, $dirname, $default_flags=array())

Protected Attributes
	$_messageClass = 'Zend_Mail_Message_File'

	$_files = array()

Protected Attributes inherited from Zend_Mail_Storage_Abstract
	$_has

	$_iterationPos = 0

	$_iterationMax = null

	$_messageClass = 'Zend_Mail_Message'

Static Protected Attributes
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 dirname of mbox file

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 263 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');
         }
 
         if (!$this->_isMaildir($params->dirname)) {
             #require_once 'Zend/Mail/Storage/Exception.php';
             throw new Zend_Mail_Storage_Exception('invalid maildir given');
         }
 
         $this->_has['top'] = true;
         $this->_has['flags'] = true;
         $this->_openMaildir($params->dirname);
     }

Member Function Documentation

◆ _getFileData()

_getFileData	(	$id,
		$field = `null`
	)

protected

Get one or all fields from file structure. Also checks if message is valid

Parameters

int	$id	message number
string \| null	$field	wanted field

Returns: string|array wanted field or all fields as array

Exceptions

Zend_Mail_Storage_Exception

See also: Zend_Mail_Storage_Exception; Zend_Mail_Storage_Exception

Definition at line 119 of file Maildir.php.

     {
         if (!isset($this->_files[$id - 1])) {
             #require_once 'Zend/Mail/Storage/Exception.php';
             throw new Zend_Mail_Storage_Exception('id does not exist');
         }
 
         if (!$field) {
             return $this->_files[$id - 1];
         }
 
         if (!isset($this->_files[$id - 1][$field])) {
             #require_once 'Zend/Mail/Storage/Exception.php';
             throw new Zend_Mail_Storage_Exception('field does not exist');
         }
 
         return $this->_files[$id - 1][$field];
     }

◆ _getMaildirFiles()

_getMaildirFiles	(	$dh,
		$dirname,
		$default_flags = `array()`
	)

protected

find all files in opened dir handle and add to maildir files

Parameters

resource	$dh	dir handle used for search
string	$dirname	dirname of dir in $dh
array	$default_flags	default flags for given dir

Returns: null

Definition at line 352 of file Maildir.php.

     {
         while (($entry = readdir($dh)) !== false) {
             if ($entry[0] == '.' || !is_file($dirname . $entry)) {
                 continue;
             }
 
             @list($uniq, $info) = explode(':', $entry, 2);
             @list(,$size) = explode(',', $uniq, 2);
             if ($size && $size[0] == 'S' && $size[1] == '=') {
                 $size = substr($size, 2);
             }
             if (!ctype_digit($size)) {
                 $size = null;
             }
             @list($version, $flags) = explode(',', $info, 2);
             if ($version != 2) {
                 $flags = '';
             }
 
             $named_flags = $default_flags;
             $length = strlen($flags);
             for ($i = 0; $i < $length; ++$i) {
                 $flag = $flags[$i];
                 $named_flags[$flag] = isset(self::$_knownFlags[$flag]) ? self::$_knownFlags[$flag] : $flag;
             }
 
             $data = array('uniq'       => $uniq,
                           'flags'      => $named_flags,
                           'flaglookup' => array_flip($named_flags),
                           'filename'   => $dirname . $entry);
             if ($size !== null) {
                 $data['size'] = (int)$size;
             }
             $this->_files[] = $data;
         }
     }

◆ _isMaildir()

_isMaildir ( $dirname )

protected

check if a given dir is a valid maildir

Parameters

string $dirname name of dir

Returns: bool dir is valid maildir

Definition at line 296 of file Maildir.php.

     {
         if (file_exists($dirname . '/new') && !is_dir($dirname . '/new')) {
             return false;
         }
         if (file_exists($dirname . '/tmp') && !is_dir($dirname . '/tmp')) {
             return false;
         }
         return is_dir($dirname . '/cur');
     }

◆ _openMaildir()

_openMaildir ( $dirname )

protected

open given dir as current maildir

Parameters

string $dirname name of maildir

Returns: null

Exceptions

Zend_Mail_Storage_Exception

See also: Zend_Mail_Storage_Exception; Zend_Mail_Storage_Exception

Definition at line 314 of file Maildir.php.

     {
         if ($this->_files) {
             $this->close();
         }
 
         $dh = @opendir($dirname . '/cur/');
         if (!$dh) {
             #require_once 'Zend/Mail/Storage/Exception.php';
             throw new Zend_Mail_Storage_Exception('cannot open maildir');
         }
         $this->_getMaildirFiles($dh, $dirname . '/cur/');
         closedir($dh);
 
         $dh = @opendir($dirname . '/new/');
         if ($dh) {
             $this->_getMaildirFiles($dh, $dirname . '/new/', array(Zend_Mail_Storage::FLAG_RECENT));
             closedir($dh);
         } else if (file_exists($dirname . '/new/')) {
             #require_once 'Zend/Mail/Storage/Exception.php';
             throw new Zend_Mail_Storage_Exception('cannot read recent mails in maildir');
         }
     }

◆ close()

close ( )

Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.

Returns: void

Definition at line 397 of file Maildir.php.

     {
         $this->_files = array();
     }

◆ countMessages()

countMessages ( $flags = null )

Count messages all messages in current box

Returns: int number of messages

Exceptions

Zend_Mail_Storage_Exception

Definition at line 83 of file Maildir.php.

     {
         if ($flags === null) {
             return count($this->_files);
         }
 
         $count = 0;
         if (!is_array($flags)) {
             foreach ($this->_files as $file) {
                 if (isset($file['flaglookup'][$flags])) {
                     ++$count;
                 }
             }
             return $count;
         }
 
         $flags = array_flip($flags);
            foreach ($this->_files as $file) {
                foreach ($flags as $flag => $v) {
                    if (!isset($file['flaglookup'][$flag])) {
                        continue 2;
                    }
                }
                ++$count;
            }
            return $count;
     }

◆ getMessage()

getMessage ( $id )

Fetch a message

Parameters

int $id number of message

Returns: Zend_Mail_Message_File

Exceptions

Zend_Mail_Storage_Exception

Definition at line 175 of file Maildir.php.

     {
         // TODO that's ugly, would be better to let the message class decide
         if (strtolower($this->_messageClass) == 'zend_mail_message_file' || is_subclass_of($this->_messageClass, 'zend_mail_message_file')) {
             return new $this->_messageClass(array('file'  => $this->_getFileData($id, 'filename'),
                                                   'flags' => $this->_getFileData($id, 'flags')));
         }
 
         return new $this->_messageClass(array('handler' => $this, 'id' => $id, 'headers' => $this->getRawHeader($id),
                                               'flags'   => $this->_getFileData($id, 'flags')));
     }

◆ getNumberByUniqueId()

getNumberByUniqueId ( $id )

get a message number from a unique id

I.e. if you have a webmailer that supports deleting messages you should use unique ids as parameter and use this method to translate it to message number right before calling removeMessage()

Parameters

string $id unique id

Returns: int message number

Exceptions

Zend_Mail_Storage_Exception

See also: Zend_Mail_Storage_Exception

Definition at line 461 of file Maildir.php.

     {
         foreach ($this->_files as $num => $file) {
             if ($file['uniq'] == $id) {
                 return $num + 1;
             }
         }
 
         #require_once 'Zend/Mail/Storage/Exception.php';
         throw new Zend_Mail_Storage_Exception('unique id not found');
     }

◆ getRawContent()

getRawContent	(	$id,
		$part = `null`
	)

See also: Zend_Mail_Storage_Exception

Definition at line 230 of file Maildir.php.

     {
         if ($part !== null) {
             // TODO: implement
             #require_once 'Zend/Mail/Storage/Exception.php';
             throw new Zend_Mail_Storage_Exception('not implemented');
         }
 
         $fh = fopen($this->_getFileData($id, 'filename'), 'r');
 
         while (!feof($fh)) {
             $line = fgets($fh);
             if (!trim($line)) {
                 break;
             }
         }
 
         $content = stream_get_contents($fh);
         fclose($fh);
         return $content;
     }

◆ getRawHeader()

getRawHeader	(	$id,
		$part = `null`,
		$topLines = `0`
	)

See also: Zend_Mail_Storage_Exception

Definition at line 196 of file Maildir.php.

     {
         if ($part !== null) {
             // TODO: implement
             #require_once 'Zend/Mail/Storage/Exception.php';
             throw new Zend_Mail_Storage_Exception('not implemented');
         }
 
         $fh = fopen($this->_getFileData($id, 'filename'), 'r');
 
         $content = '';
         while (!feof($fh)) {
             $line = fgets($fh);
             if (!trim($line)) {
                 break;
             }
             $content .= $line;
         }
 
         fclose($fh);
         return $content;
     }

◆ getSize()

getSize ( $id = null )

Get a list of messages with number and size

Parameters

int | null $id number of message or null for all messages

Returns: int|array size of given message of list with all messages as array(num => size)

Exceptions

Zend_Mail_Storage_Exception

Definition at line 151 of file Maildir.php.

     {
         if ($id !== null) {
             $filedata = $this->_getFileData($id);
             return isset($filedata['size']) ? $filedata['size'] : filesize($filedata['filename']);
         }
 
         $result = array();
         foreach ($this->_files as $num => $data) {
             $result[$num + 1] = isset($data['size']) ? $data['size'] : filesize($data['filename']);
         }
 
         return $result;
     }

◆ getUniqueId()

getUniqueId ( $id = null )

get unique id for one or all messages

if storage does not support unique ids it's the same as the message number

Parameters

int | null $id message number

Returns: array|string message number for given message or all messages as array

Exceptions

Zend_Mail_Storage_Exception

Definition at line 438 of file Maildir.php.

     {
         if ($id) {
             return $this->_getFileData($id, 'uniq');
         }
 
         $ids = array();
         foreach ($this->_files as $num => $file) {
             $ids[$num + 1] = $file['uniq'];
         }
         return $ids;
     }

◆ noop()

noop ( )

Waste some CPU cycles doing nothing.

Returns: void

Definition at line 408 of file Maildir.php.

     {
         return true;
     }

◆ removeMessage()

removeMessage ( $id )

stub for not supported message deletion

Returns: null

Exceptions

Zend_Mail_Storage_Exception

See also: Zend_Mail_Storage_Exception

Definition at line 420 of file Maildir.php.

     {
         #require_once 'Zend/Mail/Storage/Exception.php';
         throw new Zend_Mail_Storage_Exception('maildir is (currently) read-only');
     }

Field Documentation

◆ $_files

$_files = array()

protected

Definition at line 59 of file Maildir.php.

◆ $_knownFlags

$_knownFlags

staticprotected

Initial value:

= array('D' => Zend_Mail_Storage::FLAG_DRAFT,
                                          'F' => Zend_Mail_Storage::FLAG_FLAGGED,
                                          'P' => Zend_Mail_Storage::FLAG_PASSED,
                                          'R' => Zend_Mail_Storage::FLAG_ANSWERED,
                                          'S' => Zend_Mail_Storage::FLAG_SEEN,
                                          'T' => Zend_Mail_Storage::FLAG_DELETED)

Definition at line 68 of file Maildir.php.

◆ $_messageClass

$_messageClass = 'Zend_Mail_Message_File'

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/Maildir.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getFileData()

◆ _getMaildirFiles()

◆ _isMaildir()

◆ _openMaildir()

◆ close()

◆ countMessages()

◆ getMessage()

◆ getNumberByUniqueId()

◆ getRawContent()

◆ getRawHeader()

◆ getSize()

◆ getUniqueId()

◆ noop()

◆ removeMessage()

Field Documentation

◆ $_files

◆ $_knownFlags

◆ $_messageClass