FileAccess Orion

HeaderInterface

A MIME Header.

Tags
author

Chris Corbyn

Table of Contents

getBody()  : mixed
Gets the body.
getBodyAsString()  : string
Gets the header's body, prepared for folding into a final header value.
getCharset()  : string|null
getLanguage()  : string|null
getMaxLineLength()  : int
getName()  : string
setBody()  : mixed
Sets the body.
setCharset()  : mixed
setLanguage()  : mixed
setMaxLineLength()  : mixed
toString()  : string
Gets this Header rendered as a compliant string.

Methods

getBody()

Gets the body.

public getBody() : mixed

The return type depends on the Header concrete class.

Return values
mixed

getBodyAsString()

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

public getBodyAsString() : string

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

Return values
string

getCharset()

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

getLanguage()

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

getMaxLineLength()

public getMaxLineLength() : int
Return values
int

setBody()

Sets the body.

public setBody(mixed $body) : mixed

The type depends on the Header concrete class.

Parameters
$body : mixed
Return values
mixed

setCharset()

public setCharset(string $charset) : mixed
Parameters
$charset : string
Return values
mixed

setLanguage()

public setLanguage(string $lang) : mixed
Parameters
$lang : string
Return values
mixed

setMaxLineLength()

public setMaxLineLength(int $lineLength) : mixed
Parameters
$lineLength : int
Return values
mixed

toString()

Gets this Header rendered as a compliant string.

public toString() : string
Return values
string

Search results