LavaToaster/laravel-sendgrid-driver

This liblary can add sendgrid driver into the laravel's mail configure.

Laravel SendGrid Driver

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 (Laravel5.1~)

Add the package to your composer.json and run composer update.

"require": {
    "s-ichikawa/laravel-sendgrid-driver": "^1.1"
},

or installed with composer

$ composer require s-ichikawa/laravel-sendgrid-driver

Remove the default service provider and add the sendgrid service provider in config/app.php:

'providers' => [
//  Illuminate\Mail\MailServiceProvider::class,

    Sichikawa\LaravelSendgridDriver\MailServiceProvider::class,
];

#Install (Laravel5.0)

Add the package to your composer.json and run composer update.

"require": {
    "s-ichikawa/laravel-sendgrid-driver": "5.0.x-dev"
},

or installed with composer

$ composer require s-ichikawa/laravel-sendgrid-driver:5.0.x-dev

Remove the default service provider and add the sendgrid service provider in config/app.php:

'providers' => [
//  'Illuminate\Mail\MailServiceProvider',

    'Sichikawa\LaravelSendgridDriver\MailServiceProvider',
];

Install (Lumen)

Add the package to your composer.json and run composer update.

"require": {
    "s-ichikawa/laravel-sendgrid-driver": "^1.1"
},

or installed with composer

$ composer require s-ichikawa/laravel-sendgrid-driver

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']);

#API v3

##Configure

.env

MAIL_DRIVER=sendgrid
SENDGRID_API_KEY='YOUR_SENDGRID_API_KEY'

config/service.php

    'sendgrid' => [
        'api_key' => env('SENDGRID_API_KEY'),
        'version' => 'v3'
    ]

##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 v2

##Configure

.env

MAIL_DRIVER=sendgrid
SENDGRID_API_KEY='YOUR_SENDGRID_API_KEY'

config/service.php

    'sendgrid' => [
        'api_key' => env('SENDGRID_API_KEY')
    ]

#Use SMTP API

Sendgrid's SMTP API is so cool feature. This function can use by setting embed data to message. and, set 'sendgrid/x-smtpapi' to data name or content-type.

\Mail::send('view', $data, function (Message $message) {
    $message
        ->to('foo@example.com', 'foo_name')
        ->from('bar@example.com', 'bar_name')
        ->embedData([
            'category' => 'user_group1',
            'unique_args' => [
                'user_id' => 123
            ]
        ], 'sendgrid/x-smtpapi');
});