2002-04-15 00:12:54 +00:00
<?xml version="1.0" encoding="iso-8859-1"?>
2007-01-14 15:37:21 +00:00
<!-- $Revision: 1.6 $ -->
<refentry id= "function.imap-alerts" >
<refnamediv >
<refname > imap_alerts</refname>
<refpurpose > This function returns all IMAP alert messages (if any) that have occurred during this page request or since the alert stack was reset</refpurpose>
</refnamediv>
<refsect1 >
<title > Description</title>
<methodsynopsis >
<type > array</type> <methodname > imap_alerts</methodname>
<void />
</methodsynopsis>
<para >
This function returns an array of all of the IMAP alert messages
generated since the last <function > imap_alerts</function> call,
or the beginning of the page. Returns &false; if no alert messages are
available. When <function > imap_alerts</function> is called, the alert
stack is subsequently cleared. The IMAP specification requires that these
messages be passed to the user.
</para>
<para >
See also <function > imap_errors</function>
</para>
</refsect1>
</refentry>
2002-04-15 00:12:54 +00:00
<!-- 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:"../../../../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
-->
