IdHeader extends MimeEncodedHeader
Represents a Content-ID, Message-ID, In-Reply-To or References header.
For a multi-id header like In-Reply-To or References, all IDs can be
retrieved by calling getIds(). Otherwise, to retrieve the first (or
only) ID call getValue().
Tags
Table of Contents
- $mimeLiteralPartFactory : MimeLiteralPartFactory
- $name : string
- $parts : array<string|int, HeaderPart>
- $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. At the moment this is just in the form of:
- getId() : string|null
- Synonym for getValue().
- getIds() : array<string|int, string>
- Returns all IDs parsed for a multi-id header like References or In-Reply-To.
- 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 an IdBaseConsumer.
- setParseHeaderValue() : mixed
- Calls the consumer and assigns the parsed parts to member variables.
Properties
$mimeLiteralPartFactory
protected
MimeLiteralPartFactory
$mimeLiteralPartFactory
$name
protected
string
$name
$parts
protected
array<string|int, HeaderPart>
$parts
$rawValue
protected
string
$rawValue
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
- $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 —getId()
Synonym for getValue().
public
getId() : string|null
Return values
string|null —getIds()
Returns all IDs parsed for a multi-id header like References or In-Reply-To.
public
getIds() : array<string|int, string>
Return values
array<string|int, 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 an IdBaseConsumer.
protected
getConsumer(ConsumerService $consumerService) : AbstractConsumer
Parameters
- $consumerService : ConsumerService
Return values
AbstractConsumer —setParseHeaderValue()
Calls the consumer and assigns the parsed parts to member variables.
protected
setParseHeaderValue(AbstractConsumer $consumer) : mixed
The default implementation assigns the returned value to $this->part.
Parameters
- $consumer : AbstractConsumer