<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.imap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.imap-ping.php',
    1 => 'imap_ping',
    2 => 'Проверяет, активен ли ещё поток IMAP',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'Функции IMAP',
  ),
  'prev' => 
  array (
    0 => 'function.imap-open.php',
    1 => 'imap_open',
  ),
  'next' => 
  array (
    0 => 'function.imap-qprint.php',
    1 => 'imap_qprint',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/imap/functions/imap-ping.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imap-ping" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_ping</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_ping</span> &mdash; <span class="dc-title">Проверяет, активен ли ещё поток IMAP</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-ping-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_ping</strong></span>(<span class="methodparam"><span class="type"><a href="class.imap-connection.php" class="type IMAP\Connection">IMAP\Connection</a></span> <code class="parameter">$imap</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Функция <span class="function"><strong>imap_ping()</strong></span> проверяет, активен ли ещё открытый поток.
   Это помогает узнавать, есть ли новая почта. Это приоритетный
   способ проверки появления новых сообщений и аналог постоянных соединений (keep alive)
   для серверов с настроенным временем ожидания неактивности.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-ping-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    <dt>
<code class="parameter">imap</code></dt><dd><p class="para">Экземпляр класса <span class="classname"><a href="class.imap-connection.php" class="classname">IMAP\Connection</a></span>.</p></dd>
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-ping-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Возвращает <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>, если поток активен и <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если нет.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imap-ping-changelog">
  <h3 class="title">Список изменений</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Версия</th>
      <th>Описание</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  Параметр <code class="parameter">imap</code> теперь принимает объект <span class="classname"><a href="class.imap-connection.php" class="classname">IMAP\Connection</a></span>;
  раньше параметр ждал ресурс (<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>) <code class="literal">imap</code>.
 </td>
</tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.imap-ping-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример использования <span class="function"><strong>imap_ping()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$imap </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org}"</span><span style="color: #007700">, </span><span style="color: #DD0000">"mailadmin"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// после некоторого ожидания<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">imap_ping</span><span style="color: #007700">(</span><span style="color: #0000BB">$imap</span><span style="color: #007700">)) {<br />    </span><span style="color: #FF8000">// производим переподключение<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>

</div><?php manual_footer($setup); ?>