PHPFUI/InstaDoc
 
Copied!

A header containing one or more email addresses and/or groups of addresses.

An address is separated by a comma, and each group separated by a semi-colon. The AddressHeader provides a complete list of all addresses referenced in a header including any addresses in groups, in addition to being able to access the groups separately if needed.

For full specifications, see {@link https://www.ietf.org/rfc/rfc2822.txt}

CloneableInstantiable
Methods
public __construct(string $name, string $value, ?Psr\Log\LoggerInterface $logger = NULL, ?ZBateson\MailMimeParser\Header\Consumer\AddressBaseConsumerService $consumerService = NULL)
public ZBateson\MailMimeParser\Header\AbstractHeader::__toString() : string
public ZBateson\MailMimeParser\ErrorBag::addError(string $message, string $psrLogLevel, ?Throwable $exception = NULL) : static
public static ZBateson\MailMimeParser\Header\AbstractHeader::from(string $nameOrLine, ?string $value = NULL) : ZBateson\MailMimeParser\Header\IHeader
 

Parses the passed parameters into an IHeader object.

The type of returned IHeader is determined by the name of the header. See {@see \HeaderFactory::newInstance} for more details.

The required $nameOrLine parameter may contain either the name of a header to parse, or a full header line, e.g. From: email@example.com. If passing a full header line, the $value parameter must be set to null (the default).

Note that more specific types can be called on directly. For instance an AddressHeader may be created by calling AddressHeader::from() which will ignore the name of the header, and always return an AddressHeader, or by calling new AddressHeader('name', 'value') directly.

  • param string $nameOrLine The header's name or full header line.
  • param string|null $value The header's value, or null if passing a full header line to parse.
public getAddresses() : array
 

Returns all address parts in the header including any addresses that are in groups (lists).

  • return \AddressPart[] The addresses.
public ZBateson\MailMimeParser\ErrorBag::getAllErrors(bool $validate = false, string $minPsrLevel = 'error'Psr\Log\LogLevel::ERROR) : array
public ZBateson\MailMimeParser\Header\AbstractHeader::getAllParts() : array
 
  • return \IHeaderPart[]
public ZBateson\MailMimeParser\Header\AbstractHeader::getComments() : array
 
  • return string[]
public getEmail() : ?string
 

Returns the first email address in the header.

  • return ?string The email address
public ZBateson\MailMimeParser\Header\AbstractHeader::getErrorLoggingContextName() : string
public ZBateson\MailMimeParser\ErrorBag::getErrors(bool $validate = false, string $minPsrLevel = 'error'Psr\Log\LogLevel::ERROR) : array
public getGroups() : array
 

Returns all group parts (lists) in the header.

  • return \AddressGroupPart[]
public ZBateson\MailMimeParser\Header\AbstractHeader::getName() : string
public ZBateson\MailMimeParser\Header\AbstractHeader::getParts() : array
 
  • return \IHeaderPart[]
public getPersonName() : ?string
 

Returns the name associated with the first email address to complement getEmail() if one is set, or null if not.

  • return string|null The person name.
public ZBateson\MailMimeParser\Header\AbstractHeader::getRawValue() : string
public ZBateson\MailMimeParser\Header\AbstractHeader::getValue() : ?string
public hasAddress(string $email) : bool
 

Returns true if an address exists with the passed email address.

Comparison is done case insensitively.

public ZBateson\MailMimeParser\ErrorBag::hasAnyErrors(bool $validate = false, string $minPsrLevel = 'error'Psr\Log\LogLevel::ERROR) : bool
public ZBateson\MailMimeParser\ErrorBag::hasErrors(bool $validate = false, string $minPsrLevel = 'error'Psr\Log\LogLevel::ERROR) : bool
Properties
protected array $addresses = []
 
  • var \AddressPart[] array of addresses, included all addresses contained in groups.
protected array ZBateson\MailMimeParser\Header\AbstractHeader::$allParts = []
 
  • var \IHeaderPart[] the header's parts (as returned from the consumer), including commentParts
protected array $groups = []
 
  • var \AddressGroupPart[] array of address groups (lists).
protected Psr\Log\LoggerInterface ZBateson\MailMimeParser\ErrorBag::$logger
protected string ZBateson\MailMimeParser\Header\AbstractHeader::$name
 
  • var string the name of the header
protected array ZBateson\MailMimeParser\Header\AbstractHeader::$parts = []
 
  • var \IHeaderPart[] all parts not including CommentParts.
protected string ZBateson\MailMimeParser\Header\AbstractHeader::$rawValue
 
  • var string the raw value
Methods
protected filterAndAssignToParts() : void
 

Filters $this->allParts into the parts required by $this->parts and assignes it.

The AbstractHeader::filterAndAssignToParts method filters out CommentParts.

protected ZBateson\MailMimeParser\Header\AbstractHeader::getErrorBagChildren() : array
protected static ZBateson\MailMimeParser\Header\AbstractHeader::getHeaderPartsFrom(string $nameOrLine, ?string $value = NULL) : array
 

Checks if the passed $value parameter is null, and if so tries to parse a header line from $nameOrLine splitting on first occurrence of a ':' character.

The returned array always contains two elements. The first being the name (or blank if a ':' char wasn't found and $value is null), and the second being the value.

  • return string[]
protected ZBateson\MailMimeParser\Header\AbstractHeader::parseHeaderValue(ZBateson\MailMimeParser\Header\Consumer\IConsumerService $consumer, string $value) : void
 

Calls the consumer and assigns the parsed parts to member variables.

The default implementation assigns the returned value to $this->allParts and filters out comments from it, assigning the filtered array to $this->parts by calling filterAndAssignToParts.

protected ZBateson\MailMimeParser\Header\AbstractHeader::validate() : void
Methods
public static ZBateson\MailMimeParser\Header\AbstractHeader::from(string $nameOrLine, ?string $value = NULL) : ZBateson\MailMimeParser\Header\IHeader
 

Parses the passed parameters into an IHeader object.

The type of returned IHeader is determined by the name of the header. See {@see \HeaderFactory::newInstance} for more details.

The required $nameOrLine parameter may contain either the name of a header to parse, or a full header line, e.g. From: email@example.com. If passing a full header line, the $value parameter must be set to null (the default).

Note that more specific types can be called on directly. For instance an AddressHeader may be created by calling AddressHeader::from() which will ignore the name of the header, and always return an AddressHeader, or by calling new AddressHeader('name', 'value') directly.

  • param string $nameOrLine The header's name or full header line.
  • param string|null $value The header's value, or null if passing a full header line to parse.
protected static ZBateson\MailMimeParser\Header\AbstractHeader::getHeaderPartsFrom(string $nameOrLine, ?string $value = NULL) : array
 

Checks if the passed $value parameter is null, and if so tries to parse a header line from $nameOrLine splitting on first occurrence of a ':' character.

The returned array always contains two elements. The first being the name (or blank if a ':' char wasn't found and $value is null), and the second being the value.

  • return string[]
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration