coderkun/questlab
1
0
Fork 0
Code Issues 15 Pull requests Projects Releases Wiki Activity
questlab/doc/classes/PHPMailer.html
coderkun daa33a8f4b add PHPdoc (solves issue #343)
2015-03-06 09:54:41 +01:00

7052 lines
391 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">242</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">5</span>
</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-1768047902"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1768047902" 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-222424578"></a>
<a href="../namespaces/hhu.html" style="margin-left: 30px; padding-left: 0">hhu</a>
</div>
<div id="namespace-222424578" 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-132317493"></a>
<a href="../namespaces/hhu.z.html" style="margin-left: 30px; padding-left: 0">z</a>
</div>
<div id="namespace-132317493" 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-1098463209"></a>
<a href="../namespaces/hhu.z.agents.html" style="margin-left: 30px; padding-left: 0">agents</a>
</div>
<div id="namespace-1098463209" 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-1267857045"></a>
<a href="../namespaces/hhu.z.agents.bottomlevel.html" style="margin-left: 30px; padding-left: 0">bottomlevel</a>
</div>
<div id="namespace-1267857045" 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-605417600"></a>
<a href="../namespaces/hhu.z.agents.intermediate.html" style="margin-left: 30px; padding-left: 0">intermediate</a>
</div>
<div id="namespace-605417600" 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-712336326"></a>
<a href="../namespaces/hhu.z.agents.toplevel.html" style="margin-left: 30px; padding-left: 0">toplevel</a>
</div>
<div id="namespace-712336326" 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-535470186"></a>
<a href="../namespaces/hhu.z.apis.html" style="margin-left: 30px; padding-left: 0">apis</a>
</div>
<div id="namespace-535470186" 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-1419090046"></a>
<a href="../namespaces/hhu.z.controllers.html" style="margin-left: 30px; padding-left: 0">controllers</a>
</div>
<div id="namespace-1419090046" 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-387724957"></a>
<a href="../namespaces/hhu.z.controllers.components.html" style="margin-left: 30px; padding-left: 0">components</a>
</div>
<div id="namespace-387724957" 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-1973090969"></a>
<a href="../namespaces/hhu.z.exceptions.html" style="margin-left: 30px; padding-left: 0">exceptions</a>
</div>
<div id="namespace-1973090969" 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-530463867"></a>
<a href="../namespaces/hhu.z.lib.html" style="margin-left: 30px; padding-left: 0">lib</a>
</div>
<div id="namespace-530463867" 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-1347565493"></a>
<a href="../namespaces/hhu.z.models.html" style="margin-left: 30px; padding-left: 0">models</a>
</div>
<div id="namespace-1347565493" 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-1494854561"></a>
<a href="../namespaces/hhu.z.questtypes.html" style="margin-left: 30px; padding-left: 0">questtypes</a>
</div>
<div id="namespace-1494854561" 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-1754385309"></a>
<a href="../namespaces/hhu.z.requests.html" style="margin-left: 30px; padding-left: 0">requests</a>
</div>
<div id="namespace-1754385309" 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-968724283"></a>
<a href="../namespaces/hhu.z.responses.html" style="margin-left: 30px; padding-left: 0">responses</a>
</div>
<div id="namespace-968724283" 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-1300943992"></a>
<a href="../namespaces/hhu.z.views.html" style="margin-left: 30px; padding-left: 0">views</a>
</div>
<div id="namespace-1300943992" 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-1164350224"></a>
<a href="../namespaces/nre.html" style="margin-left: 30px; padding-left: 0">nre</a>
</div>
<div id="namespace-1164350224" 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-2026340192"></a>
<a href="../namespaces/nre.agents.html" style="margin-left: 30px; padding-left: 0">agents</a>
</div>
<div id="namespace-2026340192" 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-120744408"></a>
<a href="../namespaces/nre.apis.html" style="margin-left: 30px; padding-left: 0">apis</a>
</div>
<div id="namespace-120744408" 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-716410660"></a>
<a href="../namespaces/nre.configs.html" style="margin-left: 30px; padding-left: 0">configs</a>
</div>
<div id="namespace-716410660" 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-1507098173"></a>
<a href="../namespaces/nre.core.html" style="margin-left: 30px; padding-left: 0">core</a>
</div>
<div id="namespace-1507098173" 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-2082502007"></a>
<a href="../namespaces/nre.drivers.html" style="margin-left: 30px; padding-left: 0">drivers</a>
</div>
<div id="namespace-2082502007" 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-177924008"></a>
<a href="../namespaces/nre.exceptions.html" style="margin-left: 30px; padding-left: 0">exceptions</a>
</div>
<div id="namespace-177924008" 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-1767938869"></a>
<a href="../namespaces/nre.models.html" style="margin-left: 30px; padding-left: 0">models</a>
</div>
<div id="namespace-1767938869" 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-808931691"></a>
<a href="../namespaces/nre.requests.html" style="margin-left: 30px; padding-left: 0">requests</a>
</div>
<div id="namespace-808931691" 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-2009471886"></a>
<a href="../namespaces/nre.responses.html" style="margin-left: 30px; padding-left: 0">responses</a>
</div>
<div id="namespace-2009471886" 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/default.html">\</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>\</small>PHPMailer</h1>
<p><em>PHPMailer - PHP email creation and transport class.</em></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/PHPMailer.html#method___construct" class="">__construct()</a><br />
<a href="../classes/PHPMailer.html#method___destruct" class="">__destruct()</a><br />
<a href="../classes/PHPMailer.html#method_isHTML" class="">isHTML()</a><br />
<a href="../classes/PHPMailer.html#method_isSMTP" class="">isSMTP()</a><br />
<a href="../classes/PHPMailer.html#method_isMail" class="">isMail()</a><br />
<a href="../classes/PHPMailer.html#method_isSendmail" class="">isSendmail()</a><br />
<a href="../classes/PHPMailer.html#method_isQmail" class="">isQmail()</a><br />
<a href="../classes/PHPMailer.html#method_addAddress" class="">addAddress()</a><br />
<a href="../classes/PHPMailer.html#method_addCC" class="">addCC()</a><br />
<a href="../classes/PHPMailer.html#method_addBCC" class="">addBCC()</a><br />
<a href="../classes/PHPMailer.html#method_addReplyTo" class="">addReplyTo()</a><br />
<a href="../classes/PHPMailer.html#method_setFrom" class="">setFrom()</a><br />
<a href="../classes/PHPMailer.html#method_getLastMessageID" class="">getLastMessageID()</a><br />
<a href="../classes/PHPMailer.html#method_validateAddress" class="">validateAddress()</a><br />
<a href="../classes/PHPMailer.html#method_send" class="">send()</a><br />
<a href="../classes/PHPMailer.html#method_preSend" class="">preSend()</a><br />
<a href="../classes/PHPMailer.html#method_postSend" class="">postSend()</a><br />
<a href="../classes/PHPMailer.html#method_getSMTPInstance" class="">getSMTPInstance()</a><br />
<a href="../classes/PHPMailer.html#method_smtpConnect" class="">smtpConnect()</a><br />
<a href="../classes/PHPMailer.html#method_smtpClose" class="">smtpClose()</a><br />
<a href="../classes/PHPMailer.html#method_setLanguage" class="">setLanguage()</a><br />
<a href="../classes/PHPMailer.html#method_getTranslations" class="">getTranslations()</a><br />
<a href="../classes/PHPMailer.html#method_addrAppend" class="">addrAppend()</a><br />
<a href="../classes/PHPMailer.html#method_addrFormat" class="">addrFormat()</a><br />
<a href="../classes/PHPMailer.html#method_wrapText" class="">wrapText()</a><br />
<a href="../classes/PHPMailer.html#method_utf8CharBoundary" class="">utf8CharBoundary()</a><br />
<a href="../classes/PHPMailer.html#method_setWordWrap" class="">setWordWrap()</a><br />
<a href="../classes/PHPMailer.html#method_createHeader" class="">createHeader()</a><br />
<a href="../classes/PHPMailer.html#method_getMailMIME" class="">getMailMIME()</a><br />
<a href="../classes/PHPMailer.html#method_getSentMIMEMessage" class="">getSentMIMEMessage()</a><br />
<a href="../classes/PHPMailer.html#method_createBody" class="">createBody()</a><br />
<a href="../classes/PHPMailer.html#method_headerLine" class="">headerLine()</a><br />
<a href="../classes/PHPMailer.html#method_textLine" class="">textLine()</a><br />
<a href="../classes/PHPMailer.html#method_addAttachment" class="">addAttachment()</a><br />
<a href="../classes/PHPMailer.html#method_getAttachments" class="">getAttachments()</a><br />
<a href="../classes/PHPMailer.html#method_encodeString" class="">encodeString()</a><br />
<a href="../classes/PHPMailer.html#method_encodeHeader" class="">encodeHeader()</a><br />
<a href="../classes/PHPMailer.html#method_hasMultiBytes" class="">hasMultiBytes()</a><br />
<a href="../classes/PHPMailer.html#method_has8bitChars" class="">has8bitChars()</a><br />
<a href="../classes/PHPMailer.html#method_base64EncodeWrapMB" class="">base64EncodeWrapMB()</a><br />
<a href="../classes/PHPMailer.html#method_encodeQP" class="">encodeQP()</a><br />
<a href="../classes/PHPMailer.html#method_encodeQPphp" class="deprecated">encodeQPphp()</a><br />
<a href="../classes/PHPMailer.html#method_encodeQ" class="">encodeQ()</a><br />
<a href="../classes/PHPMailer.html#method_addStringAttachment" class="">addStringAttachment()</a><br />
<a href="../classes/PHPMailer.html#method_addEmbeddedImage" class="">addEmbeddedImage()</a><br />
<a href="../classes/PHPMailer.html#method_addStringEmbeddedImage" class="">addStringEmbeddedImage()</a><br />
<a href="../classes/PHPMailer.html#method_inlineImageExists" class="">inlineImageExists()</a><br />
<a href="../classes/PHPMailer.html#method_attachmentExists" class="">attachmentExists()</a><br />
<a href="../classes/PHPMailer.html#method_alternativeExists" class="">alternativeExists()</a><br />
<a href="../classes/PHPMailer.html#method_clearAddresses" class="">clearAddresses()</a><br />
<a href="../classes/PHPMailer.html#method_clearCCs" class="">clearCCs()</a><br />
<a href="../classes/PHPMailer.html#method_clearBCCs" class="">clearBCCs()</a><br />
<a href="../classes/PHPMailer.html#method_clearReplyTos" class="">clearReplyTos()</a><br />
<a href="../classes/PHPMailer.html#method_clearAllRecipients" class="">clearAllRecipients()</a><br />
<a href="../classes/PHPMailer.html#method_clearAttachments" class="">clearAttachments()</a><br />
<a href="../classes/PHPMailer.html#method_clearCustomHeaders" class="">clearCustomHeaders()</a><br />
<a href="../classes/PHPMailer.html#method_rfcDate" class="">rfcDate()</a><br />
<a href="../classes/PHPMailer.html#method_isError" class="">isError()</a><br />
<a href="../classes/PHPMailer.html#method_fixEOL" class="">fixEOL()</a><br />
<a href="../classes/PHPMailer.html#method_addCustomHeader" class="">addCustomHeader()</a><br />
<a href="../classes/PHPMailer.html#method_msgHTML" class="">msgHTML()</a><br />
<a href="../classes/PHPMailer.html#method_html2text" class="">html2text()</a><br />
<a href="../classes/PHPMailer.html#method__mime_types" class="">_mime_types()</a><br />
<a href="../classes/PHPMailer.html#method_filenameToType" class="">filenameToType()</a><br />
<a href="../classes/PHPMailer.html#method_mb_pathinfo" class="">mb_pathinfo()</a><br />
<a href="../classes/PHPMailer.html#method_set" class="">set()</a><br />
<a href="../classes/PHPMailer.html#method_secureHeader" class="">secureHeader()</a><br />
<a href="../classes/PHPMailer.html#method_normalizeBreaks" class="">normalizeBreaks()</a><br />
<a href="../classes/PHPMailer.html#method_sign" class="">sign()</a><br />
<a href="../classes/PHPMailer.html#method_DKIM_QP" class="">DKIM_QP()</a><br />
<a href="../classes/PHPMailer.html#method_DKIM_Sign" class="">DKIM_Sign()</a><br />
<a href="../classes/PHPMailer.html#method_DKIM_HeaderC" class="">DKIM_HeaderC()</a><br />
<a href="../classes/PHPMailer.html#method_DKIM_BodyC" class="">DKIM_BodyC()</a><br />
<a href="../classes/PHPMailer.html#method_DKIM_Add" class="">DKIM_Add()</a><br />
<a href="../classes/PHPMailer.html#method_getToAddresses" class="">getToAddresses()</a><br />
<a href="../classes/PHPMailer.html#method_getCcAddresses" class="">getCcAddresses()</a><br />
<a href="../classes/PHPMailer.html#method_getBccAddresses" class="">getBccAddresses()</a><br />
<a href="../classes/PHPMailer.html#method_getReplyToAddresses" class="">getReplyToAddresses()</a><br />
<a href="../classes/PHPMailer.html#method_getAllRecipientAddresses" class="">getAllRecipientAddresses()</a><br />
</section>
<section class="span4">
<a href="../classes/PHPMailer.html#property_Version" class="">$Version</a><br />
<a href="../classes/PHPMailer.html#property_Priority" class="">$Priority</a><br />
<a href="../classes/PHPMailer.html#property_CharSet" class="">$CharSet</a><br />
<a href="../classes/PHPMailer.html#property_ContentType" class="">$ContentType</a><br />
<a href="../classes/PHPMailer.html#property_Encoding" class="">$Encoding</a><br />
<a href="../classes/PHPMailer.html#property_ErrorInfo" class="">$ErrorInfo</a><br />
<a href="../classes/PHPMailer.html#property_From" class="">$From</a><br />
<a href="../classes/PHPMailer.html#property_FromName" class="">$FromName</a><br />
<a href="../classes/PHPMailer.html#property_Sender" class="">$Sender</a><br />
<a href="../classes/PHPMailer.html#property_ReturnPath" class="deprecated">$ReturnPath</a><br />
<a href="../classes/PHPMailer.html#property_Subject" class="">$Subject</a><br />
<a href="../classes/PHPMailer.html#property_Body" class="">$Body</a><br />
<a href="../classes/PHPMailer.html#property_AltBody" class="">$AltBody</a><br />
<a href="../classes/PHPMailer.html#property_Ical" class="">$Ical</a><br />
<a href="../classes/PHPMailer.html#property_WordWrap" class="">$WordWrap</a><br />
<a href="../classes/PHPMailer.html#property_Mailer" class="">$Mailer</a><br />
<a href="../classes/PHPMailer.html#property_Sendmail" class="">$Sendmail</a><br />
<a href="../classes/PHPMailer.html#property_UseSendmailOptions" class="">$UseSendmailOptions</a><br />
<a href="../classes/PHPMailer.html#property_PluginDir" class="deprecated">$PluginDir</a><br />
<a href="../classes/PHPMailer.html#property_ConfirmReadingTo" class="">$ConfirmReadingTo</a><br />
<a href="../classes/PHPMailer.html#property_Hostname" class="">$Hostname</a><br />
<a href="../classes/PHPMailer.html#property_MessageID" class="">$MessageID</a><br />
<a href="../classes/PHPMailer.html#property_MessageDate" class="">$MessageDate</a><br />
<a href="../classes/PHPMailer.html#property_Host" class="">$Host</a><br />
<a href="../classes/PHPMailer.html#property_Port" class="">$Port</a><br />
<a href="../classes/PHPMailer.html#property_Helo" class="">$Helo</a><br />
<a href="../classes/PHPMailer.html#property_SMTPSecure" class="">$SMTPSecure</a><br />
<a href="../classes/PHPMailer.html#property_SMTPAuth" class="">$SMTPAuth</a><br />
<a href="../classes/PHPMailer.html#property_Username" class="">$Username</a><br />
<a href="../classes/PHPMailer.html#property_Password" class="">$Password</a><br />
<a href="../classes/PHPMailer.html#property_AuthType" class="">$AuthType</a><br />
<a href="../classes/PHPMailer.html#property_Realm" class="">$Realm</a><br />
<a href="../classes/PHPMailer.html#property_Workstation" class="">$Workstation</a><br />
<a href="../classes/PHPMailer.html#property_Timeout" class="">$Timeout</a><br />
<a href="../classes/PHPMailer.html#property_SMTPDebug" class="">$SMTPDebug</a><br />
<a href="../classes/PHPMailer.html#property_Debugoutput" class="">$Debugoutput</a><br />
<a href="../classes/PHPMailer.html#property_SMTPKeepAlive" class="">$SMTPKeepAlive</a><br />
<a href="../classes/PHPMailer.html#property_SingleTo" class="">$SingleTo</a><br />
<a href="../classes/PHPMailer.html#property_SingleToArray" class="">$SingleToArray</a><br />
<a href="../classes/PHPMailer.html#property_do_verp" class="">$do_verp</a><br />
<a href="../classes/PHPMailer.html#property_AllowEmpty" class="">$AllowEmpty</a><br />
<a href="../classes/PHPMailer.html#property_LE" class="">$LE</a><br />
<a href="../classes/PHPMailer.html#property_DKIM_selector" class="">$DKIM_selector</a><br />
<a href="../classes/PHPMailer.html#property_DKIM_identity" class="">$DKIM_identity</a><br />
<a href="../classes/PHPMailer.html#property_DKIM_passphrase" class="">$DKIM_passphrase</a><br />
<a href="../classes/PHPMailer.html#property_DKIM_domain" class="">$DKIM_domain</a><br />
<a href="../classes/PHPMailer.html#property_DKIM_private" class="">$DKIM_private</a><br />
<a href="../classes/PHPMailer.html#property_action_function" class="">$action_function</a><br />
<a href="../classes/PHPMailer.html#property_XMailer" class="">$XMailer</a><br />
</section>
<section class="span4">
<a href="../classes/PHPMailer.html#constant_STOP_MESSAGE" class="">STOP_MESSAGE</a><br />
<a href="../classes/PHPMailer.html#constant_STOP_CONTINUE" class="">STOP_CONTINUE</a><br />
<a href="../classes/PHPMailer.html#constant_STOP_CRITICAL" class="">STOP_CRITICAL</a><br />
<a href="../classes/PHPMailer.html#constant_CRLF" class="">CRLF</a><br />
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<a href="../classes/PHPMailer.html#method_edebug" class="">edebug()</a><br />
<a href="../classes/PHPMailer.html#method_addAnAddress" class="">addAnAddress()</a><br />
<a href="../classes/PHPMailer.html#method_sendmailSend" class="">sendmailSend()</a><br />
<a href="../classes/PHPMailer.html#method_mailSend" class="">mailSend()</a><br />
<a href="../classes/PHPMailer.html#method_smtpSend" class="">smtpSend()</a><br />
<a href="../classes/PHPMailer.html#method_getBoundary" class="">getBoundary()</a><br />
<a href="../classes/PHPMailer.html#method_endBoundary" class="">endBoundary()</a><br />
<a href="../classes/PHPMailer.html#method_setMessageType" class="">setMessageType()</a><br />
<a href="../classes/PHPMailer.html#method_attachAll" class="">attachAll()</a><br />
<a href="../classes/PHPMailer.html#method_encodeFile" class="">encodeFile()</a><br />
<a href="../classes/PHPMailer.html#method_setError" class="">setError()</a><br />
<a href="../classes/PHPMailer.html#method_serverHostname" class="">serverHostname()</a><br />
<a href="../classes/PHPMailer.html#method_lang" class="">lang()</a><br />
<a href="../classes/PHPMailer.html#method_doCallback" class="">doCallback()</a><br />
</section>
<section class="span4">
<a href="../classes/PHPMailer.html#property_MIMEBody" class="">$MIMEBody</a><br />
<a href="../classes/PHPMailer.html#property_MIMEHeader" class="">$MIMEHeader</a><br />
<a href="../classes/PHPMailer.html#property_mailHeader" class="">$mailHeader</a><br />
<a href="../classes/PHPMailer.html#property_smtp" class="">$smtp</a><br />
<a href="../classes/PHPMailer.html#property_to" class="">$to</a><br />
<a href="../classes/PHPMailer.html#property_cc" class="">$cc</a><br />
<a href="../classes/PHPMailer.html#property_bcc" class="">$bcc</a><br />
<a href="../classes/PHPMailer.html#property_ReplyTo" class="">$ReplyTo</a><br />
<a href="../classes/PHPMailer.html#property_all_recipients" class="">$all_recipients</a><br />
<a href="../classes/PHPMailer.html#property_attachment" class="">$attachment</a><br />
<a href="../classes/PHPMailer.html#property_CustomHeader" class="">$CustomHeader</a><br />
<a href="../classes/PHPMailer.html#property_lastMessageID" class="">$lastMessageID</a><br />
<a href="../classes/PHPMailer.html#property_message_type" class="">$message_type</a><br />
<a href="../classes/PHPMailer.html#property_boundary" class="">$boundary</a><br />
<a href="../classes/PHPMailer.html#property_language" class="">$language</a><br />
<a href="../classes/PHPMailer.html#property_error_count" class="">$error_count</a><br />
<a href="../classes/PHPMailer.html#property_sign_cert_file" class="">$sign_cert_file</a><br />
<a href="../classes/PHPMailer.html#property_sign_key_file" class="">$sign_key_file</a><br />
<a href="../classes/PHPMailer.html#property_sign_key_pass" class="">$sign_key_pass</a><br />
<a href="../classes/PHPMailer.html#property_exceptions" class="">$exceptions</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<a href="../classes/PHPMailer.html#method_mailPassthru" class="">mailPassthru()</a><br />
</section>
<section class="span4">
<em>No private properties found</em>
</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.lib.PHPMailer.html"><div class="path-wrapper">app/lib/PHPMailer.inc</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">PHPMailer</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\PHPMailer</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
author
</th>
<td>
<p>Marcus Bointon (Synchro/coolbru) <a href="mailto:phpmailer@synchromedia.co.uk">phpmailer@synchromedia.co.uk</a></p>
<p>Jim Jagielski (jimjag) <a href="mailto:jimjag@gmail.com">jimjag@gmail.com</a></p>
<p>Andy Prevost (codeworxtech) <a href="mailto:codeworxtech@users.sourceforge.net">codeworxtech@users.sourceforge.net</a></p>
<p>Brent R. Matzelle (original founder)</p>
</td>
</tr>
</table>
</aside>
</div>
<a id="constants" name="constants"></a>
<div class="row-fluid">
<div class="span8 content class">
<h2>Constants</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="constant_STOP_MESSAGE" name="constant_STOP_MESSAGE" class="anchor"></a>
<article id="constant_STOP_MESSAGE" class="constant">
<h3 class="">STOP_MESSAGE</h3>
<pre class="signature">STOP_MESSAGE</pre>
<p><em>Error severity: message only, continue processing</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="constant_STOP_CONTINUE" name="constant_STOP_CONTINUE" class="anchor"></a>
<article id="constant_STOP_CONTINUE" class="constant">
<h3 class="">STOP_CONTINUE</h3>
<pre class="signature">STOP_CONTINUE</pre>
<p><em>Error severity: message, likely ok to continue processing</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="constant_STOP_CRITICAL" name="constant_STOP_CRITICAL" class="anchor"></a>
<article id="constant_STOP_CRITICAL" class="constant">
<h3 class="">STOP_CRITICAL</h3>
<pre class="signature">STOP_CRITICAL</pre>
<p><em>Error severity: message, plus full stop, critical error reached</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="constant_CRLF" name="constant_CRLF" class="anchor"></a>
<article id="constant_CRLF" class="constant">
<h3 class="">CRLF</h3>
<pre class="signature">CRLF</pre>
<p><em>SMTP RFC standard line ending</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>
<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_Version" name="property_Version" class="anchor"></a>
<article class="property">
<h3 class="public ">$Version</h3>
<pre class="signature">$Version : </pre>
<p><em>The PHPMailer Version number.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Priority" name="property_Priority" class="anchor"></a>
<article class="property">
<h3 class="public ">$Priority</h3>
<pre class="signature">$Priority : </pre>
<p><em>Email priority.</em></p>
<p>Options: 1 = High, 3 = Normal, 5 = low.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>int</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_CharSet" name="property_CharSet" class="anchor"></a>
<article class="property">
<h3 class="public ">$CharSet</h3>
<pre class="signature">$CharSet : </pre>
<p><em>The character set of the message.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_ContentType" name="property_ContentType" class="anchor"></a>
<article class="property">
<h3 class="public ">$ContentType</h3>
<pre class="signature">$ContentType : </pre>
<p><em>The MIME Content-type of the message.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Encoding" name="property_Encoding" class="anchor"></a>
<article class="property">
<h3 class="public ">$Encoding</h3>
<pre class="signature">$Encoding : </pre>
<p><em>The message encoding.</em></p>
<p>Options: "8bit", "7bit", "binary", "base64", and "quoted-printable".</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_ErrorInfo" name="property_ErrorInfo" class="anchor"></a>
<article class="property">
<h3 class="public ">$ErrorInfo</h3>
<pre class="signature">$ErrorInfo : </pre>
<p><em>Holds the most recent mailer error message.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_From" name="property_From" class="anchor"></a>
<article class="property">
<h3 class="public ">$From</h3>
<pre class="signature">$From : </pre>
<p><em>The From email address for the message.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_FromName" name="property_FromName" class="anchor"></a>
<article class="property">
<h3 class="public ">$FromName</h3>
<pre class="signature">$FromName : </pre>
<p><em>The From name of the message.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Sender" name="property_Sender" class="anchor"></a>
<article class="property">
<h3 class="public ">$Sender</h3>
<pre class="signature">$Sender : </pre>
<p><em>The Sender email (Return-Path) of the message.</em></p>
<p>If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_ReturnPath" name="property_ReturnPath" class="anchor"></a>
<article class="property">
<h3 class="public deprecated">$ReturnPath</h3>
<pre class="signature">$ReturnPath : </pre>
<p><em>The Return-Path of the message.</em></p>
<p>If empty, it will be set to either From or Sender.</p>
<h4>Type</h4>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
Email senders should never set a return-path header;
it&#039;s the receiver&#039;s job (RFC5321 section 4.4), so this no longer does anything.
</aside>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper">RFC5321 reference</span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Subject" name="property_Subject" class="anchor"></a>
<article class="property">
<h3 class="public ">$Subject</h3>
<pre class="signature">$Subject : </pre>
<p><em>The Subject of the message.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Body" name="property_Body" class="anchor"></a>
<article class="property">
<h3 class="public ">$Body</h3>
<pre class="signature">$Body : </pre>
<p><em>An HTML or plain text message body.</em></p>
<p>If HTML then call isHTML(true).</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_AltBody" name="property_AltBody" class="anchor"></a>
<article class="property">
<h3 class="public ">$AltBody</h3>
<pre class="signature">$AltBody : </pre>
<p><em>The plain-text message body.</em></p>
<p>This body can be read by mail clients that do not have HTML email
capability such as mutt &amp; Eudora.
Clients that can read HTML will view the normal Body.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Ical" name="property_Ical" class="anchor"></a>
<article class="property">
<h3 class="public ">$Ical</h3>
<pre class="signature">$Ical : </pre>
<p><em>An iCal message part body.</em></p>
<p>Only supported in simple alt or alt_inline message types
To generate iCal events, use the bundled extras/EasyPeasyICS.php class or iCalcreator</p>
<h4>Type</h4>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper">http://sprain.ch/blog/downloads/php-class-easypeasyics-create-ical-files-with-php/</span></a></dd>
<dd><a href=""><span class="namespace-wrapper">http://kigkonsult.se/iCalcreator/</span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_WordWrap" name="property_WordWrap" class="anchor"></a>
<article class="property">
<h3 class="public ">$WordWrap</h3>
<pre class="signature">$WordWrap : </pre>
<p><em>Word-wrap the message body to this number of chars.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>int</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Mailer" name="property_Mailer" class="anchor"></a>
<article class="property">
<h3 class="public ">$Mailer</h3>
<pre class="signature">$Mailer : </pre>
<p><em>Which method to use to send mail.</em></p>
<p>Options: "mail", "sendmail", or "smtp".</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Sendmail" name="property_Sendmail" class="anchor"></a>
<article class="property">
<h3 class="public ">$Sendmail</h3>
<pre class="signature">$Sendmail : </pre>
<p><em>The path to the sendmail program.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_UseSendmailOptions" name="property_UseSendmailOptions" class="anchor"></a>
<article class="property">
<h3 class="public ">$UseSendmailOptions</h3>
<pre class="signature">$UseSendmailOptions : </pre>
<p><em>Whether mail() uses a fully sendmail-compatible MTA.</em></p>
<p>One which supports sendmail's "-oi -f" options.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>bool</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_PluginDir" name="property_PluginDir" class="anchor"></a>
<article class="property">
<h3 class="public deprecated">$PluginDir</h3>
<pre class="signature">$PluginDir : </pre>
<p><em>Path to PHPMailer plugins.</em></p>
<p>Useful if the SMTP class is not in the PHP include path.</p>
<h4>Type</h4>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
Should not be needed now there is an autoloader.
</aside>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_ConfirmReadingTo" name="property_ConfirmReadingTo" class="anchor"></a>
<article class="property">
<h3 class="public ">$ConfirmReadingTo</h3>
<pre class="signature">$ConfirmReadingTo : </pre>
<p><em>The email address that a reading confirmation should be sent to.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Hostname" name="property_Hostname" class="anchor"></a>
<article class="property">
<h3 class="public ">$Hostname</h3>
<pre class="signature">$Hostname : </pre>
<p><em>The hostname to use in Message-Id and Received headers
and as default HELO string.</em></p>
<p>If empty, the value returned
by SERVER_NAME is used or 'localhost.localdomain'.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_MessageID" name="property_MessageID" class="anchor"></a>
<article class="property">
<h3 class="public ">$MessageID</h3>
<pre class="signature">$MessageID : </pre>
<p><em>An ID to be used in the Message-Id header.</em></p>
<p>If empty, a unique id will be generated.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_MessageDate" name="property_MessageDate" class="anchor"></a>
<article class="property">
<h3 class="public ">$MessageDate</h3>
<pre class="signature">$MessageDate : </pre>
<p><em>The message Date to be used in the Date header.</em></p>
<p>If empty, the current date will be added.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Host" name="property_Host" class="anchor"></a>
<article class="property">
<h3 class="public ">$Host</h3>
<pre class="signature">$Host : </pre>
<p><em>SMTP hosts.</em></p>
<p>Either a single hostname or multiple semicolon-delimited hostnames.
You can also specify a different port
for each host by using this format: [hostname:port]
(e.g. "smtp1.example.com:25;smtp2.example.com").
Hosts will be tried in order.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Port" name="property_Port" class="anchor"></a>
<article class="property">
<h3 class="public ">$Port</h3>
<pre class="signature">$Port : </pre>
<p><em>The default SMTP server port.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>int</p>
</td>
</tr>
<tr>
<th>
Todo
</th>
<td>
<p>Why is this needed when the SMTP class takes care of it?</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Helo" name="property_Helo" class="anchor"></a>
<article class="property">
<h3 class="public ">$Helo</h3>
<pre class="signature">$Helo : </pre>
<p><em>The SMTP HELO of the message.</em></p>
<p>Default is $Hostname.</p>
<h4>Type</h4>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/PHPMailer.html#property_Hostname"><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_SMTPSecure" name="property_SMTPSecure" class="anchor"></a>
<article class="property">
<h3 class="public ">$SMTPSecure</h3>
<pre class="signature">$SMTPSecure : </pre>
<p><em>The secure connection prefix.</em></p>
<p>Options: "", "ssl" or "tls"</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_SMTPAuth" name="property_SMTPAuth" class="anchor"></a>
<article class="property">
<h3 class="public ">$SMTPAuth</h3>
<pre class="signature">$SMTPAuth : </pre>
<p><em>Whether to use SMTP authentication.</em></p>
<p>Uses the Username and Password properties.</p>
<h4>Type</h4>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/PHPMailer.html#property_Username"><span class="namespace-wrapper"></span></a></dd>
<dd><a href="../classes/PHPMailer.html#property_Password"><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
type
</th>
<td>
<p>bool</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Username" name="property_Username" class="anchor"></a>
<article class="property">
<h3 class="public ">$Username</h3>
<pre class="signature">$Username : </pre>
<p><em>SMTP username.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Password" name="property_Password" class="anchor"></a>
<article class="property">
<h3 class="public ">$Password</h3>
<pre class="signature">$Password : </pre>
<p><em>SMTP password.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_AuthType" name="property_AuthType" class="anchor"></a>
<article class="property">
<h3 class="public ">$AuthType</h3>
<pre class="signature">$AuthType : </pre>
<p><em>SMTP auth type.</em></p>
<p>Options are LOGIN (default), PLAIN, NTLM, CRAM-MD5</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Realm" name="property_Realm" class="anchor"></a>
<article class="property">
<h3 class="public ">$Realm</h3>
<pre class="signature">$Realm : </pre>
<p><em>SMTP realm.</em></p>
<p>Used for NTLM auth</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Workstation" name="property_Workstation" class="anchor"></a>
<article class="property">
<h3 class="public ">$Workstation</h3>
<pre class="signature">$Workstation : </pre>
<p><em>SMTP workstation.</em></p>
<p>Used for NTLM auth</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Timeout" name="property_Timeout" class="anchor"></a>
<article class="property">
<h3 class="public ">$Timeout</h3>
<pre class="signature">$Timeout : </pre>
<p><em>The SMTP server timeout in seconds.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>int</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_SMTPDebug" name="property_SMTPDebug" class="anchor"></a>
<article class="property">
<h3 class="public ">$SMTPDebug</h3>
<pre class="signature">$SMTPDebug : </pre>
<p><em>SMTP class debug output mode.</em></p>
<p>Options:
0: no output
1: commands
2: data and commands
3: as 2 plus connection status
4: low level data output</p>
<h4>Type</h4>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/SMTP.html#property_do_debug"><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
type
</th>
<td>
<p>int</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_Debugoutput" name="property_Debugoutput" class="anchor"></a>
<article class="property">
<h3 class="public ">$Debugoutput</h3>
<pre class="signature">$Debugoutput : </pre>
<p><em>How to handle debug output.</em></p>
<p>Options:
'echo': Output plain-text as-is, appropriate for CLI
'html': Output escaped, line breaks converted to <br>, appropriate for browser output
'error_log': Output to error log as configured in php.ini</p>
<h4>Type</h4>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/SMTP.html#property_Debugoutput"><span class="namespace-wrapper"></span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_SMTPKeepAlive" name="property_SMTPKeepAlive" class="anchor"></a>
<article class="property">
<h3 class="public ">$SMTPKeepAlive</h3>
<pre class="signature">$SMTPKeepAlive : </pre>
<p><em>Whether to keep SMTP connection open after each message.</em></p>
<p>If this is set to true then to close the connection
requires an explicit call to smtpClose().</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>bool</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_SingleTo" name="property_SingleTo" class="anchor"></a>
<article class="property">
<h3 class="public ">$SingleTo</h3>
<pre class="signature">$SingleTo : </pre>
<p><em>Whether to split multiple to addresses into multiple messages
or send them all in one message.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>bool</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_SingleToArray" name="property_SingleToArray" class="anchor"></a>
<article class="property">
<h3 class="public ">$SingleToArray</h3>
<pre class="signature">$SingleToArray : </pre>
<p><em>Storage for addresses when SingleTo is enabled.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
<tr>
<th>
todo
</th>
<td>
<p>This should really not be public</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_do_verp" name="property_do_verp" class="anchor"></a>
<article class="property">
<h3 class="public ">$do_verp</h3>
<pre class="signature">$do_verp : </pre>
<p><em>Whether to generate VERP addresses on send.</em></p>
<p>Only applicable when sending via SMTP.</p>
<h4>Type</h4>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper">http://en.wikipedia.org/wiki/Variable_envelope_return_path</span></a></dd>
<dd><a href=""><span class="namespace-wrapper">Postfix VERP info</span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
type
</th>
<td>
<p>bool</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_AllowEmpty" name="property_AllowEmpty" class="anchor"></a>
<article class="property">
<h3 class="public ">$AllowEmpty</h3>
<pre class="signature">$AllowEmpty : </pre>
<p><em>Whether to allow sending messages with an empty body.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>bool</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_LE" name="property_LE" class="anchor"></a>
<article class="property">
<h3 class="public ">$LE</h3>
<pre class="signature">$LE : </pre>
<p><em>The default line ending.</em></p>
<h4>Type</h4>
</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>
<th>
note
</th>
<td>
<p>The default remains "\n". We force CRLF where we know</p>
<pre><code> it must be used via self::CRLF.</code></pre>
</td>
</tr>
<tr>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_DKIM_selector" name="property_DKIM_selector" class="anchor"></a>
<article class="property">
<h3 class="public ">$DKIM_selector</h3>
<pre class="signature">$DKIM_selector : </pre>
<p><em>DKIM selector.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_DKIM_identity" name="property_DKIM_identity" class="anchor"></a>
<article class="property">
<h3 class="public ">$DKIM_identity</h3>
<pre class="signature">$DKIM_identity : </pre>
<p><em>DKIM Identity.</em></p>
<p>Usually the email address used as the source of the email</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_DKIM_passphrase" name="property_DKIM_passphrase" class="anchor"></a>
<article class="property">
<h3 class="public ">$DKIM_passphrase</h3>
<pre class="signature">$DKIM_passphrase : </pre>
<p><em>DKIM passphrase.</em></p>
<p>Used if your key is encrypted.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_DKIM_domain" name="property_DKIM_domain" class="anchor"></a>
<article class="property">
<h3 class="public ">$DKIM_domain</h3>
<pre class="signature">$DKIM_domain : </pre>
<p><em>DKIM signing domain name.</em></p>
<h4>Type</h4>
</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>
<th>
example
</th>
<td>
</td>
</tr>
<tr>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_DKIM_private" name="property_DKIM_private" class="anchor"></a>
<article class="property">
<h3 class="public ">$DKIM_private</h3>
<pre class="signature">$DKIM_private : </pre>
<p><em>DKIM private key file path.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_action_function" name="property_action_function" class="anchor"></a>
<article class="property">
<h3 class="public ">$action_function</h3>
<pre class="signature">$action_function : </pre>
<p><em>Callback Action function name.</em></p>
<p>The function that handles the result of the send email action.
It is called out by send() for each email sent.</p>
<p>Value can be any php callable: <a href="http://www.php.net/is_callable">http://www.php.net/is_callable</a></p>
<p>Parameters:
bool $result result of the send action
string $to email address of the recipient
string $cc cc email addresses
string $bcc bcc email addresses
string $subject the subject
string $body the email body
string $from email address of sender</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_XMailer" name="property_XMailer" class="anchor"></a>
<article class="property">
<h3 class="public ">$XMailer</h3>
<pre class="signature">$XMailer : </pre>
<p><em>What to use in the X-Mailer header.</em></p>
<p>Options: null for default, whitespace for none, or a string to use</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_MIMEBody" name="property_MIMEBody" class="anchor"></a>
<article class="property">
<h3 class="protected ">$MIMEBody</h3>
<pre class="signature">$MIMEBody : </pre>
<p><em>The complete compiled MIME message body.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_MIMEHeader" name="property_MIMEHeader" class="anchor"></a>
<article class="property">
<h3 class="protected ">$MIMEHeader</h3>
<pre class="signature">$MIMEHeader : </pre>
<p><em>The complete compiled MIME message headers.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_mailHeader" name="property_mailHeader" class="anchor"></a>
<article class="property">
<h3 class="protected ">$mailHeader</h3>
<pre class="signature">$mailHeader : </pre>
<p><em>Extra headers that createHeader() doesn&#039;t fold in.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_smtp" name="property_smtp" class="anchor"></a>
<article class="property">
<h3 class="protected ">$smtp</h3>
<pre class="signature">$smtp : </pre>
<p><em>An instance of the SMTP sender class.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>SMTP</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_to" name="property_to" class="anchor"></a>
<article class="property">
<h3 class="protected ">$to</h3>
<pre class="signature">$to : </pre>
<p><em>The array of &#039;to&#039; addresses.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_cc" name="property_cc" class="anchor"></a>
<article class="property">
<h3 class="protected ">$cc</h3>
<pre class="signature">$cc : </pre>
<p><em>The array of &#039;cc&#039; addresses.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_bcc" name="property_bcc" class="anchor"></a>
<article class="property">
<h3 class="protected ">$bcc</h3>
<pre class="signature">$bcc : </pre>
<p><em>The array of &#039;bcc&#039; addresses.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_ReplyTo" name="property_ReplyTo" class="anchor"></a>
<article class="property">
<h3 class="protected ">$ReplyTo</h3>
<pre class="signature">$ReplyTo : </pre>
<p><em>The array of reply-to names and addresses.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_all_recipients" name="property_all_recipients" class="anchor"></a>
<article class="property">
<h3 class="protected ">$all_recipients</h3>
<pre class="signature">$all_recipients : </pre>
<p><em>An array of all kinds of addresses.</em></p>
<p>Includes all of $to, $cc, $bcc, $replyto</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_attachment" name="property_attachment" class="anchor"></a>
<article class="property">
<h3 class="protected ">$attachment</h3>
<pre class="signature">$attachment : </pre>
<p><em>The array of attachments.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_CustomHeader" name="property_CustomHeader" class="anchor"></a>
<article class="property">
<h3 class="protected ">$CustomHeader</h3>
<pre class="signature">$CustomHeader : </pre>
<p><em>The array of custom headers.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_lastMessageID" name="property_lastMessageID" class="anchor"></a>
<article class="property">
<h3 class="protected ">$lastMessageID</h3>
<pre class="signature">$lastMessageID : </pre>
<p><em>The most recent Message-ID (including angular brackets).</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_message_type" name="property_message_type" class="anchor"></a>
<article class="property">
<h3 class="protected ">$message_type</h3>
<pre class="signature">$message_type : </pre>
<p><em>The message&#039;s MIME type.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_boundary" name="property_boundary" class="anchor"></a>
<article class="property">
<h3 class="protected ">$boundary</h3>
<pre class="signature">$boundary : </pre>
<p><em>The array of MIME boundary strings.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_language" name="property_language" class="anchor"></a>
<article class="property">
<h3 class="protected ">$language</h3>
<pre class="signature">$language : </pre>
<p><em>The array of available languages.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>array</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_error_count" name="property_error_count" class="anchor"></a>
<article class="property">
<h3 class="protected ">$error_count</h3>
<pre class="signature">$error_count : </pre>
<p><em>The number of errors encountered.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>integer</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_sign_cert_file" name="property_sign_cert_file" class="anchor"></a>
<article class="property">
<h3 class="protected ">$sign_cert_file</h3>
<pre class="signature">$sign_cert_file : </pre>
<p><em>The S/MIME certificate file path.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_sign_key_file" name="property_sign_key_file" class="anchor"></a>
<article class="property">
<h3 class="protected ">$sign_key_file</h3>
<pre class="signature">$sign_key_file : </pre>
<p><em>The S/MIME key file path.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_sign_key_pass" name="property_sign_key_pass" class="anchor"></a>
<article class="property">
<h3 class="protected ">$sign_key_pass</h3>
<pre class="signature">$sign_key_pass : </pre>
<p><em>The S/MIME password for the key.</em></p>
<p>Used only if the key is encrypted.</p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>string</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_exceptions" name="property_exceptions" class="anchor"></a>
<article class="property">
<h3 class="protected ">$exceptions</h3>
<pre class="signature">$exceptions : </pre>
<p><em>Whether to throw exceptions for errors.</em></p>
<h4>Type</h4>
</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>
<th>
type
</th>
<td>
<p>bool</p>
</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(boolean <span class="argument">$exceptions = false</span>) </pre>
<p><em>Constructor</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$exceptions </td>
<td><p>Should we throw external exceptions?</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___destruct" name="method___destruct" class="anchor"></a>
<article class="method">
<h3 class="public ">__destruct()</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;">__destruct() </pre>
<p><em>Destructor.</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_isHTML" name="method_isHTML" class="anchor"></a>
<article class="method">
<h3 class="public ">isHTML()</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;">isHTML(boolean <span class="argument">$ishtml = true</span>) : void</pre>
<p><em>Sets message type to HTML or plain.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$ishtml </td>
<td><p>True for HTML mode.</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_isSMTP" name="method_isSMTP" class="anchor"></a>
<article class="method">
<h3 class="public ">isSMTP()</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;">isSMTP() : void</pre>
<p><em>Send messages using SMTP.</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_isMail" name="method_isMail" class="anchor"></a>
<article class="method">
<h3 class="public ">isMail()</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;">isMail() : void</pre>
<p><em>Send messages using PHP&#039;s mail() function.</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_isSendmail" name="method_isSendmail" class="anchor"></a>
<article class="method">
<h3 class="public ">isSendmail()</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;">isSendmail() : void</pre>
<p><em>Send messages using $Sendmail.</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_isQmail" name="method_isQmail" class="anchor"></a>
<article class="method">
<h3 class="public ">isQmail()</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;">isQmail() : void</pre>
<p><em>Send messages using qmail.</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_addAddress" name="method_addAddress" class="anchor"></a>
<article class="method">
<h3 class="public ">addAddress()</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;">addAddress(string <span class="argument">$address</span>, string <span class="argument">$name = &#039;&#039;</span>) : boolean</pre>
<p><em>Add a &quot;To&quot; address.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$address </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$name </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
boolean
&mdash; <p>true on success, false if address already used</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_addCC" name="method_addCC" class="anchor"></a>
<article class="method">
<h3 class="public ">addCC()</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;">addCC(string <span class="argument">$address</span>, string <span class="argument">$name = &#039;&#039;</span>) : boolean</pre>
<p><em>Add a &quot;CC&quot; address.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$address </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$name </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
boolean
&mdash; <p>true on success, false if address already used</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>
<th>
note
</th>
<td>
<p>: This function works with the SMTP mailer on win32, not with the "mail" mailer.</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_addBCC" name="method_addBCC" class="anchor"></a>
<article class="method">
<h3 class="public ">addBCC()</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;">addBCC(string <span class="argument">$address</span>, string <span class="argument">$name = &#039;&#039;</span>) : boolean</pre>
<p><em>Add a &quot;BCC&quot; address.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$address </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$name </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
boolean
&mdash; <p>true on success, false if address already used</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>
<th>
note
</th>
<td>
<p>: This function works with the SMTP mailer on win32, not with the "mail" mailer.</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_addReplyTo" name="method_addReplyTo" class="anchor"></a>
<article class="method">
<h3 class="public ">addReplyTo()</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;">addReplyTo(string <span class="argument">$address</span>, string <span class="argument">$name = &#039;&#039;</span>) : boolean</pre>
<p><em>Add a &quot;Reply-to&quot; address.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$address </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$name </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</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_setFrom" name="method_setFrom" class="anchor"></a>
<article class="method">
<h3 class="public ">setFrom()</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;">setFrom(string <span class="argument">$address</span>, string <span class="argument">$name = &#039;&#039;</span>, boolean <span class="argument">$auto = true</span>) : boolean</pre>
<p><em>Set the From and FromName properties.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$address </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$name </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$auto </td>
<td><p>Whether to also set the Sender address, defaults to true</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</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_getLastMessageID" name="method_getLastMessageID" class="anchor"></a>
<article class="method">
<h3 class="public ">getLastMessageID()</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;">getLastMessageID() : string</pre>
<p><em>Return the Message-ID header of the last email.</em></p>
<p>Technically this is the value from the last time the headers were created,
but it's also the message ID of the last sent message except in
pathological cases.</p>
<h4>Returns</h4>
string
</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_validateAddress" name="method_validateAddress" class="anchor"></a>
<article class="method">
<h3 class="public ">validateAddress()</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;">validateAddress(string <span class="argument">$address</span>, string <span class="argument">$patternselect = &#039;auto&#039;</span>) : boolean</pre>
<p><em>Check that a string looks like an email address.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$address </td>
<td><p>The email address to check</p></td>
</tr>
<tr>
<td>string</td>
<td>$patternselect </td>
<td><p>A selector for the validation pattern to use :</p>
<ul>
<li><code>auto</code> Pick strictest one automatically;</li>
<li><code>pcre8</code> Use the squiloople.com pattern, requires PCRE > 8.0, PHP >= 5.3.2, 5.2.14;</li>
<li><code>pcre</code> Use old PCRE implementation;</li>
<li><code>php</code> Use PHP built-in FILTER_VALIDATE_EMAIL; same as pcre8 but does not allow 'dotless' domains;</li>
<li><code>html5</code> Use the pattern given by the HTML5 spec for 'email' type form input elements.</li>
<li><code>noregex</code> Don't use a regex: super fast, really dumb.</li>
</ul></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
static
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_send" name="method_send" class="anchor"></a>
<article class="method">
<h3 class="public ">send()</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;">send() : boolean</pre>
<p><em>Create a message and send it.</em></p>
<p>Uses the sending method specified by $Mailer.</p>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
&mdash; <p>false on error - See the ErrorInfo property for details of the error.</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_preSend" name="method_preSend" class="anchor"></a>
<article class="method">
<h3 class="public ">preSend()</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;">preSend() : boolean</pre>
<p><em>Prepare a message for sending.</em></p>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</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_postSend" name="method_postSend" class="anchor"></a>
<article class="method">
<h3 class="public ">postSend()</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;">postSend() : boolean</pre>
<p><em>Actually send a message.</em></p>
<p>Send the email via the selected mechanism</p>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</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_getSMTPInstance" name="method_getSMTPInstance" class="anchor"></a>
<article class="method">
<h3 class="public ">getSMTPInstance()</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;">getSMTPInstance() : \SMTP</pre>
<p><em>Get an instance to use for SMTP operations.</em></p>
<p>Override this function to load your own SMTP implementation</p>
<h4>Returns</h4>
<a href="../classes/SMTP.html">\SMTP</a>
</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_smtpConnect" name="method_smtpConnect" class="anchor"></a>
<article class="method">
<h3 class="public ">smtpConnect()</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;">smtpConnect(array <span class="argument">$options = array()</span>) : boolean</pre>
<p><em>Initiate a connection to an SMTP server.</em></p>
<p>Returns false if the operation failed.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$options </td>
<td><p>An array of options compatible with stream_context_create()</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>Uses</dt>
<dd>SMTP</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_smtpClose" name="method_smtpClose" class="anchor"></a>
<article class="method">
<h3 class="public ">smtpClose()</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;">smtpClose() : void</pre>
<p><em>Close the active SMTP session if one exists.</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_setLanguage" name="method_setLanguage" class="anchor"></a>
<article class="method">
<h3 class="public ">setLanguage()</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;">setLanguage(string <span class="argument">$langcode = &#039;en&#039;</span>, string <span class="argument">$lang_path = &#039;&#039;</span>) : boolean</pre>
<p><em>Set the language for error messages.</em></p>
<p>Returns false if it cannot load the language file.
The default language is English.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$langcode </td>
<td><p>ISO 639-1 2-character language code (e.g. French is "fr")</p></td>
</tr>
<tr>
<td>string</td>
<td>$lang_path </td>
<td><p>Path to the language file directory, with trailing separator (slash)</p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</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_getTranslations" name="method_getTranslations" class="anchor"></a>
<article class="method">
<h3 class="public ">getTranslations()</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;">getTranslations() : array</pre>
<p><em>Get the array of strings for the current language.</em></p>
<h4>Returns</h4>
array
</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_addrAppend" name="method_addrAppend" class="anchor"></a>
<article class="method">
<h3 class="public ">addrAppend()</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;">addrAppend(string <span class="argument">$type</span>, array <span class="argument">$addr</span>) : string</pre>
<p><em>Create recipient headers.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$type </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$addr </td>
<td><p>An array of recipient,
where each recipient is a 2-element indexed array with element 0 containing an address
and element 1 containing a name, like:
array(array('joe@example.com', 'Joe User'), array('zoe@example.com', 'Zoe User'))</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_addrFormat" name="method_addrFormat" class="anchor"></a>
<article class="method">
<h3 class="public ">addrFormat()</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;">addrFormat(array <span class="argument">$addr</span>) : string</pre>
<p><em>Format an address for use in a message header.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$addr </td>
<td><p>A 2-element indexed array, element 0 containing an address, element 1 containing a name</p>
<pre><code> like array('joe@example.com', 'Joe User')</code></pre></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_wrapText" name="method_wrapText" class="anchor"></a>
<article class="method">
<h3 class="public ">wrapText()</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;">wrapText(string <span class="argument">$message</span>, integer <span class="argument">$length</span>, boolean <span class="argument">$qp_mode = false</span>) : string</pre>
<p><em>Word-wrap message.</em></p>
<p>For use with mailers that do not automatically perform wrapping
and for quoted-printable encoded messages.
Original written by philippe.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$message </td>
<td><p>The message to wrap</p></td>
</tr>
<tr>
<td>integer</td>
<td>$length </td>
<td><p>The line length to wrap to</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$qp_mode </td>
<td><p>Whether to run in Quoted-Printable mode</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_utf8CharBoundary" name="method_utf8CharBoundary" class="anchor"></a>
<article class="method">
<h3 class="public ">utf8CharBoundary()</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;">utf8CharBoundary(string <span class="argument">$encodedText</span>, integer <span class="argument">$maxLength</span>) : integer</pre>
<p><em>Find the last character boundary prior to $maxLength in a utf-8
quoted (printable) encoded string.</em></p>
<p>Original written by Colin Brown.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$encodedText </td>
<td><p>utf-8 QP text</p></td>
</tr>
<tr>
<td>integer</td>
<td>$maxLength </td>
<td><p>find last character boundary prior to this length</p></td>
</tr>
</table>
<h4>Returns</h4>
integer
</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_setWordWrap" name="method_setWordWrap" class="anchor"></a>
<article class="method">
<h3 class="public ">setWordWrap()</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;">setWordWrap() : void</pre>
<p><em>Set the body wrapping.</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_createHeader" name="method_createHeader" class="anchor"></a>
<article class="method">
<h3 class="public ">createHeader()</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;">createHeader() : string</pre>
<p><em>Assemble message headers.</em></p>
<h4>Returns</h4>
string
&mdash; <p>The assembled headers</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_getMailMIME" name="method_getMailMIME" class="anchor"></a>
<article class="method">
<h3 class="public ">getMailMIME()</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;">getMailMIME() : string</pre>
<p><em>Get the message MIME type headers.</em></p>
<h4>Returns</h4>
string
</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_getSentMIMEMessage" name="method_getSentMIMEMessage" class="anchor"></a>
<article class="method">
<h3 class="public ">getSentMIMEMessage()</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;">getSentMIMEMessage() : string</pre>
<p><em>Returns the whole MIME message.</em></p>
<p>Includes complete headers and body.
Only valid post preSend().</p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/PHPMailer.html#method_preSend"><span class="namespace-wrapper"></span></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_createBody" name="method_createBody" class="anchor"></a>
<article class="method">
<h3 class="public ">createBody()</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;">createBody() : string</pre>
<p><em>Assemble the message body.</em></p>
<p>Returns an empty string on failure.</p>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
string
&mdash; <p>The assembled message body</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_headerLine" name="method_headerLine" class="anchor"></a>
<article class="method">
<h3 class="public ">headerLine()</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;">headerLine(string <span class="argument">$name</span>, string <span class="argument">$value</span>) : string</pre>
<p><em>Format a header line.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$name </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$value </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_textLine" name="method_textLine" class="anchor"></a>
<article class="method">
<h3 class="public ">textLine()</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;">textLine(string <span class="argument">$value</span>) : string</pre>
<p><em>Return a formatted mail line.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$value </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_addAttachment" name="method_addAttachment" class="anchor"></a>
<article class="method">
<h3 class="public ">addAttachment()</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;">addAttachment(string <span class="argument">$path</span>, string <span class="argument">$name = &#039;&#039;</span>, string <span class="argument">$encoding = &#039;base64&#039;</span>, string <span class="argument">$type = &#039;&#039;</span>, string <span class="argument">$disposition = &#039;attachment&#039;</span>) : boolean</pre>
<p><em>Add an attachment from a path on the filesystem.</em></p>
<p>Returns false if the file could not be found or read.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$path </td>
<td><p>Path to the attachment.</p></td>
</tr>
<tr>
<td>string</td>
<td>$name </td>
<td><p>Overrides the attachment name.</p></td>
</tr>
<tr>
<td>string</td>
<td>$encoding </td>
<td><p>File encoding (see $Encoding).</p></td>
</tr>
<tr>
<td>string</td>
<td>$type </td>
<td><p>File extension (MIME) type.</p></td>
</tr>
<tr>
<td>string</td>
<td>$disposition </td>
<td><p>Disposition to use</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</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_getAttachments" name="method_getAttachments" class="anchor"></a>
<article class="method">
<h3 class="public ">getAttachments()</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;">getAttachments() : array</pre>
<p><em>Return the array of attachments.</em></p>
<h4>Returns</h4>
array
</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_encodeString" name="method_encodeString" class="anchor"></a>
<article class="method">
<h3 class="public ">encodeString()</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;">encodeString(string <span class="argument">$str</span>, string <span class="argument">$encoding = &#039;base64&#039;</span>) : string</pre>
<p><em>Encode a string in requested format.</em></p>
<p>Returns an empty string on failure.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str </td>
<td><p>The text to encode</p></td>
</tr>
<tr>
<td>string</td>
<td>$encoding </td>
<td><p>The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_encodeHeader" name="method_encodeHeader" class="anchor"></a>
<article class="method">
<h3 class="public ">encodeHeader()</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;">encodeHeader(string <span class="argument">$str</span>, string <span class="argument">$position = &#039;text&#039;</span>) : string</pre>
<p><em>Encode a header string optimally.</em></p>
<p>Picks shortest of Q, B, quoted-printable or none.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$position </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_hasMultiBytes" name="method_hasMultiBytes" class="anchor"></a>
<article class="method">
<h3 class="public ">hasMultiBytes()</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;">hasMultiBytes(string <span class="argument">$str</span>) : boolean</pre>
<p><em>Check if a string contains multi-byte characters.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str </td>
<td><p>multi-byte text to wrap encode</p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</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_has8bitChars" name="method_has8bitChars" class="anchor"></a>
<article class="method">
<h3 class="public ">has8bitChars()</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;">has8bitChars(string <span class="argument">$text</span>) : boolean</pre>
<p><em>Does a string contain any 8-bit chars (in any charset)?</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</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_base64EncodeWrapMB" name="method_base64EncodeWrapMB" class="anchor"></a>
<article class="method">
<h3 class="public ">base64EncodeWrapMB()</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;">base64EncodeWrapMB(string <span class="argument">$str</span>, string <span class="argument">$linebreak = null</span>) : string</pre>
<p><em>Encode and wrap long multibyte strings for mail headers
without breaking lines within a character.</em></p>
<p>Adapted from a function by paravoid</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str </td>
<td><p>multi-byte text to wrap encode</p></td>
</tr>
<tr>
<td>string</td>
<td>$linebreak </td>
<td><p>string to use as linefeed/end-of-line</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="http://www.php.net/manual/en/function.mb-encode-mimeheader.php#60283"><span class="namespace-wrapper">http://www.php.net/manual/en/function.mb-encode-mimeheader.php#60283</span></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_encodeQP" name="method_encodeQP" class="anchor"></a>
<article class="method">
<h3 class="public ">encodeQP()</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;">encodeQP(string <span class="argument">$string</span>, integer <span class="argument">$line_max = 76</span>) : string</pre>
<p><em>Encode a string in quoted-printable format.</em></p>
<p>According to RFC2045 section 6.7.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$string </td>
<td><p>The text to encode</p></td>
</tr>
<tr>
<td>integer</td>
<td>$line_max </td>
<td><p>Number of chars allowed on a line before wrapping</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="http://www.php.net/manual/en/function.quoted-printable-decode.php#89417"><span class="namespace-wrapper">Adapted from this comment</span></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_encodeQPphp" name="method_encodeQPphp" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">encodeQPphp()</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;">encodeQPphp(string <span class="argument">$string</span>, integer <span class="argument">$line_max = 76</span>, boolean <span class="argument">$space_conv = false</span>) : string</pre>
<p><em>Backward compatibility wrapper for an old QP encoding function that was removed.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$string </td>
<td></td>
</tr>
<tr>
<td>integer</td>
<td>$line_max </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$space_conv </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
Use encodeQP instead.
</aside>
<dl>
<dt>See also</dt>
<dd><a href="../classes/PHPMailer.html#method_encodeQP"><span class="namespace-wrapper"></span></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_encodeQ" name="method_encodeQ" class="anchor"></a>
<article class="method">
<h3 class="public ">encodeQ()</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;">encodeQ(string <span class="argument">$str</span>, string <span class="argument">$position = &#039;text&#039;</span>) : string</pre>
<p><em>Encode a string using Q encoding.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str </td>
<td><p>the text to encode</p></td>
</tr>
<tr>
<td>string</td>
<td>$position </td>
<td><p>Where the text is going to be used, see the RFC for what that means</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="http://tools.ietf.org/html/rfc2047"><span class="namespace-wrapper">http://tools.ietf.org/html/rfc2047</span></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_addStringAttachment" name="method_addStringAttachment" class="anchor"></a>
<article class="method">
<h3 class="public ">addStringAttachment()</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;">addStringAttachment(string <span class="argument">$string</span>, string <span class="argument">$filename</span>, string <span class="argument">$encoding = &#039;base64&#039;</span>, string <span class="argument">$type = &#039;&#039;</span>, string <span class="argument">$disposition = &#039;attachment&#039;</span>) : void</pre>
<p><em>Add a string or binary attachment (non-filesystem).</em></p>
<p>This method can be used to attach ascii or binary data,
such as a BLOB record from a database.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$string </td>
<td><p>String attachment data.</p></td>
</tr>
<tr>
<td>string</td>
<td>$filename </td>
<td><p>Name of the attachment.</p></td>
</tr>
<tr>
<td>string</td>
<td>$encoding </td>
<td><p>File encoding (see $Encoding).</p></td>
</tr>
<tr>
<td>string</td>
<td>$type </td>
<td><p>File extension (MIME) type.</p></td>
</tr>
<tr>
<td>string</td>
<td>$disposition </td>
<td><p>Disposition to use</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_addEmbeddedImage" name="method_addEmbeddedImage" class="anchor"></a>
<article class="method">
<h3 class="public ">addEmbeddedImage()</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;">addEmbeddedImage(string <span class="argument">$path</span>, string <span class="argument">$cid</span>, string <span class="argument">$name = &#039;&#039;</span>, string <span class="argument">$encoding = &#039;base64&#039;</span>, string <span class="argument">$type = &#039;&#039;</span>, string <span class="argument">$disposition = &#039;inline&#039;</span>) : boolean</pre>
<p><em>Add an embedded (inline) attachment from a file.</em></p>
<p>This can include images, sounds, and just about any other document type.
These differ from 'regular' attachmants in that they are intended to be
displayed inline with the message, not just attached for download.
This is used in HTML messages that embed the images
the HTML refers to using the $cid value.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$path </td>
<td><p>Path to the attachment.</p></td>
</tr>
<tr>
<td>string</td>
<td>$cid </td>
<td><p>Content ID of the attachment; Use this to reference</p>
<pre><code> the content when using an embedded image in HTML.</code></pre></td>
</tr>
<tr>
<td>string</td>
<td>$name </td>
<td><p>Overrides the attachment name.</p></td>
</tr>
<tr>
<td>string</td>
<td>$encoding </td>
<td><p>File encoding (see $Encoding).</p></td>
</tr>
<tr>
<td>string</td>
<td>$type </td>
<td><p>File MIME type.</p></td>
</tr>
<tr>
<td>string</td>
<td>$disposition </td>
<td><p>Disposition to use</p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
&mdash; <p>True on successfully adding an attachment</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_addStringEmbeddedImage" name="method_addStringEmbeddedImage" class="anchor"></a>
<article class="method">
<h3 class="public ">addStringEmbeddedImage()</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;">addStringEmbeddedImage(string <span class="argument">$string</span>, string <span class="argument">$cid</span>, string <span class="argument">$name = &#039;&#039;</span>, string <span class="argument">$encoding = &#039;base64&#039;</span>, string <span class="argument">$type = &#039;&#039;</span>, string <span class="argument">$disposition = &#039;inline&#039;</span>) : boolean</pre>
<p><em>Add an embedded stringified attachment.</em></p>
<p>This can include images, sounds, and just about any other document type.
Be sure to set the $type to an image type for images:
JPEG images use 'image/jpeg', GIF uses 'image/gif', PNG uses 'image/png'.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$string </td>
<td><p>The attachment binary data.</p></td>
</tr>
<tr>
<td>string</td>
<td>$cid </td>
<td><p>Content ID of the attachment; Use this to reference</p>
<pre><code> the content when using an embedded image in HTML.</code></pre></td>
</tr>
<tr>
<td>string</td>
<td>$name </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$encoding </td>
<td><p>File encoding (see $Encoding).</p></td>
</tr>
<tr>
<td>string</td>
<td>$type </td>
<td><p>MIME type.</p></td>
</tr>
<tr>
<td>string</td>
<td>$disposition </td>
<td><p>Disposition to use</p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
&mdash; <p>True on successfully adding an attachment</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_inlineImageExists" name="method_inlineImageExists" class="anchor"></a>
<article class="method">
<h3 class="public ">inlineImageExists()</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;">inlineImageExists() : boolean</pre>
<p><em>Check if an inline attachment is present.</em></p>
<h4>Returns</h4>
boolean
</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_attachmentExists" name="method_attachmentExists" class="anchor"></a>
<article class="method">
<h3 class="public ">attachmentExists()</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;">attachmentExists() : boolean</pre>
<p><em>Check if an attachment (non-inline) is present.</em></p>
<h4>Returns</h4>
boolean
</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_alternativeExists" name="method_alternativeExists" class="anchor"></a>
<article class="method">
<h3 class="public ">alternativeExists()</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;">alternativeExists() : boolean</pre>
<p><em>Check if this message has an alternative body set.</em></p>
<h4>Returns</h4>
boolean
</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_clearAddresses" name="method_clearAddresses" class="anchor"></a>
<article class="method">
<h3 class="public ">clearAddresses()</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;">clearAddresses() : void</pre>
<p><em>Clear all To recipients.</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_clearCCs" name="method_clearCCs" class="anchor"></a>
<article class="method">
<h3 class="public ">clearCCs()</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;">clearCCs() : void</pre>
<p><em>Clear all CC recipients.</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_clearBCCs" name="method_clearBCCs" class="anchor"></a>
<article class="method">
<h3 class="public ">clearBCCs()</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;">clearBCCs() : void</pre>
<p><em>Clear all BCC recipients.</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_clearReplyTos" name="method_clearReplyTos" class="anchor"></a>
<article class="method">
<h3 class="public ">clearReplyTos()</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;">clearReplyTos() : void</pre>
<p><em>Clear all ReplyTo recipients.</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_clearAllRecipients" name="method_clearAllRecipients" class="anchor"></a>
<article class="method">
<h3 class="public ">clearAllRecipients()</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;">clearAllRecipients() : void</pre>
<p><em>Clear all recipient types.</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_clearAttachments" name="method_clearAttachments" class="anchor"></a>
<article class="method">
<h3 class="public ">clearAttachments()</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;">clearAttachments() : void</pre>
<p><em>Clear all filesystem, string, and binary attachments.</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_clearCustomHeaders" name="method_clearCustomHeaders" class="anchor"></a>
<article class="method">
<h3 class="public ">clearCustomHeaders()</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;">clearCustomHeaders() : void</pre>
<p><em>Clear all custom headers.</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_rfcDate" name="method_rfcDate" class="anchor"></a>
<article class="method">
<h3 class="public ">rfcDate()</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;">rfcDate() : string</pre>
<p><em>Return an RFC 822 formatted date.</em></p>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
static
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_isError" name="method_isError" class="anchor"></a>
<article class="method">
<h3 class="public ">isError()</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;">isError() : boolean</pre>
<p><em>Check if an error occurred.</em></p>
<h4>Returns</h4>
boolean
&mdash; <p>True if an error did occur.</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_fixEOL" name="method_fixEOL" class="anchor"></a>
<article class="method">
<h3 class="public ">fixEOL()</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;">fixEOL(string <span class="argument">$str</span>) : string</pre>
<p><em>Ensure consistent line endings in a string.</em></p>
<p>Changes every end of line from CRLF, CR or LF to $this->LE.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str </td>
<td><p>String to fixEOL</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_addCustomHeader" name="method_addCustomHeader" class="anchor"></a>
<article class="method">
<h3 class="public ">addCustomHeader()</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;">addCustomHeader(string <span class="argument">$name</span>, string <span class="argument">$value = null</span>) : void</pre>
<p><em>Add a custom header.</em></p>
<p>$name value can be overloaded to contain
both header name and value (name:value)</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$name </td>
<td><p>Custom header name</p></td>
</tr>
<tr>
<td>string</td>
<td>$value </td>
<td><p>Header value</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_msgHTML" name="method_msgHTML" class="anchor"></a>
<article class="method">
<h3 class="public ">msgHTML()</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;">msgHTML(string <span class="argument">$message</span>, string <span class="argument">$basedir = &#039;&#039;</span>, boolean <span class="argument">$advanced = false</span>) : string</pre>
<p><em>Create a message from an HTML string.</em></p>
<p>Automatically makes modifications for inline images and backgrounds
and creates a plain-text version by converting the HTML.
Overwrites any existing values in $this->Body and $this->AltBody</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$message </td>
<td><p>HTML message string</p></td>
</tr>
<tr>
<td>string</td>
<td>$basedir </td>
<td><p>baseline directory for path</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$advanced </td>
<td><p>Whether to use the advanced HTML to text converter</p></td>
</tr>
</table>
<h4>Returns</h4>
string
&mdash; <p>$message</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_html2text" name="method_html2text" class="anchor"></a>
<article class="method">
<h3 class="public ">html2text()</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;">html2text(string <span class="argument">$html</span>, boolean <span class="argument">$advanced = false</span>) : string</pre>
<p><em>Convert an HTML string into plain text.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$html </td>
<td><p>The HTML text to convert</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$advanced </td>
<td><p>Should this use the more complex html2text converter or just a simple one?</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</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__mime_types" name="method__mime_types" class="anchor"></a>
<article class="method">
<h3 class="public ">_mime_types()</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;">_mime_types(string <span class="argument">$ext = &#039;&#039;</span>) : string</pre>
<p><em>Get the MIME type for a file extension.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$ext </td>
<td><p>File extension</p></td>
</tr>
</table>
<h4>Returns</h4>
string
&mdash; <p>MIME type of file.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
static
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_filenameToType" name="method_filenameToType" class="anchor"></a>
<article class="method">
<h3 class="public ">filenameToType()</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;">filenameToType(string <span class="argument">$filename</span>) : string</pre>
<p><em>Map a file name to a MIME type.</em></p>
<p>Defaults to 'application/octet-stream', i.e.. arbitrary binary data.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$filename </td>
<td><p>A file name or full path, does not need to exist as a file</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
static
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_mb_pathinfo" name="method_mb_pathinfo" class="anchor"></a>
<article class="method">
<h3 class="public ">mb_pathinfo()</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;">mb_pathinfo(string <span class="argument">$path</span>, integer|string <span class="argument">$options = null</span>) : string|array</pre>
<p><em>Multi-byte-safe pathinfo replacement.</em></p>
<p>Drop-in replacement for pathinfo(), but multibyte-safe, cross-platform-safe, old-version-safe.
Works similarly to the one in PHP >= 5.2.0</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$path </td>
<td><p>A filename or path, does not need to exist as a file</p></td>
</tr>
<tr>
<td>integer|string</td>
<td>$options </td>
<td><p>Either a PATHINFO_* constant,</p>
<pre><code> or a string name to return only the specified piece, allows 'filename' to work on PHP &lt; 5.2</code></pre></td>
</tr>
</table>
<h4>Returns</h4>
string|array
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
<dt>See also</dt>
<dd><a href="http://www.php.net/manual/en/function.pathinfo.php#107461"><span class="namespace-wrapper">http://www.php.net/manual/en/function.pathinfo.php#107461</span></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
static
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_set" name="method_set" class="anchor"></a>
<article class="method">
<h3 class="public ">set()</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;">set(string <span class="argument">$name</span>, mixed <span class="argument">$value = &#039;&#039;</span>) : boolean</pre>
<p><em>Set or reset instance properties.</em></p>
<p>Usage Example:
$page->set('X-Priority', '3');</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$name </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$value </td>
<td><p>NOTE: will not work with arrays, there are no arrays to set/reset</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</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>
<th>
todo
</th>
<td>
<p>Should this not be using __set() magic function?</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_secureHeader" name="method_secureHeader" class="anchor"></a>
<article class="method">
<h3 class="public ">secureHeader()</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;">secureHeader(string <span class="argument">$str</span>) : string</pre>
<p><em>Strip newlines to prevent header injection.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_normalizeBreaks" name="method_normalizeBreaks" class="anchor"></a>
<article class="method">
<h3 class="public ">normalizeBreaks()</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;">normalizeBreaks(string <span class="argument">$text</span>, string <span class="argument">$breaktype = &quot;\r\n&quot;</span>) : string</pre>
<p><em>Normalize line breaks in a string.</em></p>
<p>Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format.
Defaults to CRLF (for message bodies) and preserves consecutive breaks.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$breaktype </td>
<td><p>What kind of line break to use, defaults to CRLF</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
static
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_sign" name="method_sign" class="anchor"></a>
<article class="method">
<h3 class="public ">sign()</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;">sign(string <span class="argument">$cert_filename</span>, string <span class="argument">$key_filename</span>, string <span class="argument">$key_pass</span>) </pre>
<p><em>Set the public and private key files and password for S/MIME signing.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$cert_filename </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$key_filename </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$key_pass </td>
<td><p>Password for private key</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_DKIM_QP" name="method_DKIM_QP" class="anchor"></a>
<article class="method">
<h3 class="public ">DKIM_QP()</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;">DKIM_QP(string <span class="argument">$txt</span>) : string</pre>
<p><em>Quoted-Printable-encode a DKIM header.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$txt </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_DKIM_Sign" name="method_DKIM_Sign" class="anchor"></a>
<article class="method">
<h3 class="public ">DKIM_Sign()</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;">DKIM_Sign(string <span class="argument">$signheader</span>) : string</pre>
<p><em>Generate a DKIM signature.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$signheader </td>
<td><p>Header</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
string
</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_DKIM_HeaderC" name="method_DKIM_HeaderC" class="anchor"></a>
<article class="method">
<h3 class="public ">DKIM_HeaderC()</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;">DKIM_HeaderC(string <span class="argument">$signheader</span>) : string</pre>
<p><em>Generate a DKIM canonicalization header.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$signheader </td>
<td><p>Header</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_DKIM_BodyC" name="method_DKIM_BodyC" class="anchor"></a>
<article class="method">
<h3 class="public ">DKIM_BodyC()</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;">DKIM_BodyC(string <span class="argument">$body</span>) : string</pre>
<p><em>Generate a DKIM canonicalization body.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$body </td>
<td><p>Message Body</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_DKIM_Add" name="method_DKIM_Add" class="anchor"></a>
<article class="method">
<h3 class="public ">DKIM_Add()</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;">DKIM_Add(string <span class="argument">$headers_line</span>, string <span class="argument">$subject</span>, string <span class="argument">$body</span>) : string</pre>
<p><em>Create the DKIM header and body in a new message header.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$headers_line </td>
<td><p>Header lines</p></td>
</tr>
<tr>
<td>string</td>
<td>$subject </td>
<td><p>Subject</p></td>
</tr>
<tr>
<td>string</td>
<td>$body </td>
<td><p>Body</p></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_getToAddresses" name="method_getToAddresses" class="anchor"></a>
<article class="method">
<h3 class="public ">getToAddresses()</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;">getToAddresses() : array</pre>
<p><em>Allows for public read access to &#039;to&#039; property.</em></p>
<h4>Returns</h4>
array
</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_getCcAddresses" name="method_getCcAddresses" class="anchor"></a>
<article class="method">
<h3 class="public ">getCcAddresses()</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;">getCcAddresses() : array</pre>
<p><em>Allows for public read access to &#039;cc&#039; property.</em></p>
<h4>Returns</h4>
array
</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_getBccAddresses" name="method_getBccAddresses" class="anchor"></a>
<article class="method">
<h3 class="public ">getBccAddresses()</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;">getBccAddresses() : array</pre>
<p><em>Allows for public read access to &#039;bcc&#039; property.</em></p>
<h4>Returns</h4>
array
</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_getReplyToAddresses" name="method_getReplyToAddresses" class="anchor"></a>
<article class="method">
<h3 class="public ">getReplyToAddresses()</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;">getReplyToAddresses() : array</pre>
<p><em>Allows for public read access to &#039;ReplyTo&#039; property.</em></p>
<h4>Returns</h4>
array
</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_getAllRecipientAddresses" name="method_getAllRecipientAddresses" class="anchor"></a>
<article class="method">
<h3 class="public ">getAllRecipientAddresses()</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;">getAllRecipientAddresses() : array</pre>
<p><em>Allows for public read access to &#039;all_recipients&#039; property.</em></p>
<h4>Returns</h4>
array
</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_edebug" name="method_edebug" class="anchor"></a>
<article class="method">
<h3 class="protected ">edebug()</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;">edebug(string <span class="argument">$str</span>) </pre>
<p><em>Output debugging info via user-defined method.</em></p>
<p>Only if debug output is enabled.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$str </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/PHPMailer.html#property_Debugoutput"><span class="namespace-wrapper"></span></a></dd>
<dd><a href="../classes/PHPMailer.html#property_SMTPDebug"><span class="namespace-wrapper"></span></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_addAnAddress" name="method_addAnAddress" class="anchor"></a>
<article class="method">
<h3 class="protected ">addAnAddress()</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;">addAnAddress(string <span class="argument">$kind</span>, string <span class="argument">$address</span>, string <span class="argument">$name = &#039;&#039;</span>) : boolean</pre>
<p><em>Add an address to one of the recipient arrays.</em></p>
<p>Addresses that have been added already return false, but do not throw exceptions</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$kind </td>
<td><p>One of 'to', 'cc', 'bcc', 'ReplyTo'</p></td>
</tr>
<tr>
<td>string</td>
<td>$address </td>
<td><p>The email address to send to</p></td>
</tr>
<tr>
<td>string</td>
<td>$name </td>
<td></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
&mdash; <p>true on success, false if address already used or invalid in some way</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_sendmailSend" name="method_sendmailSend" class="anchor"></a>
<article class="method">
<h3 class="protected ">sendmailSend()</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;">sendmailSend(string <span class="argument">$header</span>, string <span class="argument">$body</span>) : boolean</pre>
<p><em>Send mail using the $Sendmail program.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$header </td>
<td><p>The message headers</p></td>
</tr>
<tr>
<td>string</td>
<td>$body </td>
<td><p>The message body</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/PHPMailer.html#property_Sendmail"><span class="namespace-wrapper"></span></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_mailSend" name="method_mailSend" class="anchor"></a>
<article class="method">
<h3 class="protected ">mailSend()</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;">mailSend(string <span class="argument">$header</span>, string <span class="argument">$body</span>) : boolean</pre>
<p><em>Send mail using the PHP mail() function.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$header </td>
<td><p>The message headers</p></td>
</tr>
<tr>
<td>string</td>
<td>$body </td>
<td><p>The message body</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="http://www.php.net/manual/en/book.mail.php"><span class="namespace-wrapper">http://www.php.net/manual/en/book.mail.php</span></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_smtpSend" name="method_smtpSend" class="anchor"></a>
<article class="method">
<h3 class="protected ">smtpSend()</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;">smtpSend(string <span class="argument">$header</span>, string <span class="argument">$body</span>) : boolean</pre>
<p><em>Send mail via SMTP.</em></p>
<p>Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
Uses the PHPMailerSMTP class by default.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$header </td>
<td><p>The message headers</p></td>
</tr>
<tr>
<td>string</td>
<td>$body </td>
<td><p>The message body</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
boolean
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="../classes/PHPMailer.html#method_getSMTPInstance"><span class="namespace-wrapper">to use a different class.</span></a></dd>
<dt>Uses</dt>
<dd>SMTP</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_getBoundary" name="method_getBoundary" class="anchor"></a>
<article class="method">
<h3 class="protected ">getBoundary()</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;">getBoundary(string <span class="argument">$boundary</span>, string <span class="argument">$charSet</span>, string <span class="argument">$contentType</span>, string <span class="argument">$encoding</span>) : string</pre>
<p><em>Return the start of a message boundary.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$boundary </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$charSet </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$contentType </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$encoding </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_endBoundary" name="method_endBoundary" class="anchor"></a>
<article class="method">
<h3 class="protected ">endBoundary()</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;">endBoundary(string <span class="argument">$boundary</span>) : string</pre>
<p><em>Return the end of a message boundary.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$boundary </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_setMessageType" name="method_setMessageType" class="anchor"></a>
<article class="method">
<h3 class="protected ">setMessageType()</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;">setMessageType() : void</pre>
<p><em>Set the message type.</em></p>
<p>PHPMailer only supports some preset message types,
not arbitrary MIME structures.</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_attachAll" name="method_attachAll" class="anchor"></a>
<article class="method">
<h3 class="protected ">attachAll()</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;">attachAll(string <span class="argument">$disposition_type</span>, string <span class="argument">$boundary</span>) : string</pre>
<p><em>Attach all file, string, and binary attachments to the message.</em></p>
<p>Returns an empty string on failure.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$disposition_type </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$boundary </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_encodeFile" name="method_encodeFile" class="anchor"></a>
<article class="method">
<h3 class="protected ">encodeFile()</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;">encodeFile(string <span class="argument">$path</span>, string <span class="argument">$encoding = &#039;base64&#039;</span>) : string</pre>
<p><em>Encode a file attachment in requested format.</em></p>
<p>Returns an empty string on failure.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$path </td>
<td><p>The full path to the file</p></td>
</tr>
<tr>
<td>string</td>
<td>$encoding </td>
<td><p>The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\phpmailerException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href=""><span class="namespace-wrapper"></span></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_setError" name="method_setError" class="anchor"></a>
<article class="method">
<h3 class="protected ">setError()</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;">setError(string <span class="argument">$msg</span>) : void</pre>
<p><em>Add an error message to the error container.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$msg </td>
<td></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_serverHostname" name="method_serverHostname" class="anchor"></a>
<article class="method">
<h3 class="protected ">serverHostname()</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;">serverHostname() : string</pre>
<p><em>Get the server hostname.</em></p>
<p>Returns 'localhost.localdomain' if unknown.</p>
<h4>Returns</h4>
string
</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_lang" name="method_lang" class="anchor"></a>
<article class="method">
<h3 class="protected ">lang()</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;">lang(string <span class="argument">$key</span>) : string</pre>
<p><em>Get an error message in the current language.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$key </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</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_doCallback" name="method_doCallback" class="anchor"></a>
<article class="method">
<h3 class="protected ">doCallback()</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;">doCallback(boolean <span class="argument">$isSent</span>, string <span class="argument">$to</span>, string <span class="argument">$cc</span>, string <span class="argument">$bcc</span>, string <span class="argument">$subject</span>, string <span class="argument">$body</span>, string <span class="argument">$from = null</span>) </pre>
<p><em>Perform a callback.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$isSent </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$to </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$cc </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$bcc </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$subject </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$body </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$from </td>
<td></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_mailPassthru" name="method_mailPassthru" class="anchor"></a>
<article class="method">
<h3 class="private ">mailPassthru()</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;">mailPassthru(string <span class="argument">$to</span>, string <span class="argument">$subject</span>, string <span class="argument">$body</span>, string <span class="argument">$header</span>, string <span class="argument">$params</span>) : boolean</pre>
<p><em>Call mail() in a safe_mode-aware fashion.</em></p>
<p>Also, unless sendmail_path points to sendmail (or something that
claims to be sendmail), don't pass params (not a perfect fix,
but it will do)</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$to </td>
<td><p>To</p></td>
</tr>
<tr>
<td>string</td>
<td>$subject </td>
<td><p>Subject</p></td>
</tr>
<tr>
<td>string</td>
<td>$body </td>
<td><p>Message Body</p></td>
</tr>
<tr>
<td>string</td>
<td>$header </td>
<td><p>Additional Header(s)</p></td>
</tr>
<tr>
<td>string</td>
<td>$params </td>
<td><p>Params</p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
</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">PHPMailer.inc</h3>
</div>
<div class="modal-body">
<pre data-src="../files/app/lib/PHPMailer.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 September 16th, 2014 at 10:57.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink