1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
|
<?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
-->
|