documentation/manual/ja/module_specs/Zend_Mime_Message.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <!-- EN-Revision: 20843 -->
   4 <sect1 id="zend.mime.message">
   5     <title>Zend_Mime_Message</title>
   6
   7     <sect2 id="zend.mime.message.introduction">
   8         <title>導入</title>
   9
  10         <para>
  11             <classname>Zend_Mime_Message</classname> は <acronym>MIME</acronym> 準拠のメッセージを表すものであり、
  12             ひとつあるいは複数の部分に分かれたメッセージ (<link
  13             linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link> オブジェクトで表されます)
  14             を保持できます。<classname>Zend_Mime_Message</classname> では、<classname>Zend_Mime_Part</classname> を使用して
  15             <acronym>MIME</acronym> 準拠のマルチパートメッセージを作成します。
  16             エンコーディングやバウンダリの処理も透過的に行われます。
  17             与えられた文字列から <classname>Zend_Mime_Message</classname> オブジェクトを再構成することも可能です
  18             (実験段階です)。<link
  19             linkend="zend.mail"><classname>Zend_Mail</classname></link> で使用しています。
  20         </para>
  21     </sect2>
  22
  23     <sect2 id="zend.mime.message.instantiation">
  24         <title>インスタンスの作成</title>
  25
  26         <para>
  27             <classname>Zend_Mime_Message</classname>
  28             には明示的なコンストラクタはありません。
  29         </para>
  30     </sect2>
  31
  32     <sect2 id="zend.mime.message.addparts">
  33         <title>MIME パートの追加</title>
  34
  35         <para>
  36             <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
  37             オブジェクトを <classname>Zend_Mime_Message</classname> オブジェクトに追加するには、
  38             <code>-&gt;addPart($part)</code> をコールします。
  39         </para>
  40
  41         <para>
  42             <code>-&gt;getParts()</code> メソッドは、 <classname>Zend_Mime_Message</classname>
  43             内のすべての <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
  44             オブジェクトを配列で返します。配列に保存されているのは
  45             <classname>Zend_Mime_Part</classname> オブジェクトへの参照なので、内容を変更できます。
  46             配列に新たなパートを追加したり並び順を変更したりした場合は、
  47             <code>-&gt;setParts($partsArray)</code> をコールして配列を
  48             <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
  49             オブジェクトに書き戻さなければなりません。
  50         </para>
  51
  52         <para>
  53             関数 <code>-&gt;isMultiPart()</code> は、<classname>Zend_Mime_Message</classname>
  54             オブジェクトに複数のパートが登録されている場合に <constant>TRUE</constant> を返します。
  55             この場合、実際の出力はマルチパート Mime メッセージとなります。
  56         </para>
  57     </sect2>
  58
  59     <sect2 id="zend.mime.message.bondary">
  60         <title>バウンダリの扱い</title>
  61
  62         <para>
  63             <classname>Zend_Mime_Message</classname> は、バウンダリを生成するために通常は
  64             <classname>Zend_Mime</classname> オブジェクトを使用します。
  65             バウンダリを独自に定義する必要があったり
  66             <classname>Zend_Mime_Message</classname> が使用する <classname>Zend_Mime</classname>
  67             オブジェクトの振る舞いを変更したりしたい場合は、
  68             <classname>Zend_Mime</classname> オブジェクトを自分で作成して <classname>Zend_Mime_Message</classname>
  69             に登録します。通常は、この必要はありません。
  70            この <classname>Zend_Mime_Message</classname> で使用する <classname>Zend_Mime</classname>
  71             インスタンスを設定するには、<code>-&gt;setMime(Zend_Mime $mime)</code> を使用します。
  72         </para>
  73
  74         <para>
  75             <code>-&gt;getMime()</code> は
  76             <classname>Zend_Mime</classname> のインスタンスを返します。
  77             これは、<methodname>generateMessage()</methodname>
  78             がコールされた際にメッセージをレンダリングする際に使用されます。
  79         </para>
  80
  81         <para>
  82             <code>-&gt;generateMessage()</code> は、
  83             <classname>Zend_Mime_Message</classname> の内容を文字列にレンダリングします。
  84         </para>
  85     </sect2>
  86
  87     <sect2 id="zend.mime.message.parse">
  88         <title>文字列をパースすることによる Zend_Mime_Message
  89         オブジェクトの作成 (実験段階)</title>
  90
  91         <para>
  92             <acronym>MIME</acronym> に準拠したメッセージを含む文字列をもとにして、
  93             <classname>Zend_Mime_Message</classname> オブジェクトを構築できます。
  94             <classname>Zend_Mime_Message</classname> には、このような文字列をパースして
  95             <classname>Zend_Mime_Message</classname> オブジェクトを返す
  96             静的なファクトリメソッドが用意されています。
  97         </para>
  98
  99         <para>
 100             <methodname>Zend_Mime_Message::createFromMessage($str, $boundary)</methodname>
 101             は、渡された文字列をデコードして <classname>Zend_Mime_Message</classname>
 102             オブジェクトを返します。<code>-&gt;getParts()</code>
 103             を使用すると、その中身を確認できます。
 104         </para>
 105     </sect2>
 106 </sect1>
 107 <!--
 108 vim:se ts=4 sw=4 et:
 109 -->