README

Version: 2.2.0
Author: Nazmul Hasan
License: MIT
Framework: Laravel 10 / 11
PHP: >= 8.1

🧩 Overview

A modern Laravel package for sending SMS, Email, and Push notifications seamlessly across your application.
Easily queue and localize notifications with one unified interface.

⚙️ Installation

🪄 Step 1: Install Package

composer require nht/notification

⚙️ Step 2: Enable Queues

Edit your .env file:

QUEUE_CONNECTION=database

Then create queue tables:

php artisan queue:table
php artisan queue:failed-table
php artisan migrate

⚡ Step 3: Publish Configurations

php artisan nht-notification:published

🧠 Import Class

use NH\Notification\Notifications\Notification;

You can now send SMS, Email, or Push notifications — separately or together.

📱 SMS Notifications

✉️ Option 1 — Using Notification::send()

Notification::send([
    'sms' => [
        'phone' => '+60135871622',
        // 'sms_to_users' => $users, // Optional: send to a specific user
        'message' => 'Write message here...',
    ],
]);

💬 Option 2 — Using Notification::sendSms()

Notification::sendSms([
    'phone' => '+18777804236',
    'message' => 'Write message here...',
]);

📧 Email Notifications

$users = \App\Models\User::all();

🧰 Option 1 — Template Email

To define the base view path, add to your .env file:

MAIL_TEMPLATE_PATH=emails

Notification::sendMailWithTemplate([
    'template' => ['withdrawal notification', 'Subject'], // ['view', 'subject key']
    'subject' => 'Withdrawal Request',
    'mail_to_users' => $users,
    'data' => [
        'user_name' => 'Anik Da',
        'amount' => 1000,
        'submitted_by' => 'Lukmanul Hakim Hasibuan',
        'status' => 'Pending',
        'transaction_view_on' => route('customer.product'),
    ],
]);

📩 Option 2 — Registration Notification

Notification::send([
    'mail-template' => [
        'template' => ['registration', 'Subject'],
        'subject' => 'Welcome to ALJ Harmony',
        'mail_to' => 'email@email.com', // or ['email1', 'email2']
        'mail_to_users' => $users,
        'data' => (object)[
            'user_name' => 'Anik Da',
            'role' => 'Agency Admin',
            'agency_name' => 'ALJ Harmony',
            'email' => 'example@email.com',
            'login_on' => route('customer.product'),
        ],
    ]
]);

🛠️ Option 3 — Custom Email View

Notification::send([
    'mail' => [
        'mail_to' => 'email@email.com',
        'mail_to_users' => $users,
        'subject' => 'Email Subject',
        'view' => 'applications.agents.emails.withdrawal-notification',
        'data' => (object)[
            'user_name' => 'Anik Da',
            'amount' => 1000,
            'submitted_by' => 'Lukmanul Hakim Hasibuan',
            'status' => 'Pending',
            'transaction_view_on' => route('customer.product'),
        ],
    ]
]);

✨ Option 4 — Using sendMail() Helper

Notification::sendMail([
    'mail_to' => 'email@email.com',
    'mail_to_users' => $users,
    'subject' => 'Withdrawal Notification',
    'view' => 'applications.agents.emails.withdrawal-notification',
    'data' => (object)[
        'user_name' => 'Anik Da',
        'amount' => 1000,
        'submitted_by' => 'Lukmanul Hakim Hasibuan',
        'status' => 'Pending',
        'transaction_view_on' => route('customer.product'),
    ],
]);

🔔 Push Notifications

🗄️ Step 1: Setup Database

php artisan notifications:table
php artisan migrate

🚀 Option 1 — Using Notification::send()

Notification::send([
    'push' => [
        'sent_to_users' => $users,
        'data' => [
            'booking_id' => 1,
            'message' => 'Your booking has been confirmed.',
        ],
    ]
]);

🚀 Option 2 — Using Notification::sendPush()

Notification::sendPush([
    'sent_to_users' => $users,
    'data' => [
        'booking_id' => 1,
        'message' => 'Your booking has been confirmed.',
    ],
]);

Push Notification Drawer

1. Overview

The Push Notification Drawer is a slide-in panel that shows all recent notifications for the logged-in user.

• Opens from the right side of the screen.
• Can be toggled from the notification bell icon in the top bar.
• Shows unread and read notifications, grouped by time.
• Supports click actions (e.g., open related page, mark as read, etc.).

2. Demo Page URL

You can view the demo page here:

👉 URL: https://your-domain.com/nht-notifications
(Replace this with your actual domain name)

Example placeholder:

Header menu bell icon

Sidebar notification drawer

2.1 Closed State (Bell Icon with Badge)

Top Navigation Bar
┌─────────────────────────────────────────────────────────┐
│  Logo         ...                         🔔 (3)       │
└─────────────────────────────────────────────────────────┘

🌍 Localization Support

Enable localized messages in .env:

MAIL_SUBJECT_LOCALIZE=true

Create translation files:

resources/lang/en/notification.php
resources/lang/en/account_registration.php

Example:

Notification::send([
    'mail-template' => [
        'template' => ['registration', 'Subject'],
        ...
    ]
]);

return [
    'registration' => 'Hello :cun, your account at :agn is ready. Login here: :url',
];

📨 Retrieve Notifications

Notification::get();

📡 API Reference

The package provides a JSON API for retrieving and managing notifications. These routes are protected by the auth:sanctum middleware and use the prefix /api/v1 (configurable in notification.php).

1. Notifications List

Retrieve a list of notifications for the authenticated user.

• Endpoint: GET /api/v1/notifications/{date?}
• URL Parameters:
  • date (optional): Filter notifications by a specific date (e.g., 2025-05-01).
• Query Parameters:
  • guard (optional): Specify an authentication guard.
• Response:

{
  "result": 1,
  "response": "Notifications list.",
  "notifications": {
    "all": [...],
    "unread": [...]
  }
}

2. Notification Statistics

Get counts and periodic statistics for notifications.

• Endpoint: GET /api/v1/notification-statistics
• Query Parameters:
  • guard (optional): Specify an authentication guard.
• Response:

{
  "result": 1,
  "response": "Notifications statistics.",
  "data": {
    "total_notifications": 45,
    "unread_notifications": 12,
    "read_notifications": 33,
    "notifications_today": 5,
    "notifications_this_week": 20,
    "notifications_this_month": 45
  }
}

3. Mark as Read

Mark a single notification or all notifications as read.

• Endpoint: PUT /api/v1/notification/read/{item}
• URL Parameters:
  • item: The UUID of the notification or all to mark all as read.
• Query Parameters:
  • guard (optional): Specify an authentication guard.
• Response:

{
  "result": 1,
  "response": 1,
  "unread": 11
}

4. Delete Notification

Delete a single notification or the last batch of notifications.

• Endpoint: DELETE /api/v1/notification/delete/{item}
• URL Parameters:
  • item: The UUID of the notification or all to delete the latest notifications.
• Query Parameters:
  • guard (optional): Specify an authentication guard.
• Response:

{
  "result": 1,
  "response": 1,
  "unread": 11
}

🧹 Uninstall Package

To completely remove:

php artisan nht-notification:remove
// or
php artisan nht-notification:remove --force

and then

composer remove nht/notification

💡 Tips & Notes

• Ensure queue worker is running:

  php artisan queue:work

• mail_to_users accepts any User model collection.
• phone must follow E.164 international format (+60, +88, etc.).
• You can combine SMS + Email + Push in a single call.
• Works perfectly with queued notifications.

🧬 Example: Combined Notification

Notification::send([
    'sms' => [
        'phone' => '+60135871622',
        'message' => 'Account activated successfully.',
    ],
    'mail' => [
        'mail_to' => 'email@email.com',
        'subject' => 'Account Activated',
        'view' => 'emails.account-activated',
        'data' => (object)['user_name' => 'Lukmanul Hakim'],
    ],
    'push' => [
        'sent_to_users' => $users,
        'data' => [
            'title' => 'Welcome!',
            'message' => 'Your account is ready to use.',
        ],
    ],
]);

🛠️ Troubleshooting

🧭 License

Released under the MIT License.
© 2025 Nazmul Hasan

🧡 Built with passion for modern Laravel development.