Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agence-webup/laravel-sendinblue
DEPRECATED: Laravel's mail transport for SendinBlue
https://github.com/agence-webup/laravel-sendinblue
Last synced: about 2 months ago
JSON representation
DEPRECATED: Laravel's mail transport for SendinBlue
- Host: GitHub
- URL: https://github.com/agence-webup/laravel-sendinblue
- Owner: agence-webup
- License: mit
- Archived: true
- Created: 2016-04-15T16:29:40.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-05T14:00:19.000Z (over 1 year ago)
- Last Synced: 2024-09-18T16:52:11.139Z (about 2 months ago)
- Language: PHP
- Homepage:
- Size: 59.6 KB
- Stars: 119
- Watchers: 12
- Forks: 36
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECATED
[](http://unmaintained.tech/)
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](https://github.com/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](https://laravel.com/docs/10.x/releases#support-policy), 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](https://laravel.com/docs/9.x/mail#additional-symfony-transports).
For any need beyond beyond that, use Sendinblue's official [PHP SDK](https://github.com/sendinblue/APIv3-php-library).
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
- [laravel-sendinblue](#laravel-sendinblue)
- [Summary](#summary)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage with Sendinblue templates](#usage-in-mailable-with-template-id)
- [Regarding additional features](#regarding-additional-features)
## Installation
```shell
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`
```php
'mailers' => [
// ...
'sendinblue' => [
'transport' => 'sendinblue',
],
]
```
> `config/services.php`
```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
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: https://github.com/sendinblue/APIv3-php-library/issues/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.