s-ichikawa / laravel-sendgrid-driver
This library adds a 'sendgrid' mail driver to Laravel.
Installs: 1 635 974
Dependents: 4
Suggesters: 0
Security: 0
Stars: 272
Watchers: 10
Forks: 54
Open Issues: 4
Requires
- guzzlehttp/guzzle: ^6.3 || ^7.0
- illuminate/mail: >=7.0
- illuminate/support: >=7.0
Requires (Dev)
- illuminate/container: >=7.0
- illuminate/filesystem: >=7.0
- laravel/helpers: ^1.2
- phpunit/phpunit: ^8.5
- vlucas/phpdotenv: ^4.1
Suggests
- s-ichikawa/sendgrid-api-builder: support to build json for sendgrid api
This package is auto-updated.
Last update: 2021-01-06 01:46:46 UTC
README
A Mail Driver with support for Sendgrid Web API, using the original Laravel API. This library extends the original Laravel classes, so it uses exactly the same methods.
To use this package required your Sendgrid Api Key. Please make it Here.
Notification
If your project using guzzlehttp/guzzle 6.2.0 or less, you can use version 1.0.0 But the old version has security issues,
Install (Laravel)
Add the package to your composer.json and run composer update.
"require": { "s-ichikawa/laravel-sendgrid-driver": "~3.0" },
or installed with composer
$ composer require s-ichikawa/laravel-sendgrid-driver
Add the sendgrid service provider in config/app.php: (Laravel 5.5+ uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.)
'providers' => [ Sichikawa\LaravelSendgridDriver\SendgridTransportServiceProvider::class ];
Install (Lumen)
Add the package to your composer.json and run composer update.
"require": { "s-ichikawa/laravel-sendgrid-driver": "~2.0" },
or installed with composer
$ composer require "s-ichikawa/laravel-sendgrid-driver:~2.0"
Add the sendgrid service provider in bootstrap/app.php
$app->configure('mail'); $app->configure('services'); $app->register(Sichikawa\LaravelSendgridDriver\MailServiceProvider::class); unset($app->availableBindings['mailer']);
Create mail config files. config/mail.php
<?php return [ 'driver' => env('MAIL_DRIVER', 'sendgrid'), ];
Configure
.env
MAIL_DRIVER=sendgrid
SENDGRID_API_KEY='YOUR_SENDGRID_API_KEY'
# Optional: for 7+ laravel projects
MAIL_MAILER=sendgrid
config/services.php (In using lumen, require creating config directory and file.)
'sendgrid' => [ 'api_key' => env('SENDGRID_API_KEY'), ],
config/mail.php
'mailers' => [ 'sendgrid' => [ 'transport' => 'sendgrid', ], ],
endpoint config
If you need to set custom endpoint, you can set any endpoint by using endpoint
key.
For example, calls to SendGrid API through a proxy, call endpoint for confirming a request.
'sendgrid' => [ 'api_key' => env('SENDGRID_API_KEY'), 'endpoint' => 'https://custom.example.com/send', ],
Request Body Parameters
Every request made to /v3/mail/send will require a request body formatted in JSON containing your email’s content and metadata. Required parameters are set by Laravel's usually mail sending, but you can also use useful features like "categories" and "send_at".
\Mail::send('view', $data, function (Message $message) { $message ->to('foo@example.com', 'foo_name') ->from('bar@example.com', 'bar_name') ->embedData([ 'categories' => ['user_group1'], 'send_at' => $send_at->getTimestamp(), ], 'sendgrid/x-smtpapi'); });
more info https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html#-Request-Body-Parameters
API v3
\Mail::send('view', $data, function (Message $message) { $message ->to('foo@example.com', 'foo_name') ->from('bar@example.com', 'bar_name') ->replyTo('foo@bar.com', 'foobar'); ->embedData([ 'personalizations' => [ [ 'to' => [ 'email' => 'user1@example.com', 'name' => 'user1', ], 'substitutions' => [ '-email-' => 'user1@example.com', ], ], [ 'to' => [ 'email' => 'user2@example.com', 'name' => 'user2', ], 'substitutions' => [ '-email-' => 'user2@example.com', ], ], ], 'categories' => ['user_group1'], 'custom_args' => [ 'user_id' => "123" // Make sure this is a string value ] ], 'sendgrid/x-smtpapi'); });
- custom_args values have to be strings. Sendgrid API gives a non-descriptive error message when you enter non-string values.
Use in Mailable
<? use Sichikawa\LaravelSendgridDriver\SendGrid; class SendGridSample extends Mailable { use SendGrid; public function build() { return $this ->view('template name') ->subject('subject') ->from('from@example.com') ->to(['to@example.com']) ->sendgrid([ 'personalizations' => [ [ 'substitutions' => [ ':myname' => 's-ichikawa', ], ], ], ]); } }
Using Template Id
Illuminate\Mailer has generally required a view file. But in case of using template id, set an empty array at view function.
<? \Mail::send([], [], function (Message $message) { $message ->to('to@example.com') ->embedData([ 'personalizations' => [ [ 'dynamic_template_data' => [ 'title' => 'Subject', 'name' => 's-ichikawa', ], ], ], 'template_id' => config('services.sendgrid.templates.dynamic_template_id'), ], SendgridTransport::SMTP_API_NAME); });
Using with Telescope
In case telescope is active and set array to first variable in embedData, telescope's watcher happen error in encoding. In ordar to avoid this probrem, you can use sgEncode function.
<? use Sichikawa\LaravelSendgridDriver\SendGrid; \Mail::send('view', $data, function (Message $message) { $message ->to('foo@example.com', 'foo_name') ->from('bar@example.com', 'bar_name') ->embedData(sgEncode([ 'categories' => ['user_group1'], ]), 'sendgrid/x-smtpapi'); });