MailMimeParser 2.3

ReceivedHeader extends ParameterHeader
in package

Represents a Received header.

The returned header value (as returned by a call to ReceivedHeader::getValue()) for a ReceivedHeader is the same as the raw value (as returned by a call to ReceivedHeader::getRawValue()) since the header doesn't have a single 'value' to consider 'the value'.

The parsed parts of a Received header can be accessed as parameters. To check if a part exists, call ReceivedHeader::hasParameter() with the name of the part, for example: php $header->hasParameter('from') or php $header->hasParameter('id') . The value of the part can be obtained by calling ReceivedHeader::getValueFor(), for example php $header->getValueFor('with'); .

Additional parsing is performed on the "FROM" and "BY" parts of a received header in an attempt to extract the self-identified name of the server, its hostname, and its address (depending on what's included). These can be accessed directly from the ReceivedHeader object by calling one of the following methods:

o ReceivedHeader::getFromName() -- the name portion of the FROM part o ReceivedHeader::getFromHostname() -- the hostname of the FROM part o ReceivedHeader::getFromAddress() -- the adddress portion of the FROM part o ReceivedHeader::getByName() -- same as getFromName, but for the BY part, and etc... below o ReceivedHeader::getByHostname() o ReceivedHeader::getByAddress()

The parsed parts of the FROM and BY parts are determined as follows:

o Anything outside and before a parenthesized expression is considered "the name", for example "FROM AlainDeBotton", "AlainDeBotton" would be the name, but also if the name is an address, but exists outside the parenthesized expression, it's still considered "the name". For example: "From [1.2.3.4]", getFromName would return "[1.2.3.4]". o A parenthesized expression MUST match what looks like either a domain name on its own, or a domain name and an address. Otherwise the parenthesized expression is considered a comment, and not parsed into hostname and address. The rules are defined loosely because many implementations differ in how strictly they follow the standard. For a domain, it's enough that the expression starts with any alphanumeric character and contains at least one '.', followed by any number of '.', '-' and alphanumeric characters. The address portion must be surrounded in square brackets, and contain any sequence of '.', ':', numbers, and characters 'a' through 'f'. In addition the string 'ipv6' may start the expression (for instance, '[ipv6:::1]' would be valid). A port number may also be considered valid as part of the address, for example: [1.2.3.4:3231]. No additional validation on the address is done, and so an invalid address such as '....' could be returned, so users using the 'address' header are encouraged to validate it before using it. The square brackets are parsed out of the returned address, so the value returned by getFromAddress() would be "2.2.2.2", not "[2.2.2.2]".

The date/time stamp can be accessed as a DateTime object by calling ReceivedHeader::getDateTime().

Parsed comments can be accessed by calling ReceivedHeader::getComments(). Some implementations may include connection encryption information or other details in non-standardized comments.

Tags
author

Zaahid Bateson

Table of Contents

$comments  : array<string|int, string>
$date  : DateTime
$name  : string
$parameters  : array<string|int, ParameterPart>
$parts  : array<string|int, IHeaderPart>
$rawValue  : string
__construct()  : mixed
Assigns the header's name and raw value, then calls getConsumer and setParseHeaderValue to extract a parsed value.
__toString()  : string
Returns the string representation of the header.
getByAddress()  : string|null
Returns the address part of a parenthesized BY part or null if not defined or the format wasn't parsed.
getByHostname()  : string|null
Returns the hostname part of a parenthesized BY part or null if not defined or the format wasn't parsed.
getByName()  : string|null
Returns the name identified in the BY part of the header or null if not defined or the format wasn't parsed.
getComments()  : array<string|int, string>
Returns an array of comments parsed from the header. If there are no comments in the header, an empty array is returned.
getDateTime()  : DateTime|null
Returns the date/time stamp for the received header if set, or null otherwise.
getFromAddress()  : string|null
Returns the address part of a parenthesized FROM part or null if not defined or the format wasn't parsed.
getFromHostname()  : string|null
Returns the hostname part of a parenthesized FROM part or null if not defined or the format wasn't parsed.
getFromName()  : string|null
Returns the name identified in the FROM part of the header or null if not defined or the format wasn't parsed.
getName()  : string
Returns the name of the header.
getParts()  : array<string|int, IHeaderPart>
Returns an array of IHeaderPart objects the header's value has been parsed into.
getRawValue()  : string
Returns the raw value of the header.
getValue()  : string|null
Returns the raw, unparsed header value, same as {@see ReceivedHeader::getRawValue()}.
getValueFor()  : string|null
Returns the value of the parameter with the given name, or $defaultValue if not set.
hasParameter()  : bool
Returns true if a parameter exists with the passed name.
getConsumer()  : AbstractConsumer
Returns a ReceivedConsumer.
setParseHeaderValue()  : static
Overridden to assign comments to $this->comments, and the DateTime to $this->date.

Properties

$comments

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

an array of comments in the header.

$date

protected DateTime $date = null

the date/time stamp in the header.

$parameters

protected array<string|int, ParameterPart> $parameters = []

key map of lower-case parameter names and associated ParameterParts.

Methods

__construct()

Assigns the header's name and raw value, then calls getConsumer and setParseHeaderValue to extract a parsed value.

public __construct(ConsumerService $consumerService, string $name, string $value) : mixed
Parameters
$consumerService : ConsumerService

For parsing the value.

$name : string

Name of the header.

$value : string

Value of the header.

Return values
mixed —

__toString()

Returns the string representation of the header.

public __toString() : string

i.e.: '<HeaderName>: <RawValue>'

Return values
string —

The string representation.

getByAddress()

Returns the address part of a parenthesized BY part or null if not defined or the format wasn't parsed.

public getByAddress() : string|null

For example, "BY name ([1.2.3.4])" would return the string "1.2.3.4". Validation of the address is not performed, and the returned value may not be valid. More details on how the value is parsed and extracted can be found in the class description for ReceivedHeader.

Return values
string|null —

The 'BY' address.

getByHostname()

Returns the hostname part of a parenthesized BY part or null if not defined or the format wasn't parsed.

public getByHostname() : string|null

For example, "BY name (host.name)" would return the string "host.name". Validation of the hostname is not performed, and the returned value may not be valid. More details on how the value is parsed and extracted can be found in the class description for ReceivedHeader.

Return values
string|null —

The 'BY' hostname.

getByName()

Returns the name identified in the BY part of the header or null if not defined or the format wasn't parsed.

public getByName() : string|null

The returned value may either be a name or an address in the form "[1.2.3.4]". Validation is not performed on this value, and so whatever exists in this position is returned -- be it contains spaces, or invalid characters, etc...

Return values
string|null —

The 'BY' name.

getComments()

Returns an array of comments parsed from the header. If there are no comments in the header, an empty array is returned.

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

getDateTime()

Returns the date/time stamp for the received header if set, or null otherwise.

public getDateTime() : DateTime|null
Return values
DateTime|null —

getFromAddress()

Returns the address part of a parenthesized FROM part or null if not defined or the format wasn't parsed.

public getFromAddress() : string|null

For example, "FROM name ([1.2.3.4])" would return the string "1.2.3.4". Validation of the address is not performed, and the returned value may not be valid. More details on how the value is parsed and extracted can be found in the class description for ReceivedHeader.

Return values
string|null —

The 'FROM' address.

getFromHostname()

Returns the hostname part of a parenthesized FROM part or null if not defined or the format wasn't parsed.

public getFromHostname() : string|null

For example, "FROM name (host.name)" would return the string "host.name". Validation of the hostname is not performed, and the returned value may not be valid. More details on how the value is parsed and extracted can be found in the class description for ReceivedHeader.

Return values
string|null —

The 'FROM' hostname.

getFromName()

Returns the name identified in the FROM part of the header or null if not defined or the format wasn't parsed.

public getFromName() : string|null

The returned value may either be a name or an address in the form "[1.2.3.4]". Validation is not performed on this value, and so whatever exists in this position is returned -- be it contains spaces, or invalid characters, etc...

Return values
string|null —

The 'FROM' name.

getName()

Returns the name of the header.

public getName() : string
Return values
string —

The name.

getParts()

Returns an array of IHeaderPart objects the header's value has been parsed into.

public getParts() : array<string|int, IHeaderPart>
Return values
array<string|int, IHeaderPart> —

getRawValue()

Returns the raw value of the header.

public getRawValue() : string
Return values
string —

The raw value.

getValue()

Returns the raw, unparsed header value, same as {@see ReceivedHeader::getRawValue()}.

public getValue() : string|null
Return values
string|null —

getValueFor()

Returns the value of the parameter with the given name, or $defaultValue if not set.

public getValueFor(string $name[, string $defaultValue = null ]) : string|null
Parameters
$name : string

The parameter to retrieve.

$defaultValue : string = null

Optional default value (defaulting to null if not provided).

Return values
string|null —

The parameter's value.

hasParameter()

Returns true if a parameter exists with the passed name.

public hasParameter(string $name) : bool
Parameters
$name : string

The parameter to look up.

Return values
bool —

setParseHeaderValue()

Overridden to assign comments to $this->comments, and the DateTime to $this->date.

protected setParseHeaderValue(AbstractConsumer $consumer) : static
Parameters
$consumer : AbstractConsumer
Return values
static —

Search results