yna/laravel-port-to-sms

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Port2SMS Notifications channel for Laravel 5.3.

v1.0.0 2017-09-16 14:47 UTC

This package is not auto-updated.

Last update: 2021-11-16 05:56:31 UTC


README

This package makes it easy to send notifications using Port2SMs with Laravel 5.3+.

Installation

You can install the package via composer:

composer require yna/laravel-port-to-sms

Then you must install the service provider:

// config/app.php
'providers' => [
    ...
    Yna\PortToSms\PortToSmsServiceProvider::class,
],

Setting up the PortToSms service

Add your PortToSms account, user, password and default sender name (or phone number) to your config/services.php:

// config/services.php
...
'port2sms' => [
    'account' => env('PORT2SMS_ACCOUNT'),
    'user' => env('PORT2SMS_USER'),
    'password' => env('PORT2SMS_PASSWORD'),
    'sender' => env('PORT2SMS_SENDER')
],
...

Usage

You can use the channel in your via() method inside the notification:

use Illuminate\Notifications\Notification;
use Yna\PortToSms\PortToSmsMessage;
use Yna\PortToSms\PortToSmsChannel;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return [PortToSmsChannel::class];
    }

    public function toPortToSms($notifiable)
    {
        return PortToSmsMessage::create("Task #{$notifiable->id} is complete!");
    }
}

In your notifiable model, make sure to include a routeNotificationForPort2sms() method, which return the phone number.

public function routeNotificationForPort2sms()
{
    return $this->phone;
}

Available methods

from(): Sets the sender's name or phone number.

content(): Set a content of the notification message.

sendAt(): Set a time for scheduling the notification message.

Security

If you discover any security related issues, please email security@yna.co.il instead of using the issue tracker.

License

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