API16:JMail/addRecipient

Description

Add recipients to the email

{{subst:Description:JMail/addRecipient}}

Syntax

addRecipient($recipient)

Parameter Name	Default Value	Description
$recipient		$recipient Either a string or array of strings [e-mail address(es)]

Returns

void

Defined in

libraries/joomla/mail/mail.php

Importing

jimport( 'joomla.mail.mail' );

Source Body

public function addRecipient($recipient)
{
        // If the recipient is an aray, add each recipient... otherwise just add the one
        if (is_array($recipient))
        {
                foreach ($recipient as $to) {
                        $to = JMailHelper::cleanLine($to);
                        $this->AddAddress($to);
                }
        } else {
                $recipient = JMailHelper::cleanLine($recipient);
                $this->AddAddress($recipient);
        }
}

{{subst:SeeAlso:JMail/addRecipient}}

Examples

<CodeExamplesForm />