Copied!

Represents a mime header comment -- text in a structured mime header value existing within parentheses.

CloneableInstantiable
Constants
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
Methods
public __construct(ZBateson\MbWrapper\MbWrapper $charsetConverter, string $token)
 

Constructs a MimeLiteralPart, decoding the value if it's mime-encoded.

public ZBateson\MailMimeParser\Header\Part\HeaderPart::__toString() : string
 

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

  • return string the value
public getComment() : string
 

Returns the comment's text.

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 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 constructor.

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 constructor.

Properties
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 $comment = NULL
 
  • var string the contents of the comment
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 ZBateson\MailMimeParser\Header\Part\HeaderPart::$value = NULL
 
  • var string the value of the part
Methods
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.

© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration