Copied!

Represents a Received header.

The returned header value (as returned by a call to {@see \ReceivedHeader::getValue()}) for a ReceivedHeader is the same as the raw value (as returned by a call to {@see \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 {@see \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 {@see \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 {@see \ReceivedHeader::getFromName()} -- the name portion of the FROM part o {@see \ReceivedHeader::getFromHostname()} -- the hostname of the FROM part o {@see \ReceivedHeader::getFromAddress()} -- the adddress portion of the FROM part o {@see \ReceivedHeader::getByName()} -- same as getFromName, but for the BY part, and etc... below o {@see \ReceivedHeader::getByHostname()} o {@see \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 {@see \ReceivedHeader::getDateTime()}.

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

CloneableInstantiable
Methods
public ZBateson\MailMimeParser\Header\AbstractHeader::__construct(ZBateson\MailMimeParser\Header\Consumer\ConsumerService $consumerService, string $name, string $value)
 

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

  • param \ConsumerService $consumerService For parsing the value.
  • param string $name Name of the header.
  • param string $value Value of the header.
public ZBateson\MailMimeParser\Header\AbstractHeader::__toString() : string
public getByAddress()
 

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

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 {@see \ReceivedHeader}.

  • return string|null The 'BY' address.
public getByHostname()
 

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

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 {@see \ReceivedHeader}.

  • return string|null The 'BY' hostname.
public getByName()
 

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

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 string|null The 'BY' name.
public getComments()
 

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

  • return string[]
public getDateTime()
 

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

  • return \DateTime|null
public getFromAddress()
 

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

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 {@see \ReceivedHeader}.

  • return string|null The 'FROM' address.
public getFromHostname()
 

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

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 {@see \ReceivedHeader}.

  • return string|null The 'FROM' hostname.
public getFromName()
 

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

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 string|null The 'FROM' name.
public ZBateson\MailMimeParser\Header\AbstractHeader::getName() : string
public ZBateson\MailMimeParser\Header\AbstractHeader::getParts() : array
 
  • return \IHeaderPart[]
public ZBateson\MailMimeParser\Header\AbstractHeader::getRawValue() : string
public getValue() : ?string
 

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

public ZBateson\MailMimeParser\Header\ParameterHeader::getValueFor(string $name, ?string $defaultValue = NULL) : ?string
 

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

  • param string $name The parameter to retrieve.
  • param string $defaultValue Optional default value (defaulting to null if not provided).
  • return string|null The parameter's value.
public ZBateson\MailMimeParser\Header\ParameterHeader::hasParameter(string $name) : bool
 

Returns true if a parameter exists with the passed name.

  • param string $name The parameter to look up.
Properties
protected $comments = []
 
  • var string[] an array of comments in the header.
protected $date = NULL
 
  • var \DateTime the date/time stamp in the header.
protected ZBateson\MailMimeParser\Header\AbstractHeader::$name = NULL
 
  • var string the name of the header
protected ZBateson\MailMimeParser\Header\ParameterHeader::$parameters = []
 
  • var \ParameterPart[] key map of lower-case parameter names and associated ParameterParts.
protected ZBateson\MailMimeParser\Header\AbstractHeader::$parts = NULL
 
  • var \IHeaderPart[] the header's parts (as returned from the consumer)
protected ZBateson\MailMimeParser\Header\AbstractHeader::$rawValue = NULL
 
  • var string the raw value
Methods
protected getConsumer(ZBateson\MailMimeParser\Header\Consumer\ConsumerService $consumerService)
 

Returns a ReceivedConsumer.

  • return \Consumer\AbstractConsumer
protected setParseHeaderValue(ZBateson\MailMimeParser\Header\Consumer\AbstractConsumer $consumer)
 

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

  • return static
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration