mailer Follow @yiiframework

Mailer using PHPMailer

FAQ

EMailer is a simple wrapper for the PHPMailer library, which is bundled. You should keep an eye on this library, since it could be updated and the API could get broken.

Please read the source code comments for licensing information. Please read the phpmailer/LICENCE file for the PHPMailer license.

FAQ ¶

Why should I use this extension instead of using the phpmailer directly?

Answer: this is encapsulated as a Yii extension, and you can modify the methods or extend the functionality as you'd like, instead of modifying the original source code :)

Why the license was GPL on the download page when the extension is released under LGPL?

Answer: my mistake. The license for this extension is and has always been LGPL.

My view has images on it, but when it is send as e-mail, no images are shown. Why?

You must place the images in a public HTTP server, since you're using the tag in your view.

File checksums ¶

847183726a2e59d8aa5968e2fa6f7597 mailer-2.2.tar.bz2
bef73d62003ab84399706c578294cccb mailer-2.2.zip

Resources ¶

Documentation ¶

Requirements ¶

Yii 1.0 or above
PHPMailer (version 5.0 bundled)

Installation ¶

Extract the release file under protected/extensions

Usage ¶

As a normal component:

Usage example, using SMTP as the sending method, creating a component inside a controller:

<?php
$message = 'Hello World!';
$mailer = Yii::createComponent('application.extensions.mailer.EMailer');
$mailer->Host = <your smtp host>;
$mailer->IsSMTP();
$mailer->From = 'wei@example.com';
$mailer->AddReplyTo('wei@example.com');
$mailer->AddAddress('qiang@example.com');
$mailer->FromName = 'Wei Yard';
$mailer->CharSet = 'UTF-8';
$mailer->Subject = Yii::t('demo', 'Yii rulez!');
$mailer->Body = $message;
$mailer->Send();

As an application component:

In the configuration (notice the pathViews and pathLayouts parameters):

<?php
'components'=>array(
   'mailer' => array(
      'class' => 'application.extensions.mailer.EMailer',
      'pathViews' => 'application.views.email',
      'pathLayouts' => 'application.views.email.layouts'
   ),
   // ...
}

In the controller:

<?php
$message = 'Hello World!';
Yii::app()->mailer->Host = 'smtp.yiiframework.com';
Yii::app()->mailer->IsSMTP();
Yii::app()->mailer->From = 'wei@pradosoft.com';
Yii::app()->mailer->FromName = 'Wei';
Yii::app()->mailer->AddReplyTo('wei@pradosoft.com');
Yii::app()->mailer->AddAddress('qian@yiiframework.com');
Yii::app()->mailer->Subject = 'Yii rulez!';
Yii::app()->mailer->Body = $message;
Yii::app()->mailer->Send();

Since this is a wrapper, please see:

Change Log ¶

20090529 2.2 ¶

Fixed bug (reported by ooaat)

20090516 2.1 ¶

Added pathViews and pathLayouts configuration parameters, to indicate a path aliases where the view and layout for getView are.
Added an empty init() method to make it work as an application component.

20090411 2.0 ¶

Updated PHPMailer to version 5.0
Included getView method.

Total 20 comments

#12778

andrwsv at 2013/04/11 01:17pm

i need know how i get error and mail server

I have two Questions : 1. how i send with server mail ? 2. how i get error when send mail for validate in my code and dont see error to my user. thanks

#12429

Jose H. Milán at 2013/03/20 05:53am

Be carefull

I have had a really serious privacy issue (it is my fault) but it would be fine if you add to this brief some reminders.

If you use Emailer extension as a component and you use it in that way:

Yii::app()->mailer->AddAdress('someaddress@somedomain.com');
Yii::app()->mailer->Send();

REMEMBER! it is not a fresh object, so if you loop to send the same mail to several addresses you will (maybe) need to:

Yii::app()->mailer->ClearAddresses();
    Yii::app()->mailer->ClearCCs();
    Yii::app()->mailer->ClearBCCs();
    Yii::app()->mailer->ClearReplyTos();
    Yii::app()->mailer->ClearAllRecipients();
    Yii::app()->mailer->ClearAttachments();
    Yii::app()->mailer->ClearCustomHeaders();

Otherwise you will generate emails with "visible" addresses in the "To" field. I didn't realize about that because I was in a hurry and it was problematic.

Thanks, the extension is really useful.

#12180

Maziar at 2013/03/04 03:29pm

Hide Header

Hi, is there any way to hide the X-Originating-IP in header for security reason??

#11711

Paul_Kish at 2013/01/29 03:08am

Works

Awesome used the wrapper very nice, for those who want to test smtp on Windows use this awesome dummy smtp application SMTP Tool

#11060

Ziggi at 2012/12/12 07:48pm

Callbacks

PHPMailer 5.2.2 has new feature called "Callbacks".

The documentation says:

**NEW CALLBACK FUNCTION:**

We have had requests for a method to process the results of sending emails through PHPMailer. In this new release, we have implemented a callback function that passes the results of each email sent (to, cc, and/or bcc). We have provided an example that echos the results back to the screen. The callback function can be used for any purpose. With minor modifications, the callback function can be used to create CSV logs, post results to databases, etc.

Well, it is easy in PHPMailer but I have no idea how to use it within Yii framework with MetaYii extension wrapper. Anybody can advise, please?

UPDATE:

The solution is to place the callback function in an application helper component and then pass the result to controller as application parameter.

I hope this might be helpful.

#10877

gallyamow at 2012/11/29 06:11am

Small fix

I think it would be more useful if:

Author change

protected $pathViews = 'application.views.email';
protected $pathLayouts = 'application.views.email.layouts';

public $pathViews = null;
public $pathLayouts = null;

and fix the method "getView" as follows

public function getView($view, $vars=array(), $layout=null)
{
    $viewFile=$view;
    if (!is_null($this->pathViews))
    {
        $viewFile=$this->pathViews.'.'.$view;
    }
 
    $body=Yii::app()->controller->renderPartial($viewFile, array_merge($vars, array('content'=>$this->_myMailer)), true);
    /* the rest of the program code */          
}

That fix allow you to set $pathViews and $pathLayouts attributes from the component config

'components'=>array(
    'mailer' => array(
    'class'=>'application.extensions.mailer.EMailer',
    'pathLayouts'=>'application.views.mail.layouts',
    'pathViews'=>'application.views.mail.view',
    ),
    ....

and pass the arbitrary view name to the method "getView"

Yii::app()->mailer->getView('application.modules.feedback.views.mail.admin_email_notification')

#10370

Nabi at 2012/10/23 10:31am

Set a view

@prchakal, @briiC.lv and others somebody!

You can just use this for set view:

$mailer->getView('myview');

And if have a model use this:

$mailer->getView('myview', array('model'=>$model));

#9851

GillesK at 2012/09/15 08:01am

Smtp login password

Hello, is it possible to put smtp server and credentials in config/main.php ?

#8967

Sebastian at 2012/07/10 11:02am

EMailer->getView() stopped working

After updating from PHP 5.2 to 5.3, getView() in the EMailer-Class stopped working. I got an error message in

return call_user_func_array(array($this->_myMailer, $method), $params);

telling me, that parameter 1 needs to be a valid callback and there is no function "renderPartial" in EMailer class. After further investigation, I found that the error comes from invoking $mailer->getView(), the else-part which will be applied when the class is called without a Yii CController (e.g. from a cron job or console application). If any of you need it, here is the else part, where I only changed the $body- and the second return-statement.

else {
            $body = CController::renderInternal(Yii::getPathOfAlias($this->pathViews . '.' . $view) . '.php', array_merge($vars, array('content' => $this->_myMailer)), true);
            if ($layout === null) {
                return $body;
            } else {
                return CController::renderInternal(Yii::getPathOfAlias($this->pathLayouts . '.' . $layout) . '.php', array('content' => $body), true);
            }
        }

#8096

somethingkindawierd at 2012/05/09 05:07pm

HTML Email

Just a note for anyone trying to send an html email, I had to call this method to get html to render correctly:

Yii::app()->mailer->IsHTML(true);

#7510

jacksmirk at 2012/03/27 04:43am

RE:In the controller

It depends on what you are trying to achieve. For example, if you want to send an email when a client creates an order in your store you'd have to put your code in the actionCreate() of the OrderController class.

#7509

kathy at 2012/03/27 02:39am

In the controller

Where should I put the code "in the controller"? Thank you. :)

#6712

jacksmirk at 2012/01/31 08:49am

Re:don't show images into view

I had the same problem. In order to put images in your email (not as an attachment) you have to provide an absolute and public url to the image. Can you post your view code?

#6710

Giancarlo at 2012/01/31 05:34am

don't show images into view

Hi. I have tried your extension: It's very very nice!

I have this problem: I follow your sample:

$html = $this->renderPartial('/mycontroller/myview',array('data'=>$data),true); 
...
Yii::app()->mailer->Body = $html;

my view include some picture, but the email don't show those images.

I see into html: http://prova/demo/images/splash.jpg but the exact path should be: http://www.mysite.com/prova/demo/images/splash.jpg

Can you help me? Thank you

#5616

eholsinger at 2011/10/25 04:13pm

thank you

I agree with others, it was very easy to get this plugin working.

#4500

Ivica at 2011/07/14 12:40am

Usefull extension

Thanks for this extension, PHPMailer is my favorite php mail library.

#3839

briiC.lv at 2011/05/13 02:40am

@prchakal

$html = $this->renderPartial('myview',array('data'=>$data),true);
//OR get view from other controller
$html = $this->renderPartial('/mycontroller/myview',array('data'=>$data),true);
 
...
Yii::app()->mailer->Body = $html;
...

#3834

prchakal at 2011/05/12 10:09pm

Views

Hi,

Can you post a sample getting HTML from a VIEW?

#3406

maschingan at 2011/04/11 05:13am

exceptions

Hello, can you add exceptions in __construct() method? Something like this:

public function __construct($exceptions = false)
{
    $this->_myMailer = new PHPMailer($exceptions);
}

#2006

Antonio Ramirez at 2010/10/29 03:33pm

thanks

Thank you very much for your efforts. Very easy to use and implement.

Please login to leave your comment.