Files
doc-fr/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
2021-09-24 04:13:47 +01:00

113 lines
3.2 KiB
XML
Executable File

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mailparse-msg-extract-part-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_extract_part_file</refname>
<refpurpose>Extrait et décode une section de message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mailparse_msg_extract_part_file</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>mixed</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callbackfunc</parameter></methodparam>
</methodsynopsis>
<para>
Extrait et décode une section de message depuis le fichier fourni.
</para>
<para>
Le contenu de la section sera encodé suivant son encodage
- base64, quoted-printable et texte uuencoded sont supportés.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
<para>
Une ressource valide <literal>MIME</literal>, créée avec
la fonction <function>mailparse_msg_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Peut être un nom de fichier ou un flux valide.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callbackfunc</parameter></term>
<listitem>
<para>
Si défini, ce peut être soit un callback valide qui sera passé à la
section extraite, soit &null; pour faire que cette fonction retourne
la section extraite.
</para>
<para>
Si non fourni, le contenu sera envoyé à "stdout".
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Si <parameter>callbackfunc</parameter> ne vaut pas &null; retourne &true;
en cas de succès.
</para>
<para>
Si <parameter>callbackfunc</parameter> vaut &null;, retourne la section extraite
sous la forme d'une &string;.
</para>
<para>
Retourne &false; si une erreur survient.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mailparse_msg_extract_part</function></member>
<member><function>mailparse_msg_extract_whole_part_file</function></member>
</simplelist>
</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
-->