Zend_Mime_Decode Class Reference

Static Public Member Functions
static	splitMime ($body, $boundary)
static	splitMessageStruct ( $message, $boundary, $EOL=Zend_Mime::LINEEND)
static	splitMessage ( $message, &$headers, &$body, $EOL=Zend_Mime::LINEEND)
static	splitContentType ($type, $wantedPart=null)
static	splitHeaderField ( $field, $wantedPart=null, $firstName=0)
static	decodeQuotedPrintable ($string)

Detailed Description

Definition at line 33 of file Decode.php.

Member Function Documentation

decodeQuotedPrintable()

static decodeQuotedPrintable (   $string )

static

decode a quoted printable encoded string

The charset of the returned string depends on your iconv settings.

Parameters

string

$string

Encoded string

Returns

string Decoded string

Definition at line 272 of file Decode.php.

    {
        return quoted_printable_decode($string);
    }

splitContentType()

static splitContentType (   $type,   $wantedPart = null  )

static

split a content type in its different parts

Parameters

string	$type	content-type
string	$wantedPart	the wanted part, else an array with all parts is returned

Returns

string|array wanted part or all parts as array('type' => content-type, partname => value)

Definition at line 203 of file Decode.php.

    {
        return self::splitHeaderField($type, $wantedPart, 'type');
    }

splitHeaderField()

static splitHeaderField (   $field,   $wantedPart = null,   $firstName = 0  )

static

split a header field like content type in its different parts

Parameters

string	$field
string	$wantedPart	the wanted part, else an array with all parts is returned
int | string	$firstName	key name for the first part

Exceptions

Zend_Exception

Returns

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

Definition at line 217 of file Decode.php.

    {
        $wantedPart = strtolower($wantedPart);
        $firstName  = strtolower($firstName);

        // special case - a bit optimized
        if ($firstName === $wantedPart) {
            $field = strtok($field, ';');

            return $field[0] == '"' ? substr($field, 1, -1) : $field;
        }

        $field = $firstName . '=' . $field;
        if (!preg_match_all('%([^=\s]+)\s*=\s*("[^"]+"|[^;]+)(;\s*|$)%', $field, $matches)) {
            throw new Zend_Exception('not a valid header field');
        }

        if ($wantedPart) {
            foreach ($matches[1] as $key => $name) {
                if (strcasecmp($name, $wantedPart)) {
                    continue;
                }
                if ($matches[2][$key][0] != '"') {
                    return $matches[2][$key];
                }

                return substr($matches[2][$key], 1, -1);
            }

            return null;
        }

        $split = array();
        foreach ($matches[1] as $key => $name) {
            $name = strtolower($name);
            if ($matches[2][$key][0] == '"') {
                $split[$name] = substr($matches[2][$key], 1, -1);
            } else {
                $split[$name] = $matches[2][$key];
            }
        }

        return $split;
    }

splitMessage()

static splitMessage (   $message, &  $headers, &  $body,   $EOL = Zend_Mime::LINEEND  )

static

split a message in header and body part, if no header or an invalid header is found $headers is empty

The charset of the returned headers depend on your iconv settings.

Parameters

string	$message	raw message with header and optional content
array	$headers	output param, array with headers as array(name => value)
string	$body	output param, content of message
string	$EOL	EOL string; defaults to Zend_Mime::LINEEND

Returns

null

Definition at line 123 of file Decode.php.

    {
        // check for valid header at first line
        $firstline = strtok($message, "\n");
        if (!preg_match('%^[^\s]+[^:]*:%', $firstline)) {
            $headers = array();
            // TODO: we're ignoring \r for now - is this function fast enough and is it safe to asume noone needs \r?
            $body = str_replace(
                array(
                    "\r",
                    "\n"
                ), array(
                    '',
                    $EOL
                ), $message
            );

            return;
        }

        // find an empty line between headers and body
        // default is set new line
        if (strpos($message, $EOL . $EOL)) {
            list($headers, $body) = explode($EOL . $EOL, $message, 2);
            // next is the standard new line
        } else {
            if ($EOL != "\r\n" && strpos($message, "\r\n\r\n")) {
                list($headers, $body) = explode("\r\n\r\n", $message, 2);
                // next is the other "standard" new line
            } else {
                if ($EOL != "\n" && strpos($message, "\n\n")) {
                    list($headers, $body) = explode("\n\n", $message, 2);
                    // at last resort find anything that looks like a new line
                } else {
                    @list($headers, $body) =
                        @preg_split("%([\r\n]+)\\1%U", $message, 2);
                }
            }
        }

        $headers = iconv_mime_decode_headers(
            $headers, ICONV_MIME_DECODE_CONTINUE_ON_ERROR
        );

        if ($headers === false) {
            // an error occurs during the decoding
            return;
        }

        // normalize header names
        foreach ($headers as $name => $header) {
            $lower = strtolower($name);
            if ($lower == $name) {
                continue;
            }
            unset($headers[$name]);
            if (!isset($headers[$lower])) {
                $headers[$lower] = $header;
                continue;
            }
            if (is_array($headers[$lower])) {
                $headers[$lower][] = $header;
                continue;
            }
            $headers[$lower] = array(
                $headers[$lower],
                $header
            );
        }
    }

splitMessageStruct()

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

static

decodes a mime encoded String and returns a struct of parts with header and body

Parameters

string	$message	raw message content
string	$boundary	boundary as found in content-type
string	$EOL	EOL string; defaults to Zend_Mime::LINEEND

Returns

array|null parts as array('header' => array(name => value), 'body' => content), null if no parts found

Exceptions

Zend_Exception

Definition at line 91 of file Decode.php.

    {
        $parts = self::splitMime($message, $boundary);
        if (count($parts) <= 0) {
            return null;
        }
        $result = array();
        foreach ($parts as $part) {
            self::splitMessage($part, $headers, $body, $EOL);
            $result[] = array(
                'header' => $headers,
                'body'   => $body
            );
        }

        return $result;
    }

splitMime()

static splitMime (   $body,   $boundary  )

static

Explode MIME multipart string into seperate parts

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

Parameters

string	$body	raw body of message
string	$boundary	boundary as found in content-type

Returns

array parts with content of each part, empty if no parts found

Exceptions

Zend_Exception

Definition at line 45 of file Decode.php.

    {
        // TODO: we're ignoring \r for now - is this function fast enough and is it safe to asume noone needs \r?
        $body = str_replace("\r", '', $body);

        $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;
    }

---

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

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