Actions

API15

JMail/addRecipient

From Joomla! Documentation

< API15:JMail
Revision as of 13:35, 12 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Add recipients to the email

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

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

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

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />