Files
doc-fr/reference/mailparse/functions/mailparse-rfc822-parse-addresses.xml
2021-09-24 04:13:47 +01:00

141 lines
3.5 KiB
XML
Executable File

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.mailparse-rfc822-parse-addresses" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mailparse_rfc822_parse_addresses</refname>
<refpurpose>Analyse des adresses</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mailparse_rfc822_parse_addresses</methodname>
<methodparam><type>string</type><parameter>addresses</parameter></methodparam>
</methodsynopsis>
<para>
Analyse une liste d'adresses valides eu égard à la <link xlink:href="&url.rfc;822">RFC 822</link>,
comme celles trouvées dans l'en-tête <literal>To:</literal>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>addresses</parameter></term>
<listitem>
<para>
Une &string; contenant les adresses, comme :
<literal>Wez Furlong &lt;wez@example.com&gt;, doe@example.com</literal>
</para>
<note>
<para>
Cette &string; ne doit pas contenir le nom de l'en-tête.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne un tableau de tableaux associatifs contenant les clés suivantes pour chaque
adresses :
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><literal>display</literal></entry>
<entry>
Le nom de l'adresse, aux fins d'affichage. Si cette partie n'est pas définie
pour une adresse, il contiendra la même valeur que la clé
<literal>address</literal>.
</entry>
</row>
<row>
<entry><literal>address</literal></entry>
<entry>L'adresse email</entry>
</row>
<row>
<entry><literal>is_group</literal></entry>
<entry>&true; si l'adresse est un newsgroup, &false; sinon.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>mailparse_rfc822_parse_addresses</function></title>
<programlisting role="php">
<![CDATA[
<?php
$to = 'Wez Furlong <wez@example.com>, doe@example.com';
var_dump(mailparse_rfc822_parse_addresses($to));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(2) {
[0]=>
array(3) {
["display"]=>
string(11) "Wez Furlong"
["address"]=>
string(15) "wez@example.com"
["is_group"]=>
bool(false)
}
[1]=>
array(3) {
["display"]=>
string(15) "doe@example.com"
["address"]=>
string(15) "doe@example.com"
["is_group"]=>
bool(false)
}
}
]]>
</screen>
</example>
</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
-->