MailMimeParser 2.1

AddressGroupPart extends MimeLiteralPart
in package

Holds a group of addresses, and an optional group name.

Because AddressGroupConsumer is only called once a colon (":") character is found, an AddressGroupPart is initially constructed without a $name. Once it is returned to AddressConsumer, a new AddressGroupPart is created out of AddressGroupConsumer's AddressGroupPart.

Tags
author

Zaahid Bateson

Table of Contents

MIME_PART_PATTERN  = '=\?[^?=]+\?[QBqb]\?[^\?]+\?='
MIME_PART_PATTERN_NO_QUOTES  = '=\?[^\?=]+\?[QBqb]\?[^\?"]+\?='
$addresses  : array<string|int, AddressPart>
$canIgnoreSpacesAfter  : bool
$canIgnoreSpacesBefore  : bool
$charsetConverter  : MbWrapper
$languages  : array<string|int, mixed>
$value  : string
__construct()  : mixed
Creates an AddressGroupPart out of the passed array of AddressParts and an optional name (which may be mime-encoded).
__toString()  : string
Returns the value of the part (which is a string).
getAddress()  : AddressPart|null
Returns the AddressPart at the passed index or null.
getAddresses()  : array<string|int, AddressPart>
Return the AddressGroupPart's array of addresses.
getLanguageArray()  : array<string|int, array<string|int, string>>
Returns an array of parts mapped to languages in the header value, for instance the string:
getName()  : string
Returns the name of the group
getValue()  : string
Returns the part's value.
ignoreSpacesAfter()  : bool
Returns true if spaces after this part should be ignored. True is only returned for MimeLiterals if the part ends with a mime-encoded string Tokens if the Token's value is a single space, and for CommentParts.
ignoreSpacesBefore()  : bool
Returns true if spaces before this part should be ignored. True is only returned for MimeLiterals if the part begins with a mime-encoded string, Tokens if the Token's value is a single space, and for CommentParts.
addToLanguage()  : mixed
Adds the passed part into the languages array with the given language.
convertEncoding()  : string
Ensures the encoding of the passed string is set to UTF-8.
decodeMime()  : string
Finds and replaces mime parts with their values.
decodeMatchedEntity()  : string
Decodes a matched mime entity part into a string and returns it, after adding the string into the languages array.
decodeSplitPart()  : string
Decodes a single mime-encoded entity.

Constants

MIME_PART_PATTERN

public string MIME_PART_PATTERN = '=\?[^?=]+\?[QBqb]\?[^\?]+\?='

regex pattern matching a mime-encoded part

MIME_PART_PATTERN_NO_QUOTES

public string MIME_PART_PATTERN_NO_QUOTES = '=\?[^\?=]+\?[QBqb]\?[^\?"]+\?='

regex pattern used when parsing parameterized headers

Properties

$canIgnoreSpacesAfter

protected bool $canIgnoreSpacesAfter = false

set to true to ignore spaces after this part

$canIgnoreSpacesBefore

protected bool $canIgnoreSpacesBefore = false

set to true to ignore spaces before this part

$charsetConverter

protected MbWrapper $charsetConverter

the charset converter used for converting strings in HeaderPart::convertEncoding

$languages

protected array<string|int, mixed> $languages = []

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

$value

protected string $value

the value of the part

Methods

__construct()

Creates an AddressGroupPart out of the passed array of AddressParts and an optional name (which may be mime-encoded).

public __construct(MbWrapper $charsetConverter, array<string|int, AddressPart$addresses[, string $name = '' ]) : mixed
Parameters
$charsetConverter : MbWrapper
$addresses : array<string|int, AddressPart>
$name : string = ''
Return values
mixed

__toString()

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

public __toString() : string
Return values
string

the value

getAddress()

Returns the AddressPart at the passed index or null.

public getAddress(int $index) : AddressPart|null
Parameters
$index : int

The 0-based index.

Return values
AddressPart|null

The address.

getAddresses()

Return the AddressGroupPart's array of addresses.

public getAddresses() : array<string|int, AddressPart>
Return values
array<string|int, AddressPart>

An array of address parts.

getLanguageArray()

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

public getLanguageArray() : array<string|int, array<string|int, 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 values
array<string|int, array<string|int, string>>

getName()

Returns the name of the group

public getName() : string
Return values
string

The name

getValue()

Returns the part's value.

public getValue() : string
Return values
string

the value of the part

ignoreSpacesAfter()

Returns true if spaces after this part should be ignored. True is only returned for MimeLiterals if the part ends with a mime-encoded string Tokens if the Token's value is a single space, and for CommentParts.

public ignoreSpacesAfter() : bool
Return values
bool

ignoreSpacesBefore()

Returns true if spaces before this part should be ignored. True is only returned for MimeLiterals if the part begins with a mime-encoded string, Tokens if the Token's value is a single space, and for CommentParts.

public ignoreSpacesBefore() : bool
Return values
bool

addToLanguage()

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

protected addToLanguage(string $part[, string|null $language = null ]) : mixed
Parameters
$part : string
$language : string|null = null
Return values
mixed

convertEncoding()

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

protected convertEncoding(string $str[, string $from = 'ISO-8859-1' ][, bool $force = false ]) : string

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

Parameters
$str : string
$from : string = 'ISO-8859-1'
$force : bool = false
Return values
string

utf-8 string

decodeMime()

Finds and replaces mime parts with their values.

protected decodeMime(string $value) : string

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.

Parameters
$value : string
Return values
string

decodeMatchedEntity()

Decodes a matched mime entity part into a string and returns it, after adding the string into the languages array.

private decodeMatchedEntity(array<string|int, string> $matches) : string
Parameters
$matches : array<string|int, string>
Return values
string

decodeSplitPart()

Decodes a single mime-encoded entity.

private decodeSplitPart(string $entity) : string

Unfortunately, mb_decode_header fails for many charsets on PHP 5.4 and PHP 5.5 (even if they're listed as supported). iconv_mime_decode doesn't support all charsets.

Parsing out the charset and body of the encoded entity seems to be the way to go to support the most charsets.

Parameters
$entity : string
Return values
string

Search results