[DOC-CVS] [doc-en] master: mailparse: fix XML by converting para to simpara 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/01bd007b034e7b37d019c4ec3d5fca2f8955518f
Raw diff: https://github.com/php/doc-en/commit/01bd007b034e7b37d019c4ec3d5fca2f8955518f.diff
mailparse: fix XML by converting para to simpara tags via script
Changed paths:
M reference/mailparse/book.xml
M reference/mailparse/configure.xml
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/book.xml b/reference/mailparse/book.xml
index 2fa7e9696444..7cd4d94f5947 100644
--- a/reference/mailparse/book.xml
+++ b/reference/mailparse/book.xml
@@ -1,40 +1,37 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<book xml:id="book.mailparse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.mailparse">
<?phpdoc extension-membership="pecl" ?>
<title>Mailparse</title>
-
+
<!-- {{{ preface -->
<preface xml:id="intro.mailparse">
&reftitle.intro;
- <para>
+ <simpara>
Mailparse is an extension for parsing and working with email messages.
- It can deal with <link xlink:href="&url.rfc;822">RFC 822</link> and <link
- xlink:href="&url.rfc;2045">RFC 2045</link> (<literal>MIME</literal>) compliant
+ It can deal with <link xlink:href="&url.rfc;822">RFC 822</link> and <link xlink:href="&url.rfc;2045">RFC 2045</link> (<literal>MIME</literal>) compliant
messages.
- </para>
- <para>
+ </simpara>
+ <simpara>
Mailparse is stream based, which means that it does not keep in-memory
copies of the files it processes - so it is very resource efficient when
dealing with large messages.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
Mailparse requires the <link linkend="book.mbstring">mbstring</link>
extension, and mbstring must be loaded before mailparse.
- </para>
+ </simpara>
</note>
</preface>
<!-- }}} -->
-
+
&reference.mailparse.setup;
&reference.mailparse.constants;
<!-- FIXME: Apparently this is a class.. -->
&reference.mailparse.reference;
</book>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -55,4 +52,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/mailparse/configure.xml b/reference/mailparse/configure.xml
index 14bb7d2ccdd7..e92c20f59df4 100644
--- a/reference/mailparse/configure.xml
+++ b/reference/mailparse/configure.xml
@@ -1,28 +1,27 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<section xml:id="mailparse.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="mailparse.installation">
&reftitle.install;
- <para xml:id="mailparse.configure">
+ <simpara xml:id="mailparse.configure">
&pecl.moved;
&pecl.info;
<link xlink:href="&url.pecl.package;mailparse">&url.pecl.package;mailparse</link>.
- </para>
- <para>
+ </simpara>
+ <simpara>
In order to use these functions you must compile PHP with mailparse support
- by using the <option role="configure">--enable-mailparse</option> configure
+ by using the <option role="configure">--enable-mailparse</option> configure
option.
- </para>
- <para>
+ </simpara>
+ <simpara>
Windows users will enable <filename>php_mailparse.dll</filename> inside
of &php.ini; in order to use these functions.
&pecl.windows.download.avail;
- </para>
- <para>
+ </simpara>
+ <simpara>
It is necessary that the <link linkend="ref.mbstring">mbstring</link>
extension is loaded before mailparse.
- </para>
+ </simpara>
</section>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml b/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml
index 67b12d8884f9..69306365475d 100644
--- a/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml
+++ b/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml
@@ -11,10 +11,10 @@
<type>string</type><methodname>mailparse_determine_best_xfer_encoding</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Figures out the best way of encoding the content read from the given file
pointer.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>fp</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid file pointer, which must be seek-able.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,10 +33,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns one of the character encodings supported by the
<link linkend="ref.mbstring">mbstring</link> module.
- </para>
+ </simpara>
</refsect1>
diff --git a/reference/mailparse/functions/mailparse-msg-create.xml b/reference/mailparse/functions/mailparse-msg-create.xml
index 7576cdc24dc2..f37f1997d5cc 100644
--- a/reference/mailparse/functions/mailparse-msg-create.xml
+++ b/reference/mailparse/functions/mailparse-msg-create.xml
@@ -11,9 +11,9 @@
<type>resource</type><methodname>mailparse_msg_create</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Create a <literal>MIME</literal> mail resource.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,18 +23,18 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a handle that can be used to parse a message.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
- <para>
+ <simpara>
It is recommended to call <function>mailparse_msg_free</function> on the result
of this function, when it is no longer needed, to avoid memory leaks.
- </para>
+ </simpara>
</note>
</refsect1>
diff --git a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml b/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
index e6cf02145068..f10de454f80a 100644
--- a/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
+++ b/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
@@ -13,13 +13,13 @@
<methodparam><type>mixed</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callbackfunc</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Extracts/decodes a message section from the supplied filename.
- </para>
- <para>
+ </simpara>
+ <simpara>
The contents of the section will be decoded according to their transfer
encoding - base64, quoted-printable and uuencoded text are supported.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,31 +28,31 @@
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid <literal>MIME</literal> resource, created with
<function>mailparse_msg_create</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
Can be a file name or a valid stream resource.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callbackfunc</parameter></term>
<listitem>
- <para>
+ <simpara>
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>
+ </simpara>
+ <simpara>
If not specified, the contents will be sent to "stdout".
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -60,17 +60,17 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
If <parameter>callbackfunc</parameter> is not &null; returns &true; on
success.
- </para>
- <para>
+ </simpara>
+ <simpara>
If <parameter>callbackfunc</parameter> is set to &null;, returns the
extracted section as a string.
- </para>
- <para>
+ </simpara>
+ <simpara>
Returns &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/mailparse/functions/mailparse-msg-extract-part.xml b/reference/mailparse/functions/mailparse-msg-extract-part.xml
index 0b3ecf45f2cc..46b70f18b475 100644
--- a/reference/mailparse/functions/mailparse-msg-extract-part.xml
+++ b/reference/mailparse/functions/mailparse-msg-extract-part.xml
@@ -24,23 +24,23 @@
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid <literal>MIME</literal> resource.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>msgbody</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callbackfunc</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -48,9 +48,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
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 e80d7287d02b..ff37575c2920 100644
--- a/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml
+++ b/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml
@@ -22,23 +22,23 @@
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid <literal>MIME</literal> resource.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callbackfunc</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,8 +46,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
- </para>
+ <simpara>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/mailparse/functions/mailparse-msg-free.xml b/reference/mailparse/functions/mailparse-msg-free.xml
index f455056eaca1..ded38f4977fc 100644
--- a/reference/mailparse/functions/mailparse-msg-free.xml
+++ b/reference/mailparse/functions/mailparse-msg-free.xml
@@ -11,9 +11,9 @@
<type>bool</type><methodname>mailparse_msg_free</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Frees a <literal>MIME</literal> resource.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -22,11 +22,11 @@
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid <literal>MIME</literal> resource allocated by
<function>mailparse_msg_create</function> or
<function>mailparse_msg_parse_file</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/mailparse/functions/mailparse-msg-get-part-data.xml b/reference/mailparse/functions/mailparse-msg-get-part-data.xml
index 5bab76ae684a..cb50d978e354 100644
--- a/reference/mailparse/functions/mailparse-msg-get-part-data.xml
+++ b/reference/mailparse/functions/mailparse-msg-get-part-data.xml
@@ -20,9 +20,9 @@
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid <literal>MIME</literal> resource.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
diff --git a/reference/mailparse/functions/mailparse-msg-get-part.xml b/reference/mailparse/functions/mailparse-msg-get-part.xml
index 3470327761c7..c8d2fc15c861 100644
--- a/reference/mailparse/functions/mailparse-msg-get-part.xml
+++ b/reference/mailparse/functions/mailparse-msg-get-part.xml
@@ -21,16 +21,16 @@
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid <literal>MIME</literal> resource.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mimesection</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
diff --git a/reference/mailparse/functions/mailparse-msg-get-structure.xml b/reference/mailparse/functions/mailparse-msg-get-structure.xml
index a1d00e89c2b7..155e343515a1 100644
--- a/reference/mailparse/functions/mailparse-msg-get-structure.xml
+++ b/reference/mailparse/functions/mailparse-msg-get-structure.xml
@@ -20,9 +20,9 @@
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid <literal>MIME</literal> resource.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
diff --git a/reference/mailparse/functions/mailparse-msg-parse-file.xml b/reference/mailparse/functions/mailparse-msg-parse-file.xml
index 8be615d8efc4..6bcf82ba8a61 100644
--- a/reference/mailparse/functions/mailparse-msg-parse-file.xml
+++ b/reference/mailparse/functions/mailparse-msg-parse-file.xml
@@ -11,10 +11,10 @@
<type>resource</type><methodname>mailparse_msg_parse_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Parses a file.
This is the optimal way of parsing a mail file that you have on disk.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,15 +23,15 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the file holding the message.
The file is opened and streamed through the parser.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
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>
+ </simpara>
</note>
</listitem>
</varlistentry>
@@ -40,19 +40,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a <literal>MIME</literal> resource representing the structure, or
&false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
- <para>
+ <simpara>
It is recommended to call <function>mailparse_msg_free</function> on the result
of this function, when it is no longer needed, to avoid memory leaks.
- </para>
+ </simpara>
</note>
</refsect1>
diff --git a/reference/mailparse/functions/mailparse-msg-parse.xml b/reference/mailparse/functions/mailparse-msg-parse.xml
index fa440d1e09f7..1b07ae0b809d 100644
--- a/reference/mailparse/functions/mailparse-msg-parse.xml
+++ b/reference/mailparse/functions/mailparse-msg-parse.xml
@@ -12,13 +12,13 @@
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Incrementally parse data into the supplied mime mail resource.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function allow you to stream portions of a file at a time, rather
than read and parse the whole thing.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,19 +27,19 @@
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid <literal>MIME</literal> resource.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<note>
- <para>
+ <simpara>
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>
+ </simpara>
</note>
</listitem>
</varlistentry>
@@ -48,9 +48,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml b/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
index 70abb50d44f8..b30da0866bd6 100644
--- a/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
+++ b/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
@@ -11,10 +11,10 @@
<type>array</type><methodname>mailparse_rfc822_parse_addresses</methodname>
<methodparam><type>string</type><parameter>addresses</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Parses a <link xlink:href="&url.rfc;822">RFC 822</link> compliant recipient
list, such as that found in the <literal>To:</literal> header.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,14 +23,14 @@
<varlistentry>
<term><parameter>addresses</parameter></term>
<listitem>
- <para>
+ <simpara>
A string containing addresses, like in:
<literal>Wez Furlong <[email protected]>, [email protected]</literal>
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
This string must not include the header name.
- </para>
+ </simpara>
</note>
</listitem>
</varlistentry>
diff --git a/reference/mailparse/functions/mailparse-stream-encode.xml b/reference/mailparse/functions/mailparse-stream-encode.xml
index f10d44250d7e..41c37cf96761 100644
--- a/reference/mailparse/functions/mailparse-stream-encode.xml
+++ b/reference/mailparse/functions/mailparse-stream-encode.xml
@@ -15,10 +15,10 @@
<methodparam><type>resource</type><parameter>destfp</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Streams data from the source file pointer, apply
<parameter>encoding</parameter> and write to the destination file pointer.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,26 +27,26 @@
<varlistentry>
<term><parameter>sourcefp</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid file handle. The file is streamed through the parser.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfp</parameter></term>
<listitem>
- <para>
+ <simpara>
The destination file handle in which the encoded data will be written.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
- <para>
+ <simpara>
One of the character encodings supported by the
<link linkend="ref.mbstring">mbstring</link> module.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -54,9 +54,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/mailparse/functions/mailparse-uudecode-all.xml b/reference/mailparse/functions/mailparse-uudecode-all.xml
index a4d3bf315b2f..12ae26833c6a 100644
--- a/reference/mailparse/functions/mailparse-uudecode-all.xml
+++ b/reference/mailparse/functions/mailparse-uudecode-all.xml
@@ -13,10 +13,10 @@
<type>array</type><methodname>mailparse_uudecode_all</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Scans the data from the given file pointer and extract each embedded
uuencoded file into a temporary file.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>fp</parameter></term>
<listitem>
- <para>
+ <simpara>
A valid file pointer.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
diff --git a/reference/mailparse/setup.xml b/reference/mailparse/setup.xml
index 67eaeda0a0a8..5abf24b0bc49 100644
--- a/reference/mailparse/setup.xml
+++ b/reference/mailparse/setup.xml
@@ -45,9 +45,9 @@
<type>string</type>
</term>
<listitem>
- <para>
+ <simpara>
The default character set.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -57,11 +57,11 @@
<!-- {{{ Resources -->
<section xml:id="mailparse.resources">
&reftitle.resources;
- <para>
+ <simpara>
Mailparse defines the resource type <literal>mailparse_mail_structure</literal>,
which is returned by <function>mailparse_msg_create</function> and
<function>mailparse_msg_parse_file</function>.
- </para>
+ </simpara>
</section>
<!-- }}} -->