imap-alerts.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-alerts" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_alerts</refname>
  <refpurpose>Returns all IMAP alert messages that have occurred</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>imap_alerts</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Returns all of the <acronym>IMAP</acronym> alert messages generated since the last
   <function>imap_alerts</function> call, or the beginning of the page. 
  </para>
  <para>
   When <function>imap_alerts</function> is called, the alert stack is
   subsequently cleared. The <acronym>IMAP</acronym> specification requires that these messages
   be passed to the user.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array of all of the IMAP alert messages generated or &false; if
   no alert messages are available.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_errors</function></member>
   </simplelist>
  </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
-->