Represents a name/value pair part of a header.

public ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::MIME_PART_PATTERN = '=\?[^?=]+\?[QBqb]\?[^\?]+\?='
  • var string regex pattern matching a mime-encoded part
public ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::MIME_PART_PATTERN_NO_QUOTES = '=\?[^\?=]+\?[QBqb]\?[^\?"]+\?='
  • var string regex pattern used when parsing parameterized headers
public __construct(ZBateson\MbWrapper\MbWrapper $charsetConverter, $name, $value, $language = NULL)

Constructs a ParameterPart out of a name/value pair. The name and
value are both mime-decoded if necessary.

If $language is provided, $name and $value are not mime-decoded. Instead,
they're taken as literals as part of a SplitParameterToken.

  • param string $name
  • param string $value
  • param string $language
public ZBateson\MailMimeParser\Header\Part\HeaderPart::__toString() : string

Returns the value of the part (which is a string).

  • return string the value
public getLanguage()

Returns the RFC-1766 (or subset) language tag, if the parameter is a
split RFC-2231 part with a language tag set.

  • return string the language
public ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::getLanguageArray()

Returns an array of parts mapped to languages in the header value, for
instance the string:

'Hello and =?UTF-8fr-be?Q?bonjour_?= =?UTF-8it?Q?mi amici?=. Welcome!'

Would be mapped in the returned array as follows:

    0 => [ 'lang' => null, 'value' => 'Hello and ' ],
    1 => [ 'lang' => 'fr-be', 'value' => 'bonjour ' ],
    3 => [ 'lang' => 'it', 'value' => 'mi amici' ],
    4 => [ 'lang' => null, 'value' => ' Welcome!' ]
  • return string[][]
public getName()

Returns the name of the parameter.

  • return string The name.
public ZBateson\MailMimeParser\Header\Part\HeaderPart::getValue() : ?string

Returns the part's value.

  • return ?string the value of the part
public ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::ignoreSpacesAfter() : bool

Returns true if spaces before this part should be ignored.

Overridden to return $this->canIgnoreSpacesAfter which is setup in the

public ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::ignoreSpacesBefore() : bool

Returns true if spaces before this part should be ignored.

Overridden to return $this->canIgnoreSpacesBefore which is setup in the

protected ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::$canIgnoreSpacesAfter = false
  • var bool set to true to ignore spaces after this part
protected ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::$canIgnoreSpacesBefore = false
  • var bool set to true to ignore spaces before this part
protected ZBateson\MailMimeParser\Header\Part\HeaderPart::$charsetConverter = NULL
  • var \MbWrapper $charsetConverter the charset converter used for
    converting strings in HeaderPart::convertEncoding
protected $language = NULL
  • var string the RFC-1766 language tag if set.
protected ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::$languages = []
  • var array maintains an array mapping rfc1766 language tags to parts of
    text in the value.

    Each array element is an array containing two elements, one with key
    'lang', and another with key 'value'.
protected $name = NULL
  • var string the name of the parameter
protected ZBateson\MailMimeParser\Header\Part\HeaderPart::$value = NULL
  • var string the value of the part
protected ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::addToLanguage(string $part, ?string $language = NULL) : self

Adds the passed part into the languages array with the given language.

protected ZBateson\MailMimeParser\Header\Part\HeaderPart::convertEncoding(string $str, string $from = 'ISO-8859-1', bool $force = false) : string

Ensures the encoding of the passed string is set to UTF-8.

The method does nothing if the passed $from charset is UTF-8 already, or
if $force is set to false and mb_check_encoding for $str returns true
for 'UTF-8'.

  • return string utf-8 string
protected ZBateson\MailMimeParser\Header\Part\MimeLiteralPart::decodeMime(string $value) : string

Finds and replaces mime parts with their values.

The method splits the token value into an array on mime-part-patterns,
either replacing a mime part with its value by calling iconv_mime_decode
or converts the encoding on the text part by calling convertEncoding.

© 2023 Bruce Wells
Search Namespaces \ Classes