API16

JMail/addRecipient: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JMail/addRecipient}}
 


===Syntax===
===Syntax===
Line 47: Line 47:




{{subst:SeeAlso:JMail/addRecipient}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=addRecipient
  category=addRecipient
  category=JMail
  category=JMail
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 01:53, 25 March 2017

Description

Add recipients to the email



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



Examples

Code Examples