README

A Laravel package for managing notifications through Telegram, WhatsApp, and Email. This package provides a unified interface for sending notifications via popular messaging platforms, enabling seamless integration and communication within your Laravel application. It supports rich features like templated messages, queued sending, and customizable settings for each notification channel.

Installation

To install the package, follow these steps:

Install via Composer:

composer require gl-package/notification-manager

Run the migrations:
```
php artisan migrate
```
🔔 Note: Ensure to configure your database connection properly before running migrations.
Configure your notification settings in the /notification-manager/config URL.

Publish the configuration files (optional, only if you need to customize the configuration page):

php artisan vendor:publish --provider="GlPackage\NotificationManager\Providers\NotificationManagerServiceProvider" --tag=notificationmanager-views
php artisan vendor:publish --provider="GlPackage\NotificationManager\Providers\NotificationManagerServiceProvider" --tag=notificationmanager-controllers
php artisan vendor:publish --provider="GlPackage\NotificationManager\Providers\NotificationManagerServiceProvider" --tag=notificationmanager-routes

Configure the queue (For Laravel versions prior to 11.0):

🔔 Note: To enable queuing for sending queue messages in Laravel 10 and 11, ensure that your queue driver is configured in config/queue.php and run php artisan queue:table to create the necessary database tables. Then, run php artisan migrate to apply the migrations and php artisan queue:work to start processing queued jobs.
```
php artisan queue:table
php artisan migrate
php artisan queue:work
```

Usage

You can use the notification classes in your Laravel application as follows:

Telegram Notification

🔔 Note: Ensure that the cURL extension is installed and enabled in your PHP environment. On Windows, uncomment extension=curl in your php.ini. On Ubuntu, install it with sudo apt-get install php-curl and restart your web server.

use GlPackage\NotificationManager\Notifications\TelegramNotification;

$data = [
    'message' => "<b>Hello World!</b> Click the button below:",
    'buttons' => [
        [
            ['text' => 'Click Me', 'url' => 'https://example.com'] // Optional , else pass [] array
        ]
    ]
];

$telegram = new TelegramNotification();
$telegram->quickSend($data); // For quick send
// or
$telegram->queueSend($data); // For queued send

Email Notification

use GlPackage\NotificationManager\Notifications\EmailNotification;
use Faker\Factory as Faker;

$data = [
    'to_address' => Faker::create()->email,
    'subject' => 'Welcome to Our Service',
    'body' => 'Thank you for signing up! Here are some details about your account.',
    'view' => 'notificationmanager.testmail', // Optional view page location
    'attachments' => [], // Optional attachments array
    'name' => 'Hello, Ajay' // Optional parameters
];

$mail = new EmailNotification();
$mail->send($data); // Send mail via queue
// Ensure to run: php artisan queue:work or use Supervisor

Whatsapp Notification

use GlPackage\NotificationManager\Notifications\WhatsAppNotification;

$data = [
    'mobile' => '91908*******',
    'template' => 'hello_world', // Sample template
    'parameters' => [ // Optional
        [
            "type" => "text",
            "text" => "Test"
        ],
        [
            "type" => "text",
            "text" => "1200"
        ]
    ],
    'buttons' => [ // Optional
        [
            "type" => "text",
            "text" => "16"
        ]
    ]
];

$whatsapp = new WhatsAppNotification();
$whatsapp->send($data); // Send WhatsApp message via queue

// Ensure to run: php artisan queue:work or use Supervisor

gl-package / notification-manager

Maintainers

Details