kemail | Extension | Yii Framework

Download

To Install

Basic Usage

Configuration

Advanced Usage

You can also customize headers

Queue Support

TODO/Upcoming Features

KEmail

Yii Application Component to interact with smtp servers without relying on PHP's mail or PEAR's Mail. Simply a wrapper for http://www.phpclasses.org/package/14-PHP-Sends-e-mail-messages-via-SMTP-protocol.html

Download ¶

Download from here Easiest way
Download from github https://github.com/mrkmg/KEmail Not easy, unless you are familiar with git

To Install ¶

Copy KEmail into approot/protected/extenstions
Under "import", add:

application.extensions.KEmail.KEmail
Under "components", add:

'email'=>array(
'class'=>'KEmail',
'host_name'=>'smtp_server', //Hostname or IP of smtp server
),

Basic Usage ¶

Single recipient
Yii::app()->email->send('from@email.address','to@email.address','Subject','Body');
Multiple recipients
$to = array(
'user1@email.address',
'user2@emai.address',
);
Yii::app()->email->send('from@email.address',$to,'Subject','Body');

Full API Documentation on GITHUB

Configuration ¶

The following is an outline of all the avaible options, and their default options

host_name="localhost"           Host name of smtp server
host_port=25                    Port of smtp server
ssl=false                       Force SSL
http_proxy_host_name=''         Set to enable using an http proxy to access smtp server
http_proxy_host_port=3128       Port of http proxy
socks_host_name=''              Set to enable using a socks proxy
socks_host_port=1080            Port of socks proxy
socks_version='5'               Version of socks proxy
start_tls=false                 Force `start_tls`
localhost='localhost'           Given hostname of client
direct_delivery=false           Skip smtp server and delevier directly to recipients smtp
timeout=10                      Time in seconds to timeout for all smtp connections
data_timeout=0                  Time in seconds to timeout for data transfer to SMTP server, if 0 uses timeout
debug=false                     Output Debug information to browser
html_debug=true                 Format Debug information as html
pop3_auth_host=''               Set to authenticate to a pop3 server
user=""                         Username for smtp authentication
realm=""                        Realm for smtp authentication
password=""                     Password for smtp authentication
workstation=""                  Workstation for smtp authentication
authentication_mechanism=""     Force a specific smtp authentication mechanism ('LOGIN','PLAIN','CRAM-MD5','NTLM')
enable_queue=false              Enabled the queue
autocreate_db_table=true        Check for and create if needed the queue table in the database
queue_table_name='kemail_queue' Name of the queue database table

Advanced Usage ¶

You can also customize headers ¶

For example, to send an HTML email, do the following

$headers = array(
    'MIME-Version: 1.0',
    'Content-type: text/html; charset=iso-8859-1'
);
Yii::app()->email->send('from@email.address','to@email.address','Subject','<html><head><title>Subject</title></head><body>BODY</body></html>',$headers);

Queue Support ¶

In order to use the built in queue feature, you must have a database accessable via Yii::app()->db;

To Enable to queue, set the following options

'email'=>array(  
    'class'=>'KEmail',  
    'host_name'=>'smtp_server',  //Hostname or IP of smtp server
    'enable_queue'=>true, //This enabled to queue
),

autocreate_db_table should be set to false once the table has been created.

To queue an email, do the following

$headers = array(
    'MIME-Version: 1.0',
    'Content-type: text/html; charset=iso-8859-1'
);
$priority = 2; //INT between 0 and 9. Higher the number, the sooner it will be sent.
Yii::app()->email->queue('from@email.address','to@email.address','Subject','<html><head><title>Subject</title></head><body>BODY</body></html>',$headers,$priority);

Then, maybe via a cron script or by random chance,

Yii::app()->email->processQueue(5); //Process 5 emails out of the queue
Yii::app()->email->processQueue(8,true) //Process 8 emails from the queue, and ignore priorities

TODO/Upcoming Features ¶

Improve mail queue
- Allow for use of a variety of storage methods, flatfile, sqlite.
- Implement yiic access to process mail queue
- Ability to get total number of items in queue
Error detection and reporting

Total 8 comments

#13319

mrkmg at 2013/05/22 09:32am

re: Still being updated?

Yes, I am still working on this project. Development is slow though. If you would like to help, feel free to clone the github project and send a pull request.

#13096

ktwbc at 2013/05/04 10:18am

Still being updated?

Is this extension still being updated? Error messages are desperately needed to log why an email failed other than a simple Boolean true/false.

#12341

mrkmg at 2013/03/14 03:27pm

In Reply To: CC and BCC

You can add CC and BCC recipients via the headers.

For Example:

$headers = array(
    'MIME-Version: 1.0',
    'Content-type: text/html; charset=iso-8859-1',
    'Cc: person@email.address',
    'Bcc: hidden@email.address'
);
Yii::app()->email->send('from@email.address','to@email.address','Subject','<html><head><title>Subject</title></head><body>BODY</body></html>',$headers);

#10853

teguh11 at 2012/11/27 11:59pm

CC and BCC

How to use CC and BCC??

#8479

mrkmg at 2012/06/06 11:58am

Reply to GMail as SMTP

The following setup works for GMAIL's smtp server

'email'=>array(
                    'class'=>'KEmail',
                    'host_name'=>'smtp.gmail.com',
                    'user'=>'user@gmail.com',
                    'password'=>'password',
                    'host_port'=>465,
                    'ssl'=>'true',
                ),

#8478

mrkmg at 2012/06/06 11:50am

In Reply to "Can't get it to work"

I sent you a PM on the forums. I have tried this on 3 different installations on different machines, and all of them worked perfect. My assumption is based on your error that you placed something in the config file in the wrong location.

#8465

beltrajp at 2012/06/05 10:43pm

Can't get it work

I did the steps outlined.

I get this error:

Property "CWebApplication.email" is not defined.

#8464

Daniel at 2012/06/05 10:41pm

GMail as SMTP

Hi,

Any example on using GMail as SMTP?

Cheers,

Daniel

Please login to leave your comment.

kemail Follow @yiiframework