roerjo/laravel-notifications-sendgrid-driver

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

v1.3.0 2020-02-11 14:47 UTC

Requires

• illuminate/notifications: >=5.5

Requires (Dev)

• phpunit/phpunit: ~5.7

MIT

• eric.johnson

• laravel
• sendgrid

README

A Notification Driver with support for Sendgrid Web API.

Requirements

This package depends upon https://github.com/s-ichikawa/laravel-sendgrid-driver. Ensure that you have that package installed before using this package.

Install (Laravel)

composer require roerjo/laravel-notifications-sendgrid-driver

OR

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

"require": {
    "roerjo/laravel-notifications-sendgrid-driver": "^1"
},

Usage

This package extends the functionality of the MailMessage class. It allows the addition of SendGrid API parameters in the same way that https://github.com/s-ichikawa/laravel-sendgrid-driver allows them to be added to the Mailable classes.

The sendgrid driver will need be utilized in the @via method of the Notification class:

/**
 * Get the notification's delivery channels.
 *
 * @param  mixed  $notifiable
 * @return array
 */
public function via($notifiable)
{
    return ['sendgrid'];
}

Then, a toSendGrid method call can be used to generate the SendGridMailMessage:

/**
 * Get the mail representation of the notification.
 *
 * @param  mixed  $notifiable
 * @return \Roerjo\LaravelNotificationsSendGridDriver\Messages\SendGridMailMessage
 */
public function toSendGrid($notifiable)
{
    $accountId = $this->profile->account()->first()->id;
    $channel = config("channels.{$this->profile->channel}.title");

    return (new SendGridMailMessage)
        ->sendgrid([
            'asm' => [
                'group_id' => config('services.sendgrid.unsubscribe_groups.external')
            ],
        ])
        ->error()
        ->subject("We Need To Re-Authenticate Your {$channel} Profile")
        ->line("The token for your {$channel} profile is no longer valid.")
        ->action(
            "Authenticate {$channel}",
            url("accounts/{$accountId}/profiles")
        )
        ->line('Thank you for helping us help you!');
}

Be sure to import SendGridMailMessage if not using the fully qualified namespace in toSendGrid:

use \Roerjo\LaravelNotificationsSendGridDriver\Messages\SendGridMailMessage;

Anonymous Notifications

Notification::route('sendgrid', '[e-mail]')
    ->notify(new ReportNotification);