Files
doc-fr/reference/imap/functions/imap-fetchstructure.xml
T
George Peter Banyard 15d22ea7e2 Apply commit 34892f82742329af7e7b4b22be6ad21418fd9768
[PHP 8.1] Use an IMAP\Connection instance instead of a resource
2021-09-28 19:52:16 +01:00

226 lines
7.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-fetchstructure" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_fetchstructure</refname>
<refpurpose>Lit la structure d'un message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_fetchstructure</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>int</type><parameter>message_num</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>imap_fetchstructure</function> lit la structure du message
<parameter>msg_number</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>message_num</parameter></term>
<listitem>
<para>
Le numéro du message
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Ce paramètre optionnel n'a qu'une seule option,
<constant>FT_UID</constant>, qui demande à la fonction de traiter
l'argument <parameter>message_num</parameter> comme un
<literal>UID</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne un objet dont les propriétés sont listées dans la table
ci-dessous, &return.falseforfailure;.
</para>
<para>
<table>
<title>
Objet retourné par <function>imap_fetchstructure</function>
</title>
<tgroup cols="2">
<tbody>
<row>
<entry>type</entry>
<entry>Type primaire de corps</entry>
</row>
<row>
<entry>encoding</entry>
<entry>Codage de transfert du corps</entry>
</row>
<row>
<entry>ifsubtype</entry>
<entry>&true; s'il y a une chaîne de sous type</entry>
</row>
<row>
<entry>subtype</entry>
<entry>sous type <acronym>MIME</acronym></entry>
</row>
<row>
<entry>ifdescription</entry>
<entry>&true; s'il y a une chaîne de description</entry>
</row>
<row>
<entry>description</entry>
<entry>Chaîne de description du contenu</entry>
</row>
<row>
<entry>ifid</entry>
<entry>&true; s'il y a une chaîne d'identification</entry>
</row>
<row>
<entry>id</entry>
<entry>Chaîne d'identification</entry>
</row>
<row>
<entry>lines</entry>
<entry>Nombre de lignes</entry>
</row>
<row>
<entry>bytes</entry>
<entry>Nombre d'octets</entry>
</row>
<row>
<entry>ifdisposition</entry>
<entry>&true; s'il y a une chaîne de disposition</entry>
</row>
<row>
<entry>disposition</entry>
<entry>Chaîne de disposition</entry>
</row>
<row>
<entry>ifdparameters</entry>
<entry>&true; s'il y a un tableau de paramètres <varname>dparameters</varname></entry>
</row>
<row>
<entry>dparameters</entry>
<entry>tableau d'objets où chaque objet a une propriété <literal>"attribute"</literal> et une
propriété <literal>"value"</literal> correspondant aux paramètres d'en-têtes
<literal>Content-disposition</literal> <acronym>MIME</acronym>.</entry>
</row>
<row>
<entry>ifparameters</entry>
<entry>&true; si le tableau de paramètres existe</entry>
</row>
<row>
<entry>parameters</entry>
<entry>Tableau d'objets où chacun a une propriété <literal>"attribute"</literal> et
une propriété <literal>"value"</literal>.</entry>
</row>
<row>
<entry>parts</entry>
<entry>Tableau d'objets décrivant chaque partie
<acronym>MIME</acronym> du message</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<table>
<title>Type primaire de corps (peut varier suivant la bibliothèque utilisée)</title>
<tgroup cols="3">
<thead>
<row><entry>Valeur</entry><entry>Type</entry><entry>Constante</entry></row>
</thead>
<tbody>
<row><entry>0</entry><entry>texte</entry><entry>TYPETEXT</entry></row>
<row><entry>1</entry><entry>multipart</entry><entry>TYPEMULTIPART</entry></row>
<row><entry>2</entry><entry>message</entry><entry>TYPEMESSAGE</entry></row>
<row><entry>3</entry><entry>application</entry><entry>TYPEAPPLICATION</entry></row>
<row><entry>4</entry><entry>audio</entry><entry>TYPEAUDIO</entry></row>
<row><entry>5</entry><entry>image</entry><entry>TYPEIMAGE</entry></row>
<row><entry>6</entry><entry>vidéo</entry><entry>TYPEVIDEO</entry></row>
<row><entry>7</entry><entry>modèle</entry><entry>TYPEMODEL</entry></row>
<row><entry>8</entry><entry>autre</entry><entry>TYPEOTHER</entry></row>
</tbody>
</tgroup>
</table>
</para>
<para>
<table>
<title>Codage de transfert (peut varier suivant la bibliothèque utilisée)</title>
<tgroup cols="3">
<thead>
<row><entry>Valeur</entry><entry>Type</entry><entry>Constante</entry></row>
</thead>
<tbody>
<row><entry>0</entry><entry>7 bit</entry><entry>ENC7BIT</entry></row>
<row><entry>1</entry><entry>8 bit</entry><entry>ENC8BIT</entry></row>
<row><entry>2</entry><entry>Binaire</entry><entry>ENCBINARY</entry></row>
<row><entry>3</entry><entry>Base 64</entry><entry>ENCBASE64</entry></row>
<row><entry>4</entry><entry>Cité imprimable</entry><entry>ENCQUOTEDPRINTABLE</entry></row>
<row><entry>5</entry><entry>Autre</entry><entry>ENCOTHER</entry></row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&imap.changelog.imap-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_fetchbody</function></member>
<member><function>imap_bodystruct</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
-->