[DOC-CVS] [doc-en] master: mailparse: fix XML to remove useless wrapping para tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-19T03:04:44Z
Commit: https://github.com/php/doc-en/commit/5e9421a750c97ecc68a7e026ebf5ed0c3732a9d8
Raw diff: https://github.com/php/doc-en/commit/5e9421a750c97ecc68a7e026ebf5ed0c3732a9d8.diff
mailparse: fix XML to remove useless wrapping para tags via script
Changed paths:
M reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml
M reference/mailparse/functions/mailparse-msg-create.xml
M reference/mailparse/functions/mailparse-msg-extract-part-file.xml
M reference/mailparse/functions/mailparse-msg-extract-part.xml
M reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml
M reference/mailparse/functions/mailparse-msg-free.xml
M reference/mailparse/functions/mailparse-msg-get-part-data.xml
M reference/mailparse/functions/mailparse-msg-get-part.xml
M reference/mailparse/functions/mailparse-msg-get-structure.xml
M reference/mailparse/functions/mailparse-msg-parse-file.xml
M reference/mailparse/functions/mailparse-msg-parse.xml
M reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
M reference/mailparse/functions/mailparse-stream-encode.xml
M reference/mailparse/functions/mailparse-uudecode-all.xml
M reference/mailparse/setup.xml
Diff:
diff --git a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml b/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml
index e6e88b37f0c4..67b12d8884f9 100644
--- a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml
+++ b/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-determine-best-xfer-encoding" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-determine-best-xfer-encoding">
<refnamediv>
<refname>mailparse_determine_best_xfer_encoding</refname>
<refpurpose>Gets the best way of encoding</refpurpose>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fp</parameter></term>
- <listitem>
- <para>
- A valid file pointer, which must be seek-able.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fp</parameter></term>
+ <listitem>
+ <para>
+ A valid file pointer, which must be seek-able.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,10 +42,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mailparse_determine_best_xfer_encoding</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mailparse_determine_best_xfer_encoding</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -56,19 +53,17 @@ echo 'Best encoding: ' . mailparse_determine_best_xfer_encoding($fp);
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Best encoding: 7bit
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-create.xml b/reference/mailparse/functions/mailparse-msg-create.xml
index 849fa0a498f8..7576cdc24dc2 100644
--- a/reference/mailparse/functions/mailparse-msg-create.xml
+++ b/reference/mailparse/functions/mailparse-msg-create.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-create" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-create">
<refnamediv>
<refname>mailparse_msg_create</refname>
<refpurpose>Create a mime mail resource</refpurpose>
@@ -40,16 +40,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mailparse_msg_free</function></member>
- <member><function>mailparse_msg_parse_file</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mailparse_msg_free</function></member>
+ <member><function>mailparse_msg_parse_file</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
index 0b59b5306b09..e6cf02145068 100644
--- a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
+++ b/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-extract-part-file" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-extract-part-file">
<refnamediv>
<refname>mailparse_msg_extract_part_file</refname>
<refpurpose>Extracts/decodes a message section</refpurpose>
@@ -18,46 +18,44 @@
</para>
<para>
The contents of the section will be decoded according to their transfer
- encoding - base64, quoted-printable and uuencoded text are supported.
+ encoding - base64, quoted-printable and uuencoded text are supported.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mimemail</parameter></term>
- <listitem>
- <para>
- A valid <literal>MIME</literal> resource, created with
- <function>mailparse_msg_create</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- Can be a file name or a valid stream resource.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>callbackfunc</parameter></term>
- <listitem>
- <para>
- If set, this must be either a valid callback that will be passed the
- extracted section, or &null; to make this function return the
- extracted section.
- </para>
- <para>
- If not specified, the contents will be sent to "stdout".
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mimemail</parameter></term>
+ <listitem>
+ <para>
+ A valid <literal>MIME</literal> resource, created with
+ <function>mailparse_msg_create</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Can be a file name or a valid stream resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>callbackfunc</parameter></term>
+ <listitem>
+ <para>
+ If set, this must be either a valid callback that will be passed the
+ extracted section, or &null; to make this function return the
+ extracted section.
+ </para>
+ <para>
+ If not specified, the contents will be sent to "stdout".
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -77,16 +75,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mailparse_msg_extract_part</function></member>
- <member><function>mailparse_msg_extract_whole_part_file</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mailparse_msg_extract_part</function></member>
+ <member><function>mailparse_msg_extract_whole_part_file</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-extract-part.xml b/reference/mailparse/functions/mailparse-msg-extract-part.xml
index 5ed68068422c..0b3ecf45f2cc 100644
--- a/reference/mailparse/functions/mailparse-msg-extract-part.xml
+++ b/reference/mailparse/functions/mailparse-msg-extract-part.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-extract-part" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-extract-part">
<refnamediv>
<refname>mailparse_msg_extract_part</refname>
<refpurpose>
@@ -20,32 +20,30 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mimemail</parameter></term>
- <listitem>
- <para>
- A valid <literal>MIME</literal> resource.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>msgbody</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>callbackfunc</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mimemail</parameter></term>
+ <listitem>
+ <para>
+ A valid <literal>MIME</literal> resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>msgbody</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>callbackfunc</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -57,16 +55,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mailparse_msg_extract_part_file</function></member>
- <member><function>mailparse_msg_extract_whole_part_file</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mailparse_msg_extract_part_file</function></member>
+ <member><function>mailparse_msg_extract_whole_part_file</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml
index e5de439d13b8..e80d7287d02b 100644
--- a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml
+++ b/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-extract-whole-part-file" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-extract-whole-part-file">
<refnamediv>
<refname>mailparse_msg_extract_whole_part_file</refname>
<refpurpose>Extracts a message section including headers without decoding the transfer encoding</refpurpose>
@@ -18,32 +18,30 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mimemail</parameter></term>
- <listitem>
- <para>
- A valid <literal>MIME</literal> resource.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>callbackfunc</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mimemail</parameter></term>
+ <listitem>
+ <para>
+ A valid <literal>MIME</literal> resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>callbackfunc</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,16 +52,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mailparse_msg_extract_part</function></member>
- <member><function>mailparse_msg_extract_part_file</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mailparse_msg_extract_part</function></member>
+ <member><function>mailparse_msg_extract_part_file</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-free.xml b/reference/mailparse/functions/mailparse-msg-free.xml
index 08f44f076e63..f455056eaca1 100644
--- a/reference/mailparse/functions/mailparse-msg-free.xml
+++ b/reference/mailparse/functions/mailparse-msg-free.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-free" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-free">
<refnamediv>
<refname>mailparse_msg_free</refname>
<refpurpose>Frees a MIME resource</refpurpose>
@@ -18,20 +18,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mimemail</parameter></term>
- <listitem>
- <para>
- A valid <literal>MIME</literal> resource allocated by
- <function>mailparse_msg_create</function> or
- <function>mailparse_msg_parse_file</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mimemail</parameter></term>
+ <listitem>
+ <para>
+ A valid <literal>MIME</literal> resource allocated by
+ <function>mailparse_msg_create</function> or
+ <function>mailparse_msg_parse_file</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -43,16 +41,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mailparse_msg_create</function></member>
- <member><function>mailparse_msg_parse_file</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mailparse_msg_create</function></member>
+ <member><function>mailparse_msg_parse_file</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-get-part-data.xml b/reference/mailparse/functions/mailparse-msg-get-part-data.xml
index bc32f275063a..5bab76ae684a 100644
--- a/reference/mailparse/functions/mailparse-msg-get-part-data.xml
+++ b/reference/mailparse/functions/mailparse-msg-get-part-data.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-get-part-data" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-get-part-data">
<refnamediv>
<refname>mailparse_msg_get_part_data</refname>
<refpurpose>Returns an associative array of info about the message</refpurpose>
@@ -16,22 +16,19 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mimemail</parameter></term>
- <listitem>
- <para>
- A valid <literal>MIME</literal> resource.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mimemail</parameter></term>
+ <listitem>
+ <para>
+ A valid <literal>MIME</literal> resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-get-part.xml b/reference/mailparse/functions/mailparse-msg-get-part.xml
index 7ab1b71b7b7c..3470327761c7 100644
--- a/reference/mailparse/functions/mailparse-msg-get-part.xml
+++ b/reference/mailparse/functions/mailparse-msg-get-part.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-get-part" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-get-part">
<refnamediv>
<refname>mailparse_msg_get_part</refname>
<refpurpose>Returns a handle on a given section in a mimemessage</refpurpose>
@@ -17,29 +17,26 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mimemail</parameter></term>
- <listitem>
- <para>
- A valid <literal>MIME</literal> resource.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mimesection</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mimemail</parameter></term>
+ <listitem>
+ <para>
+ A valid <literal>MIME</literal> resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mimesection</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-get-structure.xml b/reference/mailparse/functions/mailparse-msg-get-structure.xml
index c49007b4ab25..a1d00e89c2b7 100644
--- a/reference/mailparse/functions/mailparse-msg-get-structure.xml
+++ b/reference/mailparse/functions/mailparse-msg-get-structure.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-get-structure" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-get-structure">
<refnamediv>
<refname>mailparse_msg_get_structure</refname>
<refpurpose>Returns an array of mime section names in the supplied message</refpurpose>
@@ -16,22 +16,19 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mimemail</parameter></term>
- <listitem>
- <para>
- A valid <literal>MIME</literal> resource.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mimemail</parameter></term>
+ <listitem>
+ <para>
+ A valid <literal>MIME</literal> resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-parse-file.xml b/reference/mailparse/functions/mailparse-msg-parse-file.xml
index f770593a950e..8be615d8efc4 100644
--- a/reference/mailparse/functions/mailparse-msg-parse-file.xml
+++ b/reference/mailparse/functions/mailparse-msg-parse-file.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-parse-file" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-parse-file">
<refnamediv>
<refname>mailparse_msg_parse_file</refname>
<refpurpose>Parses a file</refpurpose>
@@ -19,25 +19,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Path to the file holding the message.
+ The file is opened and streamed through the parser.
+ </para>
+ <note>
<para>
- Path to the file holding the message.
- The file is opened and streamed through the parser.
+ The message contained in <parameter>filename</parameter> is supposed to end with a newline
+ (<literal>CRLF</literal>); otherwise the last line of the message will not be parsed.
</para>
- <note>
- <para>
- The message contained in <parameter>filename</parameter> is supposed to end with a newline
- (<literal>CRLF</literal>); otherwise the last line of the message will not be parsed.
- </para>
- </note>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -60,16 +58,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mailparse_msg_free</function></member>
- <member><function>mailparse_msg_create</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mailparse_msg_free</function></member>
+ <member><function>mailparse_msg_create</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-msg-parse.xml b/reference/mailparse/functions/mailparse-msg-parse.xml
index ad9945aa96da..fa440d1e09f7 100644
--- a/reference/mailparse/functions/mailparse-msg-parse.xml
+++ b/reference/mailparse/functions/mailparse-msg-parse.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-msg-parse" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-parse">
<refnamediv>
<refname>mailparse_msg_parse</refname>
<refpurpose>Incrementally parse data into buffer</refpurpose>
@@ -23,29 +23,27 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mimemail</parameter></term>
- <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mimemail</parameter></term>
+ <listitem>
+ <para>
+ A valid <literal>MIME</literal> resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <note>
<para>
- A valid <literal>MIME</literal> resource.
+ The final chunk of <parameter>data</parameter> is supposed to end with a newline
+ (<literal>CRLF</literal>); otherwise the last line of the message will not be parsed.
</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <note>
- <para>
- The final chunk of <parameter>data</parameter> is supposed to end with a newline
- (<literal>CRLF</literal>); otherwise the last line of the message will not be parsed.
- </para>
- </note>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -55,7 +53,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml b/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
index 44d2684a75d6..70abb50d44f8 100644
--- a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
+++ b/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-rfc822-parse-addresses" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.mailparse-rfc822-parse-addresses">
<refnamediv>
<refname>mailparse_rfc822_parse_addresses</refname>
<refpurpose>Parse RFC 822 compliant addresses</refpurpose>
@@ -19,24 +19,22 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>addresses</parameter></term>
- <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>addresses</parameter></term>
+ <listitem>
+ <para>
+ A string containing addresses, like in:
+ <literal>Wez Furlong <[email protected]>, [email protected]</literal>
+ </para>
+ <note>
<para>
- A string containing addresses, like in:
- <literal>Wez Furlong <[email protected]>, [email protected]</literal>
+ This string must not include the header name.
</para>
- <note>
- <para>
- This string must not include the header name.
- </para>
- </note>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -51,7 +49,7 @@
<entry><literal>display</literal></entry>
<entry>
The recipient name, for display purpose. If this part is not set for a
- recipient, this key will hold the same value as
+ recipient, this key will hold the same value as
<literal>address</literal>.
</entry>
</row>
@@ -71,10 +69,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mailparse_rfc822_parse_addresses</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mailparse_rfc822_parse_addresses</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -83,9 +80,9 @@ var_dump(mailparse_rfc822_parse_addresses($to));
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
array(2) {
[0]=>
@@ -108,13 +105,11 @@ array(2) {
}
}
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-stream-encode.xml b/reference/mailparse/functions/mailparse-stream-encode.xml
index 4240c9a7fa94..f10d44250d7e 100644
--- a/reference/mailparse/functions/mailparse-stream-encode.xml
+++ b/reference/mailparse/functions/mailparse-stream-encode.xml
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-stream-encode" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-stream-encode">
<refnamediv>
<refname>mailparse_stream_encode</refname>
<refpurpose>
- Streams data from source file pointer, apply encoding and write to destfp
+ Streams data from source file pointer, apply encoding and write to destfp
</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -13,45 +13,43 @@
<type>bool</type><methodname>mailparse_stream_encode</methodname>
<methodparam><type>resource</type><parameter>sourcefp</parameter></methodparam>
<methodparam><type>resource</type><parameter>destfp</parameter></methodparam>
- <methodparam><type>string</type><parameter>encoding</parameter></methodparam>
+ <methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
- Streams data from the source file pointer, apply
- <parameter>encoding</parameter> and write to the destination file pointer.
+ Streams data from the source file pointer, apply
+ <parameter>encoding</parameter> and write to the destination file pointer.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sourcefp</parameter></term>
- <listitem>
- <para>
- A valid file handle. The file is streamed through the parser.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>destfp</parameter></term>
- <listitem>
- <para>
- The destination file handle in which the encoded data will be written.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>encoding</parameter></term>
- <listitem>
- <para>
- One of the character encodings supported by the
- <link linkend="ref.mbstring">mbstring</link> module.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sourcefp</parameter></term>
+ <listitem>
+ <para>
+ A valid file handle. The file is streamed through the parser.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>destfp</parameter></term>
+ <listitem>
+ <para>
+ The destination file handle in which the encoded data will be written.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>encoding</parameter></term>
+ <listitem>
+ <para>
+ One of the character encodings supported by the
+ <link linkend="ref.mbstring">mbstring</link> module.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -63,10 +61,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mailparse_stream_encode</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mailparse_stream_encode</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -84,19 +81,17 @@ fpassthru($dest);
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
hello, this is some text=3Dhello.
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-uudecode-all.xml b/reference/mailparse/functions/mailparse-uudecode-all.xml
index 543cc353dd4a..a4d3bf315b2f 100644
--- a/reference/mailparse/functions/mailparse-uudecode-all.xml
+++ b/reference/mailparse/functions/mailparse-uudecode-all.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mailparse-uudecode-all" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-uudecode-all">
<refnamediv>
<refname>mailparse_uudecode_all</refname>
<refpurpose>
@@ -21,18 +21,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>fp</parameter></term>
- <listitem>
- <para>
- A valid file pointer.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fp</parameter></term>
+ <listitem>
+ <para>
+ A valid file pointer.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -60,10 +58,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mailparse_uudecode_all</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mailparse_uudecode_all</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -96,9 +93,9 @@ unlink($data[1]["filename"]);
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
BODY
To: [email protected]
@@ -109,13 +106,11 @@ blah blah blah.
UUE (test.txt)
this is a test
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/setup.xml b/reference/mailparse/setup.xml
index b189baebe911..67eaeda0a0a8 100644
--- a/reference/mailparse/setup.xml
+++ b/reference/mailparse/setup.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="mailparse.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="mailparse.setup">
&reftitle.setup;
<!-- {{{ Installation -->
@@ -29,7 +28,7 @@
<entry><link linkend="ini.mailparse.def_charset">mailparse.def_charset</link></entry>
<entry>"us-ascii"</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
</tbody>
</tgroup>
@@ -39,21 +38,19 @@
&ini.descriptions.title;
- <para>
- <variablelist>
- <varlistentry xml:id="ini.mailparse.def_charset">
- <term>
- <parameter>mailparse.def_charset</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- The default character set.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry xml:id="ini.mailparse.def_charset">
+ <term>
+ <parameter>mailparse.def_charset</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ The default character set.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<!-- }}} -->
@@ -69,7 +66,6 @@
<!-- }}} -->
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -90,4 +86,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-