yna / laravel-port-to-sms
Port2SMS Notifications channel for Laravel 5.3.
Requires
- php: >=5.6.4
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
- illuminate/notifications: 5.1.*|5.2.*|5.3.*|5.4.*|5.5.*
- illuminate/queue: 5.1.*|5.2.*|5.3.*|5.4.*|5.5.*
- illuminate/support: 5.1.*|5.2.*|5.3.*|5.4.*|5.5.*
Requires (Dev)
- mockery/mockery: ^0.9.5
- phpunit/phpunit: ^5.2
This package is not auto-updated.
Last update: 2024-04-16 17:07:13 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.