https://github.com/shershennm/yii2-sendgrid
Sendgrid wrapper for Yii 2
https://github.com/shershennm/yii2-sendgrid
emails sendgrid sendgrid-php yii2 yii2-extension
Last synced: 9 months ago
JSON representation
Sendgrid wrapper for Yii 2
- Host: GitHub
- URL: https://github.com/shershennm/yii2-sendgrid
- Owner: shershennm
- License: mit
- Fork: true (bryglen/yii2-sendgrid)
- Created: 2015-11-16T12:33:20.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-05-27T13:58:04.000Z (about 7 years ago)
- Last Synced: 2025-10-02T15:56:32.411Z (9 months ago)
- Topics: emails, sendgrid, sendgrid-php, yii2, yii2-extension
- Language: PHP
- Homepage:
- Size: 71.3 KB
- Stars: 7
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Yii 2 shershennm SendGrid
=========================
Sendgrid Mailer for Yii 2
> forked from [bryglen/yii2-sendgrid](https://github.com/bryglen/yii2-sendgrid.git)
**3.1.0 update**
Methods which returned `\SendGrid\Mail\EmailAddress` or array with this type, now returns plain email string or `['email' => 'name']` array or array with this values.
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist shershennm/yii2-sendgrid "^3.1"
```
or add
```
"shershennm/yii2-sendgrid": "^3.1"
```
to the require section of your `composer.json` file.
Usage
-----
Once the extension is installed, simply use it in your code by :
To use Mailer, you should configure it in the application configuration like the following,
```php
'components' => [
...
'sendGrid' => [
'class' => 'shershennm\sendgrid\Mailer',
'apiKey' => 'your api key',
]
...
],
```
To send an email, you may use the following code:
```php
$sendGrid = Yii::$app->sendGrid;
$message = $sendGrid->compose('contact/html', ['contactForm' => $form])
$message->setFrom('from@domain.com')
->setTo($form->email)
->setSubject($form->subject)
->send($sendGrid);
//also you can use sendgrid substitutions
->setSendGridSubstitution('template id', [
':var1' => 'var1value',
':var2' => 'var2value',
]);
```