Zend_Mime_Message Class Reference

Inheritance diagram for Zend_Mime_Message:

Public Member Functions
	getParts ()
	setParts ($parts)
	addPart (Zend_Mime_Part $part)
	isMultiPart ()
	setMime (Zend_Mime $mime)
	getMime ()
	generateMessage ($EOL=Zend_Mime::LINEEND)
	getPartHeadersArray ($partnum)
	getPartHeaders ($partnum, $EOL=Zend_Mime::LINEEND)
	getPartContent ($partnum, $EOL=Zend_Mime::LINEEND)

Static Public Member Functions
static	createFromMessage ( $message, $boundary, $EOL=Zend_Mime::LINEEND)

Static Protected Member Functions
static	_disassembleMime ($body, $boundary)

Protected Attributes
	$_parts = array()
	$_mime = null

Detailed Description

Definition at line 38 of file Message.php.

Member Function Documentation

_disassembleMime()

static _disassembleMime (   $body,   $boundary  )

staticprotected

Explode MIME multipart string into seperate parts

Parts consist of the header and the body of each MIME part.

Parameters

string	$body
string	$boundary

Exceptions

Zend_Exception

Returns

array

Definition at line 213 of file Message.php.

    {
        $start = 0;
        $res   = array();
        // find every mime part limiter and cut out the
        // string before it.
        // the part before the first boundary string is discarded:
        $p = strpos($body, '--' . $boundary . "\n", $start);
        if ($p === false) {
            // no parts found!
            return array();
        }

        // position after first boundary line
        $start = $p + 3 + strlen($boundary);

        while (($p = strpos($body, '--' . $boundary . "\n", $start))
               !== false) {
            $res[] = substr($body, $start, $p - $start);
            $start = $p + 3 + strlen($boundary);
        }

        // no more parts, find end boundary
        $p = strpos($body, '--' . $boundary . '--', $start);
        if ($p === false) {
            throw new Zend_Exception('Not a valid Mime Message: End Missing');
        }

        // the remaining part also needs to be parsed:
        $res[] = substr($body, $start, $p - $start);

        return $res;
    }

addPart()

addPart

(

Zend_Mime_Part

$part

)

Append a new Zend_Mime_Part to the current message

Parameters

Zend_Mime_Part

$part

Todo:

check for duplicate object handle

Definition at line 79 of file Message.php.

    {
        $this->_parts[] = $part;
    }

createFromMessage()

static createFromMessage (   $message,   $boundary,   $EOL = Zend_Mime::LINEEND  )

static

Decodes a MIME encoded string and returns a Zend_Mime_Message object with all the MIME parts set according to the given string

Parameters

string	$message
string	$boundary
string	$EOL	EOL string; defaults to Zend_Mime::LINEEND

Exceptions

Zend_Exception

Returns

Zend_Mime_Message

Todo:

check for characterset and filename

Definition at line 257 of file Message.php.

    {
        #require_once 'Zend/Mime/Decode.php';
        $parts = Zend_Mime_Decode::splitMessageStruct($message, $boundary, $EOL);

        $res = new self();
        foreach ($parts as $part) {
            // now we build a new MimePart for the current Message Part:
            $newPart = new Zend_Mime_Part($part['body']);
            foreach ($part['header'] as $key => $value) {
                switch (strtolower($key)) {
                    case 'content-type':
                        $newPart->type = $value;
                        break;
                    case 'content-transfer-encoding':
                        $newPart->encoding = $value;
                        break;
                    case 'content-id':
                        $newPart->id = trim($value, '<>');
                        break;
                    case 'content-disposition':
                        $newPart->disposition = $value;
                        break;
                    case 'content-description':
                        $newPart->description = $value;
                        break;
                    case 'content-location':
                        $newPart->location = $value;
                        break;
                    case 'content-language':
                        $newPart->language = $value;
                        break;
                    default:
                        throw new Zend_Exception(
                            'Unknown header ignored for MimePart:' . $key
                        );
                }
            }
            $res->addPart($newPart);
        }

        return $res;
    }

generateMessage()

generateMessage

(

$EOL = Zend_Mime::LINEEND

)

Generate MIME-compliant message from the current configuration

This can be a multipart message if more than one MIME part was added. If only one part is present, the content of this part is returned. If no part had been added, an empty string is returned.

Parts are seperated by the mime boundary as defined in Zend_Mime. If setMime() has been called before this method, the Zend_Mime object set by this call will be used. Otherwise, a new Zend_Mime object is generated and used.

Parameters

string

$EOL

EOL string; defaults to Zend_Mime::LINEEND

Returns

string

Definition at line 143 of file Message.php.

    {
        if (!$this->isMultiPart()) {
            $body = array_shift($this->_parts);
            $body = $body->getContent($EOL);
        } else {
            $mime = $this->getMime();

            $boundaryLine = $mime->boundaryLine($EOL);
            $body = 'This is a message in Mime Format.  If you see this, '
                  . "your mail reader does not support this format." . $EOL;

            foreach (array_keys($this->_parts) as $p) {
                $body .= $boundaryLine
                         . $this->getPartHeaders($p, $EOL)
                         . $EOL
                         . $this->getPartContent($p, $EOL);
            }

            $body .= $mime->mimeEnd($EOL);
        }

        return trim($body);
    }

getMime()

getMime

(

)

Returns the Zend_Mime object in use by the message

If the object was not present, it is created and returned. Can be used to determine the boundary used in this message.

Returns

Zend_Mime

Definition at line 119 of file Message.php.

    {
        if ($this->_mime === null) {
            $this->_mime = new Zend_Mime();
        }

        return $this->_mime;
    }

getPartContent()

getPartContent	(		$partnum,
			$EOL = Zend_Mime::LINEEND
	)

Get the (encoded) content of a given part as a string

Parameters

int	$partnum
string	$EOL

Returns

string

Definition at line 198 of file Message.php.

    {
        return $this->_parts[$partnum]->getContent($EOL);
    }

getPartHeaders()

getPartHeaders	(		$partnum,
			$EOL = Zend_Mime::LINEEND
	)

Get the headers of a given part as a string

Parameters

int	$partnum
string	$EOL

Returns

string

Definition at line 186 of file Message.php.

    {
        return $this->_parts[$partnum]->getHeaders($EOL);
    }

getPartHeadersArray()

getPartHeadersArray

(

$partnum

)

Get the headers of a given part as an array

Parameters

int

$partnum

Returns

array

Definition at line 174 of file Message.php.

    {
        return $this->_parts[$partnum]->getHeadersArray();
    }

getParts()

getParts

(

)

Returns the list of all Zend_Mime_Parts in the message

Returns

array of Zend_Mime_Part

Definition at line 59 of file Message.php.

    {
        return $this->_parts;
    }

isMultiPart()

isMultiPart

(

)

Check if message needs to be sent as multipart MIME message or if it has only one part.

Returns

boolean

Definition at line 93 of file Message.php.

    {
        return (count($this->_parts) > 1);
    }

setMime()

setMime

(

Zend_Mime

$mime

)

Set Zend_Mime object for the message

This can be used to set the boundary specifically or to use a subclass of Zend_Mime for generating the boundary.

Parameters

Zend_Mime

$mime

Definition at line 106 of file Message.php.

    {
        $this->_mime = $mime;
    }

setParts()

setParts

(

$parts

)

Sets the given array of Zend_Mime_Parts as the array for the message

Parameters

array

$parts

Definition at line 69 of file Message.php.

    {
        $this->_parts = $parts;
    }

Field Documentation

$_mime

$_mime = null

protected

Definition at line 52 of file Message.php.

$_parts

$_parts = array()

protected

Definition at line 45 of file Message.php.

---

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

• vendor/magento/zendframework1/library/Zend/Mime/Message.php