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

322 lines
9.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-headerinfo" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_headerinfo</refname>
<refpurpose>Lit l'en-tête du message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_headerinfo</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>from_length</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>subject_length</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Récupère les informations sur un numéro de message donné en lisant ses en-têtes.
</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>from_length</parameter></term>
<listitem>
<para>
Nombre de caractères pour la propriété <literal>fetchfrom</literal>.
Doit être plus grand ou égal à &zero;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>subject_length</parameter></term>
<listitem>
<para>
Nombre de caractères pour la propriété <literal>fetchsubject</literal>.
Doit être plus grand ou égal à &zero;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>defaulthost</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne &false; en cas d'erreurs ou, en cas de succès, les informations dans un objet contenant les propriétés suivantes :
<itemizedlist>
<listitem>
<simpara>
<literal>"toaddress"</literal> : toute la ligne d'en-tête to: jusqu'à 1024 caractères
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"to"</literal> : un tableau d'objets issus de la ligne to: avec les propriétés suivantes :
<literal>personal</literal>, <literal>adl</literal>,
<literal>mailbox</literal>, et <literal>host</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"fromaddress"</literal> : toute la ligne d'en-tête from: jusqu'à 1024 caractères
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"from"</literal> : un tableau d'objets issus de la ligne From: avec les propriétés suivantes :
<literal>personal</literal>, <literal>adl</literal>,
<literal>mailbox</literal>, et <literal>host</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"ccaddress"</literal> : toute la ligne d'en-tête cc: jusqu'à 1024 caractères
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"cc"</literal> : un tableau d'objets issus de la ligne cc: avec les propriétés suivantes :
<literal>personal</literal>, <literal>adl</literal>,
<literal>mailbox</literal>, et <literal>host</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"bccaddress"</literal> : toute la ligne d'en-tête bcc: jusqu'à 1024 caractères
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"bcc"</literal> : un tableau d'objets issus de la ligne Bcc: avec les propriétés suivantes :
<literal>personal</literal>, <literal>adl</literal>,
<literal>mailbox</literal>, et <literal>host</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"reply_toaddress"</literal> : toute la ligne d'en-tête Reply_to: jusqu'à 1024 caractères
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"reply_to"</literal> : un tableau d'objets issus de la ligne Reply_to: avec les propriétés suivantes :
<literal>personal</literal>, <literal>adl</literal>,
<literal>mailbox</literal>, et <literal>host</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"senderaddress"</literal> : toute la ligne d'en-tête Sender: jusqu'à 1024 caractères
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"sender"</literal> : un tableau d'objets issus de la ligne Sender: avec les propriétés suivantes :
<literal>personal</literal>, <literal>adl</literal>,
<literal>mailbox</literal>, et <literal>host</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"return_pathaddress"</literal> : toute la ligne d'en-tête Return-path: jusqu'à 1024 caractères
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"return_path"</literal> : un tableau d'objets issus de la ligne Return-path: avec les propriétés suivantes :
<literal>personal</literal>, <literal>adl</literal>,
<literal>mailbox</literal>, et <literal>host</literal>
</simpara>
</listitem>
<listitem>
<simpara>
remail -
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"date"</literal> : La date du message, telle que trouvée dans les en-têtes
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Date"</literal> : Identique à <literal>"date"</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"subject"</literal> : Le sujet du message
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Subject"</literal> : Identique à <literal>"subject"</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"in_reply_to"</literal> :
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"message_id"</literal> :
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"newsgroups"</literal> :
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"followup_to"</literal> :
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"references"</literal> :
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Recent"</literal> : <literal>R</literal> si le message est récent et lu, <literal>N</literal>
si le message est récent et non lu, <literal>" "</literal> si le message n'est pas récent.
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Unseen"</literal> : <literal>U</literal> si le message est non lu ET non récent, <literal>" "</literal> si le message
est non lu et récent
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Flagged"</literal> : <literal>F</literal> si le message contient un drapeau, <literal>" "</literal> sinon
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Answered"</literal> : <literal>A</literal> si une réponse a été faite à ce message, <literal>" "</literal> sinon
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Deleted"</literal> : <literal>D</literal> si le message est effacé, <literal>" "</literal> sinon
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Draft"</literal> : <literal>X</literal> si le message est un brouillon, <literal>" "</literal> sinon
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Msgno"</literal> : Le numéro du message
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"MailDate"</literal> :
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"Size"</literal> : La taille du message
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"udate"</literal> : Date de l<literal>"envoi du message, sous la forme d"</literal>une date Unix
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"fetchfrom"</literal> : Ligne <literal>"from"</literal> formatée afin de tenir dans <parameter>from_length</parameter>
caractères
</simpara>
</listitem>
<listitem>
<simpara>
<literal>"fetchsubject"</literal> : Ligne <literal>"subject"</literal> formatée afin de tenir dans
<parameter>subject_length</parameter> caractères
</simpara>
</listitem>
</itemizedlist>
</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;
<row>
<entry>8.0.0</entry>
<entry>
Le paramètre <parameter>defaulthost</parameter> inutilisé a été supprimé.
</entry>
</row>
</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
-->