PHP Interface Swift_Mime_Header, Halite

Author: Chris Corbyn
Show file Open project: HaliteChallenge/Halite Interface Usage Examples

Public Methods

Method Description
getFieldBody ( ) : string Get the field body, prepared for folding into a final header value.
getFieldBodyModel ( ) : mixed Get the model for the field body.
getFieldName ( ) : string Get the name of this header (e.g. Subject).
getFieldType ( ) : integer Get the type of Header that this instance represents.
setCharset ( string $charset ) Set the charset used when rendering the Header.
setFieldBodyModel ( mixed $model ) Set the model for the field body.
toString ( ) : string Get this Header rendered as a compliant string.

Method Details

getFieldBody() public method

Get the field body, prepared for folding into a final header value.
public getFieldBody ( ) : string
return string

getFieldBodyModel() public method

The return type depends on the specifics of the Header.
public getFieldBodyModel ( ) : mixed
return mixed

getFieldName() public method

The name is an identifier and as such will be immutable.
public getFieldName ( ) : string
return string

getFieldType() public method

Get the type of Header that this instance represents.
public getFieldType ( ) : integer
return integer

setCharset() public method

Set the charset used when rendering the Header.
public setCharset ( string $charset )
$charset string

setFieldBodyModel() public method

The actual types needed will vary depending upon the type of Header.
public setFieldBodyModel ( mixed $model )
$model mixed

toString() public method

Get this Header rendered as a compliant string.
public toString ( ) : string
return string