mirror
/
PHPMailer
mirror of https://github.com/PHPMailer/PHPMailer.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
PHPMailer/classes/PHPMailer-PHPMailer-SMTP.html

4238 lines
194 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHPMailer</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHPMailer</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/phpmailer.html" class="">PHPMailer</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/phpmailer-phpmailer.html" class="">PHPMailer</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category -reports">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpmailer.html">PHPMailer</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpmailer-phpmailer.html">PHPMailer</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
SMTP
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
</ul>
</div>
</h2>
<div class="phpdocumentor-label-line">
</div>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">PHPMailer RFC821 SMTP email transport class.</p>
<section class="phpdocumentor-description"><p>Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Chris Ryan</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Marcus Bointon <a href="mailto:phpmailer@synchromedia.co.uk">phpmailer@synchromedia.co.uk</a></p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">used-by</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/PHPMailer-PHPMailer-PHPMailer.html#method_smtpSend"><abbr title="\PHPMailer\PHPMailer\PHPMailer::smtpSend()">PHPMailer::smtpSend()</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">used-by</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/PHPMailer-PHPMailer-PHPMailer.html#method_smtpConnect"><abbr title="\PHPMailer\PHPMailer\PHPMailer::smtpConnect()">PHPMailer::smtpConnect()</abbr></a></span>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/PHPMailer-PHPMailer-SMTP.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-constants">
Constants
<a href="classes/PHPMailer-PHPMailer-SMTP.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_CLIENT">DEBUG_CLIENT</a>
<span>
&nbsp;= 1 </span>
</dt>
<dd>Debug level to show client -&gt; server messages.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_CONNECTION">DEBUG_CONNECTION</a>
<span>
&nbsp;= 3 </span>
</dt>
<dd>Debug level to show connection status, client -&gt; server and server -&gt; client messages.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_LOWLEVEL">DEBUG_LOWLEVEL</a>
<span>
&nbsp;= 4 </span>
</dt>
<dd>Debug level to show all messages.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_OFF">DEBUG_OFF</a>
<span>
&nbsp;= 0 </span>
</dt>
<dd>Debug level for no output.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_SERVER">DEBUG_SERVER</a>
<span>
&nbsp;= 2 </span>
</dt>
<dd>Debug level to show client -&gt; server and server -&gt; client messages.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEFAULT_PORT">DEFAULT_PORT</a>
<span>
&nbsp;= 25 </span>
</dt>
<dd>The SMTP port to use if one is not specified.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEFAULT_SECURE_PORT">DEFAULT_SECURE_PORT</a>
<span>
&nbsp;= 465 </span>
</dt>
<dd>The SMTPs port to use if one is not specified.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_LE">LE</a>
<span>
&nbsp;= &quot;\r\n&quot; </span>
</dt>
<dd>SMTP line break constant.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_MAX_LINE_LENGTH">MAX_LINE_LENGTH</a>
<span>
&nbsp;= 998 </span>
</dt>
<dd>The maximum line length allowed by RFC 5321 section 4.5.3.1.6,
*excluding* a trailing CRLF break.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_MAX_REPLY_LENGTH">MAX_REPLY_LENGTH</a>
<span>
&nbsp;= 512 </span>
</dt>
<dd>The maximum line length allowed for replies in RFC 5321 section 4.5.3.1.5,
*including* a trailing CRLF line break.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#constant_VERSION">VERSION</a>
<span>
&nbsp;= &#039;7.0.0&#039; </span>
</dt>
<dd>The PHPMailer SMTP version number.</dd>
</dl>
<h4 id="toc-properties">
Properties
<a href="classes/PHPMailer-PHPMailer-SMTP.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_Debugoutput">$Debugoutput</a>
<span>
&nbsp;: string|callable|<abbr title="\Psr\Log\LoggerInterface">LoggerInterface</abbr> </span>
</dt>
<dd>How to handle debug output.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_debug">$do_debug</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Debug output level.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_smtputf8">$do_smtputf8</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Whether to use SMTPUTF8.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_verp">$do_verp</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Whether to use VERP.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_Timelimit">$Timelimit</a>
<span>
&nbsp;: int </span>
</dt>
<dd>How long to wait for commands to complete, in seconds.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_Timeout">$Timeout</a>
<span>
&nbsp;: int </span>
</dt>
<dd>The timeout value for connection, in seconds.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_xclient_allowed_attributes">$xclient_allowed_attributes</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Allowed SMTP XCLIENT attributes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_error">$error</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Error information, if any, for the last SMTP command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_helo_rply">$helo_rply</a>
<span>
&nbsp;: string|null </span>
</dt>
<dd>The reply the server sent to us for HELO.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_last_reply">$last_reply</a>
<span>
&nbsp;: string </span>
</dt>
<dd>The most recent reply received from the server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_last_smtp_transaction_id">$last_smtp_transaction_id</a>
<span>
&nbsp;: string|bool|null </span>
</dt>
<dd>The last transaction ID issued in response to a DATA command,
if one was detected.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_server_caps">$server_caps</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>The set of SMTP extensions sent in reply to EHLO command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_smtp_conn">$smtp_conn</a>
<span>
&nbsp;: resource|null </span>
</dt>
<dd>The socket for the server connection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#property_smtp_transaction_id_patterns">$smtp_transaction_id_patterns</a>
<span>
&nbsp;: array&lt;string|int, string&gt; </span>
</dt>
<dd>Patterns to extract an SMTP transaction id from reply to a DATA command.</dd>
</dl>
<h4 id="toc-methods">
Methods
<a href="classes/PHPMailer-PHPMailer-SMTP.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_authenticate">authenticate()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Perform SMTP authentication.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_client_send">client_send()</a>
<span>
&nbsp;: int|bool </span>
</dt>
<dd>Send raw data to the server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_close">close()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Close the socket and clean up the state of the class.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_connect">connect()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Connect to an SMTP server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_connected">connected()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Check connection state.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_data">data()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP DATA command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getDebugLevel">getDebugLevel()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Get debug output level.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getDebugOutput">getDebugOutput()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get debug output method.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getError">getError()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Get the latest error.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getLastReply">getLastReply()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the last reply from the server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getLastTransactionID">getLastTransactionID()</a>
<span>
&nbsp;: bool|string|null </span>
</dt>
<dd>Get the queue/transaction ID of the last SMTP transaction
If no reply has been received yet, it will return null.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getServerExt">getServerExt()</a>
<span>
&nbsp;: string|bool|null </span>
</dt>
<dd>Get metadata about the SMTP server from its HELO/EHLO response.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getServerExtList">getServerExtList()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Get SMTP extensions available on the server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getSMTPUTF8">getSMTPUTF8()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Get SMTPUTF8 use.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getTimeout">getTimeout()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Get SMTP timeout.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getVerp">getVerp()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Get VERP address generation mode.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_hello">hello()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP HELO or EHLO command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_mail">mail()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP MAIL command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_noop">noop()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP NOOP command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_quit">quit()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP QUIT command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_recipient">recipient()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP RCPT command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_reset">reset()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP RSET command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendAndMail">sendAndMail()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP SAML command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_setDebugLevel">setDebugLevel()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set debug output level.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_setDebugOutput">setDebugOutput()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set debug output method.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_setSMTPUTF8">setSMTPUTF8()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Enable or disable use of SMTPUTF8.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_setTimeout">setTimeout()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set SMTP timeout.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_setVerp">setVerp()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Enable or disable VERP address generation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_startTLS">startTLS()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Initiate a TLS (encrypted) session.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_turn">turn()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP TURN command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_verify">verify()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP VRFY command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_xclient">xclient()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send SMTP XCLIENT command to server and check its return code.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_edebug">edebug()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Output debugging info via a user-selected method.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_errorHandler">errorHandler()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Reports an error number and string.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_get_lines">get_lines()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Read the SMTP server&#039;s response.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_getSMTPConnection">getSMTPConnection()</a>
<span>
&nbsp;: false|resource </span>
</dt>
<dd>Create connection to the SMTP server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_hmac">hmac()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Calculate an MD5 HMAC hash.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_parseHelloFields">parseHelloFields()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Parse a reply to HELO/EHLO command to discover server extensions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_recordLastTransactionID">recordLastTransactionID()</a>
<span>
&nbsp;: bool|string|null </span>
</dt>
<dd>Extract and return the ID of the last SMTP transaction based on
a list of patterns provided in SMTP::$smtp_transaction_id_patterns.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendCommand">sendCommand()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send a command to an SMTP server and check its return code.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendHello">sendHello()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Send an SMTP HELO or EHLO command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-SMTP.html#method_setError">setError()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set error messages and codes.</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DEBUG_CLIENT">
DEBUG_CLIENT
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_CLIENT" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">93</span>
</aside>
<p class="phpdocumentor-summary">Debug level to show client -&gt; server messages.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">DEBUG_CLIENT</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DEBUG_CONNECTION">
DEBUG_CONNECTION
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_CONNECTION" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">107</span>
</aside>
<p class="phpdocumentor-summary">Debug level to show connection status, client -&gt; server and server -&gt; client messages.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">DEBUG_CONNECTION</span>
= <span class="phpdocumentor-signature__default-value">3</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DEBUG_LOWLEVEL">
DEBUG_LOWLEVEL
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_LOWLEVEL" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
</aside>
<p class="phpdocumentor-summary">Debug level to show all messages.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">DEBUG_LOWLEVEL</span>
= <span class="phpdocumentor-signature__default-value">4</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DEBUG_OFF">
DEBUG_OFF
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_OFF" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Debug level for no output.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">DEBUG_OFF</span>
= <span class="phpdocumentor-signature__default-value">0</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DEBUG_SERVER">
DEBUG_SERVER
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_SERVER" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">100</span>
</aside>
<p class="phpdocumentor-summary">Debug level to show client -&gt; server and server -&gt; client messages.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">DEBUG_SERVER</span>
= <span class="phpdocumentor-signature__default-value">2</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_PORT">
DEFAULT_PORT
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEFAULT_PORT" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">The SMTP port to use if one is not specified.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">DEFAULT_PORT</span>
= <span class="phpdocumentor-signature__default-value">25</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_SECURE_PORT">
DEFAULT_SECURE_PORT
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEFAULT_SECURE_PORT" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">The SMTPs port to use if one is not specified.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">DEFAULT_SECURE_PORT</span>
= <span class="phpdocumentor-signature__default-value">465</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_LE">
LE
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_LE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">SMTP line break constant.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">LE</span>
= <span class="phpdocumentor-signature__default-value">&quot;\r\n&quot;</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_MAX_LINE_LENGTH">
MAX_LINE_LENGTH
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_MAX_LINE_LENGTH" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">The maximum line length allowed by RFC 5321 section 4.5.3.1.6,
*excluding* a trailing CRLF break.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">MAX_LINE_LENGTH</span>
= <span class="phpdocumentor-signature__default-value">998</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_MAX_LINE_LENGTH#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://www.rfc-editor.org/rfc/rfc5321#section-4.5.3.1.6">https://www.rfc-editor.org/rfc/rfc5321#section-4.5.3.1.6</a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_MAX_REPLY_LENGTH">
MAX_REPLY_LENGTH
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_MAX_REPLY_LENGTH" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">The maximum line length allowed for replies in RFC 5321 section 4.5.3.1.5,
*including* a trailing CRLF line break.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">MAX_REPLY_LENGTH</span>
= <span class="phpdocumentor-signature__default-value">512</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_MAX_REPLY_LENGTH#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://www.rfc-editor.org/rfc/rfc5321#section-4.5.3.1.5">https://www.rfc-editor.org/rfc/rfc5321#section-4.5.3.1.5</a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_VERSION">
VERSION
<a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">The PHPMailer SMTP version number.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">VERSION</span>
= <span class="phpdocumentor-signature__default-value">&#039;7.0.0&#039;</span>
</code>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PHPMailer-PHPMailer-SMTP.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_Debugoutput">
$Debugoutput
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_Debugoutput" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
</aside>
<p class="phpdocumentor-summary">How to handle debug output.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string|callable|<abbr title="\Psr\Log\LoggerInterface">LoggerInterface</abbr></span>
<span class="phpdocumentor-signature__name">$Debugoutput</span>
= <span class="phpdocumentor-signature__default-value">&#039;echo&#039;</span></code>
<section class="phpdocumentor-description"><p>Options:</p>
<ul>
<li><code class="prettyprint">echo</code> Output plain-text as-is, appropriate for CLI</li>
<li><code class="prettyprint">html</code> Output escaped, line breaks converted to <code class="prettyprint">&lt;br&gt;</code>, appropriate for browser output</li>
<li><code class="prettyprint">error_log</code> Output to error log as configured in php.ini
Alternatively, you can provide a callable expecting two params: a message string and the debug level:</li>
</ul>
<pre class="prettyprint"><code class="language-php">$smtp-&gt;Debugoutput = function($str, $level) {echo &quot;debug level $level; message: $str&quot;;};
</code></pre>
<p>Alternatively, you can pass in an instance of a PSR-3 compatible logger, though only <code class="prettyprint">debug</code>
level output is used:</p>
<pre class="prettyprint"><code class="language-php">$mail-&gt;Debugoutput = new myPsr3Logger;
</code></pre>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_do_debug">
$do_debug
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_debug" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">127</span>
</aside>
<p class="phpdocumentor-summary">Debug output level.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$do_debug</span>
= <span class="phpdocumentor-signature__default-value">self::DEBUG_OFF</span></code>
<section class="phpdocumentor-description"><p>Options:</p>
<ul>
<li>self::DEBUG_OFF (<code class="prettyprint">0</code>) No debug output, default</li>
<li>self::DEBUG_CLIENT (<code class="prettyprint">1</code>) Client commands</li>
<li>self::DEBUG_SERVER (<code class="prettyprint">2</code>) Client commands and server responses</li>
<li>self::DEBUG_CONNECTION (<code class="prettyprint">3</code>) As DEBUG_SERVER plus connection status</li>
<li>self::DEBUG_LOWLEVEL (<code class="prettyprint">4</code>) Low-level data output, all messages.</li>
</ul>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_do_smtputf8">
$do_smtputf8
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_smtputf8" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">169</span>
</aside>
<p class="phpdocumentor-summary">Whether to use SMTPUTF8.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$do_smtputf8</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_smtputf8#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://www.rfc-editor.org/rfc/rfc6531">https://www.rfc-editor.org/rfc/rfc6531</a></span>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_do_verp">
$do_verp
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_verp" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">160</span>
</aside>
<p class="phpdocumentor-summary">Whether to use VERP.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$do_verp</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_verp#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://en.wikipedia.org/wiki/Variable_envelope_return_path">https://en.wikipedia.org/wiki/Variable_envelope_return_path</a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://www.postfix.org/VERP_README.html">https://www.postfix.org/VERP_README.html</a></span>
<section class="phpdocumentor-description"><p>Info on VERP</p>
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_Timelimit">
$Timelimit
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_Timelimit" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">188</span>
</aside>
<p class="phpdocumentor-summary">How long to wait for commands to complete, in seconds.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$Timelimit</span>
= <span class="phpdocumentor-signature__default-value">300</span></code>
<section class="phpdocumentor-description"><p>Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_Timeout">
$Timeout
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_Timeout" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">180</span>
</aside>
<p class="phpdocumentor-summary">The timeout value for connection, in seconds.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$Timeout</span>
= <span class="phpdocumentor-signature__default-value">300</span></code>
<section class="phpdocumentor-description"><p>Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2.
This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_Timeout#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://www.rfc-editor.org/rfc/rfc2821#section-4.5.3.2">https://www.rfc-editor.org/rfc/rfc2821#section-4.5.3.2</a></span>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="property_xclient_allowed_attributes">
$xclient_allowed_attributes
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_xclient_allowed_attributes" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">219</span>
</aside>
<p class="phpdocumentor-summary">Allowed SMTP XCLIENT attributes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$xclient_allowed_attributes</span>
= <span class="phpdocumentor-signature__default-value">[&#039;NAME&#039;, &#039;ADDR&#039;, &#039;PORT&#039;, &#039;PROTO&#039;, &#039;HELO&#039;, &#039;LOGIN&#039;, &#039;DESTADDR&#039;, &#039;DESTPORT&#039;]</span></code>
<section class="phpdocumentor-description"><p>Must be allowed by the SMTP server. EHLO response is not checked.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_xclient_allowed_attributes#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://www.postfix.org/XCLIENT_README.html">https://www.postfix.org/XCLIENT_README.html</a></span>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_error">
$error
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_error" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">243</span>
</aside>
<p class="phpdocumentor-summary">Error information, if any, for the last SMTP command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$error</span>
= <span class="phpdocumentor-signature__default-value">[&#039;error&#039; =&gt; &#039;&#039;, &#039;detail&#039; =&gt; &#039;&#039;, &#039;smtp_code&#039; =&gt; &#039;&#039;, &#039;smtp_code_ex&#039; =&gt; &#039;&#039;]</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_helo_rply">
$helo_rply
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_helo_rply" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">256</span>
</aside>
<p class="phpdocumentor-summary">The reply the server sent to us for HELO.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$helo_rply</span>
</code>
<section class="phpdocumentor-description"><p>If null, no HELO string has yet been received.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_last_reply">
$last_reply
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_last_reply" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">275</span>
</aside>
<p class="phpdocumentor-summary">The most recent reply received from the server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$last_reply</span>
= <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_last_smtp_transaction_id">
$last_smtp_transaction_id
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_last_smtp_transaction_id" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">229</span>
</aside>
<p class="phpdocumentor-summary">The last transaction ID issued in response to a DATA command,
if one was detected.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string|bool|null</span>
<span class="phpdocumentor-signature__name">$last_smtp_transaction_id</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_server_caps">
$server_caps
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_server_caps" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">268</span>
</aside>
<p class="phpdocumentor-summary">The set of SMTP extensions sent in reply to EHLO command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
<span class="phpdocumentor-signature__name">$server_caps</span>
</code>
<section class="phpdocumentor-description"><p>Indexes of the array are extension names.
Value at index 'HELO' or 'EHLO' (according to command that was sent)
represents the server name. In case of HELO it is the only element of the array.
Other values can be boolean TRUE or an array containing extension options.
If null, no HELO/EHLO string has yet been received.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_smtp_conn">
$smtp_conn
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_smtp_conn" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">236</span>
</aside>
<p class="phpdocumentor-summary">The socket for the server connection.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">resource|null</span>
<span class="phpdocumentor-signature__name">$smtp_conn</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_smtp_transaction_id_patterns">
$smtp_transaction_id_patterns
<a href="classes/PHPMailer-PHPMailer-SMTP.html#property_smtp_transaction_id_patterns" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">197</span>
</aside>
<p class="phpdocumentor-summary">Patterns to extract an SMTP transaction id from reply to a DATA command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, string&gt;</span>
<span class="phpdocumentor-signature__name">$smtp_transaction_id_patterns</span>
= <span class="phpdocumentor-signature__default-value">[&#039;exim&#039; =&gt; &#039;/[\d]{3} OK id=(.*)/&#039;, &#039;sendmail&#039; =&gt; &#039;/[\d]{3} 2\.0\.0 (.*) Message/&#039;, &#039;postfix&#039; =&gt; &#039;/[\d]{3} 2\.0\.0 Ok: queued as (.*)/&#039;, &#039;Microsoft_ESMTP&#039; =&gt; &#039;/[0-9]{3} 2\.[\d]\.0 (.*)@(?:.*) Queued mail for delivery/&#039;, &#039;Amazon_SES&#039; =&gt; &#039;/[\d]{3} Ok (.*)/&#039;, &#039;SendGrid&#039; =&gt; &#039;/[\d]{3} Ok: queued as (.*)/&#039;, &#039;CampaignMonitor&#039; =&gt; &#039;/[\d]{3} 2\.0\.0 OK:([a-zA-Z\d]{48})/&#039;, &#039;Haraka&#039; =&gt; &#039;/[\d]{3} Message Queued \((.*)\)/&#039;, &#039;ZoneMTA&#039; =&gt; &#039;/[\d]{3} Message queued as (.*)/&#039;, &#039;Mailjet&#039; =&gt; &#039;/[\d]{3} OK queued as (.*)/&#039;, &#039;Gsmtp&#039; =&gt; &#039;/[\d]{3} 2\.0\.0 OK (.*) - gsmtp/&#039;]</span></code>
<section class="phpdocumentor-description"><p>The first capture group in each regex will be used as the ID.
MS ESMTP returns the message ID, which may not be correct for internal tracking.</p>
</section>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/PHPMailer-PHPMailer-SMTP.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_authenticate">
authenticate()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_authenticate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">530</span>
</aside>
<p class="phpdocumentor-summary">Perform SMTP authentication.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">authenticate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$username</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$authtype</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\null">null</abbr></span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PHPMailer-PHPMailer-OAuthTokenProvider.html"><abbr title="\PHPMailer\PHPMailer\OAuthTokenProvider">OAuthTokenProvider</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$OAuth</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\null">null</abbr></span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Must be run after hello().</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$username</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The user name</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$password</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The password</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$authtype</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\null">null</abbr></span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The auth type (CRAM-MD5, PLAIN, LOGIN, XOAUTH2)</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$OAuth</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PHPMailer-PHPMailer-OAuthTokenProvider.html"><abbr title="\PHPMailer\PHPMailer\OAuthTokenProvider">OAuthTokenProvider</abbr></a></span>
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\null">null</abbr></span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An optional OAuthTokenProvider instance for XOAUTH2 authentication</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_authenticate#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\PHPMailer\PHPMailer\hello()">hello()</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>True if successfully authenticated</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_client_send">
client_send()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_client_send" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1219</span>
</aside>
<p class="phpdocumentor-summary">Send raw data to the server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">client_send</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$command</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The data to send</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$command</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Optionally, the command this is part of, used only for controlling debug output</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|bool</span>
&mdash;
<section class="phpdocumentor-description"><p>The number of bytes sent to the server or false on error</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_close">
close()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_close" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">760</span>
</aside>
<p class="phpdocumentor-summary">Close the socket and clean up the state of the class.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">close</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Don't use this function without first trying to use QUIT.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_close#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\PHPMailer\PHPMailer\quit()">quit()</abbr></span>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_connect">
connect()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_connect" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">347</span>
</aside>
<p class="phpdocumentor-summary">Connect to an SMTP server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">connect</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$host</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$port</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\null">null</abbr></span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$timeout</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">30</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$host</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>SMTP server IP or host name</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$port</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\null">null</abbr></span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The port number to connect to</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$timeout</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">30</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>How long to wait for the connection to open</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An array of options for stream_context_create()</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_connected">
connected()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_connected" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">733</span>
</aside>
<p class="phpdocumentor-summary">Check connection state.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">connected</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>True if connected</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_data">
data()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_data" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">785</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP DATA command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">data</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$msg_data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Issues a data command and sends the msg_data to the server,
finalizing the mail transaction. $msg_data is the message
that is to be sent with the headers. Each header needs to be
on a single line followed by a &lt;CRLF&gt; with the message headers
and the message body being separated by an additional &lt;CRLF&gt;.
Implements RFC 821: DATA &lt;CRLF&gt;.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$msg_data</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Message data to send</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDebugLevel">
getDebugLevel()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getDebugLevel" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1507</span>
</aside>
<p class="phpdocumentor-summary">Get debug output level.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDebugLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDebugOutput">
getDebugOutput()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getDebugOutput" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1487</span>
</aside>
<p class="phpdocumentor-summary">Get debug output method.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDebugOutput</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getError">
getError()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getError" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1245</span>
</aside>
<p class="phpdocumentor-summary">Get the latest error.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getError</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getLastReply">
getLastReply()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getLastReply" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1305</span>
</aside>
<p class="phpdocumentor-summary">Get the last reply from the server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getLastReply</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getLastTransactionID">
getLastTransactionID()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getLastTransactionID" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1592</span>
</aside>
<p class="phpdocumentor-summary">Get the queue/transaction ID of the last SMTP transaction
If no reply has been received yet, it will return null.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getLastTransactionID</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool|string|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>If no pattern was matched, it will return false.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getLastTransactionID#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\PHPMailer\PHPMailer\recordLastTransactionID()">recordLastTransactionID()</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool|string|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getServerExt">
getServerExt()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getServerExt" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1277</span>
</aside>
<p class="phpdocumentor-summary">Get metadata about the SMTP server from its HELO/EHLO response.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getServerExt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|bool|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>The method works in three ways, dependent on argument value and current state:</p>
<ol>
<li>HELO/EHLO has not been sent - returns null and populates $this-&gt;error.</li>
<li>HELO has been sent -
$name == 'HELO': returns server name
$name == 'EHLO': returns boolean false
$name == any other string: returns null and populates $this-&gt;error</li>
<li>EHLO has been sent -
$name == 'HELO'|'EHLO': returns the server name
$name == any other string: if extension $name exists, returns True
or its options (e.g. AUTH mechanisms supported). Otherwise returns False.</li>
</ol>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of SMTP extension or 'HELO'|'EHLO'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|bool|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getServerExtList">
getServerExtList()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getServerExtList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1255</span>
</aside>
<p class="phpdocumentor-summary">Get SMTP extensions available on the server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getServerExtList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSMTPUTF8">
getSMTPUTF8()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getSMTPUTF8" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1449</span>
</aside>
<p class="phpdocumentor-summary">Get SMTPUTF8 use.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSMTPUTF8</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getTimeout">
getTimeout()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getTimeout" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1527</span>
</aside>
<p class="phpdocumentor-summary">Get SMTP timeout.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTimeout</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getVerp">
getVerp()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getVerp" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1429</span>
</aside>
<p class="phpdocumentor-summary">Get VERP address generation mode.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getVerp</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_hello">
hello()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_hello" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">878</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP HELO or EHLO command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">hello</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$host</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Used to identify the sending server to the receiving server.
This makes sure that client and server are in a known state.
Implements RFC 821: HELO &lt;SP&gt; <domain> &lt;CRLF&gt;
and RFC 2821 EHLO.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$host</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The host name or IP to connect to</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_mail">
mail()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_mail" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">979</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP MAIL command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">mail</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$from</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Starts a mail transaction from the email address specified in
$from. Returns true if successful or false otherwise. If True
the mail transaction is started and then one or more recipient
commands may be called followed by a data command.
Implements RFC 821: MAIL &lt;SP&gt; FROM:<reverse-path> &lt;CRLF&gt; and
two extensions, namely XVERP and SMTPUTF8.</p>
<p>The server's EHLO response is not checked. If use of either
extensions is enabled even though the server does not support
that, mail submission will fail.</p>
<p>XVERP is documented at https://www.postfix.org/VERP_README.html
and SMTPUTF8 is specified in RFC 6531.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$from</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Source address of this message</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_noop">
noop()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_noop" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1189</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP NOOP command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">noop</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Used to keep keep-alives alive, doesn't actually do anything.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_quit">
quit()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_quit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1000</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP QUIT command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">quit</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$close_on_error</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\true">true</abbr></span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Closes the socket if there is no error or the $close_on_error argument is true.
Implements from RFC 821: QUIT &lt;CRLF&gt;.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$close_on_error</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\true">true</abbr></span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Should the connection close if an error occurs?</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_recipient">
recipient()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_recipient" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1024</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP RCPT command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">recipient</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$address</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$dsn</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Sets the TO argument to $toaddr.
Returns true if the recipient was accepted false if it was rejected.
Implements from RFC 821: RCPT &lt;SP&gt; TO:<forward-path> &lt;CRLF&gt;.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$address</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The address the message is being sent to</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dsn</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Comma separated list of DSN notifications. NEVER, SUCCESS, FAILURE
or DELAY. If you specify NEVER all other notifications are ignored.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_reset">
reset()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_reset" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1078</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP RSET command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">reset</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Abort any transaction that is currently in progress.
Implements RFC 821: RSET &lt;CRLF&gt;.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>True on success</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_sendAndMail">
sendAndMail()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendAndMail" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1166</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP SAML command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">sendAndMail</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$from</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Starts a mail transaction from the email address specified in $from.
Returns true if successful or false otherwise. If True
the mail transaction is started and then one or more recipient
commands may be called followed by a data command. This command
will send the message to the users terminal if they are logged
in and send them an email.
Implements RFC 821: SAML &lt;SP&gt; FROM:<reverse-path> &lt;CRLF&gt;.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$from</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The address the message is from</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setDebugLevel">
setDebugLevel()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setDebugLevel" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1497</span>
</aside>
<p class="phpdocumentor-summary">Set debug output level.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDebugLevel</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$level</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$level</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setDebugOutput">
setDebugOutput()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setDebugOutput" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1477</span>
</aside>
<p class="phpdocumentor-summary">Set debug output method.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDebugOutput</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|callable&nbsp;</span><span class="phpdocumentor-signature__argument__name">$method</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'echo'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$method</span>
: <span class="phpdocumentor-signature__argument__return-type">string|callable</span>
= <span class="phpdocumentor-signature__argument__default-value">'echo'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the mechanism to use for debugging output, or a callable to handle it</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setSMTPUTF8">
setSMTPUTF8()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setSMTPUTF8" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1439</span>
</aside>
<p class="phpdocumentor-summary">Enable or disable use of SMTPUTF8.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setSMTPUTF8</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$enabled</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\false">false</abbr></span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$enabled</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\false">false</abbr></span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setTimeout">
setTimeout()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setTimeout" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1517</span>
</aside>
<p class="phpdocumentor-summary">Set SMTP timeout.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setTimeout</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$timeout</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$timeout</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The timeout duration in seconds</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setVerp">
setVerp()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setVerp" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1419</span>
</aside>
<p class="phpdocumentor-summary">Enable or disable VERP address generation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setVerp</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$enabled</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\false">false</abbr></span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$enabled</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\false">false</abbr></span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_startTLS">
startTLS()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_startTLS" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">485</span>
</aside>
<p class="phpdocumentor-summary">Initiate a TLS (encrypted) session.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">startTLS</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_turn">
turn()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_turn" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1203</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP TURN command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">turn</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>This is an optional command for SMTP that this class does not support.
This method is here to make the RFC821 Definition complete for this class
and <em>may</em> be implemented in future.
Implements from RFC 821: TURN &lt;CRLF&gt;.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_verify">
verify()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_verify" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1178</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP VRFY command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">verify</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name to verify</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_xclient">
xclient()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_xclient" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1057</span>
</aside>
<p class="phpdocumentor-summary">Send SMTP XCLIENT command to server and check its return code.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">xclient</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$vars</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$vars</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>True on success</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_edebug">
edebug()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_edebug" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">286</span>
</aside>
<p class="phpdocumentor-summary">Output debugging info via a user-selected method.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">edebug</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$str</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$level</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$str</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Debug string to output</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$level</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The debug level of this message; see DEBUG_* constants</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_edebug#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_Debugoutput"><abbr title="\PHPMailer\PHPMailer\SMTP::$Debugoutput">SMTP::$Debugoutput</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_debug"><abbr title="\PHPMailer\PHPMailer\SMTP::$do_debug">SMTP::$do_debug</abbr></a></span>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_errorHandler">
errorHandler()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_errorHandler" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1540</span>
</aside>
<p class="phpdocumentor-summary">Reports an error number and string.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">errorHandler</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errno</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errmsg</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errfile</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errline</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$errno</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The error number returned by PHP</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$errmsg</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The error message returned by PHP</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$errfile</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The file the error occurred in</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$errline</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The line number the error occurred on</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_get_lines">
get_lines()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_get_lines" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1319</span>
</aside>
<p class="phpdocumentor-summary">Read the SMTP server&#039;s response.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">get_lines</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Either before eof or socket timeout occurs on the operation.
With SMTP we can tell if we have more lines to read if the
4th character is '-' symbol. If it is a space then we don't
need to read anything else.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_getSMTPConnection">
getSMTPConnection()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getSMTPConnection" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">406</span>
</aside>
<p class="phpdocumentor-summary">Create connection to the SMTP server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getSMTPConnection</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$host</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$port</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\null">null</abbr></span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$timeout</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">30</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">false|resource</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$host</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>SMTP server IP or host name</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$port</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\PHPMailer\PHPMailer\null">null</abbr></span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The port number to connect to</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$timeout</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">30</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>How long to wait for the connection to open</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An array of options for stream_context_create()</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">false|resource</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_hmac">
hmac()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_hmac" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">701</span>
</aside>
<p class="phpdocumentor-summary">Calculate an MD5 HMAC hash.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">hmac</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Works like hash_hmac('md5', $data, $key)
in case that function is not available.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The data to hash</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The key to hash with</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_parseHelloFields">
parseHelloFields()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_parseHelloFields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">923</span>
</aside>
<p class="phpdocumentor-summary">Parse a reply to HELO/EHLO command to discover server extensions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">parseHelloFields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>In case of HELO, the only parameter that can be discovered is a server name.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p><code class="prettyprint">HELO</code> or <code class="prettyprint">EHLO</code></p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_recordLastTransactionID">
recordLastTransactionID()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_recordLastTransactionID" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1563</span>
</aside>
<p class="phpdocumentor-summary">Extract and return the ID of the last SMTP transaction based on
a list of patterns provided in SMTP::$smtp_transaction_id_patterns.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">recordLastTransactionID</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool|string|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Relies on the host providing the ID in response to a DATA command.
If no reply has been received yet, it will return null.
If no pattern was matched, it will return false.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool|string|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_sendCommand">
sendCommand()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendCommand" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1092</span>
</aside>
<p class="phpdocumentor-summary">Send a command to an SMTP server and check its return code.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">sendCommand</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$command</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$commandstring</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$expect</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$command</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The command name - not sent to the server</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$commandstring</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The actual command to send</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$expect</span>
: <span class="phpdocumentor-signature__argument__return-type">int|array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>One or more expected integer success codes</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>True on success</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_sendHello">
sendHello()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendHello" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">904</span>
</aside>
<p class="phpdocumentor-summary">Send an SMTP HELO or EHLO command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">sendHello</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hello</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$host</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Low-level implementation used by hello().</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$hello</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The HELO string</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$host</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The hostname to say we are</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendHello#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\PHPMailer\PHPMailer\hello()">hello()</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setError">
setError()
<a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setError" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/SMTP.php"><a href="files/src-smtp.html"><abbr title="src/SMTP.php">SMTP.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1462</span>
</aside>
<p class="phpdocumentor-summary">Set error messages and codes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setError</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$message</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$detail</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$smtp_code</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$smtp_code_ex</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$message</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The error message</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$detail</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Further detail on the error</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smtp_code</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associated SMTP error code</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smtp_code_ex</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Extended SMTP code</p>
</section>
</dd>
</dl>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/SMTP.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
d=document.getElementsByClassName("line-numbers");
d[0].scrollTop = d[0].children[1].offsetTop;
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/PHPMailer-PHPMailer-SMTP.html#toc-constants">Constants</a></li>
<li><a href="classes/PHPMailer-PHPMailer-SMTP.html#toc-properties">Properties</a></li>
<li><a href="classes/PHPMailer-PHPMailer-SMTP.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Constants</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_CLIENT">DEBUG_CLIENT</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_CONNECTION">DEBUG_CONNECTION</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_LOWLEVEL">DEBUG_LOWLEVEL</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_OFF">DEBUG_OFF</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEBUG_SERVER">DEBUG_SERVER</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEFAULT_PORT">DEFAULT_PORT</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_DEFAULT_SECURE_PORT">DEFAULT_SECURE_PORT</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_LE">LE</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_MAX_LINE_LENGTH">MAX_LINE_LENGTH</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_MAX_REPLY_LENGTH">MAX_REPLY_LENGTH</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#constant_VERSION">VERSION</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_Debugoutput">$Debugoutput</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_debug">$do_debug</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_smtputf8">$do_smtputf8</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_do_verp">$do_verp</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_Timelimit">$Timelimit</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_Timeout">$Timeout</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_xclient_allowed_attributes">$xclient_allowed_attributes</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_error">$error</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_helo_rply">$helo_rply</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_last_reply">$last_reply</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_last_smtp_transaction_id">$last_smtp_transaction_id</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_server_caps">$server_caps</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_smtp_conn">$smtp_conn</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#property_smtp_transaction_id_patterns">$smtp_transaction_id_patterns</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_authenticate">authenticate()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_client_send">client_send()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_close">close()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_connect">connect()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_connected">connected()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_data">data()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getDebugLevel">getDebugLevel()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getDebugOutput">getDebugOutput()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getError">getError()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getLastReply">getLastReply()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getLastTransactionID">getLastTransactionID()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getServerExt">getServerExt()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getServerExtList">getServerExtList()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getSMTPUTF8">getSMTPUTF8()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getTimeout">getTimeout()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getVerp">getVerp()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_hello">hello()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_mail">mail()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_noop">noop()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_quit">quit()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_recipient">recipient()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_reset">reset()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendAndMail">sendAndMail()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setDebugLevel">setDebugLevel()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setDebugOutput">setDebugOutput()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setSMTPUTF8">setSMTPUTF8()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setTimeout">setTimeout()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setVerp">setVerp()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_startTLS">startTLS()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_turn">turn()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_verify">verify()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_xclient">xclient()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_edebug">edebug()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_errorHandler">errorHandler()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_get_lines">get_lines()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_getSMTPConnection">getSMTPConnection()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_hmac">hmac()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_parseHelloFields">parseHelloFields()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_recordLastTransactionID">recordLastTransactionID()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendCommand">sendCommand()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_sendHello">sendHello()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-SMTP.html#method_setError">setError()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/PHPMailer-PHPMailer-SMTP.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink