README

Send Laravel mail through the Shwanix HTTP mail API (JSON POST) instead of SMTP. Works with standard Mail facades, Mailables, and queues.

Requirements: PHP ^8.0, Guzzle ^7.5, Laravel ^7.30 through ^12.0 (see below).

Laravel & PHP: Supports Laravel 7.30+ through 12.x (Composer cannot install this package on Laravel 7.0–7.29). Laravel 7 requires PHP 8 via 7.30.x for use with this package. Laravel 11+ needs PHP ^8.2 (framework requirement). Internally, Laravel 7–8 use a SwiftMailer transport (legacy/SwiftShwanixTransport.php); Laravel 9+ use Symfony Mailer (ApiTransport).

Installation

From your Laravel application root:

composer require mahrdanial/shwanix-mailer

The service provider is auto-discovered; you do not need to register it manually.

Publish the optional configuration file:

php artisan vendor:publish --tag=shwanix-mailer-config

This creates config/shwanix-mail.php (endpoint URL, API key, HTTP timeouts, SSL verification).

What MAIL_MAILER=shwanix does

Laravel’s mail stack is driven by config/mail.php. The mailer (sometimes called “driver” in docs) decides how messages are sent: smtp, log, array, etc.

Setting MAIL_MAILER=shwanix tells Laravel to use this package’s custom transport. The provider registers it with Mail::extend('shwanix', …), so the name shwanix must appear in your mailers config (see below). You can still use other mailers (smtp, log) for different messages via Mail::mailer('smtp'), etc.

Configuration

1. Environment (.env)

Required:

MAIL_MAILER=shwanix
SHWANIX_MAIL_KEY=your-plain-secret

SHWANIX_MAIL_KEY is required. Use the plain secret registered for your app (validated server-side, e.g. against a bcrypt hash). Each request sends api_key in the JSON body and X-API-Key / API-Key headers with that value.

Optional tuning (defaults are set in config/shwanix-mail.php):

SHWANIX_MAIL_TIMEOUT=30
SHWANIX_MAIL_CONNECT_TIMEOUT=10
SHWANIX_MAIL_VERIFY_SSL=true

The default API URL is defined in the published config/shwanix-mail.php file. Set SHWANIX_MAIL_URL in .env only when you need to override that value.

2. Mail config (config/mail.php)

Register the shwanix mailer under mailers:

'mailers' => [
    // ...
    'shwanix' => [
        'transport' => 'shwanix',
    ],
],

To use Shwanix for all outgoing mail by default:

'default' => env('MAIL_MAILER', 'shwanix'),

Usage

Use Laravel’s mail API as usual. Ensure SHWANIX_MAIL_KEY is set in .env so requests authenticate with the Shwanix API.

use Illuminate\Support\Facades\Mail;

Mail::raw('Hello from Shwanix.', function ($message) {
    $message->to('user@example.com')
        ->subject('Test');
});

Mail::send('emails.welcome', $data, function ($message) {
    $message->to(['a@example.com', 'b@example.com'])
        ->cc('cc@example.com')
        ->subject('Welcome');
});

Explicit mailer:

Mail::mailer('shwanix')->send(...);

Behaviour

HTTP payload

One POST with JSON body:

• Headers: Content-Type: application/json, Accept: application/json, X-API-Key, API-Key (values from SHWANIX_MAIL_KEY)
• Fields: api_key (same secret), to, cc, bcc (comma-separated emails), subject, body, attachments (filename, mime, content base64)

Implementation note (transport base class)

• Laravel 9+: MailManager uses Symfony Mailer. ApiTransport extends Symfony\Component\Mailer\Transport\AbstractTransport, like Laravel’s SES transport.
• Laravel 7–8: Mail uses SwiftMailer. A dedicated SwiftShwanixTransport extends Illuminate\Mail\Transport\Transport and is loaded only on those versions (see legacy/SwiftShwanixTransport.php).

Releasing

Tag a stable version so Composer can resolve a default release:

git tag v1.0.0
git push origin v1.0.0

Then install with:

composer require mahrdanial/shwanix-mailer

License

MIT.