https://github.com/mrkmg/kemail

Yii Application Component to interact with smtp servers without relying on PHP's mail or PEAR's Mail.
https://github.com/mrkmg/kemail

Last synced: 30 days ago
JSON representation

Yii Application Component to interact with smtp servers without relying on PHP's mail or PEAR's Mail.

• Host: GitHub
• URL: https://github.com/mrkmg/kemail
• Owner: mrkmg
• Created: 2012-06-05T16:20:43.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2014-07-08T20:40:37.000Z (over 10 years ago)
• Last Synced: 2024-10-22T14:31:50.802Z (3 months ago)
• Language: PHP
• Size: 269 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
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](http://www.phpclasses.org/package/14-PHP-Sends-e-mail-messages-via-SMTP-protocol.html)

## To Install ##

1. Copy KEmail into approot/protected/extenstions

2. Under "import", add:

    application.extensions.KEmail.KEmail

3. Under "components", add:

    'email'=>array(  

        'class'=>'KEmail',  

        'host_name'=>'smtp_server',  //Hostname or IP of smtp server  

    ),

## Full Documentation ##

You can view the [full documentation](http://mrkmg.github.com/KEmail/class-KEmail.html) online or

you can checkout the docs branch and view it locally on your machine.

## Basic Usage ##

1. Single recipient  

    Yii::app()->email->send('[email protected]','[email protected]','Subject','Body');

2. Multiple recipients    

    $to = array(  

    '[email protected]',  

    '[email protected]',  

    );  

    Yii::app()->email->send('[email protected]',$to,'Subject','Body');

## 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('[email protected]','[email protected]','Subject','SubjectBODY',$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('[email protected]','[email protected]','Subject','SubjectBODY',$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