Zend_Mime_Message.xml 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20843 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.mime.message">
  5. <title>Zend_Mime_Message</title>
  6. <sect2 id="zend.mime.message.introduction">
  7. <title>Introduction</title>
  8. <para>
  9. <classname>Zend_Mime_Message</classname> représente un message compatible <acronym>MIME</acronym> qui
  10. peut contenir une ou plusieurs parties séparées (représentées par des objets <link
  11. linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>) Avec
  12. <classname>Zend_Mime_Message</classname>, les messages multiparts compatibles <acronym>MIME</acronym>
  13. peuvent être générés à partir de <classname>Zend_Mime_Part</classname>. L'encodage et la
  14. gestion des frontières sont gérées de manière transparente par la classe. Les objets
  15. <classname>Zend_Mime_Message</classname> peuvent aussi être reconstruits à partir de
  16. chaînes de caractères données (expérimental). Utilisés par <link
  17. linkend="zend.mail"><classname>Zend_Mail</classname></link>.
  18. </para>
  19. </sect2>
  20. <sect2 id="zend.mime.message.instantiation">
  21. <title>Instancier Zend_Mime_Message</title>
  22. <para>
  23. Il n'y a pas de constructeur explicite pour
  24. <classname>Zend_Mime_Message</classname>.
  25. </para>
  26. </sect2>
  27. <sect2 id="zend.mime.message.addparts">
  28. <title>Ajouter des parties MIME</title>
  29. <para>
  30. Les objets <link
  31. linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link> peuvent êtres
  32. ajoutés à un objet <classname>Zend_Mime_Message</classname> donné en appelant
  33. <code>-&gt;addPart($part)</code>.
  34. </para>
  35. <para>
  36. Un tableau avec toutes les objets <link
  37. linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link> du
  38. <classname>Zend_Mime_Message</classname> est retourné dans un tableau grâce à
  39. <code>-&gt;getParts()</code>. Les objets Zend_Mime_Part peuvent ainsi être changés car
  40. ils sont stockés dans le tableau comme références. Si des parties sont ajoutées au
  41. tableau, ou que la séquence est changée, le tableau à besoin d'être retourné à l'objet
  42. <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link> en appelant
  43. <code>-&gt;setParts($partsArray)</code>.
  44. </para>
  45. <para>
  46. La fonction <code>-&gt;isMultiPart()</code> retournera <constant>TRUE</constant> si plus
  47. d'une partie est enregistrée avec l'objet Zend_Mime_Message, l'objet pourra ainsi
  48. régénérer un objet Multipart-Mime-Message lors de la génération de la sortie.
  49. </para>
  50. </sect2>
  51. <sect2 id="zend.mime.message.bondary">
  52. <title>Gérer les frontières</title>
  53. <para>
  54. <classname>Zend_Mime_Message</classname> crée et utilise généralement son propre
  55. objet <classname>Zend_Mime</classname> pour générer une frontière. Si vous avez besoin
  56. de définir une frontière ou si vous voulez changer le comportement de l'objet
  57. <classname>Zend_Mime</classname> utilisé par <classname>Zend_Mime_Message</classname>,
  58. vous pouvez instancier l'objet <classname>Zend_Mime</classname> vous-même et
  59. l'enregistrer ensuite dans <classname>Zend_Mime_Message</classname>. Généralement, vous
  60. n'aurez pas besoin de faire cela. <code>-&gt;setMime(Zend_Mime $mime)</code> définit une
  61. instance spéciale de <classname>Zend_Mime</classname> pour qu'elle soit utilisée par ce
  62. Message.
  63. </para>
  64. <para>
  65. <code>-&gt;getMime()</code> retourne l'instance de
  66. <classname>Zend_Mime</classname> qui sera utilisée pour générer le message lorsque
  67. <methodname>generateMessage()</methodname> est appelée.
  68. </para>
  69. <para>
  70. <code>-&gt;generateMessage()</code> génère le contenu
  71. Z<classname>Zend_Mime_Message</classname> en une chaîne de caractères.
  72. </para>
  73. </sect2>
  74. <sect2 id="zend.mime.message.parse">
  75. <title>Parser une chaîne de caractère pour créer un objet Zend_Mime_Message
  76. (expérimental)</title>
  77. <para>
  78. Un message compatible <acronym>MIME</acronym> donné sous forme de chaîne de caractère peut être
  79. utilisé pour reconstruire un objet <classname>Zend_Mime_Message</classname>.
  80. <classname>Zend_Mime_Message</classname> a une méthode de fabrique statique pour parser
  81. cette chaîne et retourner un objet <classname>Zend_Mime_Message</classname>.
  82. </para>
  83. <para>
  84. <methodname>Zend_Mime_Message::createFromMessage($str, $boundary)</methodname>
  85. décode la chaîne de caractères donnée et retourne un objet
  86. <classname>Zend_Mime_Message</classname> qui peut ensuite être examiné en utilisant
  87. <code>-&gt;getParts()</code>.
  88. </para>
  89. </sect2>
  90. </sect1>