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