aiqedge/smtp-notifications-channel

Laravel Notification Channel for the AIQEDGE-SMTP service.

dev-master 2025-07-27 14:03 UTC

Requires

• php: ^8.0
• illuminate/http: ^8.0 || ^9.0 || ^10.0 || ^11.0 || ^12.0
• illuminate/notifications: ^8.0 || ^9.0 || ^10.0 || ^11.0 || ^12.0
• illuminate/support: ^8.0 || ^9.0 || ^10.0 || ^11.0 || ^12.0

MIT

• paullaster

README

A Laravel notification channel for sending emails via the AIQEDGE SMTP API. This package lets you deliver notifications using AIQEDGE's SMTP service, making it easy to integrate external email delivery into your Laravel applications.

Features

• Send notifications through AIQEDGE SMTP API
• Simple integration with Laravel's notification system
• Error logging for failed requests

Installation

Install the package via Composer:

composer require aiqedge/smtp-notifications-channel

Configuration

Add your AIQEDGE SMTP credentials to your .env file:

AIQEDGE_SMTP_KEY=your-api-key-here
AIQEDGE_SMTP_URL=https://api.aiqedge.com/smtp

Then, add the following to your config/services.php:

'aiqedge_smtp' => [
    'key' => env('AIQEDGE_SMTP_KEY'),
    'url' => env('AIQEDGE_SMTP_URL'),
],

Usage

1. Add the Channel to Your Notification

In your notification class, add the via() method to specify the channel:

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

2. Define the toAiqedgeSmtp() Method

Add a toAiqedgeSmtp() method to your notification class. This should return an array with the email details:

public function toAiqedgeSmtp($notifiable)
{
    return [
        'to' => $notifiable->email,
        'subject' => 'Your Subject',
        'body' => 'Your message body',
        // Add other fields as required by AIQEDGE SMTP API
    ];
}

3. Send the Notification

Use Laravel's notification system as usual:

$user->notify(new YourNotification());

Request Body Reference

To see the possible request body and required fields, visit this Postman collection:

AIQEDGE SMTP Send Email Request Example (Postman)

Example

use Aiqedge\SmtpNotificationsChannel\AiqedgeSmtpChannel;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification
{
    public function via($notifiable)
    {
        return [AiqedgeSmtpChannel::class];
    }

    public function toAiqedgeSmtp($notifiable)
    {
        return [
            'to' => $notifiable->email,
            'subject' => 'Invoice Paid',
            'body' => 'Your invoice has been paid.',
        ];
    }
}

Error Handling

If the API request fails, the error will be logged using Laravel's logging system. Check your logs for details.

License

This package is open-sourced software licensed under the MIT license.