PHPackages                             mirvan/ippanel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. mirvan/ippanel

ActiveLibrary[Mail & Notifications](/categories/mail)

mirvan/ippanel
==============

laravel notification channel for ippanel

v2.1(1y ago)016[1 issues](https://github.com/MirvanGh/ippanel/issues)MITPHPPHP >=7.2CI failing

Since Sep 14Pushed 1y ago1 watchersCompare

[ Source](https://github.com/MirvanGh/ippanel)[ Packagist](https://packagist.org/packages/mirvan/ippanel)[ Docs](https://github.com/mirvangh/ippanel)[ RSS](/packages/mirvan-ippanel/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (5)Versions (4)Used By (0)

IPPanel Laravel Notification Channel
====================================

[](#ippanel-laravel-notification-channel)

[![Packagist Downloads](https://camo.githubusercontent.com/6a01d85d242f49c03e335c172f6ce3529677c5e745e095d1186dd4ab693601eb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d697276616e2f697070616e656c3f7374796c653d666f722d7468652d6261646765)](https://packagist.org/packages/mirvan/ippanel)[![Packagist Version](https://camo.githubusercontent.com/b5b0c3b973689d8309ec884ea8305c9485fbfe2dab0a0513608df27962a0901c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d697276616e2f697070616e656c3f7374796c653d666f722d7468652d6261646765)](https://packagist.org/packages/mirvan/ippanel)[![Software License](https://camo.githubusercontent.com/9897f4467850972a38c7db9a4d38280b8fcdac0ada00e9c8c0a72ecfa8551653/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666f722d7468652d6261646765)](LICENSE.md)

### [راهنمای فارسی](README.fa.md)

[](#راهنمای-فارسی)

Contents
--------

[](#contents)

- [Installation](#installation)
    - [Setting up the IPPanel service](#setting-up-the-ippanel-service)
- [Usage](#usage)
    - [Available Message methods](#available-message-methods)
- [Changelog](#changelog)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)

Installation
------------

[](#installation)

This package is laravel adapter for Official package [ippanel/php-rest-sdk](https://packagist.org/packages/ippanel/php-rest-sdk)

You can install the package via composer:

```
$ composer require mirvan/ippanel
```

### Setting up the IPPanel service

[](#setting-up-the-ippanel-service)

You need to set your api key in `config/services.php`

```
"ippanel"   => [
    'api_key'  =>  'API_KEY_SECRET',
],
```

Usage
-----

[](#usage)

### Official IPPanel PHP Client

[](#official-ippanel-php-client)

You can access Official IPPanel PHP Client directly like

```
use Mirvan\IPPanel\IPPanel;

$client = new IPPanel();

# return float64 type credit amount
$credit = $client->getCredit();

$bulkID = $client->send(
    "+9810001",          // originator
    ["98912xxxxxxx"],    // recipients
    "ippanel is awesome" // message
);
```

or use class facade

```
# return float64 type credit amount
$credit = \IPPanel::getCredit();

$bulkID = \IPPanel::send(
    "+9810001",          // originator
    ["98912xxxxxxx"],    // recipients
    "ippanel is awesome" // message
);
```

[See Full Document](https://github.com/ippanel/php-rest-sdk/blob/master/README.md)

### Notification Channel

[](#notification-channel)

You can set Reference in your model

```
public function routeNotificationForIPPanel()
{
    return '09121234567';
}
```

You can set Originator in your model

```
public function ippanelOriginator()
{
    return '+983000505';
}
```

Set channel in notification class

```
use Mirvan\IPPanel\IPPanelChannel;

public function via($notifiable)
{
    return [IPPanelChannel::class];
}
```

For send normal message

```
use Mirvan\IPPanel\IPPanelMessage;

 public function toIPPanel($notifiable)
{
    return (new IPPanelMessage)
        ->reference('09121231212')
        ->originator('+983000505')
        ->body('message');
}
```

For pattern message

```
use Mirvan\IPPanel\IPPanelMessage;

 public function toIPPanel($notifiable)
{
    return (new IPPanelMessage)
        ->reference('09121231212')
        ->originator('+983000505')
        ->pattern('pattern_code')
        ->variable('variable-name','1234');
}
```

Remember: `reference()` and `originator()` is overwrite `routeNotificationForIPPanel()` and `ippanelOriginator()`

```
return (new IPPanelMessage)
    ->originator('+983000505')
    ->reference('09121231212')
    ->body('message');
```

### Available Notification Message methods

[](#available-notification-message-methods)

- `originator('')`: Accepts a string value between 1 and 11 characters, used as the message sender name. This will overwrite `ippanelOriginator()`
- `reference('')`: Accepts a string value for your message reference. This information will be returned in a status report so you can match the message and it's status. Restrictions: 1 - 32 alphanumeric characters. This will overwrite `routeNotificationForIPPanel()`

Available options for **Normal Message**

- `body('')`: Accepts a string value for the message body.

Available options for **Pattern Message**

- `pattern('')`: Accepts a string value for the pattern code.
- `variable('name','value')`: Accepts an string for variable name and another string for variable value
- `variables([])`: Accepts an array for variables

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

Security
--------

[](#security)

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

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Credits
-------

[](#credits)

- [MirVan](https://github.com/MirvanGh)
- [MVHost](https://sms.mvhost.ir)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance46

Moderate activity, may be stable

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~645 days

Total

3

Last Release

411d ago

Major Versions

v1.0.1 → v2.02023-11-14

### Community

Maintainers

![](https://www.gravatar.com/avatar/40b7083627766d9b1d2657c43711a4601729153dfacf90679ea0fee20e893f74?d=identicon)[mirvan](/maintainers/mirvan)

---

Top Contributors

[![MirvanGh](https://avatars.githubusercontent.com/u/10960287?v=4)](https://github.com/MirvanGh "MirvanGh (8 commits)")

---

Tags

laravellaravel-notification-channelIPPanel

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/mirvan-ippanel/health.svg)

```
[![Health](https://phpackages.com/badges/mirvan-ippanel/health.svg)](https://phpackages.com/packages/mirvan-ippanel)
```

###  Alternatives

[laravel-notification-channels/telegram

Telegram Notifications Channel for Laravel

1.1k3.4M35](/packages/laravel-notification-channels-telegram)[s-ichikawa/laravel-sendgrid-driver

This library adds a 'sendgrid' mail driver to Laravel.

4139.3M1](/packages/s-ichikawa-laravel-sendgrid-driver)[laravel-notification-channels/twilio

Provides Twilio notification channel for Laravel

2587.7M12](/packages/laravel-notification-channels-twilio)[laravel-notification-channels/discord

Laravel notification driver for Discord.

2371.3M11](/packages/laravel-notification-channels-discord)[tzsk/sms

A robust and unified SMS gateway integration package for Laravel, supporting multiple providers.

320244.3k6](/packages/tzsk-sms)[erag/laravel-disposable-email

A Laravel package to detect and block disposable email addresses.

226102.4k](/packages/erag-laravel-disposable-email)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)