README

A notification channel for Daily Bin by Chris Arter.

Prerequisites

An account on Daily Bin
A token with at least the following scopes:
- ingest:write

Installation

Install using Composer:

composer require rvxlab/laravel-notification-channel-dailybin

Add this to your config/services.php:

'dailybin' => [
    'token' => env('DAILYBIN_TOKEN'),
],

Set your DAILYBIN_TOKEN in your .env file:

DAILYBIN_TOKEN=YOUR TOKEN GOES HERE

Setting Up Your Notification

Add the Daily Bin channel to your notification and set up a toDailyBin method:

class SomeNotification extends Notification
{
    public function via($notifiable)
    {
        return [DailyBinChannel::class]; // or ['dailyBin']
    }
    
    public function toDailyBin($notifiable)
    {
        return (new DailyBinMessage())
            ->section('content')
            ->content('# Hello, world!')
            ->source('My App'); // Optional
    }
}

Then either make use of anonymous notification or register a notification route:

use Illuminate\Support\Facades\Notification;

Notification::route('dailyBin', 'whatever you like')
    ->notify(new SomeNotification());

// OR

use Illuminate\Database\Eloquent\Model;
use Illuminate\Notifications\Notifiable;

class User extends Model
{
    public function routeNotificationForDailyBin(): string
    {
        return 'whatever you like'; // or false if you don't want to send notifications
    }
}

$user = User::firstOrFail();
$user->notify(new SomeNotification());

Contributing

Contributions are very welcome. Please read CONTRIBUTING.md for guidelines.

License

This package is licensed under the MIT License.

rvxlab / laravel-notification-channel-dailybin

Maintainers

Details