mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
580f15d31d
also added a basic example git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@167944 c90b9560-bf6c-de11-be94-00142212c4b1
65 lines
1.7 KiB
XML
65 lines
1.7 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
|
|
<refentry id="function.imap-ping">
|
|
<refnamediv>
|
|
<refname>imap_ping</refname>
|
|
<refpurpose>Check if the IMAP stream is still active</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>imap_ping</methodname>
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns &true; if the stream is still alive, &false; otherwise.
|
|
</para>
|
|
<para>
|
|
<function>imap_ping</function> pings the stream to see if it's still
|
|
active. It may discover new mail; this is the preferred method for a
|
|
periodic "new mail check" as well as a "keep alive" for servers which
|
|
have inactivity timeout.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>imap_ping</function> Example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$imap = imap_open("{your.imap.host}", "mailadmin", "password");
|
|
|
|
// after some sleeping
|
|
if (!imap_ping($imap)) {
|
|
// do some stuff to reconnect
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</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:"../../../../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
|
|
-->
|