Symfony\Component\Mime\Header\HeaderInterface Interface Reference

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

Public Member Functions
	getBody ()
	getBodyAsString ()
	getCharset ()
	getLanguage ()
	getMaxLineLength ()
	getName ()
	setBody ($body)
	setCharset (string $charset)
	setLanguage (string $lang)
	setMaxLineLength (int $lineLength)
	toString ()

Detailed Description

A MIME Header.

Author

Chris Corbyn

Definition at line 19 of file vendor/symfony/mime/Header/HeaderInterface.php.

Member Function Documentation

getBody()

Symfony\Component\Mime\Header\HeaderInterface::getBody

(

)

Gets the body.

The return type depends on the Header concrete class.

Returns

mixed

Implemented in Symfony\Component\Mime\Header\MailboxListHeader, Symfony\Component\Mime\Header\IdentificationHeader, Symfony\Component\Mime\Header\MailboxHeader, Symfony\Component\Mime\Header\PathHeader, Symfony\Component\Mime\Header\UnstructuredHeader, and Symfony\Component\Mime\Header\DateHeader.

getBodyAsString()

Symfony\Component\Mime\Header\HeaderInterface::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).

Implemented in Symfony\Component\Mime\Header\MailboxListHeader, Symfony\Component\Mime\Header\IdentificationHeader, Symfony\Component\Mime\Header\ParameterizedHeader, Symfony\Component\Mime\Header\UnstructuredHeader, Symfony\Component\Mime\Header\MailboxHeader, Symfony\Component\Mime\Header\DateHeader, and Symfony\Component\Mime\Header\PathHeader.

Referenced by Symfony\Component\Mime\Header\AbstractHeader\toTokens().

getCharset()

Symfony\Component\Mime\Header\HeaderInterface::getCharset

(

)

Implemented in Symfony\Component\Mime\Header\AbstractHeader.

getLanguage()

Symfony\Component\Mime\Header\HeaderInterface::getLanguage

(

)

Implemented in Symfony\Component\Mime\Header\AbstractHeader.

getMaxLineLength()

Symfony\Component\Mime\Header\HeaderInterface::getMaxLineLength

(

)

Implemented in Symfony\Component\Mime\Header\AbstractHeader.

getName()

Symfony\Component\Mime\Header\HeaderInterface::getName

(

)

Implemented in Symfony\Component\Mime\Header\AbstractHeader.

Referenced by Symfony\Component\Mime\Header\Headers\add(), Symfony\Component\Mime\Header\AbstractHeader\createPhrase(), and Symfony\Component\Mime\Header\AbstractHeader\encodeWords().

setBody()

Symfony\Component\Mime\Header\HeaderInterface::setBody

(

$body

)

Sets the body.

The type depends on the Header concrete class.

Parameters

mixed

$body

Implemented in Symfony\Component\Mime\Header\IdentificationHeader, Symfony\Component\Mime\Header\MailboxListHeader, Symfony\Component\Mime\Header\MailboxHeader, Symfony\Component\Mime\Header\PathHeader, Symfony\Component\Mime\Header\DateHeader, and Symfony\Component\Mime\Header\UnstructuredHeader.

setCharset()

Symfony\Component\Mime\Header\HeaderInterface::setCharset

(

string

$charset

)

Implemented in Symfony\Component\Mime\Header\AbstractHeader.

setLanguage()

Symfony\Component\Mime\Header\HeaderInterface::setLanguage

(

string

$lang

)

Implemented in Symfony\Component\Mime\Header\AbstractHeader.

setMaxLineLength()

Symfony\Component\Mime\Header\HeaderInterface::setMaxLineLength

(

int

$lineLength

)

Implemented in Symfony\Component\Mime\Header\AbstractHeader.

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

toString()

Symfony\Component\Mime\Header\HeaderInterface::toString

(

)

Gets this Header rendered as a compliant string.

Implemented in Symfony\Component\Mime\Header\AbstractHeader.

---

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

• vendor/symfony/mime/Header/HeaderInterface.php