php-doc-en/reference/mailparse/functions/mailparse-uudecode-all.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

138 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-uudecode-all" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_uudecode_all</refname>
<refpurpose>
Scans the data from fp and extract each embedded uuencoded file
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mailparse_uudecode_all</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
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: fred@example.com
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: fred@example.com
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
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
-->