Zend_Mime_Part.xml 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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>Introduction</title>
  8. <para>
  9. Cette classe représente une seule partie d'un message <acronym>MIME</acronym>. Elle contient le
  10. contenu actuel de la partie du message ainsi que des informations sur son encodage, le
  11. type de contenu ("content-type") et le nom de fichier original. Elle fournie une méthode
  12. pour générer une chaîne de caractères à partir des données stockées. Les objets
  13. <classname>Zend_Mime_Part</classname> peuvent-être ajoutés à <link
  14. linkend="zend.mime.message"><classname>Zend_Mime_Message</classname></link> pour
  15. assembler un message multipart complet.
  16. </para>
  17. </sect2>
  18. <sect2 id="zend.mime.part.instantiation">
  19. <title>Instanciation</title>
  20. <para>
  21. <classname>Zend_Mime_Part</classname> est instanciée avec une chaîne de caractères
  22. qui représente le contenu de cette nouvelle partie. Le type doit être
  23. <code>OCTET-STREAM</code>, et l'encodage 8 bits. Après instanciation de
  24. <classname>Zend_Mime_Part</classname>, les métas-informations peuvent être définies en
  25. accédant directement aux attributs :
  26. </para>
  27. <programlisting language="php"><![CDATA[
  28. public $type = Zend_Mime::TYPE_OCTETSTREAM;
  29. public $encoding = Zend_Mime::ENCODING_8BIT;
  30. public $id;
  31. public $disposition;
  32. public $filename;
  33. public $description;
  34. public $charset;
  35. public $boundary;
  36. public $location;
  37. public $language;
  38. ]]></programlisting>
  39. </sect2>
  40. <sect2 id="zend.mime.part.methods">
  41. <title>Méthodes pour retourner la partie du message en une chaîne de caractères</title>
  42. <para>
  43. <methodname>getContent()</methodname> retourne le contenu encodé de MimePart en une chaîne de
  44. caractères en utilisant l'encodage spécifié dans l'attribut <varname>$encoding</varname>. Les
  45. valeurs valides sont <classname>Zend_Mime::ENCODING_*</classname>, les conversions de
  46. jeux de caractères ne sont pas effectuées.
  47. </para>
  48. <para>
  49. <methodname>getHeaders()</methodname> retourne les Mime-Headers d'un MimePart générés à partir
  50. des attributs accessibles publiquement. Les attributs de l'objet doivent être paramétrés
  51. correctement avant que cette méthode ne soit appelée. <itemizedlist>
  52. <listitem>
  53. <para>
  54. <varname>$charset</varname> doit définir l'encodage actuel du contenu, si
  55. c'est un type texte (Texte ou HTML).
  56. </para>
  57. </listitem>
  58. <listitem>
  59. <para>
  60. <varname>$id</varname> doit être défini pour identifier un content-id pour
  61. les images d'un mail HTML.
  62. </para>
  63. </listitem>
  64. <listitem>
  65. <para>
  66. <varname>$filename</varname> contient le nom que le fichier aura lors de son
  67. téléchargement.
  68. </para>
  69. </listitem>
  70. <listitem>
  71. <para>
  72. <varname>$disposition</varname> définit si le fichier doit être traité comme
  73. une pièce jointe ou s'il est inclus dans le mail (HTML).
  74. </para>
  75. </listitem>
  76. <listitem>
  77. <para><varname>$description</varname> sert uniquement pour information.</para>
  78. </listitem>
  79. <listitem>
  80. <para><varname>$boundary</varname> définit une chaîne en tant que limite.</para>
  81. </listitem>
  82. <listitem>
  83. <para>
  84. <varname>$location</varname> peut être utilisé comme <acronym>URI</acronym> d'une ressource <acronym>URI</acronym>
  85. qui a une relation avec le contenu.
  86. </para>
  87. </listitem>
  88. <listitem>
  89. <para><varname>$language</varname> définit la langue du contenu.</para>
  90. </listitem>
  91. </itemizedlist>
  92. </para>
  93. </sect2>
  94. </sect1>