yieldstudio/laravel-brevo-notifier

Easily send Brevo transactional email and sms with Laravel notifier.

1.0.0 2024-01-24 16:18 UTC

Requires

• php: ^8.1|^8.2
• illuminate/database: ^9|^10
• illuminate/support: ^9|^10

Requires (Dev)

• ciareis/bypass: ^1.0
• friendsofphp/php-cs-fixer: ^3.8
• orchestra/testbench: ^7.22|^8.1
• pestphp/pest: ^1.21
• phpunit/phpunit: ^9.1

MIT

• James Hemery
• David Tang

• email
• sms
• notification
• laravel
• notifier
• yieldstudio
• brevo

README

Easily send Brevo transactional email and sms with Laravel notifier.

Installation

composer require yieldstudio/laravel-brevo-notifier

Configure

Just define these environment variables:

BREVO_KEY=
MAIL_FROM_ADDRESS=
MAIL_FROM_NAME=
BREVO_SMS_SENDER=

Make sure that MAIL_FROM_ADDRESS is an authenticated email on Brevo.

BREVO_SMS_SENDER is limited to 11 for alphanumeric characters and 15 for numeric characters.

You can publish the configuration file with:

php artisan vendor:publish --provider="YieldStudio\LaravelBrevoNotifier\BrevoNotifierServiceProvider" --tag="config"

Usage

Send email

<?php

namespace App\Notifications;

use Illuminate\Notifications\Notification;
use YieldStudio\LaravelBrevoNotifier\BrevoEmailChannel;
use YieldStudio\LaravelBrevoNotifier\BrevoEmailMessage;

class OrderConfirmation extends Notification
{
    public function via(): array
    {
        return [BrevoEmailChannel::class];
    }

    public function toBrevoEmail($notifiable): BrevoEmailMessage
    {
        return (new BrevoEmailMessage())
            ->templateId(1)
            ->to($notifiable->firstname, $notifiable->email)
            ->params(['order_ref' => 'N°0000001']);
    }
}

Send sms

<?php

namespace App\Notifications;

use Illuminate\Notifications\Notification
use YieldStudio\LaravelBrevoNotifier\BrevoSmsChannel;
use YieldStudio\LaravelBrevoNotifier\BrevoSmsMessage;

class OrderConfirmation extends Notification
{
    public function via()
    {
        return [BrevoSmsChannel::class];
    }

    public function toBrevoSms($notifiable): BrevoSmsMessage
    {
        return (new BrevoSmsMessage())
            ->from('YIELD')
            ->to('[phone]')
            ->content('Your order is confirmed.');
    }
}

Unit tests

To run the tests, just run composer install and composer test.

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail [e-mail] instead of using the issue tracker.

Credits

• David Tang
• James Hemery

License

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