miradnan/yii2-sendgrid

PHP 5.6+ Sendgrid integration for the Yii framework

1.1.2 2017-07-22 04:48 UTC

Requires

• php: >=5.6.0
• sendgrid/sendgrid: ~4.0
• yiisoft/yii2: ~2.0

Requires (Dev)

• php: >=5.6.0
• codeception/codeception: ~2.2

BSD-3-Clause

• Philippe Gaultier

• mail
• mailer
• email
• sendgrid
• yii2

README

This extension allow the developper to use Sendgrid as an email transport.

Installation

If you use Packagist for installing packages, then you can update your composer.json like this :

{
    "require": {
        "sweelix/yii2-sendgrid": "*"
    }
}

Howto use it

Add extension to your configuration

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

You can send email as follow (using postmark templates)

Yii::$app->mailer->compose('contact/html')
     ->setFrom('[e-mail]')
     ->setTo($form->email)
     ->setSubject($form->subject)
     ->setTemplateId(12345)
     ->setTemplateModel([
         'firstname' => $form->firstname,
         'lastname' => $form->lastname,
     ->send();

For further instructions refer to the related section in the Yii Definitive Guide

Running the tests

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

// ...
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.

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.

Fork the project, create a feature branch , and send us a pull request.