Source of: /manual/fa/function.imap-alerts.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = 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 => 'fa',
),
'this' =>
array (
0 => 'function.imap-alerts.php',
1 => 'imap_alerts',
),
'up' =>
array (
0 => 'ref.imap.php',
1 => 'IMAP Functions',
),
'prev' =>
array (
0 => 'function.imap-8bit.php',
1 => 'imap_8bit',
),
'next' =>
array (
0 => 'function.imap-append.php',
1 => 'imap_append',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.imap-alerts" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_alerts</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_alerts</span> — <span class="dc-title">Returns all IMAP alert messages that have occurred</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-alerts-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><b>imap_alerts</b></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Returns all of the <acronym title="Internet Message Access Protocol">IMAP</acronym> alert messages generated since the last
<span class="function"><b>imap_alerts()</b></span> call, or the beginning of the page.
</p>
<p class="para">
When <span class="function"><b>imap_alerts()</b></span> is called, the alert stack is
subsequently cleared. The <acronym title="Internet Message Access Protocol">IMAP</acronym> specification requires that these messages
be passed to the user.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-alerts-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of all of the IMAP alert messages generated or <b><tt>FALSE</tt></b> if
no alert messages are available.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-alerts-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.imap-errors.php" class="function" rel="rdfs-seeAlso">imap_errors()</a> - Returns all of the IMAP errors that have occured</span></li>
</ul>
</p>
</div>
</div><?php manual_footer(); ?>
