[PHP 8.2] added imap_is_open documentation (#2583)

Co-authored-by: George Peter Banyard <[email protected]>

Author: mumumu

appendices/migration82/new-functions.xml

@@ -9,6 +9,13 @@
   </simplelist>
  </sect2>
 
+ <sect2 xml:id="migration82.new-functions.imap">
+  <title>IMAP</title>
+  <simplelist>
+    <member><function>imap_is_open</function> (as of PHP 8.2.1)</member>
+  </simplelist>
+ </sect2>
+
  <sect2 xml:id="migration82.new-functions.mysqli">
   <title>MySQLi</title>
   <simplelist>

reference/imap/functions/imap-is-open.xml

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.imap-is-open" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>imap_is_open</refname>
+  <refpurpose>Check if the <acronym>IMAP</acronym> stream is still valid</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>imap_is_open</methodname>
+   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Check if the <acronym>IMAP</acronym> stream is still valid.
+  </para>
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    &imap.imap-parameter.imap;
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the stream is still valid, &false; otherwise.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>imap_is_open</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password") or die(implode(", ", imap_errors()));
+imap_is_open($mbox);
+// ...
+?>
+]]>
+    </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
+-->

reference/imap/versions.xml

@@ -35,6 +35,7 @@
  <function name="imap_headerinfo" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="imap_headers" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="imap_gc" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
+ <function name="imap_is_open" from="PHP 8 &gt;= 8.2.1"/>
  <function name="imap_last_error" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="imap_list" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="imap_listscan" from="PHP 4, PHP 5, PHP 7, PHP 8"/>