documentation/manual/en/module_specs/Zend_Mime.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.mime.mime">
   4     <title>Zend_Mime</title>
   5
   6     <sect2 id="zend.mime.mime.introduction">
   7         <title>Introduction</title>
   8
   9         <para>
  10             <classname>Zend_Mime</classname> is a support class for handling multipart
  11             <acronym>MIME</acronym> messages. It is used by <link
  12                 linkend="zend.mail"><classname>Zend_Mail</classname></link> and <link
  13                 linkend="zend.mime.message"><classname>Zend_Mime_Message</classname></link> and may
  14             be used by applications requiring <acronym>MIME</acronym> support.
  15         </para>
  16     </sect2>
  17
  18     <sect2 id="zend.mime.mime.static">
  19         <title>Static Methods and Constants</title>
  20
  21         <para>
  22             <classname>Zend_Mime</classname> provides a simple set of static helper methods to work
  23             with <acronym>MIME</acronym>:
  24
  25             <itemizedlist>
  26                 <listitem>
  27                     <para>
  28                         <methodname>Zend_Mime::isPrintable()</methodname>: Returns
  29                         <constant>TRUE</constant> if the given string contains no unprintable
  30                         characters, <constant>FALSE</constant> otherwise.
  31                     </para>
  32                 </listitem>
  33
  34                 <listitem>
  35                     <para>
  36                         <methodname>Zend_Mime::encode()</methodname>: Encodes a string with
  37                         specified encoding.
  38                     </para>
  39                 </listitem>
  40
  41                 <listitem>
  42                     <para>
  43                         <methodname>Zend_Mime::encodeBase64()</methodname>: Encodes a string into
  44                         base64 encoding.
  45                     </para>
  46                 </listitem>
  47
  48                 <listitem>
  49                     <para>
  50                         <methodname>Zend_Mime::encodeQuotedPrintable()</methodname>: Encodes a
  51                         string with the quoted-printable mechanism.
  52                     </para>
  53                 </listitem>
  54
  55                 <listitem>
  56                     <para>
  57                         <methodname>Zend_Mime::encodeBase64Header()</methodname>: Encodes a string
  58                         into base64 encoding for Mail Headers.
  59                     </para>
  60                 </listitem>
  61
  62                 <listitem>
  63                     <para>
  64                         <methodname>Zend_Mime::encodeQuotedPrintableHeader()</methodname>: Encodes
  65                         a string with the quoted-printable mechanism for Mail Headers.
  66                     </para>
  67                 </listitem>
  68             </itemizedlist>
  69         </para>
  70
  71         <para>
  72             <classname>Zend_Mime</classname> defines a set of constants commonly used with
  73             <acronym>MIME</acronym> Messages:
  74
  75             <itemizedlist>
  76                 <listitem>
  77                     <para>
  78                         <constant>Zend_Mime::TYPE_OCTETSTREAM</constant>: 'application/octet-stream'
  79                     </para>
  80                 </listitem>
  81
  82                 <listitem>
  83                     <para>
  84                         <constant>Zend_Mime::TYPE_TEXT</constant>: 'text/plain'
  85                     </para>
  86                 </listitem>
  87
  88                 <listitem>
  89                     <para>
  90                         <constant>Zend_Mime::TYPE_HTML</constant>: 'text/html'
  91                     </para>
  92                 </listitem>
  93
  94                 <listitem>
  95                     <para>
  96                         <constant>Zend_Mime::ENCODING_7BIT</constant>: '7bit'
  97                     </para>
  98                 </listitem>
  99
 100                 <listitem>
 101                     <para>
 102                         <constant>Zend_Mime::ENCODING_8BIT</constant>: '8bit'
 103                     </para>
 104                 </listitem>
 105
 106                 <listitem>
 107                     <para>
 108                         <constant>Zend_Mime::ENCODING_QUOTEDPRINTABLE</constant>: 'quoted-printable'
 109                     </para>
 110                 </listitem>
 111
 112                 <listitem>
 113                     <para>
 114                         <constant>Zend_Mime::ENCODING_BASE64</constant>: 'base64'
 115                     </para>
 116                 </listitem>
 117
 118                 <listitem>
 119                     <para>
 120                         <constant>Zend_Mime::DISPOSITION_ATTACHMENT</constant>: 'attachment'
 121                     </para>
 122                 </listitem>
 123
 124                 <listitem>
 125                     <para>
 126                         <constant>Zend_Mime::DISPOSITION_INLINE</constant>: 'inline'
 127                     </para>
 128                 </listitem>
 129
 130                 <listitem>
 131                     <para>
 132                         <constant>Zend_Mime::MULTIPART_ALTERNATIVE</constant>:
 133                         'multipart/alternative'
 134                     </para>
 135                 </listitem>
 136
 137                 <listitem>
 138                     <para>
 139                         <constant>Zend_Mime::MULTIPART_MIXED</constant>: 'multipart/mixed'
 140                     </para>
 141                 </listitem>
 142
 143                 <listitem>
 144                     <para>
 145                         <constant>Zend_Mime::MULTIPART_RELATED</constant>: 'multipart/related'
 146                     </para>
 147                 </listitem>
 148             </itemizedlist>
 149         </para>
 150     </sect2>
 151
 152     <sect2 id="zend.mime.mime.instantiation">
 153         <title>Instantiating Zend_Mime</title>
 154
 155         <para>
 156             When Instantiating a <classname>Zend_Mime</classname> Object, a <acronym>MIME</acronym>
 157             boundary is stored that is used for all subsequent non-static method calls on that
 158             object. If the constructor is called with a string parameter, this value
 159             is used as a <acronym>MIME</acronym> boundary. If not, a random <acronym>MIME</acronym>
 160             boundary is generated during construction time.
 161         </para>
 162
 163         <para>
 164             A <classname>Zend_Mime</classname> object has the following Methods:
 165
 166             <itemizedlist>
 167                 <listitem>
 168                     <para>
 169                         <methodname>boundary()</methodname>: Returns the <acronym>MIME</acronym>
 170                         boundary string.
 171                     </para>
 172                 </listitem>
 173
 174                 <listitem>
 175                     <para>
 176                         <methodname>boundaryLine()</methodname>: Returns the complete
 177                         <acronym>MIME</acronym> boundary line.
 178                     </para>
 179                 </listitem>
 180
 181                 <listitem>
 182                     <para>
 183                         <methodname>mimeEnd()</methodname>: Returns the complete
 184                         <acronym>MIME</acronym> end boundary line.
 185                     </para>
 186                 </listitem>
 187             </itemizedlist>
 188         </para>
 189     </sect2>
 190 </sect1>
 191 <!--
 192 vim:se ts=4 sw=4 et:
 193 -->