mrit01/laravel-sendgrid

This library adds a 'sendgrid' mail driver to Laravel.

dev-master 2019-05-27 13:36 UTC

Requires

• guzzlehttp/guzzle: ~5.3|~6.2
• illuminate/mail: ~5.1

Requires (Dev)

• illuminate/container: ~5.1
• illuminate/filesystem: ~5.1
• phpunit/phpunit: >=4.0

Suggests

• s-ichikawa/sendgrid-api-builder: support to build json for sendgrid api

MIT

• mrit01

• laravel
• sendgrid

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

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

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

or installed with composer

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

Add the sendgrid service provider in config/app.php:

'providers' => [
    Sichikawa\LaravelSendgridDriver\SendgridTransportServiceProvider::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']);

Create mail config files. config/mail.php

<?php
return [
    'driver' => env('MAIL_DRIVER', 'sendgrid'),
];

API v3

Configure

.env

MAIL_DRIVER=sendgrid
SENDGRID_API_KEY='YOUR_SENDGRID_API_KEY'

config/services.php (In using lumen, require creating config directory and file.)

    '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('[e-mail]', 'foo_name')
        ->from('[e-mail]', '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/services.php (In using lumen, require creating config directory and file.)

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

Use SMTP API

Sendgrid's SMTP API is a very handy feature.

To use this 'sendgrid/x-smtpapi' functionality, use our embedData() function.

API v2

\Mail::send('view', $data, function (Message $message) {
    $message
        ->to('[e-mail]', 'foo_name')
        ->from('[e-mail]', 'bar_name')
        ->embedData([
            'to' => ['[e-mail]', '[e-mail]'],
            'sub' => [
                '-email-' => ['[e-mail]', '[e-mail]'],
            ],
            'category' => 'user_group1',
            'unique_args' => [
                'user_id' => 123
            ]
        ], 'sendgrid/x-smtpapi');
});

API v3

\Mail::send('view', $data, function (Message $message) {
    $message
        ->to('[e-mail]', 'foo_name')
        ->from('[e-mail]', 'bar_name')
        ->replyTo('[e-mail]', 'foobar');
        ->embedData([
            'personalizations' => [
                [
                    'to' => [
                        'email' => '[e-mail]',
                        'name' => 'user1',
                    ],
                    'substitutions' => [
                        '-email-' => '[e-mail]',
                    ],
                ],
                [
                    'to' => [
                        'email' => '[e-mail]',
                        'name' => 'user2',
                    ],
                    'substitutions' => [
                        '-email-' => '[e-mail]',
                    ],
                ],
            ],
            '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.

Difference v2 vs v3

Have a look at 'How to migrate' for more information on the difference in parameters.

Use in Mailable

<?
use Sichikawa\LaravelSendgridDriver\SendGrid;

class SendGridSample extends Mailable
{
    use SendGrid;
    
    public function build()
    {
        return $this
            ->view('template name')
            ->subject('subject')
            ->from('[e-mail]')
            ->to(['[e-mail]'])
            ->sendgrid([
                'personalizations' => [
                    [
                        'substitutions' => [
                            ':myname' => 's-ichikawa',
                        ],
                    ],
                ],
            ]);
    }
}