Zend_Mime_Message.xml 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. <sect1 id="zend.mime.message">
  2. <title>Zend_Mime_Message</title>
  3. <sect2 id="zend.mime.message.introduction">
  4. <title>Wprowadzenie</title>
  5. <para><code>Zend_Mime_Message</code> reprezetuje wiadomość zgodną z MIME,
  6. która zawiera jedną lub więcej odrębnych części (Reprezentowanych przez obiekty
  7. <link linkend="zend.mime.part"><code>Zend_Mime_Part</code></link>). Klasa
  8. <code>Zend_Mime_Message</code>, może wygenerować wieloczęściowe wiadomości
  9. zgodne z MIME z obiektów <code>Zend_Mime_Part</code>. Kodowanie i obsługa
  10. pól rozgraniczających są obsługiwane przez samą klasę. Obiekty <code>Zend_Mime_Message</code>
  11. mogą być także zrekonstruowane z podanych łańcuchów znaków (eksperymentalne).
  12. Klasa używana jest przez <link linkend="zend.mail"><code>Zend_Mail</code></link>.
  13. </para>
  14. </sect2>
  15. <sect2 id="zend.mime.message.instantiation">
  16. <title>Tworzenie instancji</title>
  17. <para>
  18. <code>Zend_Mime_Message</code> nie posiada konstruktora.
  19. </para>
  20. </sect2>
  21. <sect2 id="zend.mime.message.addparts">
  22. <title>Dodawanie części MIME</title>
  23. <para>Obiekty <link linkend="zend.mime.part"><code>Zend_Mime_Part</code></link>
  24. mogą być dodane poprzez ich przekazanie do obiektu <code>Zend_Mime_Message</code>
  25. za pomocą metody <code>-&gt;addPart($part)</code></para>
  26. <para>Tablica z wszystkimi obiektami <link linkend="zend.mime.part">
  27. <code>Zend_Mime_Part</code></link> z wiadomości <code>Zend_Mime_Message</code>
  28. jest zwraca za pomocą metody <code>-&gt;getParts()</code>. Obiekty Zend_Mime_Part
  29. mogą być wtedy zmienione ponieważ są one przechowywane w tablicy jako referencje.
  30. Jeśli jakieś części są dodane do tablicy lub zmieniona jest ich kolejność,
  31. konieczne jest przekazanie tablicy spowrotem do <link linkend="zend.mime.part">
  32. <code>Zend_Mime_Part</code></link> poprzez wywolanie <code>-&gt;setParts($partsArray)</code>.</para>
  33. <para>Funkcja <code>-&gt;isMultiPart()</code> zwróci wartość true jeśli
  34. w obiekcie <code>Zend_Mime_Message</code> zarejestrowanych jest więcej
  35. części niż jedna. Wtedy gdy obiekt będzie generował wyjściową wiadomość,
  36. wygeneruje ją jako wieloczęściową wiadomość MIME.</para>
  37. </sect2>
  38. <sect2 id="zend.mime.message.bondary">
  39. <title>Obsługa pola rozgraniczającego (boundary)</title>
  40. <para><code>Zend_Mime_Message</code> zazwyczaj tworzy obiekt <code>Zend_Mime</code>
  41. i używa go do tworzenia pola rozgraniczającego. Jeśli chcesz zdefiniować
  42. pole samodzielnie lub chcesz zmienić zachowanie obiektu <code>Zend_Mime</code>
  43. używanego przez <code>Zend_Mime_Message</code>, możesz utworzyć instancję
  44. obiektu <code>Zend_Mime</code> samodzielnie i potem zarejestrować ją do obiekcie
  45. <code>Zend_Mime_Message</code>. Zazwyczaj jednak nie jest to potrzebne.
  46. <code>-&gt;setMime(Zend_Mime $mime)</code> ustawia specjalną instancję
  47. <code>Zend_Mime</code> która ma być używana przez obiekt <code>Zend_Mime_Message</code></para>
  48. <para><code>-&gt;getMime()</code> zwraca instancję <code>Zend_Mime</code>
  49. która będzie użyta do renderowania wiadomości przez wywołanie metody
  50. <code>generateMessage()</code>.</para>
  51. <para><code>-&gt;generateMessage()</code> renderuje wiadomość
  52. <code>Zend_Mime_Message</code> do postaci łańcuchu znaków.</para>
  53. </sect2>
  54. <sect2 id="zend.mime.message.parse">
  55. <title>Tworzenie obiektu Zend_Mime_Message z łańcucha znaków.
  56. (eksperymentalne)</title>
  57. <para>Wiadomość zgodna z MIME zapisana w postaci łańcucha znaków może
  58. być użyta do zrekonstruowania obiektu <code>Zend_Mime_Message</code>.
  59. <code>Zend_Mime_Message</code> ma statyczną fabrykę przetwarzającą podany
  60. łańcuch znaków i następnie zwracającą obiekt <code>Zend_Mime_Message</code>.
  61. </para>
  62. <para><code>Zend_Mime_Message::createFromMessage($str, $boundary)</code>
  63. dekoduje podany łańcuch znaków i zwraca obiekt <code>Zend_Mime_Message</code>.
  64. Jego poprawność może być następnie sprawdzona przez użycie metody
  65. <code>-&gt;getParts()</code></para>
  66. </sect2>
  67. </sect1>
  68. <!--
  69. vim:se ts=4 sw=4 et:
  70. -->