PHPFUI/InstaDoc
 
Copied!

Holds a group of addresses and a group name.

CloneableInstantiable
Methods
public __construct(Psr\Log\LoggerInterface $logger, ZBateson\MbWrapper\MbWrapper $charsetConverter, array $nameParts, array $addressesAndGroupParts)
 

Creates an AddressGroupPart out of the passed array of AddressParts/ AddressGroupParts and name.

  • param \HeaderPart[] $nameParts
  • param \AddressPart[]|\AddressGroupPart[] $addressesAndGroupParts
public ZBateson\MailMimeParser\Header\Part\HeaderPart::__toString() : string
 

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

  • return string the value
public ZBateson\MailMimeParser\ErrorBag::addError(string $message, string $psrLogLevel, ?Throwable $exception = NULL) : static
public getAddress(int $index) : ?ZBateson\MailMimeParser\Header\Part\AddressPart
 

Returns the AddressPart at the passed index or null.

  • param int $index The 0-based index.
  • return ?\AddressPart The address.
public getAddresses() : array
 

Return the AddressGroupPart's array of addresses.

  • return \AddressPart[] An array of address parts.
public ZBateson\MailMimeParser\ErrorBag::getAllErrors(bool $validate = false, string $minPsrLevel = 'error'Psr\Log\LogLevel::ERROR) : array
public ZBateson\MailMimeParser\Header\Part\ContainerPart::getChildParts() : array
 

Returns the child parts this container part consists of.

  • return \IHeaderPart[]
public ZBateson\MailMimeParser\Header\Part\ContainerPart::getComments() : array
public ZBateson\MailMimeParser\ErrorBag::getErrorLoggingContextName() : string
 

Returns the class name. Override to identify objects in logs.

public ZBateson\MailMimeParser\ErrorBag::getErrors(bool $validate = false, string $minPsrLevel = 'error'Psr\Log\LogLevel::ERROR) : array
public ZBateson\MailMimeParser\Header\Part\NameValuePart::getName() : string
 

Returns the name of the name/value part.

public ZBateson\MailMimeParser\Header\Part\HeaderPart::getValue() : string
 

Returns the part's representative value after any necessary processing has been performed. For the raw value, call getRawValue().

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[] an array of AddressParts
protected bool ZBateson\MailMimeParser\Header\Part\HeaderPart::$canIgnoreSpacesAfter = false
 
  • var bool set to true to ignore spaces after this part
protected bool ZBateson\MailMimeParser\Header\Part\HeaderPart::$canIgnoreSpacesBefore = false
 
  • var bool set to true to ignore spaces before this part
protected ZBateson\MbWrapper\MbWrapper ZBateson\MailMimeParser\Header\Part\HeaderPart::$charsetConverter
 
  • var \MbWrapper $charsetConverter the charset converter used for converting strings in HeaderPart::convertEncoding
protected ZBateson\MailMimeParser\Header\Part\ContainerPart::$children = []
 
  • var \HeaderPart[] parts that were used to create this part, collected for proper error reporting and validation.
protected bool ZBateson\MailMimeParser\Header\Part\HeaderPart::$isSpace = false
 

True if the part is a space token

protected Psr\Log\LoggerInterface ZBateson\MailMimeParser\ErrorBag::$logger
protected string ZBateson\MailMimeParser\Header\Part\NameValuePart::$name
 
  • var string the name of the part
protected string ZBateson\MailMimeParser\Header\Part\HeaderPart::$value
 
  • var string the representative value of the part after any conversion or processing has been done on it (e.g. removing new lines, converting, whatever else).
Methods
protected ZBateson\MailMimeParser\Header\Part\HeaderPart::convertEncoding(string $str, string $from = 'ISO-8859-1', bool $force = false) : string
 

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

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

  • return string utf-8 string
protected ZBateson\MailMimeParser\Header\Part\ContainerPart::filterIgnoredSpaces(array $parts) : array
 

Filters out ignorable space tokens.

Spaces are removed if parts on either side of it have their canIgnoreSpaceAfter/canIgnoreSpaceBefore properties set to true.

  • param \HeaderPart[] $parts
  • return \HeaderPart[]
protected ZBateson\MailMimeParser\Header\Part\ContainerPart::getErrorBagChildren() : array
 

Returns this part's children, same as getChildParts().

  • return \ErrorBag
protected ZBateson\MailMimeParser\Header\Part\NameValuePart::getNameFromParts(array $parts) : string
 

Creates the string 'name' representation of this part constructed from the child name parts passed to it.

  • param \HeaderParts[] $parts
protected ZBateson\MailMimeParser\Header\Part\ContainerPart::getValueFromParts(array $parts) : string
 

Creates the string value representation of this part constructed from the child parts passed to it.

The default implementation filters out ignorable whitespace between parts, and concatenates parts calling 'getValue'.

  • param \HeaderParts[] $parts
protected validate() : void
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration