documentation/manual/en/module_specs/Zend_Mime_Message.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.mime.message">
   4     <title>Zend_Mime_Message</title>
   5
   6     <sect2 id="zend.mime.message.introduction">
   7         <title>Introduction</title>
   8
   9         <para>
  10             <classname>Zend_Mime_Message</classname> represents a <acronym>MIME</acronym> compliant
  11             message that can contain one or more separate Parts (Represented as <link
  12                 linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link> objects). With
  13             <classname>Zend_Mime_Message</classname>, <acronym>MIME</acronym> compliant multipart
  14             messages can be generated from <classname>Zend_Mime_Part</classname> objects. Encoding
  15             and Boundary handling are handled transparently by the class.
  16             <classname>Zend_Mime_Message</classname> objects can also be reconstructed from given
  17             strings (experimental). Used by <link
  18                 linkend="zend.mail"><classname>Zend_Mail</classname></link>.
  19         </para>
  20     </sect2>
  21
  22     <sect2 id="zend.mime.message.instantiation">
  23         <title>Instantiation</title>
  24
  25         <para>
  26             There is no explicit constructor for <classname>Zend_Mime_Message</classname>.
  27         </para>
  28     </sect2>
  29
  30     <sect2 id="zend.mime.message.addparts">
  31         <title>Adding MIME Parts</title>
  32
  33         <para>
  34             <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
  35             Objects can be added to a given <classname>Zend_Mime_Message</classname> object by
  36             calling <code>-&gt;addPart($part)</code>
  37         </para>
  38
  39         <para>
  40             An array with all <link
  41                 linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
  42             objects in the <classname>Zend_Mime_Message</classname> is returned
  43             from the method <code>-&gt;getParts()</code>. The <classname>Zend_Mime_Part</classname>
  44             objects can then be changed since they are stored in the array as references. If
  45             parts are added to the array or the sequence is changed, the array needs
  46             to be given back to the <link
  47                 linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
  48             object by calling <code>-&gt;setParts($partsArray)</code>.
  49         </para>
  50
  51         <para>
  52             The function <code>-&gt;isMultiPart()</code> will return <constant>TRUE</constant> if
  53             more than one part is registered with the <classname>Zend_Mime_Message</classname>
  54             object and thus the object would generate a Multipart-Mime-Message when generating the
  55             actual output.
  56         </para>
  57     </sect2>
  58
  59     <sect2 id="zend.mime.message.bondary">
  60         <title>Boundary handling</title>
  61
  62         <para>
  63             <classname>Zend_Mime_Message</classname> usually creates and uses its own
  64             <classname>Zend_Mime</classname> Object to generate a boundary. If you need to define
  65             the boundary or want to change the behaviour of the <classname>Zend_Mime</classname>
  66             object used by <classname>Zend_Mime_Message</classname>, you can instantiate the
  67             <classname>Zend_Mime</classname> object yourself and then register it to
  68             <classname>Zend_Mime_Message</classname>. Usually you will not need to do this.
  69             <code>-&gt;setMime(Zend_Mime $mime)</code> sets a special instance of
  70             <classname>Zend_Mime</classname> to be used by this
  71             <classname>Zend_Mime_Message</classname>
  72         </para>
  73
  74         <para>
  75             <code>-&gt;getMime()</code> returns the instance of
  76             <classname>Zend_Mime</classname> that will be used to render the message when
  77             <methodname>generateMessage()</methodname> is called.
  78         </para>
  79
  80         <para>
  81             <code>-&gt;generateMessage()</code> renders the <classname>Zend_Mime_Message</classname>
  82             content to a string.
  83         </para>
  84     </sect2>
  85
  86     <sect2 id="zend.mime.message.parse">
  87         <title>parsing a string to create a Zend_Mime_Message object (experimental)</title>
  88
  89         <para>
  90             A given <acronym>MIME</acronym> compliant message in string form can be used to
  91             reconstruct a <classname>Zend_Mime_Message</classname> Object from it.
  92             <classname>Zend_Mime_Message</classname> has a static factory Method to parse this
  93             String and return a <classname>Zend_Mime_Message</classname> Object.
  94         </para>
  95
  96         <para>
  97             <methodname>Zend_Mime_Message::createFromMessage($str, $boundary)</methodname>
  98             decodes the given string and returns a <classname>Zend_Mime_Message</classname>
  99             Object that can then be examined using <code>-&gt;getParts()</code>
 100         </para>
 101     </sect2>
 102 </sect1>
 103 <!--
 104 vim:se ts=4 sw=4 et:
 105 -->