MailMimeParser 3.0

AddressConsumerService extends AbstractConsumerService
in package

Parses a single part of an address header.

Represents a single part of a list of addresses. A part could be one email address, or one 'group' containing multiple addresses. The consumer ends on finding either a comma token, representing a separation between addresses, or a semi-colon token representing the end of a group.

A single email address may consist of just an email, or a name and an email address. Both of these are valid examples of a From header:

Groups must be named, for example:

Addresses may contain quoted parts and comments, and names may be mime-header encoded.

Tags
author

Zaahid Bateson

Table of Contents

$logger  : LoggerInterface
$partFactory  : HeaderPartFactory
$subConsumers  : array<string|int, mixed>
$tokenSplitPattern  : string|null
__construct()  : mixed
__invoke()  : array<string|int, IHeaderPart>
Invokes parsing of a header's value into header parts.
getTokenSeparators()  : array<string|int, string>
Overridden to return patterns matching end tokens ("," and ";"), and whitespace.
advanceToNextToken()  : static
Determines if the iterator should be advanced to the next token after reading tokens or finding a start token.
getAllConsumers()  : array<string|int, AbstractConsumerService>
Returns this consumer and all unique sub consumers.
getAllTokenSeparators()  : array<string|int, string>
Returns a list of regular expression markers for this consumer and all sub-consumers by calling getTokenSeparators().
getConsumerTokenParts()  : array<string|int, IHeaderPart>
Iterates through this consumer's sub-consumers checking if the current token triggers a sub-consumer's start token and passes control onto that sub-consumer's parseTokenIntoParts().
getPartForToken()  : IHeaderPart|null
Constructs and returns an IHeaderPart for the passed string token.
getTokenParts()  : array<string|int, IHeaderPart>
Returns an array of IHeaderPart for the current token on the iterator.
getTokenSplitPattern()  : string
Returns a regex pattern used to split the input header string.
isEndToken()  : bool
Returns true for commas and semi-colons.
isStartToken()  : bool
AddressConsumer is "greedy", so this always returns true.
parseTokensIntoParts()  : array<string|int, IHeaderPart>
Iterates over the passed token Iterator and returns an array of parsed IHeaderPart objects.
processParts()  : array<string|int, IHeaderPart>|array<string|int, mixed>
Performs final processing on parsed parts.
splitRawValue()  : array<string|int, string>
Returns an array of split tokens from the input string.
parseRawValue()  : array<string|int, IHeaderPart>
Parses the raw header value into header parts.

Properties

$subConsumers

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

array of sub-consumers used by this consumer if any, or an empty array if none exist.

$tokenSplitPattern

private string|null $tokenSplitPattern = null

the generated token split pattern on first run, so it doesn't need to be regenerated every time.

Methods

__construct()

public __construct(LoggerInterface $logger, MimeTokenPartFactory $partFactory, AddressGroupConsumerService $addressGroupConsumerService, AddressEmailConsumerService $addressEmailConsumerService, CommentConsumerService $commentConsumerService, QuotedStringConsumerService $quotedStringConsumerService) : mixed
Parameters
$logger : LoggerInterface
$partFactory : MimeTokenPartFactory
$addressGroupConsumerService : AddressGroupConsumerService
$addressEmailConsumerService : AddressEmailConsumerService
$commentConsumerService : CommentConsumerService
$quotedStringConsumerService : QuotedStringConsumerService
Return values
mixed

__invoke()

Invokes parsing of a header's value into header parts.

public __invoke(string $value) : array<string|int, IHeaderPart>
Parameters
$value : string

the raw header value

Return values
array<string|int, IHeaderPart>

the array of parsed parts

getTokenSeparators()

Overridden to return patterns matching end tokens ("," and ";"), and whitespace.

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

the patterns

advanceToNextToken()

Determines if the iterator should be advanced to the next token after reading tokens or finding a start token.

protected advanceToNextToken(Iterator $tokens, bool $isStartToken) : static

The default implementation will advance for a start token, but not advance on the end token of the current consumer, allowing the end token to be passed up to a higher-level consumer.

Parameters
$tokens : Iterator

The token iterator.

$isStartToken : bool

true for the start token.

Return values
static

getAllConsumers()

Returns this consumer and all unique sub consumers.

protected getAllConsumers() : array<string|int, AbstractConsumerService>

Loops into the sub-consumers (and their sub-consumers, etc...) finding all unique consumers, and returns them in an array.

Return values
array<string|int, AbstractConsumerService>

Array of unique consumers.

getAllTokenSeparators()

Returns a list of regular expression markers for this consumer and all sub-consumers by calling getTokenSeparators().

protected getAllTokenSeparators() : array<string|int, string>
Return values
array<string|int, string>

Array of regular expression markers.

getConsumerTokenParts()

Iterates through this consumer's sub-consumers checking if the current token triggers a sub-consumer's start token and passes control onto that sub-consumer's parseTokenIntoParts().

protected getConsumerTokenParts(Iterator<string|int, string> $tokens) : array<string|int, IHeaderPart>

If no sub-consumer is responsible for the current token, calls AbstractConsumerService::getPartForToken() and returns it in an array.

Parameters
$tokens : Iterator<string|int, string>
Return values
array<string|int, IHeaderPart>

getPartForToken()

Constructs and returns an IHeaderPart for the passed string token.

protected getPartForToken(string $token, bool $isLiteral) : IHeaderPart|null

If the token should be ignored, the function must return null.

The default created part uses the instance's partFactory->newInstance method.

Parameters
$token : string

the token

$isLiteral : bool

set to true if the token represents a literal - e.g. an escaped token

Return values
IHeaderPart|null

The constructed header part or null if the token should be ignored.

getTokenParts()

Returns an array of IHeaderPart for the current token on the iterator.

protected getTokenParts(Iterator<string|int, string> $tokens) : array<string|int, IHeaderPart>

If the current token is a start token from a sub-consumer, the sub- consumer's AbstractConsumerService::parseTokensIntoParts() method is called.

Parameters
$tokens : Iterator<string|int, string>

The token iterator.

Return values
array<string|int, IHeaderPart>

isEndToken()

Returns true for commas and semi-colons.

protected isEndToken(string $token) : bool

Although the semi-colon is not strictly the end token of an AddressConsumerService, it could end a parent AddressGroupConsumerService.

Parameters
$token : string

The current token

Return values
bool

isStartToken()

AddressConsumer is "greedy", so this always returns true.

protected isStartToken(string $token) : bool
Parameters
$token : string

The current token

Return values
bool

parseTokensIntoParts()

Iterates over the passed token Iterator and returns an array of parsed IHeaderPart objects.

protected parseTokensIntoParts(Iterator<string|int, string> $tokens) : array<string|int, IHeaderPart>

The method checks each token to see if the token matches a sub-consumer's start token, or if it matches the current consumer's end token to stop processing.

If a sub-consumer's start token is matched, the sub-consumer is invoked and its returned parts are merged to the current consumer's header parts.

After all tokens are read and an array of Header\Parts are constructed, the array is passed to AbstractConsumerService::processParts for any final processing if there are any parts.

Parameters
$tokens : Iterator<string|int, string>

An iterator over a string of tokens

Return values
array<string|int, IHeaderPart>

An array of parsed parts

processParts()

Performs final processing on parsed parts.

protected processParts(array<string|int, IHeaderPart$parts) : array<string|int, IHeaderPart>|array<string|int, mixed>

AddressConsumerService's implementation looks for tokens representing the beginning of an address part, to create a AddressPart out of a name/address pair, or assign the name part to a parsed AddressGroupPart returned from its AddressGroupConsumerService sub-consumer.

The returned array consists of a single element - either an AddressPart or an AddressGroupPart.

Parameters
$parts : array<string|int, IHeaderPart>
Return values
array<string|int, IHeaderPart>|array<string|int, mixed>

splitRawValue()

Returns an array of split tokens from the input string.

protected splitRawValue(string $rawValue) : array<string|int, string>

The method calls preg_split using AbstractConsumerService::getTokenSplitPattern(). The split array will not contain any empty parts and will contain the markers.

Parameters
$rawValue : string

the raw string

Return values
array<string|int, string>

the array of tokens

parseRawValue()

Parses the raw header value into header parts.

private parseRawValue(string $value) : array<string|int, IHeaderPart>

Calls splitTokens to split the value into token part strings, then calls parseParts to parse the returned array.

Parameters
$value : string
Return values
array<string|int, IHeaderPart>

the array of parsed parts

Search results