repo_zf1/documentation/manual/ja/module_specs/Zend_Mime_Message.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<!-- EN-Revision: 20115 -->
<sect1 id="zend.mime.message">
    <title>Zend_Mime_Message</title>

    <sect2 id="zend.mime.message.introduction">
      <title>導入</title>

      <para><classname>Zend_Mime_Message</classname> は <acronym>MIME</acronym> 準拠のメッセージを表すものであり、
      ひとつあるいは複数の部分に分かれたメッセージ (<link
      linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link> オブジェクトで表されます)
      を保持できます。<classname>Zend_Mime_Message</classname> では、<classname>Zend_Mime_Part</classname> を使用して
      <acronym>MIME</acronym> 準拠のマルチパートメッセージを作成します。
      エンコーディングやバウンダリの処理も透過的に行われます。
      与えられた文字列から <classname>Zend_Mime_Message</classname> オブジェクトを再構成することも可能です
      (実験段階です)。<link
      linkend="zend.mail"><classname>Zend_Mail</classname></link> で使用しています。</para>
    </sect2>

    <sect2 id="zend.mime.message.instantiation">
        <title>インスタンスの作成</title>
        <para>
            <classname>Zend_Mime_Message</classname>
            には明示的なコンストラクタはありません。
        </para>
    </sect2>

    <sect2 id="zend.mime.message.addparts">
        <title>MIME パートの追加</title>

        <para><link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
        オブジェクトを <classname>Zend_Mime_Message</classname> オブジェクトに追加するには、
        <code>-&gt;addPart($part)</code> をコールします。</para>

        <para><code>-&gt;getParts()</code> メソッドは、
        <classname>Zend_Mime_Message</classname> 内のすべての
        <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link> オブジェクトを配列で返します。配列に保存されているのは
        <classname>Zend_Mime_Part</classname> オブジェクトへの参照なので、内容を変更することが可能です。
        配列に新たなパートを追加したり並び順を変更したりした場合は、
        <code>-&gt;setParts($partsArray)</code> をコールして配列を
        <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link> オブジェクトに書き戻さなければなりません。</para>

        <para>
            関数 <code>-&gt;isMultiPart()</code> は、<classname>Zend_Mime_Message</classname>
            オブジェクトに複数のパートが登録されている場合に <constant>TRUE</constant> を返します。
            この場合、実際の出力はマルチパート Mime メッセージとなります。
        </para>
        </sect2>

    <sect2 id="zend.mime.message.bondary">
        <title>バウンダリの扱い</title>

        <para><classname>Zend_Mime_Message</classname> は、バウンダリを生成するために通常は
        <classname>Zend_Mime</classname> オブジェクトを使用します。
        バウンダリを独自に定義する必要があったり
        <classname>Zend_Mime_Message</classname> が使用する <classname>Zend_Mime</classname>
        オブジェクトの振る舞いを変更したりしたい場合は、
        <classname>Zend_Mime</classname> オブジェクトを自分で作成して <classname>Zend_Mime_Message</classname>
        に登録します。通常は、この必要はありません。
        この <classname>Zend_Mime_Message</classname> で使用する <classname>Zend_Mime</classname>
        インスタンスを設定するには、<code>-&gt;setMime(Zend_Mime
        $mime)</code> を使用します。</para>

        <para><code>-&gt;getMime()</code> は
        <classname>Zend_Mime</classname> のインスタンスを返します。
        これは、<methodname>generateMessage()</methodname>
        がコールされた際にメッセージをレンダリングする際に使用されます。</para>

        <para><code>-&gt;generateMessage()</code> は、
        <classname>Zend_Mime_Message</classname> の内容を文字列にレンダリングします。</para>
    </sect2>

    <sect2 id="zend.mime.message.parse">
        <title>文字列をパースすることによる Zend_Mime_Message
        オブジェクトの作成 (実験段階)</title>

        <para><acronym>MIME</acronym> に準拠したメッセージを含む文字列をもとにして、
        <classname>Zend_Mime_Message</classname> オブジェクトを構築できます。
        <classname>Zend_Mime_Message</classname> には、このような文字列をパースして
        <classname>Zend_Mime_Message</classname> オブジェクトを返す
        静的なファクトリメソッドが用意されています。</para>

        <para><methodname>Zend_Mime_Message::createFromMessage($str, $boundary)</methodname>
        は、渡された文字列をデコードして <classname>Zend_Mime_Message</classname>
        オブジェクトを返します。<code>-&gt;getParts()</code>
        を使用すると、その中身を確認できます。</para>
    </sect2>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->