Search by

jeffersongoncalves / laravel-sendgrid

jeffersongoncalves

Laravel wrapper for SendGrid's Web API v3

Package info

github.com/jeffersongoncalves/laravel-sendgrid

pkg:composer/jeffersongoncalves/laravel-sendgrid

Statistics

Installs: 1

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

1.0.0 2026-09-08 00:59 UTC

This package is auto-updated.

Last update: 2026-09-08 01:00:44 UTC


README

Laravel SendGrid

Laravel SendGrid

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads License

A Laravel wrapper for SendGrid's Web API v3. Covers transactional email sending, contact/list management, campaigns, stats and suppressions through a simple, typed API built on Laravel's Http client.

Features

  • Mail: send (plain text/HTML content, dynamic templates, cc/bcc, reply-to)
  • Contacts: list, add, search
  • Campaigns: list, get
  • Stats: get
  • Bounces: list
  • Spam reports: list
  • Email validation: validateEmail
  • Throws SendgridException (with the original API error body) on any non-2xx response

Installation

You can install the package via composer:

composer require jeffersongoncalves/laravel-sendgrid

Publish the config file:

php artisan vendor:publish --tag=sendgrid-config

Set your SendGrid API key in .env:

SENDGRID_API_KEY=your-api-key
SENDGRID_FROM_EMAIL=no-reply@example.com
SENDGRID_FROM_NAME="Example App"

Generate an API key under Settings > API Keys in your SendGrid account.

Configuration

// config/sendgrid.php
return [
    'api_key' => env('SENDGRID_API_KEY', ''),
    'from_email' => env('SENDGRID_FROM_EMAIL', ''),
    'from_name' => env('SENDGRID_FROM_NAME', ''),
    'base_url' => env('SENDGRID_BASE_URL', 'https://api.sendgrid.com/v3'),
];

Usage

The package is resolved via the Sendgrid facade or by injecting JeffersonGoncalves\LaravelSendgrid\Sendgrid. Resources are exposed as methods returning a dedicated resource class.

Sending mail

use JeffersonGoncalves\LaravelSendgrid\Facades\Sendgrid;

Sendgrid::send([
    'to' => 'jane@example.com',
    'subject' => 'Welcome!',
    'text' => 'Hi Jane, welcome aboard.',
    'html' => '<p>Hi Jane, welcome aboard.</p>',
]);

// Multiple recipients, cc/bcc, custom from, reply-to
Sendgrid::send([
    'to' => ['jane@example.com', 'john@example.com'],
    'from' => 'no-reply@example.com',
    'from_name' => 'Example App',
    'subject' => 'Welcome!',
    'html' => '<p>Welcome aboard.</p>',
    'cc' => 'cc@example.com',
    'bcc' => 'bcc@example.com',
    'reply_to' => 'support@example.com',
]);

// Dynamic templates
Sendgrid::send([
    'to' => 'jane@example.com',
    'template_id' => 'd-1234567890',
    'dynamic_template_data' => ['name' => 'Jane'],
]);

If from/from_name are omitted, the values from config('sendgrid.from_email') / config('sendgrid.from_name') are used.

Contacts

$contacts = Sendgrid::contacts()->list();

Sendgrid::contacts()->add(
    email: 'jane@example.com',
    firstName: 'Jane',
    lastName: 'Doe',
    listIds: ['list-id'],
);

$result = Sendgrid::contacts()->search('email LIKE \'jane%\'');

Campaigns

$campaigns = Sendgrid::campaigns()->list(pageSize: 10);

$campaign = Sendgrid::campaigns()->get('campaign-id');

Stats

$stats = Sendgrid::stats()->get(startDate: '2026-01-01', endDate: '2026-01-31');

Bounces

$bounces = Sendgrid::bounces()->list(limit: 50);

Spam reports

$reports = Sendgrid::spamReports()->list(limit: 50);

Email validation

$result = Sendgrid::validateEmail('jane@example.com');

Error handling

Any non-2xx API response throws JeffersonGoncalves\LaravelSendgrid\Exceptions\SendgridException, which exposes the decoded error body:

use JeffersonGoncalves\LaravelSendgrid\Exceptions\SendgridException;

try {
    Sendgrid::send(['to' => 'jane@example.com', 'subject' => 'Hi', 'text' => 'Hi']);
} catch (SendgridException $e) {
    logger()->error($e->getMessage(), $e->errorBody());
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.