JMail/addRecipient

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Add recipients to the email

Syntax[edit]

addRecipient($recipient)

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

Returns[edit]

void

Defined in[edit]

libraries/joomla/mail/mail.php

Importing[edit]

jimport( 'joomla.mail.mail' );

Source Body[edit]

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);
        }
}

Examples[edit]

Code Examples[edit]

API16