repo_zf1/documentation/manual/en/module_specs/Zend_Mail-Attachments.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.mail.attachments">
    <title>Attachments</title>

    <para>
        Files can be attached to an e-mail using the <methodname>createAttachment()</methodname>
        method. The default behavior of <classname>Zend_Mail</classname> is to assume the
        attachment is a binary object (<property>application/octet-stream</property>), that it
        should be transferred with base64 encoding, and that it is handled as an attachment. These
        assumptions can be overridden by passing more parameters to
        <methodname>createAttachment()</methodname>:
    </para>

    <example id="zend.mail.attachments.example-1">
        <title>E-Mail Messages with Attachments</title>

        <programlisting language="php"><![CDATA[
$mail = new Zend_Mail();
// build message...
$mail->createAttachment($someBinaryString);
$mail->createAttachment($myImage,
                        'image/gif',
                        Zend_Mime::DISPOSITION_INLINE,
                        Zend_Mime::ENCODING_BASE64);
]]></programlisting>
    </example>

    <para>
        If you want more control over the <acronym>MIME</acronym> part generated for this
        attachment you can use the return value of <methodname>createAttachment()</methodname> to
        modify its attributes. The <methodname>createAttachment()</methodname> method returns a
        <classname>Zend_Mime_Part</classname> object:
    </para>

    <programlisting language="php"><![CDATA[
$mail = new Zend_Mail();

$at = $mail->createAttachment($myImage);
$at->type        = 'image/gif';
$at->disposition = Zend_Mime::DISPOSITION_INLINE;
$at->encoding    = Zend_Mime::ENCODING_BASE64;
$at->filename    = 'test.gif';

$mail->send();
]]></programlisting>

    <para>
        An alternative is to create an instance of <classname>Zend_Mime_Part</classname> and add it
        with <methodname>addAttachment()</methodname>:
    </para>

    <programlisting language="php"><![CDATA[
$mail = new Zend_Mail();

$at = new Zend_Mime_Part($myImage);
$at->type        = 'image/gif';
$at->disposition = Zend_Mime::DISPOSITION_INLINE;
$at->encoding    = Zend_Mime::ENCODING_BASE64;
$at->filename    = 'test.gif';

$mail->addAttachment($at);

$mail->send();
]]></programlisting>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->