\hhu\z\responsesMailResponse

Representation of a mail-response.

Summary

Methods
Properties
Constants
addParam()
addParams()
clearParams()
getParam()
getParams()
setOutput()
getOutput()
setExit()
getExit()
setSubject()
getSubject()
No public properties found
No constants found
No protected methods found
$params
N/A
No private methods found
$output
$exit
$subject
N/A

Properties

$params

$params : array

Applied parameters

Type

array

$output

$output : string

Generated output

Type

string

$exit

$exit : boolean

Abort futher execution

Type

boolean

$subject

$subject : string

Mail subject

Type

string

Methods

addParam()

addParam(mixed  $value) 

Add a parameter.

Parameters

mixed $value

Value of parameter

addParams()

addParams(mixed  $value1) 

Add multiple parameters.

Parameters

mixed $value1

Value of first parameter

clearParams()

clearParams(integer  $offset) 

Delete all stored parameters (from offset on).

Parameters

integer $offset

Offset-index

getParam()

getParam(integer  $index, string  $defaultIndex = null) : string

Get a parameter.

Parameters

integer $index

Index of parameter

string $defaultIndex

Index of default configuration value for this parameter

Returns

string —

Value of parameter

getParams()

getParams(integer  $offset) : array

Get all parameters from index on.

Parameters

integer $offset

Offset-index

Returns

array —

Parameter values

setOutput()

setOutput(string  $output) 

Set output.

Parameters

string $output

Generated output

getOutput()

getOutput() : string

Get generated output.

Returns

string —

Generated output

setExit()

setExit(boolean  $exit = true) 

Set exit-state.

Parameters

boolean $exit

Abort further execution

getExit()

getExit() : boolean

Get exit-state.

Returns

boolean —

Abort further execution

setSubject()

setSubject(string  $subject) 

Set subject.

Parameters

string $subject

Subject to set

getSubject()

getSubject() : string

Get subject.

Returns

string —

Subject