MailMimeParser 2.1

IdHeader extends MimeEncodedHeader
in package

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 IdHeader::getIds(). Otherwise, to retrieve the first (or only) ID call IdHeader::getValue().

Tags
author

Zaahid Bateson

Table of Contents

$mimeLiteralPartFactory  : MimeLiteralPartFactory
$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.
getId()  : string|null
Returns the ID. Synonymous to calling 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, 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 an IdBaseConsumer.
setParseHeaderValue()  : mixed
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.: ': '

Return values
string

The string representation.

getId()

Returns the ID. Synonymous to calling getValue().

public getId() : string|null
Return values
string|null

The ID

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>

An array of IDs

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>

The array of parts.

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) : mixed

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

Parameters
$consumer : AbstractConsumer
Return values
mixed

Search results