Zend_Mime_Part Class Reference

Public Member Functions
	__construct ($content)
	isStream ()
	getEncodedStream ()
	getContent ($EOL=Zend_Mime::LINEEND)
	getRawContent ()
	getHeadersArray ($EOL=Zend_Mime::LINEEND)
	getHeaders ($EOL=Zend_Mime::LINEEND)

Data Fields
	$type = Zend_Mime::TYPE_OCTETSTREAM
	$encoding = Zend_Mime::ENCODING_8BIT
	$id
	$disposition
	$filename
	$description
	$charset
	$boundary
	$location
	$language

Protected Attributes
	$_content
	$_isStream = false

Detailed Description

Definition at line 35 of file Part.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$content

)

create a new Mime Part. The (unencoded) content of the Part as passed as a string or stream

Parameters

mixed

$content

String or Stream containing the content

Definition at line 127 of file Part.php.

    {
        $this->_content = $content;
        if (is_resource($content)) {
            $this->_isStream = true;
        }
    }

Member Function Documentation

getContent()

getContent

(

$EOL = Zend_Mime::LINEEND

)

Get the Content of the current Mime Part in the given encoding.

Parameters

string

$EOL

Line end; defaults to Zend_Mime::LINEEND

Exceptions

Zend_Mime_Exception

Returns

string

Definition at line 221 of file Part.php.

    {
        if ($this->_isStream) {
            return stream_get_contents($this->getEncodedStream());
        } else {
            return Zend_Mime::encode($this->_content, $this->encoding, $EOL);
        }
    }

getEncodedStream()

getEncodedStream

(

)

if this was created with a stream, return a filtered stream for reading the content. very useful for large file attachments.

Returns

mixed Stream

Exceptions

Zend_Mime_Exception

if not a stream or unable to append filter

Definition at line 161 of file Part.php.

    {
        if (!$this->_isStream) {
            #require_once 'Zend/Mime/Exception.php';
            throw new Zend_Mime_Exception(
                'Attempt to get a stream from a string part'
            );
        }

        //stream_filter_remove(); // ??? is that right?
        switch ($this->encoding) {
            case Zend_Mime::ENCODING_QUOTEDPRINTABLE:
                $filter = stream_filter_append(
                    $this->_content,
                    'convert.quoted-printable-encode',
                    STREAM_FILTER_READ,
                    array(
                        'line-length'      => 76,
                        'line-break-chars' => Zend_Mime::LINEEND
                    )
                );
                if (!is_resource($filter)) {
                    #require_once 'Zend/Mime/Exception.php';
                    throw new Zend_Mime_Exception(
                        'Failed to append quoted-printable filter'
                    );
                }
                break;

            case Zend_Mime::ENCODING_BASE64:
                $filter = stream_filter_append(
                    $this->_content,
                    'convert.base64-encode',
                    STREAM_FILTER_READ,
                    array(
                        'line-length'      => 76,
                        'line-break-chars' => Zend_Mime::LINEEND
                    )
                );
                if (!is_resource($filter)) {
                    #require_once 'Zend/Mime/Exception.php';
                    throw new Zend_Mime_Exception(
                        'Failed to append base64 filter'
                    );
                }
                break;

            default:
        }

        return $this->_content;
    }

getHeaders()

getHeaders

(

$EOL = Zend_Mime::LINEEND

)

Return the headers for this part as a string

Parameters

string

$EOL

Line end; defaults to Zend_Mime::LINEEND

Returns

string

Definition at line 324 of file Part.php.

    {
        $res = '';
        foreach ($this->getHeadersArray($EOL) as $header) {
            $res .= $header[0] . ': ' . $header[1] . $EOL;
        }

        return $res;
    }

getHeadersArray()

getHeadersArray

(

$EOL = Zend_Mime::LINEEND

)

Create and return the array of headers for this MIME part

Parameters

string

$EOL

Line end; defaults to Zend_Mime::LINEEND

Returns

array

Definition at line 250 of file Part.php.

    {
        $headers = array();

        $contentType = $this->type;
        if ($this->charset) {
            $contentType .= '; charset=' . $this->charset;
        }

        if ($this->boundary) {
            $contentType .= ';' . $EOL
                            . " boundary=\"" . $this->boundary . '"';
        }

        $headers[] = array(
            'Content-Type',
            $contentType
        );

        if ($this->encoding) {
            $headers[] = array(
                'Content-Transfer-Encoding',
                $this->encoding
            );
        }

        if ($this->id) {
            $headers[] = array(
                'Content-ID',
                '<' . $this->id . '>'
            );
        }

        if ($this->disposition) {
            $disposition = $this->disposition;
            if ($this->filename) {
                $disposition .= '; filename="' . $this->filename . '"';
            }
            $headers[] = array(
                'Content-Disposition',
                $disposition
            );
        }

        if ($this->description) {
            $headers[] = array(
                'Content-Description',
                $this->description
            );
        }

        if ($this->location) {
            $headers[] = array(
                'Content-Location',
                $this->location
            );
        }

        if ($this->language) {
            $headers[] = array(
                'Content-Language',
                $this->language
            );
        }

        return $headers;
    }

getRawContent()

getRawContent

(

)

Get the RAW unencoded content from this part

Returns

string

Definition at line 235 of file Part.php.

    {
        if ($this->_isStream) {
            return stream_get_contents($this->_content);
        } else {
            return $this->_content;
        }
    }

isStream()

isStream

(

)

Todo:

setters/getters

error checking for setting $type

error checking for setting $encoding

check if this part can be read as a stream. if true, getEncodedStream can be called, otherwise only getContent can be used to fetch the encoded content of the part

Returns

bool

Definition at line 149 of file Part.php.

    {
        return $this->_isStream;
    }

Field Documentation

$_content

$_content

protected

Definition at line 113 of file Part.php.

$_isStream

$_isStream = false

protected

Definition at line 118 of file Part.php.

$boundary

$boundary

Definition at line 92 of file Part.php.

$charset

$charset

Definition at line 85 of file Part.php.

$description

$description

Definition at line 78 of file Part.php.

$disposition

$disposition

Definition at line 64 of file Part.php.

$encoding

$encoding = Zend_Mime::ENCODING_8BIT

Definition at line 50 of file Part.php.

$filename

$filename

Definition at line 71 of file Part.php.

$id

$id

Definition at line 57 of file Part.php.

$language

$language

Definition at line 106 of file Part.php.

$location

$location

Definition at line 99 of file Part.php.

$type

$type = Zend_Mime::TYPE_OCTETSTREAM

Definition at line 43 of file Part.php.

---

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

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