Symfony\Component\Mime\Header\IdentificationHeader Class Reference

Inheritance diagram for Symfony\Component\Mime\Header\IdentificationHeader:

Public Member Functions
	__construct (string $name, $ids)
	getBody ()
	getBodyAsString ()
	getId ()
	getIds ()
	setBody ($body)
	setId ($id)
	setIds (array $ids)
Public Member Functions inherited from Symfony\Component\Mime\Header\AbstractHeader
	__construct (string $name)
	getCharset ()
	getLanguage ()
	getMaxLineLength ()
	getName ()
	setCharset (string $charset)
	setLanguage (string $lang)
	setMaxLineLength (int $lineLength)
	toString ()

Additional Inherited Members
Data Fields inherited from Symfony\Component\Mime\Header\AbstractHeader
const	PHRASE_PATTERN = '(?:(?:(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?[a-zA-Z0-9!#\$%&\'\*\+\-\/=\?\^_`\{\}\|~]+(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?)|(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?"((?:(?:[ \t]*(?:\r\n))?[ \t])?(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21\x23-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])))*(?:(?:[ \t]*(?:\r\n))?[ \t])?"(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?))+?)'
Protected Member Functions inherited from Symfony\Component\Mime\Header\AbstractHeader
	createPhrase (HeaderInterface $header, string $string, string $charset, bool $shorten=false)
	encodeWords (HeaderInterface $header, string $input, int $usedLength=-1)
	generateTokenLines (string $token)
	getEncodableWordTokens (string $string)
	getTokenAsEncodedWord (string $token, int $firstLineOffset=0)
	tokenNeedsEncoding (string $token)
	toTokens (string $string=null)

Detailed Description

An ID MIME Header for something like Message-ID or Content-ID (one or more addresses).

Author

Chris Corbyn

Definition at line 22 of file IdentificationHeader.php.

Constructor & Destructor Documentation

__construct()

Symfony\Component\Mime\Header\IdentificationHeader::__construct	(	string	$name,
			$ids
	)

Parameters

string | array

$ids

Definition at line 30 of file IdentificationHeader.php.

References Symfony\Component\Mime\Header\IdentificationHeader\setId().

Member Function Documentation

getBody()

Symfony\Component\Mime\Header\IdentificationHeader::getBody

(

)

Gets the body.

The return type depends on the Header concrete class.

Returns

mixed

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 47 of file IdentificationHeader.php.

References Symfony\Component\Mime\Header\IdentificationHeader\getIds().

getBodyAsString()

Symfony\Component\Mime\Header\IdentificationHeader::getBodyAsString

(

)

Gets the header's body, prepared for folding into a final header value.

This is not necessarily RFC 2822 compliant since folding white space is not added at this stage (see toString() for that).

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 101 of file IdentificationHeader.php.

getId()

Symfony\Component\Mime\Header\IdentificationHeader::getId

(

)

Get the ID used in the value of this Header.

If multiple IDs are set only the first is returned.

Definition at line 69 of file IdentificationHeader.php.

getIds()

Symfony\Component\Mime\Header\IdentificationHeader::getIds

(

)

Get the list of IDs used in this Header.

Returns

string[]

Definition at line 96 of file IdentificationHeader.php.

Referenced by Symfony\Component\Mime\Header\IdentificationHeader\getBody().

setBody()

Symfony\Component\Mime\Header\IdentificationHeader::setBody

(

$body

)

Parameters

string | array

$body

a string ID or an array of IDs

Exceptions

RfcComplianceException

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 42 of file IdentificationHeader.php.

References Symfony\Component\Mime\Header\IdentificationHeader\setId().

setId()

Symfony\Component\Mime\Header\IdentificationHeader::setId

(

$id

)

Set the ID used in the value of this header.

Parameters

string | array

$id

Exceptions

RfcComplianceException

Definition at line 59 of file IdentificationHeader.php.

References Symfony\Component\Mime\Header\IdentificationHeader\setIds().

Referenced by Symfony\Component\Mime\Header\IdentificationHeader\__construct(), and Symfony\Component\Mime\Header\IdentificationHeader\setBody().

setIds()

Symfony\Component\Mime\Header\IdentificationHeader::setIds

(

array

$ids

)

Set a collection of IDs to use in the value of this Header.

Parameters

string[]

$ids

Exceptions

RfcComplianceException

Definition at line 81 of file IdentificationHeader.php.

Referenced by Symfony\Component\Mime\Header\IdentificationHeader\setId().

---

The documentation for this class was generated from the following file:

• IdentificationHeader.php