Zend_Mail_Part Class Reference

Inheritance diagram for Zend_Mail_Part:

Public Member Functions
	__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 Member Functions
	_cacheContent ()
	_validateHeaders (array $headers, $assertNames=true)

Protected Attributes
	$_headers
	$_content
	$_topLines = ''
	$_parts = array()
	$_countParts
	$_iterationPos = 1
	$_mail
	$_messageNum = 0
	$_partClass

Detailed Description

Definition at line 50 of file Part.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$params

)

Public constructor

Zend_Mail_Part supports different sources for content. The possible params are:

• handler a instance of Zend_Mail_Storage_Abstract for late fetch
• id number of message for handler
• raw raw content with header and body as string
• headers headers as array (name => value) or string, if a content part is found it's used as toplines
• noToplines ignore content found after headers in param 'headers'
• content content as string

Parameters

array

$params

full message with or without headers

Exceptions

Zend_Mail_Exception

See also

Zend_Mail_Exception

Zend_Mail_Exception

Definition at line 120 of file Part.php.

    {
        if (isset($params['handler'])) {
            if (!$params['handler'] instanceof Zend_Mail_Storage_Abstract) {
                #require_once 'Zend/Mail/Exception.php';
                throw new Zend_Mail_Exception('handler is not a valid mail handler');
            }
            if (!isset($params['id'])) {
                #require_once 'Zend/Mail/Exception.php';
                throw new Zend_Mail_Exception('need a message id with a handler');
            }

            $this->_mail       = $params['handler'];
            $this->_messageNum = $params['id'];
        }

        if (isset($params['partclass'])) {
            $this->setPartClass($params['partclass']);
        }

        if (isset($params['raw'])) {
            Zend_Mime_Decode::splitMessage($params['raw'], $this->_headers, $this->_content, "\r\n");
        } else if (isset($params['headers'])) {
            if (is_array($params['headers'])) {
                $this->_headers = $params['headers'];
                $this->_validateHeaders($this->_headers);
            } else {
                if (!empty($params['noToplines'])) {
                    Zend_Mime_Decode::splitMessage($params['headers'], $this->_headers, $null, "\r\n");
                } else {
                    Zend_Mime_Decode::splitMessage($params['headers'], $this->_headers, $this->_topLines, "\r\n");
                }
            }

            if (isset($params['content'])) {
                $this->_content = $params['content'];
            }
        }
    }

Member Function Documentation

__get()

__get

(

$name

)

Getter for mail headers - name is matched in lowercase

This getter is short for Zend_Mail_Part::getHeader($name, 'string')

See also

Zend_Mail_Part::getHeader()

Parameters

string

$name

header name

Returns

string value of header

Exceptions

Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

Definition at line 477 of file Part.php.

    {
        return $this->getHeader($name, 'string');
    }

__isset()

__isset

(

$name

)

Isset magic method proxy to hasHeader

This method is short syntax for Zend_Mail_Part::hasHeader($name);

See also

Zend_Mail_Part::hasHeader

Parameters

string

Returns

boolean

Definition at line 492 of file Part.php.

    {
        return $this->headerExists($name);
    }

__toString()

__toString

(

)

magic method to get content of part

Returns

string content

Implements Zend_Mail_Part_Interface.

Definition at line 502 of file Part.php.

    {
        return $this->getContent();
    }

_cacheContent()

_cacheContent ( )

protected

Cache content and split in parts if multipart

Returns

null

Exceptions

Zend_Mail_Exception

See also

Zend_Mail_Exception

Definition at line 262 of file Part.php.

    {
        // caching content if we can't fetch parts
        if ($this->_content === null && $this->_mail) {
            $this->_content = $this->_mail->getRawContent($this->_messageNum);
        }

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

        // split content in parts
        $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');
        }
        $parts = Zend_Mime_Decode::splitMessageStruct($this->_content, $boundary);
        if ($parts === null) {
            return;
        }
        $partClass = $this->getPartClass();
        $counter = 1;
        foreach ($parts as $part) {
            $this->_parts[$counter++] = new $partClass(array('headers' => $part['header'], 'content' => $part['body']));
        }
    }

_validateHeaders()

_validateHeaders ( array  $headers,   $assertNames = true  )

protected

Ensure headers do not contain invalid characters

Parameters

array	$headers
bool	$assertNames

Definition at line 588 of file Part.php.

    {
        foreach ($headers as $name => $value) {
            if ($assertNames) {
                Zend_Mail_Header_HeaderName::assertValid($name);
            }

            if (is_array($value)) {
                $this->_validateHeaders($value, false);
                continue;
            }

            Zend_Mail_Header_HeaderValue::assertValid($value);
        }
    }

countParts()

countParts

(

)

Count parts of a multipart part

Returns

int number of sub-parts

Implements Zend_Mail_Part_Interface.

Definition at line 337 of file Part.php.

    {
        if ($this->_countParts) {
            return $this->_countParts;
        }

        $this->_countParts = count($this->_parts);
        if ($this->_countParts) {
            return $this->_countParts;
        }

        if ($this->_mail && $this->_mail->hasFetchPart) {
            // TODO: fetch part
            // return
        }

        $this->_cacheContent();

        $this->_countParts = count($this->_parts);
        return $this->_countParts;
    }

current()

current

(

)

implements Iterator::current()

Returns

Zend_Mail_Part current part

Definition at line 566 of file Part.php.

    {
        return $this->getPart($this->_iterationPos);
    }

getChildren()

getChildren

(

)

implements RecursiveIterator::getChildren()

Returns

Zend_Mail_Part same as self::current()

Definition at line 523 of file Part.php.

    {
        return $this->current();
    }

getContent()

getContent

(

)

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

See also

Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

Definition at line 227 of file Part.php.

    {
        if ($this->_content !== null) {
            return $this->_content;
        }

        if ($this->_mail) {
            return $this->_mail->getRawContent($this->_messageNum);
        } else {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('no content');
        }
    }

getHeader()

getHeader	(		$name,
			$format = null
	)

Get a header in specificed format

Internally headers that occur more than once are saved as array, all other as string. If $format is set to string implode is used to concat the values (with Zend_Mime::LINEEND as delim).

Parameters

string	$name	name of header, matches case-insensitive, but camel-case is replaced with dashes
string	$format	change type of return value to 'string' or 'array'

Returns

string|array value of header in wanted or internal format

Exceptions

Zend_Mail_Exception

See also

Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

Definition at line 393 of file Part.php.

    {
        if ($this->_headers === null) {
            $this->getHeaders();
        }

        $lowerName = strtolower($name);

        if ($this->headerExists($name) == false) {
            $lowerName = strtolower(preg_replace('%([a-z])([A-Z])%', '\1-\2', $name));
            if($this->headerExists($lowerName) == false) {
                #require_once 'Zend/Mail/Exception.php';
                throw new Zend_Mail_Exception("no Header with Name $name or $lowerName found");
            }
        }
        $name = $lowerName;

        $header = $this->_headers[$name];

        switch ($format) {
            case 'string':
                if (is_array($header)) {
                    $header = implode(Zend_Mime::LINEEND, $header);
                }
                break;
            case 'array':
                $header = (array)$header;
            default:
                // do nothing
        }

        return $header;
    }

getHeaderField()

getHeaderField	(		$name,
			$wantedPart = 0,
			$firstName = 0
	)

Get a specific field from a header like content type or all fields as array

If the header occurs more than once, only the value from the first header is returned.

Throws a Zend_Mail_Exception if the requested header does not exist. If the specific header field does not exist, returns null.

Parameters

string	$name	name of header, like in getHeader()
string	$wantedPart	the wanted part, default is first, if null an array with all parts is returned
string	$firstName	key name for the first part

Returns

string|array wanted part or all parts as array($firstName => firstPart, partname => value)

Exceptions

Zend_Exception,Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

Definition at line 461 of file Part.php.

                                                                           {
        return Zend_Mime_Decode::splitHeaderField(current($this->getHeader($name, 'array')), $wantedPart, $firstName);
    }

getHeaders()

getHeaders

(

)

Get all headers

The returned headers are as saved internally. All names are lowercased. The value is a string or an array if a header with the same name occurs more than once.

Returns

array headers as array(name => value)

Implements Zend_Mail_Part_Interface.

Definition at line 368 of file Part.php.

    {
        if ($this->_headers === null) {
            if (!$this->_mail) {
                $this->_headers = array();
            } else {
                $part = $this->_mail->getRawHeader($this->_messageNum);
                Zend_Mime_Decode::splitMessage($part, $this->_headers, $null);
            }
        }

        return $this->_headers;
    }

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

Zend_Mail_Exception

Implements Zend_Mail_Part_Interface.

Definition at line 300 of file Part.php.

    {
        if (isset($this->_parts[$num])) {
            return $this->_parts[$num];
        }

        if (!$this->_mail && $this->_content === null) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('part not found');
        }

        if ($this->_mail && $this->_mail->hasFetchPart) {
            // TODO: fetch part
            // return
        }

        $this->_cacheContent();

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

        return $this->_parts[$num];
    }

getPartClass()

getPartClass

(

)

Retrieve the class name used to encapsulate message parts

Returns

string

Definition at line 196 of file Part.php.

    {
        if ( !$this->_partClass ) {
            $this->_partClass = __CLASS__;
        }
        return $this->_partClass;
    }

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 251 of file Part.php.

                              {
        return strlen($this->getContent());
    }

hasChildren()

hasChildren

(

)

implements RecursiveIterator::hasChildren()

Returns

bool current element has children/is multipart

Definition at line 512 of file Part.php.

    {
        $current = $this->current();
        return $current && $current instanceof Zend_Mail_Part && $current->isMultipart();
    }

headerExists()

headerExists

(

$name

)

Check wheater the Mail part has a specific header.

Parameters

string

$name

Returns

boolean

Definition at line 436 of file Part.php.

    {
        $name = strtolower($name);
        if(isset($this->_headers[$name])) {
            return true;
        } else {
            return false;
        }
    }

isMultipart()

isMultipart

(

)

Check if part is a multipart message

Returns

bool if part is multipart

Implements Zend_Mail_Part_Interface.

Definition at line 209 of file Part.php.

    {
        try {
            return stripos($this->contentType, 'multipart/') === 0;
        } catch(Zend_Mail_Exception $e) {
            return false;
        }
    }

key()

key

(

)

implements Iterator::key()

Returns

string key/number of current part

Definition at line 556 of file Part.php.

    {
        return $this->_iterationPos;
    }

next()

next

(

)

implements Iterator::next()

Returns

null

Definition at line 546 of file Part.php.

    {
        ++$this->_iterationPos;
    }

rewind()

rewind

(

)

implements Iterator::rewind()

Returns

null

Definition at line 576 of file Part.php.

    {
        $this->countParts();
        $this->_iterationPos = 1;
    }

setPartClass()

setPartClass

(

$class

)

Set name pf class used to encapsulate message parts

Parameters

string

$class

Returns

Zend_Mail_Part

See also

Zend_Mail_Exception

Zend_Mail_Exception

Definition at line 171 of file Part.php.

    {
        if ( !class_exists($class) ) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception("Class '{$class}' does not exist");
        }
        if ( !is_subclass_of($class, 'Zend_Mail_Part_Interface') ) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception("Class '{$class}' must implement Zend_Mail_Part_Interface");
        }

        $this->_partClass = $class;
        return $this;
    }

valid()

valid

(

)

implements Iterator::valid()

Returns

bool check if there's a current element

Definition at line 533 of file Part.php.

    {
        if ($this->_countParts === null) {
            $this->countParts();
        }
        return $this->_iterationPos && $this->_iterationPos <= $this->_countParts;
    }

Field Documentation

$_content

$_content

protected

Definition at line 62 of file Part.php.

$_countParts

$_countParts

protected

Definition at line 80 of file Part.php.

$_headers

$_headers

protected

Definition at line 56 of file Part.php.

$_iterationPos

$_iterationPos = 1

protected

Definition at line 86 of file Part.php.

$_mail

$_mail

protected

Definition at line 92 of file Part.php.

$_messageNum

$_messageNum = 0

protected

Definition at line 98 of file Part.php.

$_partClass

$_partClass

protected

Definition at line 104 of file Part.php.

$_parts

$_parts = array()

protected

Definition at line 74 of file Part.php.

$_topLines

$_topLines = ''

protected

Definition at line 68 of file Part.php.

---

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

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