miradnan/yii2-sendgrid

PHP 5.6+ Sendgrid integration for the Yii framework

Sendgrid Yii2 integration

This extension allow the developper to use Sendgrid as an email transport., _(*1)

, _(*2)

, _(*3)

Installation

If you use Packagist for installing packages, then you can update your composer.json like this :, _(*4)

``` json { "require": { "sweelix/yii2-sendgrid": "*" } }, <sub>(*5)</sub>

Howto use it
------------

Add extension to your configuration

``` php
return [
    //....
    'components' => [
        'mailer' => [
            'class' => 'sweelix\sendgrid\Mailer',
            'token' => '<your sendgrid token>',
        ],
    ],
];

You can send email as follow (using postmark templates), <sub>(*6)</sub>

``` php Yii::$app->mailer->compose('contact/html') ->setFrom('from@domain.com') ->setTo($form->email) ->setSubject($form->subject) ->setTemplateId(12345) ->setTemplateModel([ 'firstname' => $form->firstname, 'lastname' => $form->lastname, ->send();, <sub>(*7)</sub>

For further instructions refer to the [related section in the Yii Definitive Guide](http://www.yiiframework.com/doc-2.0/guide-tutorial-mailing.html)


Running the tests
-----------------

Before running the tests, you should edit the file tests/_bootstrap.php and change the defines :

``` php
// ...
define('SENDGRID_FROM', '<sender>');
define('SENDGRID_TOKEN', '<token>');
define('SENDGRID_TO', '<target>');
define('SENDGRID_TEMPLATE', 575741);

define('SENDGRID_TEST_SEND', false);
// ...

to match your Sendgrid configuration., <sub>(*8)</sub>

Contributing

All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code., <sub>(*9)</sub>

Fork the project, create a feature branch , and send us a pull request., <sub>(*10)</sub>