Zend_Mail_Header_HeaderValue Class Reference

Static Public Member Functions
static	filter ($value)
static	isValid ($value)
static	assertValid ($value)

Detailed Description

Definition at line 29 of file HeaderValue.php.

Member Function Documentation

assertValid()

static assertValid (   $value )

static

Assert that the header value is valid.

Raises an exception if invalid.

Parameters

string

$value

Exceptions

Exception

Definition at line 129 of file HeaderValue.php.

    {
        if (! self::isValid($value)) {
            #require_once 'Zend/Mail/Exception.php';
            throw new Zend_Mail_Exception('Invalid header value detected');
        }
    }

filter()

static filter (   $value )

static

Filter the header value according to RFC 2822

See also

http://www.rfc-base.org/txt/rfc-2822.txt (section 2.2)

Parameters

string

$value

Returns

string

Definition at line 45 of file HeaderValue.php.

    {
        $result = '';
        $tot    = strlen($value);

        // Filter for CR and LF characters, leaving CRLF + WSP sequences for
        // Long Header Fields (section 2.2.3 of RFC 2822)
        for ($i = 0; $i < $tot; $i += 1) {
            $ord = ord($value[$i]);
            if (($ord < 32 || $ord > 126)
                && $ord !== 13
            ) {
                continue;
            }

            if ($ord === 13) {
                if ($i + 2 >= $tot) {
                    continue;
                }

                $lf = ord($value[$i + 1]);
                $sp = ord($value[$i + 2]);

                if ($lf !== 10 || $sp !== 32) {
                    continue;
                }

                $result .= "\r\n ";
                $i += 2;
                continue;
            }

            $result .= $value[$i];
        }

        return $result;
    }

isValid()

static isValid (   $value )

static

Determine if the header value contains any invalid characters.

See also

http://www.rfc-base.org/txt/rfc-2822.txt (section 2.2)

Parameters

string

$value

Returns

bool

Definition at line 90 of file HeaderValue.php.

    {
        $tot = strlen($value);
        for ($i = 0; $i < $tot; $i += 1) {
            $ord = ord($value[$i]);
            if (($ord < 32 || $ord > 126)
                && $ord !== 13
            ) {
                return false;
            }

            if ($ord === 13) {
                if ($i + 2 >= $tot) {
                    return false;
                }

                $lf = ord($value[$i + 1]);
                $sp = ord($value[$i + 2]);

                if ($lf !== 10 || $sp !== 32) {
                    return false;
                }

                $i += 2;
            }
        }

        return true;
    }

---

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

• vendor/magento/zendframework1/library/Zend/Mail/Header/HeaderValue.php