<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set or fetch imap timeout</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-thread.html">imap_thread</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-uid.html">imap_uid</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imap-timeout" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_timeout</h1>
<p class="verinfo">(PHP 4 >= 4.3.3, PHP 5)</p><p class="refpurpose"><span class="refname">imap_timeout</span> — <span class="dc-title">Set or fetch imap timeout</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-timeout-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>imap_timeout</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout_type</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code><span class="initializer"> = -1</span></span>
] )</div>
<p class="para rdfs-comment">
Sets or fetches the imap timeout.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-timeout-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">timeout_type</code></em></span>
<dd>
<p class="para">
One of the following:
<strong><code>IMAP_OPENTIMEOUT</code></strong>,
<strong><code>IMAP_READTIMEOUT</code></strong>,
<strong><code>IMAP_WRITETIMEOUT</code></strong>, or
<strong><code>IMAP_CLOSETIMEOUT</code></strong>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">timeout</code></em></span>
<dd>
<p class="para">
The timeout, in seconds.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-timeout-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If the <em><code class="parameter">timeout</code></em> parameter is set, this function
returns <strong><code>TRUE</code></strong> on success and <strong><code>FALSE</code></strong> on failure.
</p>
<p class="para">
If <em><code class="parameter">timeout</code></em> is not provided or evaluates to -1,
the current timeout value of <em><code class="parameter">timeout_type</code></em> is
returned as an integer.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imap-timeout-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3378">
<p><strong>Example #1 <span class="function"><strong>imap_timeout()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"The current read timeout is " </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">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-thread.html">imap_thread</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-uid.html">imap_uid</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
