mailparse-rfc822-parse-addresses.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<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>RFC 822 準拠のアドレスをパースする</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>
   <link xlink:href="&url.rfc;822">RFC 822</link> 準拠の受信者リスト、
   たとえば <literal>To:</literal> ヘッダの内容などをパースします。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>addresses</parameter></term>
     <listitem>
      <para>
       アドレスを含む文字列。たとえば
       <literal>Wez Furlong &lt;wez@example.com&gt;, doe@example.com</literal>
       のようになります。
      </para>
      <note>
       <para>
        この文字列にはヘッダ名を含めてはいけません。
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   各受信者について以下のキーをもつ連想配列の配列を返します。
   <informaltable>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry><literal>display</literal></entry>
       <entry>
        表示用の受信者名。この部分が設定されていない場合は、
        <literal>address</literal> と同じ値となります。
       </entry>
      </row>
      <row>
       <entry><literal>address</literal></entry>
       <entry>メールアドレス。</entry>
      </row>
      <row>
       <entry><literal>is_group</literal></entry>
       <entry>受信者がニュースグループである場合に &true;、そうでない場合に &false;。</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><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
-->