imap-ping.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hholzgra Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Reviewer: samesch -->
<refentry xml:id="function.imap-ping" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_ping</refname>
  <refpurpose>Prüft einen IMAP-Stream auf Funktionalität</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>imap_ping</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>imap_ping</function> 'pingt' einen IMAP-Stream an, um zu sehen,
   ob dieser noch aktiv ist. Diese Funktion kann auch neu eingetroffene
   Nachrichten erkennen. Daher ist dies die bevorzugte Methode zur
   regelmäßigen Überprüfung auf neue Nachrichten und um die Verbindung bei
   Servern offen zu halten, die sie sonst nach einer gewissen Zeit der
   Inaktivität beenden.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt &true; zurück, wenn der Stream noch funktioniert, sonst &false;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &imap.changelog.imap-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imap_ping</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php

$imap = imap_open("{imap.example.org}", "mailadmin", "password");

// nach einer gewissen Zeit
if (!imap_ping($imap)) {
    // Verbindung wieder aufbauen
}

?>
]]>
    </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
-->