questlab/doc/classes/hhu.z.apis.MailApi.html

1438 lines
117 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>Questlab</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="../js/html5.js"></script>
<![endif]-->
<script src="../js/jquery-1.11.0.min.js"></script>
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">Questlab</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown">
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="../namespaces/hhu.html">\hhu</a></li>
<li><a href="../namespaces/nre.html">\nre</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
</a>
</li>
<li>
<a href="../reports/markers.html">
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">6</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1788180449"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1788180449" class="accordion-body collapse in">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1468454677"></a>
<a href="../namespaces/hhu.html" style="margin-left: 30px; padding-left: 0">hhu</a>
</div>
<div id="namespace-1468454677" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-669801115"></a>
<a href="../namespaces/hhu.z.html" style="margin-left: 30px; padding-left: 0">z</a>
</div>
<div id="namespace-669801115" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1213040566"></a>
<a href="../namespaces/hhu.z.agents.html" style="margin-left: 30px; padding-left: 0">agents</a>
</div>
<div id="namespace-1213040566" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-546353870"></a>
<a href="../namespaces/hhu.z.agents.bottomlevel.html" style="margin-left: 30px; padding-left: 0">bottomlevel</a>
</div>
<div id="namespace-546353870" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.agents.bottomlevel.MailreceiverAgent.html">MailreceiverAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.bottomlevel.MenuAgent.html">MenuAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.bottomlevel.QuestgroupshierarchypathAgent.html">QuestgroupshierarchypathAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.bottomlevel.SeminarybarAgent.html">SeminarybarAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.bottomlevel.SeminarymenuAgent.html">SeminarymenuAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.bottomlevel.UserrolesAgent.html">UserrolesAgent</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-2029530480"></a>
<a href="../namespaces/hhu.z.agents.intermediate.html" style="margin-left: 30px; padding-left: 0">intermediate</a>
</div>
<div id="namespace-2029530480" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.AchievementsAgent.html">AchievementsAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.CharactergroupsAgent.html">CharactergroupsAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.CharactergroupsquestsAgent.html">CharactergroupsquestsAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.CharactersAgent.html">CharactersAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.CharactertypesAgent.html">CharactertypesAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.ErrorAgent.html">ErrorAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.IntroductionAgent.html">IntroductionAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.LibraryAgent.html">LibraryAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.MailAgent.html">MailAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.MediaAgent.html">MediaAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.QuestgroupsAgent.html">QuestgroupsAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.QuestgroupshierarchyAgent.html">QuestgroupshierarchyAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.QuestsAgent.html">QuestsAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.SeminariesAgent.html">SeminariesAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.UploadsAgent.html">UploadsAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.UsersAgent.html">UsersAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.intermediate.XplevelsAgent.html">XplevelsAgent</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-946786983"></a>
<a href="../namespaces/hhu.z.agents.toplevel.html" style="margin-left: 30px; padding-left: 0">toplevel</a>
</div>
<div id="namespace-946786983" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.agents.toplevel.AjaxAgent.html">AjaxAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.toplevel.BinaryAgent.html">BinaryAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.toplevel.FaultAgent.html">FaultAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.toplevel.HtmlAgent.html">HtmlAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.toplevel.HtmlmailAgent.html">HtmlmailAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.toplevel.TextmailAgent.html">TextmailAgent</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="class"><a href="../classes/hhu.z.agents.QuesttypeAgent.html">QuesttypeAgent</a></li>
<li class="class"><a href="../classes/hhu.z.agents.ToplevelAgent.html">ToplevelAgent</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1856834515"></a>
<a href="../namespaces/hhu.z.apis.html" style="margin-left: 30px; padding-left: 0">apis</a>
</div>
<div id="namespace-1856834515" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.apis.MailApi.html">MailApi</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1487267849"></a>
<a href="../namespaces/hhu.z.controllers.html" style="margin-left: 30px; padding-left: 0">controllers</a>
</div>
<div id="namespace-1487267849" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-2038677606"></a>
<a href="../namespaces/hhu.z.controllers.components.html" style="margin-left: 30px; padding-left: 0">components</a>
</div>
<div id="namespace-2038677606" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.controllers.components.AchievementComponent.html">AchievementComponent</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.components.AuthComponent.html">AuthComponent</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.components.NotificationComponent.html">NotificationComponent</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.components.ValidationComponent.html">ValidationComponent</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="class"><a href="../classes/hhu.z.controllers.AchievementsController.html">AchievementsController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.AjaxController.html">AjaxController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.BinaryController.html">BinaryController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.CharactergroupsController.html">CharactergroupsController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.CharactergroupsquestsController.html">CharactergroupsquestsController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.CharactersController.html">CharactersController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.CharactertypesController.html">CharactertypesController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.ErrorController.html">ErrorController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.FaultController.html">FaultController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.HtmlController.html">HtmlController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.HtmlmailController.html">HtmlmailController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.IntermediateController.html">IntermediateController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.IntroductionController.html">IntroductionController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.LibraryController.html">LibraryController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.MailController.html">MailController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.MailreceiverController.html">MailreceiverController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.MediaController.html">MediaController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.MenuController.html">MenuController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.QuestgroupsController.html">QuestgroupsController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.QuestgroupshierarchyController.html">QuestgroupshierarchyController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.QuestgroupshierarchypathController.html">QuestgroupshierarchypathController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.QuestsController.html">QuestsController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.QuesttypeController.html">QuesttypeController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.SeminariesController.html">SeminariesController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.SeminarybarController.html">SeminarybarController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.SeminaryController.html">SeminaryController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.SeminarymenuController.html">SeminarymenuController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.TextmailController.html">TextmailController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.UploadsController.html">UploadsController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.UserrolesController.html">UserrolesController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.UsersController.html">UsersController</a></li>
<li class="class"><a href="../classes/hhu.z.controllers.XplevelsController.html">XplevelsController</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1997993213"></a>
<a href="../namespaces/hhu.z.exceptions.html" style="margin-left: 30px; padding-left: 0">exceptions</a>
</div>
<div id="namespace-1997993213" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.exceptions.FileUploadException.html">FileUploadException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.MailingException.html">MailingException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.MaxFilesizeException.html">MaxFilesizeException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.QuesttypeAgentNotFoundException.html">QuesttypeAgentNotFoundException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.QuesttypeAgentNotValidException.html">QuesttypeAgentNotValidException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.QuesttypeControllerNotFoundException.html">QuesttypeControllerNotFoundException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.QuesttypeControllerNotValidException.html">QuesttypeControllerNotValidException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.QuesttypeModelNotFoundException.html">QuesttypeModelNotFoundException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.QuesttypeModelNotValidException.html">QuesttypeModelNotValidException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.SubmissionNotValidException.html">SubmissionNotValidException</a></li>
<li class="class"><a href="../classes/hhu.z.exceptions.WrongFiletypeException.html">WrongFiletypeException</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1552177033"></a>
<a href="../namespaces/hhu.z.lib.html" style="margin-left: 30px; padding-left: 0">lib</a>
</div>
<div id="namespace-1552177033" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.lib.Password.html">Password</a></li>
<li class="class"><a href="../classes/hhu.z.lib.PHPMailer.html">PHPMailer</a></li>
<li class="class"><a href="../classes/hhu.z.lib.PHPMailerAutoload.html">PHPMailerAutoload</a></li>
<li class="class"><a href="../classes/hhu.z.lib.SMTP.html">SMTP</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-665164372"></a>
<a href="../namespaces/hhu.z.models.html" style="margin-left: 30px; padding-left: 0">models</a>
</div>
<div id="namespace-665164372" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.models.AchievementsModel.html">AchievementsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.AvatarsModel.html">AvatarsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.CharactergroupsModel.html">CharactergroupsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.CharactergroupsquestsModel.html">CharactergroupsquestsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.CharacterrolesModel.html">CharacterrolesModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.CharactersModel.html">CharactersModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.CharactertypesModel.html">CharactertypesModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.MediaModel.html">MediaModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.QuestgroupshierarchyModel.html">QuestgroupshierarchyModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.QuestgroupsModel.html">QuestgroupsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.QuestgrouptextsModel.html">QuestgrouptextsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.QuestsModel.html">QuestsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.QuesttextsModel.html">QuesttextsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.QuesttopicsModel.html">QuesttopicsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.QuesttypeModel.html">QuesttypeModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.QuesttypesModel.html">QuesttypesModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.SeminariesModel.html">SeminariesModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.SeminarycharacterfieldsModel.html">SeminarycharacterfieldsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.UploadsModel.html">UploadsModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.UserrolesModel.html">UserrolesModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.UsersModel.html">UsersModel</a></li>
<li class="class"><a href="../classes/hhu.z.models.XplevelsModel.html">XplevelsModel</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1920146536"></a>
<a href="../namespaces/hhu.z.questtypes.html" style="margin-left: 30px; padding-left: 0">questtypes</a>
</div>
<div id="namespace-1920146536" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.questtypes.BossfightQuesttypeAgent.html">BossfightQuesttypeAgent</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.BossfightQuesttypeController.html">BossfightQuesttypeController</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.BossfightQuesttypeModel.html">BossfightQuesttypeModel</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.ChoiceinputQuesttypeAgent.html">ChoiceinputQuesttypeAgent</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.ChoiceinputQuesttypeController.html">ChoiceinputQuesttypeController</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.ChoiceinputQuesttypeModel.html">ChoiceinputQuesttypeModel</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.CrosswordQuesttypeAgent.html">CrosswordQuesttypeAgent</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.CrosswordQuesttypeController.html">CrosswordQuesttypeController</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.CrosswordQuesttypeModel.html">CrosswordQuesttypeModel</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.DragndropQuesttypeAgent.html">DragndropQuesttypeAgent</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.DragndropQuesttypeController.html">DragndropQuesttypeController</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.DragndropQuesttypeModel.html">DragndropQuesttypeModel</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.MultiplechoiceQuesttypeAgent.html">MultiplechoiceQuesttypeAgent</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.MultiplechoiceQuesttypeController.html">MultiplechoiceQuesttypeController</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.MultiplechoiceQuesttypeModel.html">MultiplechoiceQuesttypeModel</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.SubmitQuesttypeAgent.html">SubmitQuesttypeAgent</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.SubmitQuesttypeController.html">SubmitQuesttypeController</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.SubmitQuesttypeModel.html">SubmitQuesttypeModel</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.TextinputQuesttypeAgent.html">TextinputQuesttypeAgent</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.TextinputQuesttypeController.html">TextinputQuesttypeController</a></li>
<li class="class"><a href="../classes/hhu.z.questtypes.TextinputQuesttypeModel.html">TextinputQuesttypeModel</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-830312030"></a>
<a href="../namespaces/hhu.z.requests.html" style="margin-left: 30px; padding-left: 0">requests</a>
</div>
<div id="namespace-830312030" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.requests.MailRequest.html">MailRequest</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-815038613"></a>
<a href="../namespaces/hhu.z.responses.html" style="margin-left: 30px; padding-left: 0">responses</a>
</div>
<div id="namespace-815038613" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.responses.MailResponse.html">MailResponse</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-214220093"></a>
<a href="../namespaces/hhu.z.views.html" style="margin-left: 30px; padding-left: 0">views</a>
</div>
<div id="namespace-214220093" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/hhu.z.views.QuesttypeView.html">QuesttypeView</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="class"><a href="../classes/hhu.z.Controller.html">Controller</a></li>
<li class="class"><a href="../classes/hhu.z.Model.html">Model</a></li>
<li class="class"><a href="../classes/hhu.z.TextFormatter.html">TextFormatter</a></li>
<li class="class"><a href="../classes/hhu.z.Utils.html">Utils</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-146580712"></a>
<a href="../namespaces/nre.html" style="margin-left: 30px; padding-left: 0">nre</a>
</div>
<div id="namespace-146580712" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-240954326"></a>
<a href="../namespaces/nre.agents.html" style="margin-left: 30px; padding-left: 0">agents</a>
</div>
<div id="namespace-240954326" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/nre.agents.BottomlevelAgent.html">BottomlevelAgent</a></li>
<li class="class"><a href="../classes/nre.agents.IntermediateAgent.html">IntermediateAgent</a></li>
<li class="class"><a href="../classes/nre.agents.ToplevelAgent.html">ToplevelAgent</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1254694638"></a>
<a href="../namespaces/nre.apis.html" style="margin-left: 30px; padding-left: 0">apis</a>
</div>
<div id="namespace-1254694638" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/nre.apis.WebApi.html">WebApi</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-754317974"></a>
<a href="../namespaces/nre.configs.html" style="margin-left: 30px; padding-left: 0">configs</a>
</div>
<div id="namespace-754317974" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/nre.configs.AppConfig.html">AppConfig</a></li>
<li class="class"><a href="../classes/nre.configs.CoreConfig.html">CoreConfig</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1075786935"></a>
<a href="../namespaces/nre.core.html" style="margin-left: 30px; padding-left: 0">core</a>
</div>
<div id="namespace-1075786935" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/nre.core.Agent.html">Agent</a></li>
<li class="class"><a href="../classes/nre.core.Api.html">Api</a></li>
<li class="class"><a href="../classes/nre.core.Autoloader.html">Autoloader</a></li>
<li class="class"><a href="../classes/nre.core.ClassLoader.html">ClassLoader</a></li>
<li class="class"><a href="../classes/nre.core.Component.html">Component</a></li>
<li class="class"><a href="../classes/nre.core.Config.html">Config</a></li>
<li class="class"><a href="../classes/nre.core.Controller.html">Controller</a></li>
<li class="class"><a href="../classes/nre.core.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/nre.core.Exception.html">Exception</a></li>
<li class="class"><a href="../classes/nre.core.Linker.html">Linker</a></li>
<li class="class"><a href="../classes/nre.core.Logger.html">Logger</a></li>
<li class="class"><a href="../classes/nre.core.Model.html">Model</a></li>
<li class="class"><a href="../classes/nre.core.Request.html">Request</a></li>
<li class="class"><a href="../classes/nre.core.Response.html">Response</a></li>
<li class="class"><a href="../classes/nre.core.View.html">View</a></li>
<li class="class"><a href="../classes/nre.core.WebUtils.html">WebUtils</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1800581266"></a>
<a href="../namespaces/nre.drivers.html" style="margin-left: 30px; padding-left: 0">drivers</a>
</div>
<div id="namespace-1800581266" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/nre.drivers.DatabaseDriver.html">DatabaseDriver</a></li>
<li class="class"><a href="../classes/nre.drivers.MysqliDriver.html">MysqliDriver</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1915680206"></a>
<a href="../namespaces/nre.exceptions.html" style="margin-left: 30px; padding-left: 0">exceptions</a>
</div>
<div id="namespace-1915680206" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/nre.exceptions.AccessDeniedException.html">AccessDeniedException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ActionNotFoundException.html">ActionNotFoundException</a></li>
<li class="class"><a href="../classes/nre.exceptions.AgentNotFoundException.html">AgentNotFoundException</a></li>
<li class="class"><a href="../classes/nre.exceptions.AgentNotValidException.html">AgentNotValidException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ClassNotFoundException.html">ClassNotFoundException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ClassNotValidException.html">ClassNotValidException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ComponentNotFoundException.html">ComponentNotFoundException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ComponentNotValidException.html">ComponentNotValidException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ControllerNotFoundException.html">ControllerNotFoundException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ControllerNotValidException.html">ControllerNotValidException</a></li>
<li class="class"><a href="../classes/nre.exceptions.DatamodelException.html">DatamodelException</a></li>
<li class="class"><a href="../classes/nre.exceptions.DriverNotFoundException.html">DriverNotFoundException</a></li>
<li class="class"><a href="../classes/nre.exceptions.DriverNotValidException.html">DriverNotValidException</a></li>
<li class="class"><a href="../classes/nre.exceptions.FatalDatamodelException.html">FatalDatamodelException</a></li>
<li class="class"><a href="../classes/nre.exceptions.IdNotFoundException.html">IdNotFoundException</a></li>
<li class="class"><a href="../classes/nre.exceptions.LayoutNotFoundException.html">LayoutNotFoundException</a></li>
<li class="class"><a href="../classes/nre.exceptions.LayoutNotValidException.html">LayoutNotValidException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ModelNotFoundException.html">ModelNotFoundException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ModelNotValidException.html">ModelNotValidException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ParamsNotValidException.html">ParamsNotValidException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ServiceUnavailableException.html">ServiceUnavailableException</a></li>
<li class="class"><a href="../classes/nre.exceptions.ViewNotFoundException.html">ViewNotFoundException</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-683126372"></a>
<a href="../namespaces/nre.models.html" style="margin-left: 30px; padding-left: 0">models</a>
</div>
<div id="namespace-683126372" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/nre.models.DatabaseModel.html">DatabaseModel</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-475192336"></a>
<a href="../namespaces/nre.requests.html" style="margin-left: 30px; padding-left: 0">requests</a>
</div>
<div id="namespace-475192336" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/nre.requests.WebRequest.html">WebRequest</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-164875188"></a>
<a href="../namespaces/nre.responses.html" style="margin-left: 30px; padding-left: 0">responses</a>
</div>
<div id="namespace-164875188" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/nre.responses.WebResponse.html">WebResponse</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="class"><a href="../classes/PHPMailer.html">PHPMailer</a></li>
<li class="class"><a href="../classes/phpmailerException.html">phpmailerException</a></li>
<li class="class"><a href="../classes/SMTP.html">SMTP</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/hhu.z.apis.html">\hhu\z\apis</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\hhu\z\apis</small>MailApi</h1>
<p><em>MailApi-implementation.</em></p>
<p>This class runs and renders email text and subject.</p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/hhu.z.apis.MailApi.html#method___construct" class="">__construct()</a><br />
<a href="../classes/hhu.z.apis.MailApi.html#method_run" class="">run()</a><br />
<a href="../classes/hhu.z.apis.MailApi.html#method_render" class="">render()</a><br />
<a href="../classes/hhu.z.apis.MailApi.html#method_setLinker" class="">setLinker()</a><br />
<a href="../classes/hhu.z.apis.MailApi.html#method_setHTML" class="">setHTML()</a><br />
<a href="../classes/hhu.z.apis.MailApi.html#method_setMessage" class="">setMessage()</a><br />
<a href="../classes/hhu.z.apis.MailApi.html#method_setParams" class="">setParams()</a><br />
<a href="../classes/hhu.z.apis.MailApi.html#method_getSubject" class="">getSubject()</a><br />
</section>
<section class="span4">
<em>No public properties found</em>
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<a href="../classes/nre.core.Api.html#method_log" class="">log()</a><br />
</section>
<section class="span4">
<a href="../classes/nre.core.Api.html#property_request" class="">$request</a><br />
<a href="../classes/nre.core.Api.html#property_response" class="">$response</a><br />
<a href="../classes/nre.core.Api.html#property_log" class="">$log</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<a href="../classes/nre.core.Api.html#method_loadToplevelAgent" class="">loadToplevelAgent()</a><br />
<a href="../classes/hhu.z.apis.MailApi.html#method_addParams" class="">addParams()</a><br />
</section>
<section class="span4">
<a href="../classes/nre.core.Api.html#property_toplevelAgent" class="">$toplevelAgent</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/app.apis.MailApi.html"><div class="path-wrapper">app/apis/MailApi.inc</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">Default</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper"><a href="../classes/nre.core.Api.html">\nre\core\Api</a></div>
<div class="namespace-wrapper">\hhu\z\apis\MailApi</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
author
</th>
<td>
<p>Oliver Hanraths <a href="mailto:oliver.hanraths@uni-duesseldorf.de">oliver.hanraths@uni-duesseldorf.de</a></p>
</td>
</tr>
</table>
</aside>
</div>
<a id="properties" name="properties"></a>
<div class="row-fluid">
<div class="span8 content class">
<h2>Properties</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_request" name="property_request" class="anchor"></a>
<article class="property">
<h3 class="protected ">$request</h3>
<pre class="signature">$request : \nre\core\Request</pre>
<p><em>Die aktuelle Anfrage</em></p>
<h4>Type</h4>
<a href="../classes/nre.core.Request.html">\nre\core\Request</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/nre.core.Api.html"><div class="path-wrapper">\nre\core\Api</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_response" name="property_response" class="anchor"></a>
<article class="property">
<h3 class="protected ">$response</h3>
<pre class="signature">$response : \nre\core\Response</pre>
<p><em>Die aktuelle Antwort</em></p>
<h4>Type</h4>
<a href="../classes/nre.core.Response.html">\nre\core\Response</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/nre.core.Api.html"><div class="path-wrapper">\nre\core\Api</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_log" name="property_log" class="anchor"></a>
<article class="property">
<h3 class="protected ">$log</h3>
<pre class="signature">$log : \nre\core\Logger</pre>
<p><em>Log-System</em></p>
<h4>Type</h4>
<a href="../classes/nre.core.Logger.html">\nre\core\Logger</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/nre.core.Api.html"><div class="path-wrapper">\nre\core\Api</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_toplevelAgent" name="property_toplevelAgent" class="anchor"></a>
<article class="property">
<h3 class="private ">$toplevelAgent</h3>
<pre class="signature">$toplevelAgent : \nre\agents\ToplevelAgent</pre>
<p><em>Der Toplevelagent</em></p>
<h4>Type</h4>
<a href="../classes/nre.agents.ToplevelAgent.html">\nre\agents\ToplevelAgent</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/nre.core.Api.html"><div class="path-wrapper">\nre\core\Api</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method___construct" name="method___construct" class="anchor"></a>
<article class="method">
<h3 class="public ">__construct()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">__construct() </pre>
<p><em>Construct a new MailApi.</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_run" name="method_run" class="anchor"></a>
<article class="method">
<h3 class="public ">run()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">run() : \Exception</pre>
<p><em>Run mailtext generation.</em></p>
<p>This method runs the generation of mailtext.</p>
<h4>Returns</h4>
\Exception
&mdash; <p>Occured exception or null</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_render" name="method_render" class="anchor"></a>
<article class="method">
<h3 class="public ">render()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">render() : string</pre>
<p><em>Render output.</em></p>
<h4>Returns</h4>
string
&mdash; <p>Rendered output</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_setLinker" name="method_setLinker" class="anchor"></a>
<article class="method">
<h3 class="public ">setLinker()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">setLinker(\nre\core\Linker <span class="argument">$linker</span>) </pre>
<p><em>Set linker instance for creating links.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td><a href="../classes/nre.core.Linker.html">\nre\core\Linker</a></td>
<td>$linker </td>
<td><p>Linker instance for creating links</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_setHTML" name="method_setHTML" class="anchor"></a>
<article class="method">
<h3 class="public ">setHTML()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">setHTML(boolean <span class="argument">$html = true</span>) </pre>
<p><em>Use a ToplevelAgent for HTML-mail</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$html </td>
<td><p>Whether to use HTML or not</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_setMessage" name="method_setMessage" class="anchor"></a>
<article class="method">
<h3 class="public ">setMessage()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">setMessage(string <span class="argument">$messageAgent</span>) </pre>
<p><em>Set the Action for the message to render.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$messageAgent </td>
<td><p>Agent to handle the message</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_setParams" name="method_setParams" class="anchor"></a>
<article class="method">
<h3 class="public ">setParams()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">setParams(array <span class="argument">$params</span>) </pre>
<p><em>Set additional params to pass to the Action.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$params </td>
<td><p>Additional params to set</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getSubject" name="method_getSubject" class="anchor"></a>
<article class="method">
<h3 class="public ">getSubject()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getSubject() : string</pre>
<p><em>Return the subject set by the Controller.</em></p>
<h4>Returns</h4>
string
&mdash; <p>Subject set by Controller</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_log" name="method_log" class="anchor"></a>
<article class="method">
<h3 class="protected ">log()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">log(\Exception <span class="argument">$exception</span>, integer <span class="argument">$logMode</span>) </pre>
<p><em>Log an exception</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>\Exception</td>
<td>$exception </td>
<td><p>Occurred exception</p></td>
</tr>
<tr>
<td>integer</td>
<td>$logMode </td>
<td><p>Log-mode</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/nre.core.Api.html"><div class="path-wrapper">\nre\core\Api</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_loadToplevelAgent" name="method_loadToplevelAgent" class="anchor"></a>
<article class="method">
<h3 class="private ">loadToplevelAgent()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">loadToplevelAgent() </pre>
<p><em>Load the ToplevelAgent specified by the request.</em></p>
<h4>Throws</h4>
<dl>
<dt>\nre\exceptions\ServiceUnavailableException</dt>
<dd></dd>
<dt>\nre\exceptions\AgentNotValidException</dt>
<dd></dd>
<dt>\nre\exceptions\AgentNotFoundException</dt>
<dd></dd>
</dl>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Inherited from</dt>
<dd><a href="../classes/nre.core.Api.html"><div class="path-wrapper">\nre\core\Api</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_addParams" name="method_addParams" class="anchor"></a>
<article class="method">
<h3 class="private ">addParams()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">addParams(array <span class="argument">$params</span>) </pre>
<p><em>Add multiple request params.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$params </td>
<td><p>Request params to add</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">MailApi.inc</h3>
</div>
<div class="modal-body">
<pre data-src="../files/app/apis/MailApi.inc.txt" class="language-php line-numbers"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
<li><a href="../namespaces/hhu.html">\hhu</a></li>
<li><a href="../namespaces/nre.html">\nre</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on March 6th, 2015 at 11:17.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>