Symfony\Component\Mime\Header\Headers Class Reference

Public Member Functions
	__clone ()
	__construct (HeaderInterface ... $headers)
	add (HeaderInterface $header)
	addDateHeader (string $name, \DateTimeInterface $dateTime)
	addIdHeader (string $name, $ids)
	addMailboxHeader (string $name, $address)
	addMailboxListHeader (string $name, array $addresses)
	addParameterizedHeader (string $name, string $value, array $params=[])
	addPathHeader (string $name, $path)
	addTextHeader (string $name, string $value)
	all (string $name=null)
	get (string $name)
	getHeaderBody ($name)
	getHeaderParameter (string $name, string $parameter)
	getMaxLineLength ()
	getNames ()
	has (string $name)
	remove (string $name)
	setHeaderBody (string $type, string $name, $body)
	setHeaderParameter (string $name, string $parameter, $value)
	setMaxLineLength (int $lineLength)
	toArray ()
	toString ()

Static Public Member Functions
static	isUniqueHeader (string $name)

Detailed Description

A collection of headers.

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 22 of file Headers.php.

Constructor & Destructor Documentation

__construct()

Symfony\Component\Mime\Header\Headers::__construct

(

HeaderInterface ...

$headers

)

Definition at line 32 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\add().

Member Function Documentation

__clone()

Symfony\Component\Mime\Header\Headers::__clone

(

)

Definition at line 39 of file Headers.php.

add()

Symfony\Component\Mime\Header\Headers::add

(

HeaderInterface

$header

)

Returns

$this

Definition at line 133 of file Headers.php.

References Symfony\Component\Mime\Header\HeaderInterface\getName(), and Symfony\Component\Mime\Header\HeaderInterface\setMaxLineLength().

Referenced by Symfony\Component\Mime\Header\Headers\__construct(), Symfony\Component\Mime\Header\Headers\addDateHeader(), Symfony\Component\Mime\Header\Headers\addIdHeader(), Symfony\Component\Mime\Header\Headers\addMailboxHeader(), Symfony\Component\Mime\Header\Headers\addMailboxListHeader(), Symfony\Component\Mime\Header\Headers\addParameterizedHeader(), Symfony\Component\Mime\Header\Headers\addPathHeader(), and Symfony\Component\Mime\Header\Headers\addTextHeader().

addDateHeader()

Symfony\Component\Mime\Header\Headers::addDateHeader	(	string	$name,
		\DateTimeInterface	$dateTime
	)

Returns

$this

Definition at line 104 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\add().

addIdHeader()

Symfony\Component\Mime\Header\Headers::addIdHeader	(	string	$name,
			$ids
	)

Parameters

string | array

$ids

Returns

$this

Definition at line 86 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\add().

addMailboxHeader()

Symfony\Component\Mime\Header\Headers::addMailboxHeader	(	string	$name,
			$address
	)

Parameters

Address | string

$address

Returns

$this

Definition at line 76 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\add(), and Symfony\Component\Mime\Address\create().

addMailboxListHeader()

Symfony\Component\Mime\Header\Headers::addMailboxListHeader	(	string	$name,
		array	$addresses
	)

Parameters

(Address|string)[]

$addresses

Returns

$this

Definition at line 66 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\add(), and Symfony\Component\Mime\Address\createArray().

addParameterizedHeader()

Symfony\Component\Mime\Header\Headers::addParameterizedHeader	(	string	$name,
		string	$value,
		array	$params = []
	)

Returns

$this

Definition at line 120 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\add().

addPathHeader()

Symfony\Component\Mime\Header\Headers::addPathHeader	(	string	$name,
			$path
	)

Parameters

Address | string

$path

Returns

$this

Definition at line 96 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\add().

addTextHeader()

Symfony\Component\Mime\Header\Headers::addTextHeader	(	string	$name,
		string	$value
	)

Returns

$this

Definition at line 112 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\add().

all()

Symfony\Component\Mime\Header\Headers::all

(

string

$name = null

)

Definition at line 177 of file Headers.php.

Referenced by Symfony\Component\Mime\Header\Headers\setMaxLineLength(), and Symfony\Component\Mime\Header\Headers\toArray().

get()

Symfony\Component\Mime\Header\Headers::get

(

string

$name

)

Definition at line 165 of file Headers.php.

getHeaderBody()

Symfony\Component\Mime\Header\Headers::getHeaderBody

(

$name

)

Definition at line 232 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\has().

getHeaderParameter()

Symfony\Component\Mime\Header\Headers::getHeaderParameter	(	string	$name,
		string	$parameter
	)

Definition at line 252 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\has().

getMaxLineLength()

Symfony\Component\Mime\Header\Headers::getMaxLineLength

(

)

Definition at line 56 of file Headers.php.

getNames()

Symfony\Component\Mime\Header\Headers::getNames

(

)

Definition at line 192 of file Headers.php.

has()

Symfony\Component\Mime\Header\Headers::has

(

string

$name

)

Definition at line 125 of file Headers.php.

Referenced by Symfony\Component\Mime\Header\Headers\getHeaderBody(), Symfony\Component\Mime\Header\Headers\getHeaderParameter(), Symfony\Component\Mime\Header\Headers\setHeaderBody(), and Symfony\Component\Mime\Header\Headers\setHeaderParameter().

isUniqueHeader()

static Symfony\Component\Mime\Header\Headers::isUniqueHeader ( string  $name )

static

Definition at line 202 of file Headers.php.

remove()

Symfony\Component\Mime\Header\Headers::remove

(

string

$name

)

Definition at line 197 of file Headers.php.

setHeaderBody()

Symfony\Component\Mime\Header\Headers::setHeaderBody	(	string	$type,
		string	$name,
			$body
	)

Definition at line 240 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\has().

setHeaderParameter()

Symfony\Component\Mime\Header\Headers::setHeaderParameter	(	string	$name,
		string	$parameter,
			$value
	)

Definition at line 269 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\has().

setMaxLineLength()

Symfony\Component\Mime\Header\Headers::setMaxLineLength

(

int

$lineLength

)

Definition at line 48 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\all().

toArray()

Symfony\Component\Mime\Header\Headers::toArray

(

)

Definition at line 217 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\all().

Referenced by Symfony\Component\Mime\Header\Headers\toString().

toString()

Symfony\Component\Mime\Header\Headers::toString

(

)

Definition at line 207 of file Headers.php.

References Symfony\Component\Mime\Header\Headers\toArray().

---

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

• Headers.php