php-doc-en/reference/mailparse/functions/mailparse-determine-best-xfer-encoding.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-determine-best-xfer-encoding" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mailparse_determine_best_xfer_encoding</refname>
  <refpurpose>Gets the best way of encoding</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mailparse_determine_best_xfer_encoding</methodname>
   <methodparam><type>resource</type><parameter>fp</parameter></methodparam>
  </methodsynopsis>
  <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
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
-->