repo_zf1/documentation/manual/en/module_specs/Zend_Mime.xml

<?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:
-->