Download the PHP package schoolpalm/message-delivery without Composer

SchoolPalm Message Delivery

A Laravel package for multi-channel message delivery supporting Email, SMS, WhatsApp, Push Notifications, and In-App Notifications — with a Notification Engine that orchestrates the entire flow through resolver interfaces.

Table of Contents

• SchoolPalm Message Delivery
  • Table of Contents
  • Architecture
  • Installation
  • Aliases
  • Configuration
  • Configuration Reference
  • Message Delivery
  • Single Channel
  • Multi-Channel
  • Context Propagation
  • Queue Options
  • Notification Engine
  • Overview
  • Resolvers
  • Engine Flow
  • Fluent API
  • Extending Resolvers
  • Channels
  • Providers
  • SMS Providers
  • WhatsApp Providers
  • Push Providers
  • Email Providers
  • In-App Provider
• Provider Definitions
  • Provider Configuration Fields
  • Provider Registry
  • Delivery Tracking
  • Events
  • Testing
  • Running Tests
  • Writing Tests
  • Publishing
  • Config
  • Migrations
  • License

Architecture

Key principle: The package is an infrastructure package only. It knows nothing about your business models (Student, Parent, Teacher, etc.). All business-specific logic is supplied by your application through resolver interfaces.

Installation

The service provider is auto-discovered. If you disable auto-discovery, add it manually:

Aliases

The package registers two facades:

Configuration

Publish the configuration:

Configuration Reference

Message Delivery

Single Channel

Each channel has a dedicated builder method accessible via the MessageDelivery facade.

SMS:

Email:

Email with view:

Push Notification:

In-App Notification:

WhatsApp:

Multi-Channel

Send the same message through multiple channels:

Or chain with context:

Context Propagation

Attach execution context that flows through the entire delivery:

Queue Options

Send messages through the queue:

Notification Engine

Overview

The Notification Engine is an orchestrator that sits between your business modules and the Message Delivery layer. Instead of calling MessageDelivery::sms()->to(...)->send() directly, you dispatch a notification event and the engine resolves everything.

Resolvers

The engine uses resolver interfaces to determine how to deliver the notification. All resolvers have Null implementations so the package works out of the box. Your application replaces these bindings with custom implementations.

Engine Flow

Fluent API

The NotificationDispatch builder provides a fluent chainable API:

Extending Resolvers

To replace a resolver, bind your implementation in the service container:

The engine will automatically use your implementation.

Channels

The package registers five channels out of the box:

Providers

SMS Providers

EgoSMS (egosms):

Twilio SMS (twilio-sms):

Africa's Talking (africas-talking):

WhatsApp Providers

Meta WhatsApp (meta-whatsapp):

Twilio WhatsApp (twilio-whatsapp):

Push Providers

Firebase Cloud Messaging (firebase):

Email Providers

Laravel Mail (laravel-mail):

The Laravel Mail provider supports any mailer configured in config/mail.php (SES, Mailgun, Postmark, SMTP, Log, etc.).

In-App Provider

Database Notifications (database-notifications):

Recipients can be specified as:

• Associative array with notifiable_type and notifiable_id keys
• Simple string ID (uses configured default notifiable model)

Provider Definitions

Provider definitions expose configuration fields for admin UIs:

Provider Configuration Fields

The package exposes the configuration schema for every provider so your application can initialize provider settings in its own storage (e.g. a tenant settings scope). The package does not persist anything — it only returns the fields; you decide where and how to save them.

Each field is a plain array with the canonical keys:

Available APIs

All are accessible via the MessageDelivery facade:

Initializing Settings (e.g. a Settings Scope)

A common pattern is to seed a tenant's settings when a provider is enabled:

To separate credentials from non-sensitive options, use providerScopedSettings():

You can store $scoped['secrets'] in an encrypted store and $scoped['secured'] in a normal settings table.

Registered Providers

Provider Registry

The provider registry manages the lifecycle of provider factories:

Delivery Tracking

When enabled, the package records delivery lifecycle events:

Each delivery goes through statuses:

• queued → processing → sent → delivered / failed

Data is stored in the message_deliveries table and operational logs are written via AppLogger.

Events

Testing

Running Tests

This runs all 225+ tests (712+ assertions) covering:

• Each channel and provider
• Delivery tracking lifecycle
• Provider resolution and configuration
• Failure handling and timeouts
• Metadata handling
• Multi-channel message building
• Notification Engine dispatch
• Resolver resolution and replacement
• Default (Null) resolver behavior
• Queue options
• Context propagation

Writing Tests

Publishing

Config

Migrations

License

MIT License. See LICENSE for more information.