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-POP3.html

1874 lines
85 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">
POP3
<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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">PHPMailer POP-Before-SMTP Authentication Class.</p>
<section class="phpdocumentor-description"><p>Specifically for PHPMailer to use for RFC1939 POP-before-SMTP authentication.</p>
<ol>
<li>This class does not support APOP authentication.</li>
<li>Opening and closing lots of POP3 connections can be quite slow. If you need
to send a batch of emails then just perform the authentication once at the start,
and then loop through your mail sending script. Providing this process doesn't
take longer than the verification period lasts on your POP3 server, you should be fine.</li>
<li>This is really ancient technology; you should only need to use it to talk to very old systems.</li>
<li>This POP3 class is deliberately lightweight and incomplete, implementing just
enough to do authentication.
If you want a more complete class there are other POP3 classes for PHP available.</li>
</ol>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-POP3.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>Richard Davey (original author) <a href="mailto:rich@corephp.co.uk">rich@corephp.co.uk</a></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 (Synchro/coolbru) <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">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Jim Jagielski (jimjag) <a href="mailto:jimjag@gmail.com">jimjag@gmail.com</a></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>Andy Prevost (codeworxtech) <a href="mailto:codeworxtech@users.sourceforge.net">codeworxtech@users.sourceforge.net</a></p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/PHPMailer-PHPMailer-POP3.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-constants">
Constants
<a href="classes/PHPMailer-PHPMailer-POP3.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-POP3.html#constant_DEBUG_CLIENT">DEBUG_CLIENT</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-POP3.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-POP3.html#constant_DEBUG_SERVER">DEBUG_SERVER</a>
<span>
&nbsp;= 1 </span>
</dt>
<dd>Debug level to show server -&gt; client messages
also shows clients connection errors or errors from server</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#constant_DEFAULT_PORT">DEFAULT_PORT</a>
<span>
&nbsp;= 110 </span>
</dt>
<dd>Default POP3 port number.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#constant_DEFAULT_TIMEOUT">DEFAULT_TIMEOUT</a>
<span>
&nbsp;= 30 </span>
</dt>
<dd>Default timeout in seconds.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#constant_LE">LE</a>
<span>
&nbsp;= &quot;\r\n&quot; </span>
</dt>
<dd>Line break constant.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="-deprecated" href="classes/PHPMailer-PHPMailer-POP3.html#constant_VERSION">VERSION</a>
<span>
&nbsp;= &#039;7.0.1&#039; </span>
</dt>
<dd>The POP3 PHPMailer Version number.</dd>
</dl>
<h4 id="toc-properties">
Properties
<a href="classes/PHPMailer-PHPMailer-POP3.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-POP3.html#property_do_debug">$do_debug</a>
<span>
&nbsp;: int </span>
</dt>
<dd>POP3 class debug output mode.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#property_host">$host</a>
<span>
&nbsp;: string </span>
</dt>
<dd>POP3 mail server hostname.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#property_password">$password</a>
<span>
&nbsp;: string </span>
</dt>
<dd>POP3 password.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#property_port">$port</a>
<span>
&nbsp;: int </span>
</dt>
<dd>POP3 port number.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#property_tval">$tval</a>
<span>
&nbsp;: int </span>
</dt>
<dd>POP3 Timeout Value in seconds.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#property_username">$username</a>
<span>
&nbsp;: string </span>
</dt>
<dd>POP3 username.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#property_connected">$connected</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Are we connected?</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#property_errors">$errors</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Error container.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#property_pop_conn">$pop_conn</a>
<span>
&nbsp;: resource </span>
</dt>
<dd>Resource handle for the POP3 connection socket.</dd>
</dl>
<h4 id="toc-methods">
Methods
<a href="classes/PHPMailer-PHPMailer-POP3.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-POP3.html#method_authorise">authorise()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Authenticate with a POP3 server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_connect">connect()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Connect to a POP3 server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_disconnect">disconnect()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Disconnect from the POP3 server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_getErrors">getErrors()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Get an array of error messages, if any.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_login">login()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Log in to the POP3 server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_popBeforeSmtp">popBeforeSmtp()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Simple static wrapper for all-in-one POP before SMTP.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_catchWarning">catchWarning()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>POP3 connection error handler.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_checkResponse">checkResponse()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Checks the POP3 server response.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_getResponse">getResponse()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get a response from the POP3 server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_sendString">sendString()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Send raw data to the POP3 server.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a class="" href="classes/PHPMailer-PHPMailer-POP3.html#method_setError">setError()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Add an error to the internal error store.</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/PHPMailer-PHPMailer-POP3.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-POP3.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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">159</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_CLIENT</span>
= <span class="phpdocumentor-signature__default-value">2</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-POP3.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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">144</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-POP3.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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">152</span>
</aside>
<p class="phpdocumentor-summary">Debug level to show server -&gt; client messages
also shows clients connection errors or errors from server</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">1</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-POP3.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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Default POP3 port number.</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">110</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DEFAULT_TIMEOUT">
DEFAULT_TIMEOUT
<a href="classes/PHPMailer-PHPMailer-POP3.html#constant_DEFAULT_TIMEOUT" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Default timeout in seconds.</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_TIMEOUT</span>
= <span class="phpdocumentor-signature__default-value">30</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_LE">
LE
<a href="classes/PHPMailer-PHPMailer-POP3.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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">137</span>
</aside>
<p class="phpdocumentor-summary">Line break constant.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</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 -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_VERSION">
VERSION
<a href="classes/PHPMailer-PHPMailer-POP3.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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
</aside>
<p class="phpdocumentor-summary">The POP3 PHPMailer Version number.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>This constant will be removed in PHPMailer 8.0. Use <code class="prettyprint">PHPMailer::VERSION</code> instead.</p>
</article>
</div>
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<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.1&#039;</span>
</code>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PHPMailer-PHPMailer-POP3.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_do_debug">
$do_debug
<a href="classes/PHPMailer-PHPMailer-POP3.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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">POP3 class debug output mode.</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>Debug output level.
Options:</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/PHPMailer-PHPMailer-POP3.html#property_do_debug#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">
<section class="phpdocumentor-description"><p>POP3::DEBUG_OFF: No output</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>POP3::DEBUG_SERVER: Server messages, connection/server errors</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>POP3::DEBUG_CLIENT: Client and Server messages, connection/server errors</p>
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_host">
$host
<a href="classes/PHPMailer-PHPMailer-POP3.html#property_host" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
<p class="phpdocumentor-summary">POP3 mail server hostname.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$host</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_password">
$password
<a href="classes/PHPMailer-PHPMailer-POP3.html#property_password" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
</aside>
<p class="phpdocumentor-summary">POP3 password.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$password</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_port">
$port
<a href="classes/PHPMailer-PHPMailer-POP3.html#property_port" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<p class="phpdocumentor-summary">POP3 port number.</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">$port</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_tval">
$tval
<a href="classes/PHPMailer-PHPMailer-POP3.html#property_tval" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">97</span>
</aside>
<p class="phpdocumentor-summary">POP3 Timeout Value 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">$tval</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_username">
$username
<a href="classes/PHPMailer-PHPMailer-POP3.html#property_username" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">104</span>
</aside>
<p class="phpdocumentor-summary">POP3 username.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$username</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_connected">
$connected
<a href="classes/PHPMailer-PHPMailer-POP3.html#property_connected" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">125</span>
</aside>
<p class="phpdocumentor-summary">Are we connected?</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$connected</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_errors">
$errors
<a href="classes/PHPMailer-PHPMailer-POP3.html#property_errors" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">132</span>
</aside>
<p class="phpdocumentor-summary">Error container.</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">$errors</span>
= <span class="phpdocumentor-signature__default-value">[]</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_pop_conn">
$pop_conn
<a href="classes/PHPMailer-PHPMailer-POP3.html#property_pop_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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">118</span>
</aside>
<p class="phpdocumentor-summary">Resource handle for the POP3 connection socket.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">resource</span>
<span class="phpdocumentor-signature__name">$pop_conn</span>
</code>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/PHPMailer-PHPMailer-POP3.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_authorise">
authorise()
<a href="classes/PHPMailer-PHPMailer-POP3.html#method_authorise" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">200</span>
</aside>
<p class="phpdocumentor-summary">Authenticate with a POP3 server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">authorise</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__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__type">int|bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$port</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">int|bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$timeout</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$username</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__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</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__type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$debug_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">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>A connect, login, disconnect sequence
appropriate for POP-before SMTP authorisation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$host</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The hostname to connect to</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$port</span>
: <span class="phpdocumentor-argument-list__argument__type">int|bool</span>
= <span class="phpdocumentor-argument-list__argument__default-value">false</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-argument-list__argument__name">$timeout</span>
: <span class="phpdocumentor-argument-list__argument__type">int|bool</span>
= <span class="phpdocumentor-argument-list__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The timeout value</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$username</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
= <span class="phpdocumentor-argument-list__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$password</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
= <span class="phpdocumentor-argument-list__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$debug_level</span>
: <span class="phpdocumentor-argument-list__argument__type">int</span>
= <span class="phpdocumentor-argument-list__argument__default-value">0</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>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_connect">
connect()
<a href="classes/PHPMailer-PHPMailer-POP3.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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">245</span>
</aside>
<p class="phpdocumentor-summary">Connect to a POP3 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__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__type">int|bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$port</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$tval</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">30</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-argument-list__argument__name">$host</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$port</span>
: <span class="phpdocumentor-argument-list__argument__type">int|bool</span>
= <span class="phpdocumentor-argument-list__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$tval</span>
: <span class="phpdocumentor-argument-list__argument__type">int</span>
= <span class="phpdocumentor-argument-list__argument__default-value">30</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>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_disconnect">
disconnect()
<a href="classes/PHPMailer-PHPMailer-POP3.html#method_disconnect" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">341</span>
</aside>
<p class="phpdocumentor-summary">Disconnect from the POP3 server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">disconnect</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getErrors">
getErrors()
<a href="classes/PHPMailer-PHPMailer-POP3.html#method_getErrors" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">450</span>
</aside>
<p class="phpdocumentor-summary">Get an array of error messages, if any.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getErrors</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_login">
login()
<a href="classes/PHPMailer-PHPMailer-POP3.html#method_login" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">310</span>
</aside>
<p class="phpdocumentor-summary">Log in to the POP3 server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">login</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$username</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__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</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>Does not support APOP (RFC 2828, 4949).</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$username</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
= <span class="phpdocumentor-argument-list__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$password</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
= <span class="phpdocumentor-argument-list__argument__default-value">''</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>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_popBeforeSmtp">
popBeforeSmtp()
<a href="classes/PHPMailer-PHPMailer-POP3.html#method_popBeforeSmtp" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">173</span>
</aside>
<p class="phpdocumentor-summary">Simple static wrapper for all-in-one POP before SMTP.</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__name">popBeforeSmtp</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__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__type">int|bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$port</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">int|bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$timeout</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$username</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__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</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__type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$debug_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">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-argument-list__argument__name">$host</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The hostname to connect to</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$port</span>
: <span class="phpdocumentor-argument-list__argument__type">int|bool</span>
= <span class="phpdocumentor-argument-list__argument__default-value">false</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-argument-list__argument__name">$timeout</span>
: <span class="phpdocumentor-argument-list__argument__type">int|bool</span>
= <span class="phpdocumentor-argument-list__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The timeout value</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$username</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
= <span class="phpdocumentor-argument-list__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$password</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
= <span class="phpdocumentor-argument-list__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$debug_level</span>
: <span class="phpdocumentor-argument-list__argument__type">int</span>
= <span class="phpdocumentor-argument-list__argument__default-value">0</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>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_catchWarning">
catchWarning()
<a href="classes/PHPMailer-PHPMailer-POP3.html#method_catchWarning" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">463</span>
</aside>
<p class="phpdocumentor-summary">POP3 connection error handler.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">catchWarning</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__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__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errstr</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errfile</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$errline</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-argument-list__argument__name">$errno</span>
: <span class="phpdocumentor-argument-list__argument__type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$errstr</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$errfile</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$errline</span>
: <span class="phpdocumentor-argument-list__argument__type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_checkResponse">
checkResponse()
<a href="classes/PHPMailer-PHPMailer-POP3.html#method_checkResponse" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">416</span>
</aside>
<p class="phpdocumentor-summary">Checks the POP3 server response.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">checkResponse</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</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>Looks for for +OK or -ERR.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$string</span>
: <span class="phpdocumentor-argument-list__argument__type">string</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>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_getResponse">
getResponse()
<a href="classes/PHPMailer-PHPMailer-POP3.html#method_getResponse" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">378</span>
</aside>
<p class="phpdocumentor-summary">Get a response from the POP3 server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getResponse</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$size</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">128</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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-argument-list__argument__name">$size</span>
: <span class="phpdocumentor-argument-list__argument__type">int</span>
= <span class="phpdocumentor-argument-list__argument__default-value">128</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The maximum number of bytes to retrieve</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_sendString">
sendString()
<a href="classes/PHPMailer-PHPMailer-POP3.html#method_sendString" 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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">395</span>
</aside>
<p class="phpdocumentor-summary">Send raw data to the POP3 server.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">sendString</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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-argument-list__argument__name">$string</span>
: <span class="phpdocumentor-argument-list__argument__type">string</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">int</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setError">
setError()
<a href="classes/PHPMailer-PHPMailer-POP3.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/POP3.php"><a href="files/src-pop3.html"><abbr title="src/POP3.php">POP3.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">433</span>
</aside>
<p class="phpdocumentor-summary">Add an error to the internal error store.</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__type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$error</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>Also display debug output if it's enabled.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-argument-list__argument__name">$error</span>
: <span class="phpdocumentor-argument-list__argument__type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</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/POP3.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-POP3.html#toc-constants">Constants</a></li>
<li><a href="classes/PHPMailer-PHPMailer-POP3.html#toc-properties">Properties</a></li>
<li><a href="classes/PHPMailer-PHPMailer-POP3.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-POP3.html#constant_DEBUG_CLIENT">DEBUG_CLIENT</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#constant_DEBUG_OFF">DEBUG_OFF</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#constant_DEBUG_SERVER">DEBUG_SERVER</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#constant_DEFAULT_PORT">DEFAULT_PORT</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#constant_DEFAULT_TIMEOUT">DEFAULT_TIMEOUT</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#constant_LE">LE</a></li>
<li class="-deprecated"><a href="classes/PHPMailer-PHPMailer-POP3.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-POP3.html#property_do_debug">$do_debug</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#property_host">$host</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#property_password">$password</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#property_port">$port</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#property_tval">$tval</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#property_username">$username</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#property_connected">$connected</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#property_errors">$errors</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#property_pop_conn">$pop_conn</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-POP3.html#method_authorise">authorise()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#method_connect">connect()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#method_disconnect">disconnect()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#method_getErrors">getErrors()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#method_login">login()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#method_popBeforeSmtp">popBeforeSmtp()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#method_catchWarning">catchWarning()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#method_checkResponse">checkResponse()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#method_getResponse">getResponse()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.html#method_sendString">sendString()</a></li>
<li class=""><a href="classes/PHPMailer-PHPMailer-POP3.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-POP3.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