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 (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('[email protected]', 'foo_name')
        ->from('[email protected]', '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('[email protected]', 'foo_name')
        ->from('[email protected]', 'bar_name')
        ->replyTo('[email protected]', 'foobar');
        ->embedData([
            'personalizations' => [
                [
                    'to' => [
                        'email' => '[email protected]',
                        'name'  => 'user1',
                    ],
                    'substitutions' => [
                        '-email-' => '[email protected]',
                    ],
                ],
                [
                    'to' => [
                        'email' => '[email protected]',
                        'name'  => 'user2',
                    ],
                    'substitutions' => [
                        '-email-' => '[email protected]',
                    ],
                ],
            ],
            '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('[email protected]')
            ->to(['[email protected]'])
            ->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('[email protected]')
        ->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('[email protected]', 'foo_name')
        ->from('[email protected]', 'bar_name')
        ->embedData(sgEncode([
            'categories' => ['user_group1'],
        ]), 'sendgrid/x-smtpapi');
});

awanesia / laravel-sendgrid-driver Goto Github PK