README

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

Installation
- Setting up the Corvass service
Usage
- Available methods
- Available events
Changelog
Testing
Security
Contributing
Credits
License

Installation

You can install this package via composer:

composer require bahricanli/corvass

Next add the service provider to your config/app.php:

/*
 * Package Service Providers...
 */

NotificationChannels\Corvass\CorvassServiceProvider::class,

Register the Corvass alias to your application. This registration is not optional because the channel itself uses this very alias.

'Corvass' => NotificationChannels\Corvass\Corvass::class,

Setting up the Corvass service

Add your desired client, username, password, originator (outbox name, sender name) and request timeout configuration to your config/services.php file:

...
    'Corvass' => [
        'client'     => 'http', // or xml
        'http'       => [
            'endpoint' => 'https://service.jetsms.com.tr/SMS-Web/HttpSmsSend',
        ],
        'xml'        => [
            'endpoint' => 'www.biotekno.biz:8080/SMS-Web/xmlsms',
        ],
        'username'   => '',
        'password'   => '',
        'originator' => "", // Sender name.
        'timeout'    => 60,
    ],
...

Usage

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

use NotificationChannels\Corvass\CorvassChannel;
use NotificationChannels\Corvass\CorvassMessage;

class ResetPasswordWasRequested extends Notification
{
    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [CorvassChannel::class];
    }
    
    /**
     * Get the Corvass representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return string|\NotificationChannels\Corvass\CorvassMessage
     */
    public function toCorvass($notifiable) {
        return "Test notification";
        // Or
        return new ShortMessage($notifiable->phone_number, 'Test notification');
    }
}

Don't forget to place the dedicated method for Corvass inside your notifiables. (e.g. User)

class User extends Authenticatable
{
    use Notifiable;
    
    public function routeNotificationForCorvass()
    {
        return "905123456789";
    }
}

Available methods

Corvass can also be used directly to send short messages.

Examples:

Corvass::sendShortMessage($to, $message);
Corvass::sendShortMessages([[
    'recipient' => $to,
    'message'   => $message,
], [
    'recipient' => $anotherTo,
    'message'   => $anotherMessage,
]]);

see: corvass-php documentation for more information.

Available events

Corvass Notification channel comes with handy events which provides the required information about the SMS messages.

Message Was Sent (NotificationChannels\Corvass\Events\MessageWasSent)
Messages Were Sent (NotificationChannels\Corvass\Events\MessageWasSent)
Sending Message (NotificationChannels\Corvass\Events\SendingMessage)
Sending Messages (NotificationChannels\Corvass\Events\SendingMessages)

Example:

namespace App\Listeners;

use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use NotificationChannels\Corvass\Events\MessageWasSent;

class SentMessageHandler
{
    /**
     * Handle the event.
     *
     * @param  MessageWasSent  $event
     * @return void
     */
    public function handle(MessageWasSent $event)
    {
        $response = $event->response;
        $message = $event->message;
    }
}

Notes

$response->groupId() will throw BadMethodCallException if the client is set to 'http'. $response->messageReportIdentifiers() will throw BadMethodCallException if the client is set to 'xml'.

change client configuration with caution.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email bahri@bahri.info instead of using the issue tracker.

bahricanli / corvass

Maintainers

Details