MailMimeParser 2.4

AbstractHeader
in package
implements IHeader

Abstract base class representing a mime email's header.

The base class sets up the header's consumer for parsing, sets the name of the header, and calls the consumer to parse the header's value.

AbstractHeader::getConsumer is an abstract method that must be overridden to return an appropriate Consumer\AbstractConsumer type.

Tags
author

Zaahid Bateson

Interfaces, Classes, Traits and Enums

IHeader
A mime email header line consisting of a name and value.

Table of Contents

$name  : string
$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.
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
Returns the parsed 'value' of the header.
getConsumer()  : AbstractConsumer
Returns the header's Consumer
setParseHeaderValue()  : static
Calls the consumer and assigns the parsed parts to member variables.

Properties

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.

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 parsed 'value' of the header.

public getValue() : string

For headers that contain multiple parts, like address headers (To, From) or parameter headers (Content-Type), the 'value' is the value of the first parsed part.

Return values
string

The value

setParseHeaderValue()

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

protected setParseHeaderValue(AbstractConsumer $consumer) : static

The default implementation assigns the returned value to $this->part.

Parameters
$consumer : AbstractConsumer
Return values
static

Search results