Zend_Mime_Message.xml 4.5 KB

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