webup / laravel-sendinblue
Laravel's mail transport for SendinBlue
Installs: 481 841
Dependents: 0
Suggesters: 0
Security: 0
Stars: 120
Watchers: 12
Forks: 37
Open Issues: 1
Requires
- guzzlehttp/guzzle: ^6.2|^7.0
- illuminate/mail: ^7.0|^8.0|^9.0
- sendinblue/api-v3-sdk: ^7.4.4
Requires (Dev)
- phpunit/phpunit: ^8.0|^9.0
README
As of April 2023 this repo is deprecated and unmaintained.
Since Laravel 9, there is official support for Sendinblue as a regular mail transport thanks to symfony/sendinblue-mailer. It supports SiB through API and SMTP, with templates, tags, and custom headers. Because Laravel 8 has reached its end of life, the official support has now become the new default.
You can find more about how to use it inside your Laravel project in the Laravel documentation.
For any need beyond beyond that, use Sendinblue's official PHP SDK.
Feel free to fork this repository if you need to modify it for legacy reasons.
Special thanks to the wonderful contributors that kept this project standing over the years 🙏. You rock 🤘
Summary
Installation
composer require webup/laravel-sendinblue
Compatibility
Version | Laravel | Sendinblue Api |
---|---|---|
3.* | 7.0 and above | v3 |
2.* | 5.5 - 6.* | v3 |
1.1.* | 5.5 - 6.* | v2 |
1.0.* | 5.0 - 5.4 | v2 |
Configuration
config/mail.php
'mailers' => [ // ... 'sendinblue' => [ 'transport' => 'sendinblue', ], ]
config/services.php
'sendinblue' => [ // api-key or partner-key 'key_identifier' => env('SENDINBLUE_KEY_IDENTIFIER', 'api-key'), 'key' => env('SENDINBLUE_KEY'), ],
.env
MAIL_MAILER=sendinblue
SENDINBLUE_KEY=your-access-key
# if you need to set the guzzle proxy config
# those are example values
HTTP_PROXY="tcp://localhost:8125"
HTTPS_PROXY="tcp://localhost:9124"
NO_PROXY=.mit.edu,foo.com
Usage in Mailable with Template Id
Using the sendinblue()
method you may pass extra fields listed below. All fields are optional:
template_id
(integer)tags
(array)params
(array)
If you want to use the subject defined in the template, it's necessary to pass
the SendinBlueTransport::USE_TEMPLATE_SUBJECT
placeholder in the subject()
. You may as well override the subject
text here. Otherwise, without the subject()
method, the subject will be derived from the class name.
Mailable requires a view - pass an empty array in the view()
method.
<?php declare(strict_types=1); namespace App\Mail; use Illuminate\Bus\Queueable; use Illuminate\Contracts\Queue\ShouldQueue; use Illuminate\Mail\Mailable; use Illuminate\Queue\SerializesModels; use Webup\LaravelSendinBlue\SendinBlue; // <- you need this use Webup\LaravelSendinBlue\SendinBlueTransport; // <- you need this class MyMailable extends Mailable { use Queueable; use SerializesModels; use SendinBlue; // <- you need this // ... public function build() { return $this ->view([]) ->subject(SendinBlueTransport::USE_TEMPLATE_SUBJECT) // use template subject // ->subject('My own subject') // subject overridden ->sendinblue( [ 'template_id' => 84, 'tags' => ['offer'], 'params' => [ 'FIRSTNAME' => 'John', 'LINK' => 'https://www.example.com', 'AMOUNT' => '29', ], ] ); } }
Params are accessbile in the SendinBlue template as:
{{ params.FIRSTNAME }}
{{ params.LINK }}
{{ params.AMOUNT }}
You may as well use param substitution in the subject field, eg.:
{{ params.FIRSTNAME }}, forgot your password?!
Note: Do not use hyphens '-' in the variable names. {{ params.FIRST_NAME }}
will work properly, but {{ params.FIRST-NAME }}
will fail. Source: sendinblue/APIv3-php-library#151
Regarding additional features
This library aims to provide a Laravel-compatible interface for SendInBlue along with support for template ids, tags and params.
If you need features like specific SendInBlue beta SMTP Template batching, you should directly use the official SendInBlue PHP library.