Zend_Mime_Part.xml 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.mime.part">
  5. <title>Zend_Mime_Part</title>
  6. <sect2 id="zend.mime.part.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. Diese Klasse repräsentiert einen einzelnen Abschnitte einer <acronym>MIME</acronym>
  10. Nachricht. Sie enthält den aktuellen Inhalt des Abschnitts der Nachricht und zusätzlich
  11. Informationen über Ihre Verschlüsselung, den Typ und den originalen Dateinamen.
  12. Sie stellt ausserdem eine Methode, für die Erzeugung eines Strings aus den
  13. in Ihr gespeicherten Daten, zur Verfügung. <classname>Zend_Mime_Part</classname> Objekte
  14. können zu <link
  15. linkend="zend.mime.message"><classname>Zend_Mime_Message</classname></link>
  16. hinzugefügt werden, um zu einer kompletten mehrteiligen Nachricht verknüpft
  17. zu werden.
  18. </para>
  19. </sect2>
  20. <sect2 id="zend.mime.part.instantiation">
  21. <title>Instanziierung</title>
  22. <para>
  23. <classname>Zend_Mime_Part</classname> wird instanziiert mit einem String welcher den
  24. Inhalt des neuen Abschnitts repräsentiert. Der Typ wird angenommen mit OCTET-STREAM,
  25. die Verschlüsselung mit 8Bit. Nach der Instanziierung einer
  26. <classname>Zend_Mime_Part</classname> kann die Meta Informationen gesetzt werden durch
  27. direkten Zugriff auf die Attribute:
  28. </para>
  29. <programlisting language="php"><![CDATA[
  30. public $type = Zend_Mime::TYPE_OCTETSTREAM;
  31. public $encoding = Zend_Mime::ENCODING_8BIT;
  32. public $id;
  33. public $disposition;
  34. public $filename;
  35. public $description;
  36. public $charset;
  37. public $boundary;
  38. public $location;
  39. public $language;
  40. ]]></programlisting>
  41. </sect2>
  42. <sect2 id="zend.mime.part.methods">
  43. <title>Methoden für das übertragen der des Teils der Nachricht zu einem String</title>
  44. <para>
  45. <methodname>getContent()</methodname> gibt den verschlüsselten Inhalt des MimeParts als
  46. String zurück, wobei die Verschlüsselung verwendet wird welche im Attribut
  47. $encoding definiert wurde. Gültige Werte sind Zend_Mime::ENCODING_* Zeichensatz
  48. Konvertierungen werden nicht durchgeführt.
  49. </para>
  50. <para>
  51. <methodname>getHeaders()</methodname> gibt den Mime-Headers für den
  52. MimePart zurück, erzeugt anhand der Informationen der öffentlich
  53. zugänglichen Attribute. Die Attribute des Objektes müssen korrekt gesetzt sein,
  54. bevor diese Methode aufgerufen wird.
  55. <itemizedlist>
  56. <listitem>
  57. <para>
  58. <varname>$charset</varname> muß auf den aktuellen Charset des Inhaltes
  59. gesetzt werden, wenn dieser ein Texttyp ist (Text oder
  60. <acronym>HTML</acronym>).
  61. </para>
  62. </listitem>
  63. <listitem>
  64. <para>
  65. <varname>$id</varname> kann gesetzt werden für die Erkennung einer
  66. Content-ID für Inline Grafiken in einer <acronym>HTML</acronym> Nachricht.
  67. </para>
  68. </listitem>
  69. <listitem>
  70. <para>
  71. <varname>$filename</varname> enthält den Namen welche die Datei bekommt wenn
  72. sie heruntergeladen wird.
  73. </para>
  74. </listitem>
  75. <listitem>
  76. <para>
  77. <varname>$disposition</varname> definiert ob die Datei als Anhang behandelt
  78. werden soll, oder ob sie in einer (HTML-) Nachricht verwendet wird (Inline).
  79. </para>
  80. </listitem>
  81. <listitem>
  82. <para>
  83. <varname>$description</varname> wird nur zur Zweck der Information
  84. verwendet.
  85. </para>
  86. </listitem>
  87. <listitem>
  88. <para>
  89. <varname>$boundary</varname> definiert den String als umgebend.
  90. </para>
  91. </listitem>
  92. <listitem>
  93. <para>
  94. <varname>$location</varname> kann als Ressource <acronym>URI</acronym>
  95. verwendet werden, der eine Relation zum Inhalt hat.
  96. </para>
  97. </listitem>
  98. <listitem>
  99. <para>
  100. <varname>$language</varname> definiert die Sprache des Inhalts.
  101. </para>
  102. </listitem>
  103. </itemizedlist>
  104. </para>
  105. </sect2>
  106. </sect1>