Zend_Mail_Storage_Mbox Class Reference

Inheritance diagram for Zend_Mail_Storage_Mbox:

Public Member Functions
	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
	_getPos ($id)
	_isMboxFile ($file, $fileIsString=true)
	_openMboxFile ($filename)

Protected Attributes
	$_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 48 of file Mbox.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$params

)

Create instance with parameters Supported parameters are:

• filename filename of mbox file

Parameters

array

$params

mail reader specific parameters

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Definition at line 222 of file Mbox.php.

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

        if (!isset($params->filename) /* || Zend_Loader::isReadable($params['filename']) */) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('no valid filename given in params');
        }

        $this->_openMboxFile($params->filename);
        $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 416 of file Mbox.php.

    {
        return array('_filename', '_positions', '_filemtime');
    }

__wakeup()

__wakeup

(

)

magic method for unserialize()

with this method you can cache the mbox class for cache validation the mtime of the mbox file is used

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Definition at line 430 of file Mbox.php.

    {
        if ($this->_filemtime != @filemtime($this->_filename)) {
            $this->close();
            $this->_openMboxFile($this->_filename);
        } else {
            $this->_fh = @fopen($this->_filename, 'r');
            if (!$this->_fh) {
                #require_once 'Zend/Mail/Storage/Exception.php';
                throw new Zend_Mail_Storage_Exception('cannot open mbox file');
            }
        }
    }

_getPos()

_getPos (   $id )

protected

Get positions for mail message or throw exeption if id is invalid

Parameters

int

$id

number of message

Returns

array positions as in _positions

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Definition at line 121 of file Mbox.php.

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

        return $this->_positions[$id - 1];
    }

_isMboxFile()

_isMboxFile (   $file,   $fileIsString = true  )

protected

check if given file is a mbox file

if $file is a resource its file pointer is moved after the first line

Parameters

resource | string	$file	stream resource of name of file
bool	$fileIsString	file is string or resource

Returns

bool file is mbox file

Definition at line 250 of file Mbox.php.

    {
        if ($fileIsString) {
            $file = @fopen($file, 'r');
            if (!$file) {
                return false;
            }
        } else {
            fseek($file, 0);
        }

        $result = false;

        $line = fgets($file);
        if (strpos($line, 'From ') === 0) {
            $result = true;
        }

        if ($fileIsString) {
            @fclose($file);
        }

        return $result;
    }

_openMboxFile()

_openMboxFile (   $filename )

protected

open given file as current mbox file

Parameters

string

$filename

filename of mbox file

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Zend_Mail_Storage_Exception

Definition at line 282 of file Mbox.php.

    {
        if ($this->_fh) {
            $this->close();
        }

        $this->_fh = @fopen($filename, 'r');
        if (!$this->_fh) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot open mbox file');
        }
        $this->_filename = $filename;
        $this->_filemtime = filemtime($this->_filename);

        if (!$this->_isMboxFile($this->_fh, false)) {
            @fclose($this->_fh);
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('file is not a valid mbox format');
        }

        $messagePos = array('start' => ftell($this->_fh), 'separator' => 0, 'end' => 0);
        while (($line = fgets($this->_fh)) !== false) {
            if (strpos($line, 'From ') === 0) {
                $messagePos['end'] = ftell($this->_fh) - strlen($line) - 2; // + newline
                if (!$messagePos['separator']) {
                    $messagePos['separator'] = $messagePos['end'];
                }
                $this->_positions[] = $messagePos;
                $messagePos = array('start' => ftell($this->_fh), 'separator' => 0, 'end' => 0);
            }
            if (!$messagePos['separator'] && !trim($line)) {
                $messagePos['separator'] = ftell($this->_fh);
            }
        }

        $messagePos['end'] = ftell($this->_fh);
        if (!$messagePos['separator']) {
            $messagePos['separator'] = $messagePos['end'];
        }
        $this->_positions[] = $messagePos;
    }

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 336 of file Mbox.php.

    {
        @fclose($this->_fh);
        $this->_positions = array();
    }

countMessages()

countMessages

(

)

Count messages all messages in current box

Returns

int number of messages

Exceptions

Zend_Mail_Storage_Exception

Definition at line 86 of file Mbox.php.

    {
        return count($this->_positions);
    }

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 142 of file Mbox.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')) {
            // TODO top/body lines
            $messagePos = $this->_getPos($id);
            return new $this->_messageClass(array('file' => $this->_fh, 'startPos' => $messagePos['start'],
                                                  'endPos' => $messagePos['end']));
        }

        $bodyLines = 0; // TODO: need a way to change that

        $message = $this->getRawHeader($id);
        // file pointer is after headers now
        if ($bodyLines) {
            $message .= "\n";
            while ($bodyLines-- && ftell($this->_fh) < $this->_positions[$id - 1]['end']) {
                $message .= fgets($this->_fh);
            }
        }

        return new $this->_messageClass(array('handler' => $this, 'id' => $id, 'headers' => $message));
    }

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

Definition at line 402 of file Mbox.php.

    {
        // check if id exists
        $this->_getPos($id);
        return $id;
    }

getRawContent()

getRawContent	(		$id,
			$part = null
	)

See also

Zend_Mail_Storage_Exception

Definition at line 200 of file Mbox.php.

    {
        if ($part !== null) {
            // TODO: implement
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('not implemented');
        }
        $messagePos = $this->_getPos($id);
        return stream_get_contents($this->_fh, $messagePos['end'] - $messagePos['separator'], $messagePos['separator']);
    }

getRawHeader()

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

See also

Zend_Mail_Storage_Exception

Definition at line 176 of file Mbox.php.

    {
        if ($part !== null) {
            // TODO: implement
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('not implemented');
        }
        $messagePos = $this->_getPos($id);
        // TODO: toplines
        return stream_get_contents($this->_fh, $messagePos['separator'] - $messagePos['start'], $messagePos['start']);
    }

getSize()

getSize

(

$id = 0

)

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)

Definition at line 98 of file Mbox.php.

    {
        if ($id) {
            $pos = $this->_positions[$id - 1];
            return $pos['end'] - $pos['start'];
        }

        $result = array();
        foreach ($this->_positions as $num => $pos) {
            $result[$num + 1] = $pos['end'] - $pos['start'];
        }

        return $result;
    }

getUniqueId()

getUniqueId

(

$id = null

)

get unique id for one or all messages

Mbox does not support unique ids (yet) - it's always the same as the message number. That shouldn't be a problem, because we can't change mbox files. Therefor the message number is save enough.

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 380 of file Mbox.php.

    {
        if ($id) {
            // check if id exists
            $this->_getPos($id);
            return $id;
        }

        $range = range(1, $this->countMessages());
        return array_combine($range, $range);
    }

noop()

noop

(

)

Waste some CPU cycles doing nothing.

Returns

void

Definition at line 348 of file Mbox.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 360 of file Mbox.php.

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

Field Documentation

$_fh

$_fh

protected

Definition at line 54 of file Mbox.php.

$_filemtime

$_filemtime

protected

Definition at line 66 of file Mbox.php.

$_filename

$_filename

protected

Definition at line 60 of file Mbox.php.

$_messageClass

$_messageClass = 'Zend_Mail_Message_File'

protected

Definition at line 78 of file Mbox.php.

$_positions

$_positions

protected

Definition at line 72 of file Mbox.php.

---

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

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