\hhu\z\apisMailApi

MailApi-implementation.

This class runs and renders e‑mail text and subject.

Summary

Methods
Properties
Constants
__construct()
run()
render()
setLinker()
setHTML()
setMessage()
setParams()
getSubject()
No public properties found
No constants found
log()
$request
$response
$log
N/A
loadToplevelAgent()
addParams()
$toplevelAgent
N/A

Properties

$toplevelAgent

$toplevelAgent : \nre\core\ToplevelAgent

Der Toplevelagent

Type

\nre\core\ToplevelAgent

Methods

__construct()

__construct() 

Construct a new MailApi.

run()

run() : \hhu\z\apis\Exception

Run mailtext generation.

This method runs the generation of mailtext.

Returns

\hhu\z\apis\Exception —

Occured exception or null

render()

render() : string

Render output.

Returns

string —

Rendered output

setLinker()

setLinker(\hhu\z\apis\Linker  $linker) 

Set linker instance for creating links.

Parameters

\hhu\z\apis\Linker $linker

Linker instance for creating links

setHTML()

setHTML(  $html = true) 

Use a ToplevelAgent for HTML-mail

Parameters

$html

setMessage()

setMessage(  $messageAgent) 

Set the Action for the message to render.

Parameters

$messageAgent

setParams()

setParams(array  $params) 

Set additional params to pass to the Action.

Parameters

array $params

Additional params to set

getSubject()

getSubject() : string

Return the subject set by the Controller.

Returns

string —

Subject set by Controller

log()

log(\nre\core\Exception  $exception, integer  $logMode) 

Log an exception

Parameters

\nre\core\Exception $exception

Occurred exception

integer $logMode

Log-mode

loadToplevelAgent()

loadToplevelAgent() 

Load the ToplevelAgent specified by the request.

Throws

\nre\core\ServiceUnavailableException
\nre\core\AgentNotValidException
\nre\core\AgentNotFoundException

addParams()

addParams(array  $params) 

Add multiple request params.

Parameters

array $params

Request params to add