<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-timeout" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_timeout</refname>
  <refpurpose>Set or fetch imap timeout</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>bool</type></type><methodname>imap_timeout</methodname>
   <methodparam><type>int</type><parameter>timeout_type</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>
  <para>
   Sets or fetches the imap timeout.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>timeout_type</parameter></term>
     <listitem>
      <para>
       One of the following:
       <constant>IMAP_OPENTIMEOUT</constant>,
       <constant>IMAP_READTIMEOUT</constant>,
       <constant>IMAP_WRITETIMEOUT</constant>, or
       <constant>IMAP_CLOSETIMEOUT</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>timeout</parameter></term>
     <listitem>
      <para>
       The timeout, in seconds.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   If the <parameter>timeout</parameter> parameter is set, this function
   returns &true; on success and &false; on failure.
  </para>
  <para>
   If <parameter>timeout</parameter>  is not provided or evaluates to -1,
   the current timeout value of <parameter>timeout_type</parameter> is
   returned as an integer.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imap_timeout</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

echo "The current read timeout is " . imap_timeout(IMAP_READTIMEOUT) . "\n";

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
