Zend_Mime_Part.xml 4.3 KB

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