didou Mon Feb 19 00:13:49 2007 UTC
Added files:
/phpdoc/en/reference/mailparse constants.xml ini.xml
/phpdoc/en/reference/mailparse/functions
mailparse-msg-extract-whole-part-file.xml
Modified files:
/phpdoc/en/reference/mailparse reference.xml
/phpdoc/en/reference/mailparse/functions
mailparse-determine-best-xfer-encoding.xml
mailparse-msg-create.xml
mailparse-msg-extract-part-file.xml
mailparse-msg-extract-part.xml
mailparse-msg-free.xml
mailparse-msg-get-part-data.xml
mailparse-msg-get-part.xml
mailparse-msg-get-structure.xml
mailparse-msg-parse-file.xml
mailparse-msg-parse.xml
mailparse-rfc822-parse-addresses.xml
mailparse-stream-encode.xml
mailparse-uudecode-all.xml
Log:
Document the Mailparse extension
# Review appreciated. Still working on the Mimemail Object documentation
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/reference.xml?r1=1.9&r2=1.10&diff_format=u
Index: phpdoc/en/reference/mailparse/reference.xml
diff -u phpdoc/en/reference/mailparse/reference.xml:1.9
phpdoc/en/reference/mailparse/reference.xml:1.10
--- phpdoc/en/reference/mailparse/reference.xml:1.9 Sun Sep 4 19:39:17 2005
+++ phpdoc/en/reference/mailparse/reference.xml Mon Feb 19 00:13:49 2007
@@ -1,24 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
<!-- Purpose: remote.mail -->
<!-- Membership: pecl -->
-<!-- State: experimental -->
<reference id="ref.mailparse">
- <title>mailparse Functions</title>
- <titleabbrev>mailparse</titleabbrev>
+ <title>Mailparse Functions</title>
+ <titleabbrev>Mailparse</titleabbrev>
<partintro>
<section id="mailparse.intro">
&reftitle.intro;
- &warn.experimental;
- <para>&pecl.moved-ver;4.2.0.</para>
+ <para>
+ Mailparse is an extension for parsing and working with email messages.
+ It can deal with <ulink url="&url.rfc;822">RFC 822</ulink> and <ulink
+ url="&url.rfc;2045">RFC 2045</ulink> (<literal>MIME</literal>) compliant
+ messages.
+ </para>
+ <para>
+ 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>
+ <note>
+ <para>
+ Mailparse requires the <link linkend="ref.mbstring">mbstring</link>
+ extension.
+ </para>
+ </note>
+ <para>
+ &pecl.moved-ver;4.2.0.
+ </para>
</section>
&reference.mailparse.configure;
-
+ &reference.mailparse.ini;
+ &reference.mailparse.constants;
+
+<!-- <section id="mailparse.classes">
+ &reftitle.classes;
+ &extension.classes;
+ <para>
+ </para>
+
+ <section>
+ <title>Classes</title>
+ <simplelist>
+ <member><link
linkend="mailparse.mimemessage"><classname>MimeMessage</classname></link></member>
+ </simplelist>
+ </section>
+ </section> -->
+
</partintro>
+<!-- &reference.mailparse.mimemessage; -->
&reference.mailparse.functions;
</reference>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml?r1=1.4&r2=1.5&diff_format=u
Index:
phpdoc/en/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml
diff -u
phpdoc/en/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml:1.4
phpdoc/en/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml:1.5
---
phpdoc/en/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml:1.4
Sun Jan 7 18:32:21 2007
+++
phpdoc/en/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml
Mon Feb 19 00:13:49 2007
@@ -1,12 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.mailparse-determine-best-xfer-encoding">
<refnamediv>
<refname>mailparse_determine_best_xfer_encoding</refname>
- <refpurpose>
- Figures out the best way of encoding the content read from the file
- pointer fp, which must be seek-able
- </refpurpose>
+ <refpurpose>Gets the best way of encoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@@ -14,9 +11,62 @@
<type>string</type><methodname>mailparse_determine_best_xfer_encoding</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
- &warn.undocumented.func;
+ <para>
+ Figures out the best way of encoding the content read from the given file
+ pointer.
+ </para>
</refsect1>
+
+ <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>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns one of the character encodings supported by the
+ <link linkend="ref.mbstring">mbstring</link> module.
+ </para>
+ </refsect1>
+
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>mailparse_determine_best_xfer_encoding</function>
example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+$fp = fopen('somemail.eml', 'r');
+echo 'Best encoding: ' . mailparse_determine_best_xfer_encoding($fp);
+
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+Best encoding: 7bit
+]]>
+ </screen>
+ </example>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-create.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-msg-create.xml
diff -u phpdoc/en/reference/mailparse/functions/mailparse-msg-create.xml:1.4
phpdoc/en/reference/mailparse/functions/mailparse-msg-create.xml:1.5
--- phpdoc/en/reference/mailparse/functions/mailparse-msg-create.xml:1.4
Sun Jan 7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-msg-create.xml Mon Feb
19 00:13:49 2007
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.mailparse-msg-create">
<refnamediv>
<refname>mailparse_msg_create</refname>
- <refpurpose>Returns a handle that can be used to parse a message</refpurpose>
+ <refpurpose>Create a mime mail resource</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@@ -11,9 +11,28 @@
<type>resource</type><methodname>mailparse_msg_create</methodname>
<void/>
</methodsynopsis>
- &warn.experimental.func;
- &warn.undocumented.func;
+ <para>
+ Create a <literal>MIME</literal> mail resource.
+ </para>
</refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a handle that can be used to parse a message.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>mailparse_msg_free</function></member>
+ <member><function>mailparse_msg_parse_file</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part-file.xml?r1=1.4&r2=1.5&diff_format=u
Index:
phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
diff -u
phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part-file.xml:1.4
phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part-file.xml:1.5
---
phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part-file.xml:1.4
Sun Jan 7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
Mon Feb 19 00:13:49 2007
@@ -1,21 +1,90 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.mailparse-msg-extract-part-file">
<refnamediv>
<refname>mailparse_msg_extract_part_file</refname>
- <refpurpose>Extracts/decodes a message section, decoding the transfer
encoding</refpurpose>
+ <refpurpose>Extracts/decodes a message section</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mailparse_msg_extract_part_file</methodname>
-
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
-
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
+ <methodparam><type>mixed</type><parameter>filename</parameter></methodparam>
<methodparam
choice="opt"><type>callback</type><parameter>callbackfunc</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
- &warn.undocumented.func;
+ <para>
+ Extracts/decodes a message section from the supplied filename.
+ </para>
+ <para>
+ The contents of the section will be decoded according to their transfer
+ 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>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ If <parameter>callbackfunc</parameter> is not &null; returns &true; on
+ success.
+ </para>
+ <para>
+ If <parameter>callbackfunc</parameter> is set to &null;, returns the
+ extracted section as a string.
+ </para>
+ <para>
+ Returns &false; on error.
+ </para>
+ </refsect1>
+
+ <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>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part.xml
diff -u
phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part.xml:1.5
phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part.xml:1.6
--- phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part.xml:1.5
Sun Jan 7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-part.xml
Mon Feb 19 00:13:49 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.mailparse-msg-extract-part">
<refnamediv>
<refname>mailparse_msg_extract_part</refname>
@@ -11,16 +11,60 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>mailparse_msg_extract_part</methodname>
-
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>string</type><parameter>msgbody</parameter></methodparam>
<methodparam
choice="opt"><type>callback</type><parameter>callbackfunc</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
&warn.undocumented.func;
+ </refsect1>
+
+ <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>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- If callbackfunc is not specified, the contents will be sent to "stdout".
+ &return.void;
</para>
</refsect1>
+
+ <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>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-free.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-msg-free.xml
diff -u phpdoc/en/reference/mailparse/functions/mailparse-msg-free.xml:1.5
phpdoc/en/reference/mailparse/functions/mailparse-msg-free.xml:1.6
--- phpdoc/en/reference/mailparse/functions/mailparse-msg-free.xml:1.5 Sun Jan
7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-msg-free.xml Mon Feb
19 00:13:49 2007
@@ -1,19 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.mailparse-msg-free">
<refnamediv>
<refname>mailparse_msg_free</refname>
- <refpurpose>Frees a handle allocated by
<function>mailparse_msg_create</function></refpurpose>
+ <refpurpose>Frees a MIME resource</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mailparse_msg_free</methodname>
-
<methodparam><type>resource</type><parameter>rfc2045buf</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
- &warn.undocumented.func;
+ <para>
+ Frees a <literal>MIME</literal> resource.
+ </para>
</refsect1>
+
+ <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>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>mailparse_msg_create</function></member>
+ <member><function>mailparse_msg_parse_file</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part-data.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part-data.xml
diff -u
phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part-data.xml:1.3
phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part-data.xml:1.4
--- phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part-data.xml:1.3
Sun Jan 7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part-data.xml
Mon Feb 19 00:13:49 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.mailparse-msg-get-part-data">
<refnamediv>
<refname>mailparse_msg_get_part_data</refname>
@@ -9,11 +9,27 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mailparse_msg_get_part_data</methodname>
-
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
&warn.undocumented.func;
</refsect1>
+
+ <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>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part.xml
diff -u phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part.xml:1.4
phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part.xml:1.5
--- phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part.xml:1.4
Sun Jan 7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-msg-get-part.xml Mon Feb
19 00:13:49 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.mailparse-msg-get-part">
<refnamediv>
<refname>mailparse_msg_get_part</refname>
@@ -9,12 +9,35 @@
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>mailparse_msg_get_part</methodname>
-
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>string</type><parameter>mimesection</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
&warn.undocumented.func;
</refsect1>
+
+ <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>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-get-structure.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-msg-get-structure.xml
diff -u
phpdoc/en/reference/mailparse/functions/mailparse-msg-get-structure.xml:1.3
phpdoc/en/reference/mailparse/functions/mailparse-msg-get-structure.xml:1.4
--- phpdoc/en/reference/mailparse/functions/mailparse-msg-get-structure.xml:1.3
Sun Jan 7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-msg-get-structure.xml
Mon Feb 19 00:13:49 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.mailparse-msg-get-structure">
<refnamediv>
<refname>mailparse_msg_get_structure</refname>
@@ -9,11 +9,27 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mailparse_msg_get_structure</methodname>
-
<methodparam><type>resource</type><parameter>rfc2045</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
&warn.undocumented.func;
</refsect1>
+
+ <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>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-parse-file.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-msg-parse-file.xml
diff -u
phpdoc/en/reference/mailparse/functions/mailparse-msg-parse-file.xml:1.3
phpdoc/en/reference/mailparse/functions/mailparse-msg-parse-file.xml:1.4
--- phpdoc/en/reference/mailparse/functions/mailparse-msg-parse-file.xml:1.3
Sun Jan 7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-msg-parse-file.xml
Mon Feb 19 00:13:49 2007
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.mailparse-msg-parse-file">
<refnamediv>
<refname>mailparse_msg_parse_file</refname>
- <refpurpose>Parse file and return a resource representing the
structure</refpurpose>
+ <refpurpose>Parses a file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@@ -11,9 +11,47 @@
<type>resource</type><methodname>mailparse_msg_parse_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
- &warn.undocumented.func;
+ <para>
+ Parses a file.
+ This is the optimal way of parsing a mail file that you have on disk.
+ </para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a <literal>MIME</literal> resource representing the structure, or
+ &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>mailparse_msg_free</function></member>
+ <member><function>mailparse_msg_create</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-parse.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-msg-parse.xml
diff -u phpdoc/en/reference/mailparse/functions/mailparse-msg-parse.xml:1.4
phpdoc/en/reference/mailparse/functions/mailparse-msg-parse.xml:1.5
--- phpdoc/en/reference/mailparse/functions/mailparse-msg-parse.xml:1.4 Sun Jan
7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-msg-parse.xml Mon Feb
19 00:13:49 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.mailparse-msg-parse">
<refnamediv>
<refname>mailparse_msg_parse</refname>
@@ -9,11 +9,46 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mailparse_msg_parse</methodname>
-
<methodparam><type>resource</type><parameter>rfc2045buf</parameter></methodparam>
+
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
- &warn.undocumented.func;
+ <para>
+ Incrementally parse data into the supplied mime mail resource.
+ </para>
+ <para>
+ This function allow you to stream portions of a file at a time, rather
+ than read and parse the whole thing.
+ </para>
+ </refsect1>
+
+ <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>data</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml?r1=1.3&r2=1.4&diff_format=u
Index:
phpdoc/en/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
diff -u
phpdoc/en/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml:1.3
phpdoc/en/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml:1.4
---
phpdoc/en/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml:1.3
Sun Jan 7 18:32:21 2007
+++
phpdoc/en/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
Mon Feb 19 00:13:49 2007
@@ -1,11 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.mailparse-rfc822-parse-addresses">
<refnamediv>
<refname>mailparse_rfc822_parse_addresses</refname>
- <refpurpose>
- Parse addresses and returns a hash containing that data
- </refpurpose>
+ <refpurpose>Parse RFC 822 compliant addresses</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@@ -13,9 +11,108 @@
<type>array</type><methodname>mailparse_rfc822_parse_addresses</methodname>
<methodparam><type>string</type><parameter>addresses</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
- &warn.undocumented.func;
+ <para>
+ Parses a <ulink url="&url.rfc;822">RFC 822</ulink> compliant recipient
+ list, such as that found in the <literal>To:</literal> header.
+ </para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <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>
+ This string must not include the header name.
+ </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an array of associative arrays with the following keys for each
+ recipient:
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <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
+ <literal>address</literal>.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>address</literal></entry>
+ <entry>The email address</entry>
+ </row>
+ <row>
+ <entry><literal>is_group</literal></entry>
+ <entry>&true; if the recipient is a newsgroup, &false;
otherwise.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>mailparse_rfc822_parse_addresses</function>
example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+$to = 'Wez Furlong <[EMAIL PROTECTED]>, [EMAIL PROTECTED]';
+var_dump(mailparse_rfc822_parse_addresses($to));
+
+?>
+]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+array(2) {
+ [0]=>
+ array(3) {
+ ["display"]=>
+ string(11) "Wez Furlong"
+ ["address"]=>
+ string(15) "[EMAIL PROTECTED]"
+ ["is_group"]=>
+ bool(false)
+ }
+ [1]=>
+ array(3) {
+ ["display"]=>
+ string(15) "[EMAIL PROTECTED]"
+ ["address"]=>
+ string(15) "[EMAIL PROTECTED]"
+ ["is_group"]=>
+ bool(false)
+ }
+}
+]]>
+ </screen>
+ </example>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-stream-encode.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-stream-encode.xml
diff -u phpdoc/en/reference/mailparse/functions/mailparse-stream-encode.xml:1.3
phpdoc/en/reference/mailparse/functions/mailparse-stream-encode.xml:1.4
--- phpdoc/en/reference/mailparse/functions/mailparse-stream-encode.xml:1.3
Sun Jan 7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-stream-encode.xml Mon Feb
19 00:13:49 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.mailparse-stream-encode">
<refnamediv>
<refname>mailparse_stream_encode</refname>
@@ -15,9 +15,86 @@
<methodparam><type>resource</type><parameter>destfp</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
- &warn.undocumented.func;
+ <para>
+ 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>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>mailparse_stream_encode</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+// email.eml contents: hello, this is some text=hello.
+$fp = fopen('email.eml', 'r');
+
+$dest = tmpfile();
+
+mailparse_stream_encode($fp, $dest, "quoted-printable");
+
+rewind($dest);
+
+// Display new file contents
+fpassthru($dest);
+
+?>
+]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+hello, this is some text=3Dhello.
+]]>
+ </screen>
+ </example>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-uudecode-all.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/mailparse/functions/mailparse-uudecode-all.xml
diff -u phpdoc/en/reference/mailparse/functions/mailparse-uudecode-all.xml:1.4
phpdoc/en/reference/mailparse/functions/mailparse-uudecode-all.xml:1.5
--- phpdoc/en/reference/mailparse/functions/mailparse-uudecode-all.xml:1.4
Sun Jan 7 18:32:21 2007
+++ phpdoc/en/reference/mailparse/functions/mailparse-uudecode-all.xml Mon Feb
19 00:13:49 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.mailparse-uudecode-all">
<refnamediv>
<refname>mailparse_uudecode_all</refname>
@@ -13,12 +13,107 @@
<type>array</type><methodname>mailparse_uudecode_all</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
- &warn.experimental.func;
- &warn.undocumented.func;
<para>
- Returns an array listing filename information.
+ Scans the data from the given file pointer and extract each embedded
+ uuencoded file into a temporary file.
</para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fp</parameter></term>
+ <listitem>
+ <para>
+ A valid file pointer.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an array of associative arrays listing filename information.
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry><literal>filename</literal></entry>
+ <entry>Path to the temporary file name created</entry>
+ </row>
+ <row>
+ <entry><literal>origfilename</literal></entry>
+ <entry>The original filename, for uuencoded parts only</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ The first filename entry is the message body. The next entries are the
+ decoded uuencoded files.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>mailparse_uudecode_all</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+$text = <<<EOD
+To: [EMAIL PROTECTED]
+
+hello, this is some text hello.
+blah blah blah.
+
+begin 644 test.txt
+/=&AI<R!I<R!A('1E<W0*
+`
+end
+
+EOD;
+
+$fp = tmpfile();
+fwrite($fp, $text);
+
+$data = mailparse_uudecode_all($fp);
+
+echo "BODY\n";
+readfile($data[0]["filename"]);
+echo "UUE ({$data[1]['origfilename']})\n";
+readfile($data[1]["filename"]);
+
+// Clean up
+unlink($data[0]["filename"]);
+unlink($data[1]["filename"]);
+
+?>
+]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+BODY
+To: [EMAIL PROTECTED]
+
+hello, this is some text hello.
+blah blah blah.
+
+UUE (test.txt)
+this is a test
+]]>
+ </screen>
+ </example>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/constants.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/mailparse/constants.xml
+++ phpdoc/en/reference/mailparse/constants.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<section id="mailparse.constants">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>MAILPARSE_EXTRACT_OUTPUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MAILPARSE_EXTRACT_STREAM</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MAILPARSE_EXTRACT_RETURN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- 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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/ini.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/mailparse/ini.xml
+++ phpdoc/en/reference/mailparse/ini.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="mailparse.configuration">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>Mailparse configuration options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
<entry>Changelog</entry>
</row>
</thead>
<tbody>
<row>
<entry>mailparse.def_charset</entry>
<entry>"us-ascii"</entry>
<entry>PHP_INI_ALL</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
&ini.php.constants;
</para>
</section>
<!-- 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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml?view=markup&rev=1.1
Index:
phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml
+++
phpdoc/en/reference/mailparse/functions/mailparse-msg-extract-whole-part-file.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry 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>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mailparse_msg_extract_whole_part_file</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam
choice="opt"><type>callback</type><parameter>callbackfunc</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<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>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<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>
</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
-->
