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

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.mail.adding-recipients">
    <title>Adding Recipients</title>

    <para>
        Recipients can be added in three ways:
    </para>

    <itemizedlist>
        <listitem>
            <para>
                <methodname>addTo()</methodname>: Adds a recipient to the mail with a "To" header
            </para>
        </listitem>

        <listitem>
            <para>
                <methodname>addCc()</methodname>: Adds a recipient to the mail with a "Cc" header
            </para>
        </listitem>

        <listitem>
            <para>
                <methodname>addBcc()</methodname>: Adds a recipient to the mail not visible in the
                header
            </para>
        </listitem>
    </itemizedlist>

    <para>
        <methodname>getRecipients()</methodname> serves list of the recipients.
        <methodname>clearRecipients()</methodname> clears the list.
    </para>

    <note>
        <title>Additional parameter</title>

        <para>
            <methodname>addTo()</methodname> and <methodname>addCc()</methodname> accept a second
            optional parameter that is used as a human-readable name of the recipient for the
            header. Double quotation is changed to single quotation and angle brackets to square
            brackets in the parameter.
        </para>
    </note>

    <note>
        <title>Optional Usage</title>

        <para>
            All three of these methods can also accept an array of email addresses
            to add instead of one at a time. In the case of <methodname>addTo()</methodname> and
            <methodname>addCc()</methodname>, they can be associative arrays where the key is the
            human readable name for the recipient.
        </para>
    </note>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->