Zend_Mail_Part_File Class Reference

Inheritance diagram for Zend_Mail_Part_File:

Public Member Functions
	__construct (array $params)
	getContent ($stream=null)
	getSize ()
	getPart ($num)
Public Member Functions inherited from Zend_Mail_Part
	__construct (array $params)
	setPartClass ($class)
	getPartClass ()
	isMultipart ()
	getContent ()
	getSize ()
	getPart ($num)
	countParts ()
	getHeaders ()
	getHeader ($name, $format=null)
	headerExists ($name)
	getHeaderField ($name, $wantedPart=0, $firstName=0)
	__get ($name)
	__isset ($name)
	__toString ()
	hasChildren ()
	getChildren ()
	valid ()
	next ()
	key ()
	current ()
	rewind ()

Protected Attributes
	$_contentPos = array()
	$_partPos = array()
	$_fh
Protected Attributes inherited from Zend_Mail_Part
	$_headers
	$_content
	$_topLines = ''
	$_parts = array()
	$_countParts
	$_iterationPos = 1
	$_mail
	$_messageNum = 0
	$_partClass

Additional Inherited Members
Protected Member Functions inherited from Zend_Mail_Part
	_cacheContent ()
	_validateHeaders (array $headers, $assertNames=true)

Detailed Description

Definition at line 40 of file File.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$params

)

Public constructor

This handler supports the following params:

• file filename or open file handler with message content (required)
• startPos start position of message or part in file (default: current position)
• endPos end position of message or part in file (default: end of file)

Parameters

array

$params

full message with or without headers

Exceptions

Zend_Mail_Exception

See also

Zend_Mail_Exception

Zend_Mail_Exception

Zend_Mail_Exception

Zend_Mail_Exception

Definition at line 57 of file File.php.

    {
        if (empty($params['file'])) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('no file given in params');
        }

        if (!is_resource($params['file'])) {
            $this->_fh = fopen($params['file'], 'r');
        } else {
            $this->_fh = $params['file'];
        }
        if (!$this->_fh) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('could not open file');
        }
        if (isset($params['startPos'])) {
            fseek($this->_fh, $params['startPos']);
        }
        $header = '';
        $endPos = isset($params['endPos']) ? $params['endPos'] : null;
        while (($endPos === null || ftell($this->_fh) < $endPos) && trim($line = fgets($this->_fh))) {
            $header .= $line;
        }

        Zend_Mime_Decode::splitMessage($header, $this->_headers, $null);

        $this->_contentPos[0] = ftell($this->_fh);
        if ($endPos !== null) {
            $this->_contentPos[1] = $endPos;
        } else {
            fseek($this->_fh, 0, SEEK_END);
            $this->_contentPos[1] = ftell($this->_fh);
        }
        if (!$this->isMultipart()) {
            return;
        }

        $boundary = $this->getHeaderField('content-type', 'boundary');
        if (!$boundary) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('no boundary found in content type to split message');
        }

        $part = array();
        $pos = $this->_contentPos[0];
        fseek($this->_fh, $pos);
        while (!feof($this->_fh) && ($endPos === null || $pos < $endPos)) {
            $line = fgets($this->_fh);
            if ($line === false) {
                if (feof($this->_fh)) {
                    break;
                }
                #require_once 'Zend/Mail/Exception.php';
                throw new Zend_Mail_Exception('error reading file');
            }

            $lastPos = $pos;
            $pos = ftell($this->_fh);
            $line = trim($line);

            if ($line == '--' . $boundary) {
                if ($part) {
                    // not first part
                    $part[1] = $lastPos;
                    $this->_partPos[] = $part;
                }
                $part = array($pos);
            } else if ($line == '--' . $boundary . '--') {
                $part[1] = $lastPos;
                $this->_partPos[] = $part;
                break;
            }
        }
        $this->_countParts = count($this->_partPos);

    }

Member Function Documentation

getContent()

getContent

(

$stream = null

)

Body of part

If part is multipart the raw content of this part with all sub parts is returned

Returns

string body

Exceptions

Zend_Mail_Exception

Definition at line 156 of file File.php.

    {
        fseek($this->_fh, $this->_contentPos[0]);
        if ($stream !== null) {
            return stream_copy_to_stream($this->_fh, $stream, $this->_contentPos[1] - $this->_contentPos[0]);
        }
        $length = $this->_contentPos[1] - $this->_contentPos[0];
        return $length < 1 ? '' : fread($this->_fh, $length);
    }

getPart()

getPart

(

$num

)

Get part of multipart message

Parameters

int

$num

number of part starting with 1 for first part

Returns

Zend_Mail_Part wanted part

Exceptions

Zend_Mail_Exception

See also

Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

Definition at line 184 of file File.php.

    {
        --$num;
        if (!isset($this->_partPos[$num])) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('part not found');
        }

        return new self(array('file' => $this->_fh, 'startPos' => $this->_partPos[$num][0],
                              'endPos' => $this->_partPos[$num][1]));
    }

getSize()

getSize

(

)

Return size of part

Quite simple implemented currently (not decoding). Handle with care.

Returns

int size

Implements Zend_Mail_Part_Interface.

Definition at line 173 of file File.php.

                              {
        return $this->_contentPos[1] - $this->_contentPos[0];
    }

Field Documentation

$_contentPos

$_contentPos = array()

protected

Definition at line 42 of file File.php.

$_fh

$_fh

protected

Definition at line 44 of file File.php.

$_partPos

$_partPos = array()

protected

Definition at line 43 of file File.php.

---

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

• vendor/magento/zendframework1/library/Zend/Mail/Part/File.php