Zend_Mime_Message.xml 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect1 id="zend.mime.message">
  4. <title>Zend_Mime_Message</title>
  5. <sect2 id="zend.mime.message.introduction">
  6. <title>Введение</title>
  7. <para>
  8. <classname>Zend_Mime_Message</classname> представляет сообщения,
  9. составленные в соответствии со спецификациями
  10. <acronym>MIME</acronym>, такие сообщения могут содержать одну или
  11. более отдельных частей, представляемых как объекты класса
  12. <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>).
  13. С помощью <classname>Zend_Mime_Message</classname> из объектов
  14. <classname>Zend_Mime_Part</classname> могут быть сгенерированы
  15. сообщения MIME multipart. Также с помощью этого класса
  16. производится прозрачное управление кодированием и разделителями.
  17. Объекты <classname>Zend_Mime_Message</classname> могут быть
  18. восстановлены из данных строк (экспериментальная возможность).
  19. Используется
  20. <link linkend="zend.mail"><classname>Zend_Mail</classname></link>-ом.
  21. </para>
  22. </sect2>
  23. <sect2 id="zend.mime.message.instantiation">
  24. <title>Инстанцирование</title>
  25. <para>
  26. Нет явного конструктора для <classname>Zend_Mime_Message</classname>.
  27. </para>
  28. </sect2>
  29. <sect2 id="zend.mime.message.addparts">
  30. <title>Добавление частей MIME</title>
  31. <para>
  32. Объекты <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
  33. могут быть добавлены в конкретный объект
  34. <classname>Zend_Mime_Message</classname> путем вызова
  35. <code>-&gt;addPart($part)</code>.
  36. </para>
  37. <para>
  38. Массив со всеми объектами частей
  39. <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
  40. в <classname>Zend_Mime_Message</classname> возвращается методом
  41. <code>-&gt;getParts()</code>. Через этот массив можно вносить
  42. изменения в объекты частей, поскольку они хранятся в
  43. виде ссылок. Если в массив были добавлены новые части или
  44. последовательность изменилась, то массив нужно заново
  45. передать объекту
  46. <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
  47. через вызов метода <code>-&gt;setParts($partsArray)</code>.
  48. </para>
  49. <para>
  50. Функция <code>-&gt;isMultiPart()</code> вернет
  51. <constant>TRUE</constant>, если была зарегистрирована более чем
  52. одна часть в объекте <classname>Zend_Mime_Message</classname>
  53. и, следовательно, объект должен сгенерировать сообщение MIME multipart.
  54. </para>
  55. </sect2>
  56. <sect2 id="zend.mime.message.bondary">
  57. <title>Управление разделителями</title>
  58. <para>
  59. <classname>Zend_Mime_Message</classname> обычно создает и использует свой
  60. объект <classname>Zend_Mime</classname> для генерации разделителей.
  61. Если нужно самостоятельно установить разделители или изменить поведение
  62. объекта <classname>Zend_Mime</classname>, используемого <classname>Zend_Mime_Message</classname>,
  63. то можно самостоятельно создать экземпляр <classname>Zend_Mime</classname>
  64. и зарегистрировать его в <classname>Zend_Mime_Message</classname>
  65. (но обычно вам не нужно делать это). Метод <code>-&gt;setMime(Zend_Mime
  66. $mime)</code> устанавливает специальный экземпляр <code>Zend_Mime</code>,
  67. который будет использоваться данным объектом <classname>Zend_Mime_Message</classname>.
  68. </para>
  69. <para>
  70. <code>-&gt;getMime()</code> возвращает экземпляр класса <classname>Zend_Mime</classname>,
  71. который будет использоваться для формирования сообщения при вызове метода
  72. <methodname>generateMessage()</methodname>.
  73. </para>
  74. <para>
  75. <code>-&gt;generateMessage()</code> формирует содержимое
  76. <classname>Zend_Mime_Message</classname> в строке.
  77. </para>
  78. </sect2>
  79. <sect2 id="zend.mime.message.parse">
  80. <title>Создание объекта Zend_Mime_Message из строки (экспериментальная возможность)</title>
  81. <para>
  82. Если имеется сообщение MIME в виде строки, то оно может
  83. использоваться для получения объекта
  84. <classname>Zend_Mime_Message</classname>.
  85. <classname>Zend_Mime_Message</classname> имеет фабричный метод,
  86. который принимает строку и возвращает объект
  87. <classname>Zend_Mime_Message</classname>.
  88. </para>
  89. <para>
  90. <methodname>Zend_Mime_Message::createFromMessage($str, $boundary)</methodname>
  91. декодирует переданную строку и возвращает объект
  92. <classname>Zend_Mime_Message</classname>,
  93. который затем может быть исследован с помощью <code>-&gt;getParts()</code>.
  94. </para>
  95. </sect2>
  96. </sect1>
  97. <!--
  98. vim:se ts=4 sw=4 et:
  99. -->