Files
doc-fr/reference/imap/functions/imap-fetchheader.xml
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

124 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-fetchheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imap_fetchheader</refname>
<refpurpose>Retourne l'en-tête d'un message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>imap_fetchheader</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_fetchheader</function> retourne l'en-tête brut et
complet <link xlink:href="&url.rfc;2822">RFC2822</link> du message
<parameter>msgno</parameter>, sous la forme d'une chaîne.
</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>
Les options possibles sont :
<itemizedlist>
<listitem>
<simpara>
<constant>FT_UID</constant> - <parameter>message_num</parameter> est un UID
</simpara>
</listitem>
<listitem>
<simpara>
<constant>FT_INTERNAL</constant> - La chaîne renvoyée est
au format "internal" , c'est-à-dire sans canonisation des CRLF
</simpara>
</listitem>
<listitem>
<simpara>
<constant>FT_PREFETCHTEXT</constant> - RFC822.TEXT doit être pré
téléchargé en même temps que l'en-tête.
Cela réduit le RTT sur une connexion <acronym>IMAP</acronym>, si
le message complet est souhaité. (e.g. dans une opération
de sauvegarde dans un fichier).
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne l'en-tête du message spécifié, sous la forme d'une &string;, &return.falseforfailure;.
</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_fetch_overview</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
-->