laravel-notification-channels/messagebird

MessageBird notification channel for Laravel 5.3

Messagebird notifications channel for Laravel

, _(*1)

This package makes it easy to send Messagebird SMS notifications with Laravel., _(*2)

Contents

• Requirements
• Installation
• Setting up your Messagebird account
• Usage
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Requirements

• Sign up for a free MessageBird account
• Create a new access_key in the developers sections

Installation

You can install the package via composer:, _(*3)

``` bash composer require laravel-notification-channels/messagebird, <sub>(*4)</sub>

for Laravel 5.4 or lower, you must add the service provider to your config:

```php
// config/app.php
'providers' => [
    ...
    NotificationChannels\Messagebird\MessagebirdServiceProvider::class,
],

Setting up your Messagebird account

Add the environment variables to your config/services.php:, <sub>(*5)</sub>

// config/services.php
...
'messagebird' => [
    'access_key' => env('MESSAGEBIRD_ACCESS_KEY'),
    'originator' => env('MESSAGEBIRD_ORIGINATOR'),
    'recipients' => env('MESSAGEBIRD_RECIPIENTS'),
],
...

Add your Messagebird Access Key, Default originator (name or number of sender), and default recipients to your .env:, <sub>(*6)</sub>

// .env
...
MESSAGEBIRD_ACCESS_KEY=
MESSAGEBIRD_ORIGINATOR=
MESSAGEBIRD_RECIPIENTS=
],
...

Notice: The originator can contain a maximum of 11 alfa-numeric characters., <sub>(*7)</sub>

Usage

Now you can use the channel in your via() method inside the notification:, <sub>(*8)</sub>

``` php use NotificationChannels\Messagebird\MessagebirdChannel; use NotificationChannels\Messagebird\MessagebirdMessage; use Illuminate\Notifications\Notification;, <sub>(*9)</sub>

class VpsServerOrdered extends Notification { public function via($notifiable) { return [MessagebirdChannel::class]; }, <sub>(*10)</sub>

public function toMessagebird($notifiable)
{
    return (new MessagebirdMessage("Your {$notifiable->service} was ordered!"));
}

}, <sub>(*11)</sub>

Additionally you can add recipients (single value or array)

``` php
return (new MessagebirdMessage("Your {$notifiable->service} was ordered!"))->setRecipients($recipients);

In order to handle a status report you can also set a reference, <sub>(*12)</sub>

``` php return (new MessagebirdMessage("Your {$notifiable->service} was ordered!"))->setReference($id);, <sub>(*13)</sub>

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash
$ composer test

Security

If you discover any security related issues, please email psteenbergen@gmail.com instead of using the issue tracker., <sub>(*14)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*15)</sub>

Credits

• Peter Steenbergen
• Tonko Mulder
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*16)</sub>