documentation/manual/ja/module_specs/Zend_Mime_Part.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <!-- EN-Revision: 20827 -->
   4 <sect1 id="zend.mime.part">
   5     <title>Zend_Mime_Part</title>
   6
   7     <sect2 id="zend.mime.part.introduction">
   8         <title>導入</title>
   9
  10         <para>
  11             このクラスは、 <acronym>MIME</acronym> メッセージのひとつのパートを表します。
  12             実際のメッセージの内容に加え、エンコーディングや Content Type、
  13             そして元のファイル名などの情報も含まれます。
  14             保存されたデータから文字列を生成するためのメソッドが用意されています。
  15             <classname>Zend_Mime_Part</classname> オブジェクトを <link
  16             linkend="zend.mime.message"><classname>Zend_Mime_Message</classname></link>
  17             に追加することで、完全なマルチパートメッセージを作成できます。
  18         </para>
  19     </sect2>
  20
  21     <sect2 id="zend.mime.part.instantiation">
  22         <title>インスタンスの作成</title>
  23
  24         <para>
  25             <classname>Zend_Mime_Part</classname> のインスタンスを作成する際には、
  26             新しいパートの内容を表す文字列を使用します。新しいパートの型は
  27             OCTET-STREAM、エンコーディングは 8Bit であるとして作成されます。
  28             <classname>Zend_Mime_Part</classname> のインスタンスを作成した後で、
  29             その属性に直接アクセスすることでメタ情報を設定できます。
  30         </para>
  31
  32         <programlisting language="php"><![CDATA[
  33 public $type = Zend_Mime::TYPE_OCTETSTREAM;
  34 public $encoding = Zend_Mime::ENCODING_8BIT;
  35 public $id;
  36 public $disposition;
  37 public $filename;
  38 public $description;
  39 public $charset;
  40 public $boundary;
  41 public $location;
  42 public $language;
  43 ]]></programlisting>
  44     </sect2>
  45
  46     <sect2 id="zend.mime.part.methods">
  47         <title>メッセージパートを文字列にレンダリングするためのメソッド</title>
  48
  49         <para>
  50             <methodname>getContent()</methodname> は、MimePart
  51             の内容をエンコードし、文字列で返します。
  52             使用するエンコーディングは属性 $encoding で指定します。
  53             使用可能な値は Zend_Mime::ENCODING_* です。
  54             文字セットの変換は行いません。
  55         </para>
  56
  57         <para>
  58             <methodname>getHeaders()</methodname> は、アクセス可能な属性の情報から生成した
  59             MimePart の Mime ヘッダを返します。
  60             このメソッドをコールする前に、オブジェクトの属性を正しく設定しておく必要があります。
  61             <itemizedlist>
  62                 <listitem>
  63                     <para>
  64                         <code>$charset</code>
  65                         テキスト型 (Text あるいは HTML) の場合は、実際の文字セットを設定しなければなりません。
  66                     </para>
  67                 </listitem>
  68
  69                 <listitem>
  70                     <para>
  71                         <code>$id</code>
  72                         HTML メールにおけるインライン画像のための ID を設定します。
  73                     </para>
  74                 </listitem>
  75
  76                 <listitem>
  77                     <para>
  78                         <code>$filename</code>
  79                         ダウンロードする際に使用されるファイル名を含めます。
  80                     </para>
  81                 </listitem>
  82
  83                 <listitem>
  84                     <para>
  85                         <code>$disposition</code>
  86                         ファイルを添付として扱うのか、あるいは (HTML-) メールに埋め込む (インライン)
  87                         のかを指定します。
  88                     </para>
  89                 </listitem>
  90
  91                 <listitem>
  92                     <para>
  93                         <code>$description</code>
  94                         情報を提供するためだけの目的で使用されます。
  95                     </para>
  96                 </listitem>
  97
  98                 <listitem>
  99                     <para>
 100                         <code>$boundary</code>
 101                         バウンダリ文字列を指定します。
 102                     </para>
 103                 </listitem>
 104
 105                 <listitem>
 106                     <para>
 107                         <code>$location</code>
 108                         コンテンツに関連するリソース <acronym>URI</acronym> として使用します。
 109                     </para>
 110                 </listitem>
 111
 112                 <listitem>
 113                     <para>
 114                         <code>$language</code>
 115                         コンテンツで使用する言語を指定します。
 116                     </para>
 117                 </listitem>
 118             </itemizedlist>
 119         </para>
 120     </sect2>
 121 </sect1>
 122 <!--
 123 vim:se ts=4 sw=4 et:
 124 -->