JUtility/sendMail

From Joomla! Documentation

Jump to: navigation, search

Contents

Description

Mail function (uses phpMailer)

Syntax

JUtility::sendMail($from, $fromname, $recipient, $subject, $body, $mode=0, $cc=null, $bcc=null, $attachment=null, $replyto=null, $replytoname=null)
Parameter Name Default Value Description
$from $from From e-mail address
$fromname $fromname From name
$recipient $recipient Recipient e-mail address(es)
$subject $subject E-mail subject
$body $body Message body
$mode 0 $mode false = plain text, true = HTML
$cc null $cc CC e-mail address(es)
$bcc null $bcc BCC e-mail address(es)
$attachment null $attachment Attachment file name(s)
$replyto null $replyto Reply to email address(es)
$replytoname null $replytoname Reply to name(s)

Returns

boolean True on success

Defined in

libraries/joomla/utilities/utility.php

Importing

jimport( 'joomla.utilities.utility' );

Source Body

        function sendMail($from, $fromname, $recipient, $subject, $body, $mode=0, $cc=null, $bcc=null, $attachment=null, $replyto=null, $replytoname=null)
        {
                // Get a JMail instance
                $mail = &JFactory::getMailer();
 
                $mail->setSender(array($from, $fromname));
                $mail->setSubject($subject);
                $mail->setBody($body);
 
                // Are we sending the email as HTML?
                if ($mode) {
                        $mail->IsHTML(true);
                }
 
                $mail->addRecipient($recipient);
                $mail->addCC($cc);
                $mail->addBCC($bcc);
                $mail->addAttachment($attachment);
 
                // Take care of reply email addresses
                if (is_array($replyto)) {
                        $numReplyTo = count($replyto);
                        for ($i=0; $i < $numReplyTo; $i++){
                                $mail->addReplyTo(array($replyto[$i], $replytoname[$i]));
                        }
                } elseif (isset($replyto)) {
                        $mail->addReplyTo(array($replyto, $replytoname));
                }
 
                return  $mail->Send();
        }
Personal tools