<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-stream-encode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mailparse_stream_encode</refname>
  <refpurpose>
   Streams data from source file pointer, apply encoding and write to destfp 
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <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>      
  </methodsynopsis>
  <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
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
-->
