mailparse-msg-parse.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 393365367eebdb347f8c643279b143edf3ada04f Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.mailparse-msg-parse" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mailparse_msg_parse</refname>
  <refpurpose>Analyse incrémentalement des données dans un buffer</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>mailparse_msg_parse</methodname>
   <methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
  </methodsynopsis>
  <para>
   Analyse incrémentalement des données dans une ressource <literal>MIME</literal> fournie.
  </para>
  <para>
   Cette fonction vous permet d'envoyer sous forme de flux des portions d'un
   fichier à la fois, plutôt que de tout lire et de tout analyser en une seule fois.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>mimemail</parameter></term>
     <listitem>
      <para>
       Une ressource <literal>MIME</literal> valide.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <note>
       <para>
        Le bloc final d'un <parameter>data</parameter> est supposé être
        un caractère de nouvelle ligne
        (<literal>CRLF</literal>) ; sinon, la dernière ligne du message
        se sera pas analysée.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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
-->