MimeEncodedHeader extends AbstractHeader
Allows a header to be mime-encoded and be decoded with a consumer after decoding.
The entire header's value must only consist of mime-encoded parts for this to apply.
Tags
Table of Contents
- $mimeLiteralPartFactory : MimeLiteralPartFactory
- $name : string
- $parts : array<string|int, HeaderPart>
- $rawValue : string
- __construct() : mixed
- Includes
- __toString() : string
- Returns the string representation of the header. At the moment this is just in the form of:
- getName() : string
- Returns the name of the header.
- getParts() : array<string|int, HeaderPart>
- Returns an array of HeaderPart objects associated with this header.
- getRawValue() : string
- Returns the raw value of the header prior to any processing.
- getValue() : string
- Returns the parsed value of the header -- calls getValue on $this->part
- getConsumer() : AbstractConsumer
- Returns the header's Consumer
- setParseHeaderValue() : mixed
- Mime-decodes the raw value if the whole raw value only consists of mime- encoded parts and whitespace prior to invoking the passed consumer.
Properties
$mimeLiteralPartFactory
protected
MimeLiteralPartFactory
$mimeLiteralPartFactory
$name
protected
string
$name
$parts
protected
array<string|int, HeaderPart>
$parts
$rawValue
protected
string
$rawValue
Methods
__construct()
Includes
public
__construct(MimeLiteralPartFactory $mimeLiteralPartFactory, ConsumerService $consumerService, string $name, string $value) : mixed
Parameters
- $mimeLiteralPartFactory : MimeLiteralPartFactory
- $consumerService : ConsumerService
- $name : string
- $value : string
Return values
mixed —__toString()
Returns the string representation of the header. At the moment this is just in the form of:
public
__toString() : string
No additional processing is performed (for instance to wrap long lines.)
Return values
string —getName()
Returns the name of the header.
public
getName() : string
Return values
string —getParts()
Returns an array of HeaderPart objects associated with this header.
public
getParts() : array<string|int, HeaderPart>
Return values
array<string|int, HeaderPart> —getRawValue()
Returns the raw value of the header prior to any processing.
public
getRawValue() : string
Return values
string —getValue()
Returns the parsed value of the header -- calls getValue on $this->part
public
getValue() : string
Return values
string —getConsumer()
Returns the header's Consumer
protected
abstract getConsumer(ConsumerService $consumerService) : AbstractConsumer
Parameters
- $consumerService : ConsumerService
Return values
AbstractConsumer —setParseHeaderValue()
Mime-decodes the raw value if the whole raw value only consists of mime- encoded parts and whitespace prior to invoking the passed consumer.
protected
setParseHeaderValue(AbstractConsumer $consumer) : mixed
Parameters
- $consumer : AbstractConsumer