Laravel Sendgrid Driver
Laravel Sendgrid Driver stats
- Downloads
- 5.2M
- Stars
- 367
- Open Issues
- 8
- Forks
- 89
This library adds a 'sendgrid' mail driver to Laravel.
Laravel SendGrid Driver Package Summary
The Laravel SendGrid Driver is a robust package designed to integrate SendGrid's Web API with Laravel's mailing capabilities. This package extends Laravel's native mail functionality, allowing developers to leverage SendGrid for email delivery without deviating from Laravel's standard mailing practices.
Main Features:
- Seamless Integration: Works with Laravel’s native mail functions.
- Support for SendGrid API: Utilizes SendGrid for sending emails, including advanced features like categories and scheduling.
- Template Support: Allows the use of SendGrid’s dynamic templates.
- Custom Endpoints: Ability to set custom endpoints for API requests, useful for routing through proxies or other specific needs.
Installation and Configuration:
For Laravel:
-
Installation via Composer:
composer require s-ichikawa/laravel-sendgrid-driverFor Laravel 5.5 and above, service providers are auto-discovered.
-
Configuration:
- Set the mail driver in
.env:MAIL_DRIVER=sendgridSENDGRID_API_KEY='YOUR_SENDGRID_API_KEY' - Update
config/services.php:'sendgrid' => ['api_key' => env('SENDGRID_API_KEY'),],
- Set the mail driver in
For Lumen:
-
Installation via Composer:
composer require "s-ichikawa/laravel-sendgrid-driver:^4.0" -
Configuration:
- Register the service provider in
bootstrap/app.php. - Configure mail and service details in respective config files.
- Register the service provider in
Usage:
- Basic Usage: Similar to Laravel's typical mail sending functions but with additional settings for SendGrid specific features such as categories.
- Using Templates: For using SendGrid templates, specify the template ID and optionally use an empty array in the view method if you don’t need to pass data to a Laravel view.
Endpoint Configuration:
Customize the endpoint in config/services.php if you need to route requests through a custom URL or proxy:
'sendgrid' => [ 'api_key' => env('SENDGRID_API_KEY'), 'endpoint' => 'https://custom.example.com/send',],
This package is ideal for developers looking to integrate SendGrid's powerful email delivery services seamlessly into Laravel applications, providing both simplicity and flexibility in managing email communications.