<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.imap-timeout.php',
    1 => 'imap_timeout',
    2 => 'Define ou busca o tempo limite do imap',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'Fun&ccedil;&otilde;es de IMAP',
  ),
  'prev' => 
  array (
    0 => 'function.imap-thread.php',
    1 => 'imap_thread',
  ),
  'next' => 
  array (
    0 => 'function.imap-uid.php',
    1 => 'imap_uid',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/imap/functions/imap-timeout.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imap-timeout" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_timeout</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.3.3, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_timeout</span> &mdash; <span class="dc-title">Define ou busca o tempo limite do imap</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-timeout-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_timeout</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$timeout_type</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$timeout</code><span class="initializer"> = -1</span></span>): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>

  <p class="para rdfs-comment">
   Define ou busca o tempo limite do imap.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-timeout-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">timeout_type</code></dt>
     <dd>
      <p class="para">
       Uma das seguintes constantes:
       <strong><code><a href="imap.constants.php#constant.imap-opentimeout">IMAP_OPENTIMEOUT</a></code></strong>,
       <strong><code><a href="imap.constants.php#constant.imap-readtimeout">IMAP_READTIMEOUT</a></code></strong>,
       <strong><code><a href="imap.constants.php#constant.imap-writetimeout">IMAP_WRITETIMEOUT</a></code></strong> ou
       <strong><code><a href="imap.constants.php#constant.imap-closetimeout">IMAP_CLOSETIMEOUT</a></code></strong>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">timeout</code></dt>
     <dd>
      <p class="para">
       O tempo limite, em segundos.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-timeout-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Se o parâmetro <code class="parameter">timeout</code> estiver definido, esta função
   retornará <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> em caso de sucesso e <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
  <p class="para">
   Se <code class="parameter">timeout</code> não for fornecido ou for avaliado como -1,
   o valor de tempo limite atual de <code class="parameter">timeout_type</code> será
   retornado como um inteiro.
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-function.imap-timeout-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>imap_timeout()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"O tempo limite de leitura atual é " </span><span style="color: #007700">. </span><span style="color: #0000BB">imap_timeout</span><span style="color: #007700">(</span><span style="color: #0000BB">IMAP_READTIMEOUT</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</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); ?>