Some integration tips for Laravel app

[csoutham]

Hi, thought I'd share some code I've used to integrate MailCarrier into a recent web app.
It's my personal preference, and happy for it to be improved upon but works for me!

Add two new .env variables:

MAILCARRIER_ENDPOINT=https://domain.com/api/send
MAILCARRIER_TOKEN="yourtoken"

Add a new config array to config/mail.php > mailers section

'mailcarrier' => [
    'endpoint' => env('MAILCARRIER_ENDPOINT'),
    'token' => env('MAILCARRIER_TOKEN'),
],

Create a new Services class under app/Services

<?php

namespace App\Services;

use GuzzleHttp\Promise\PromiseInterface;
use Illuminate\Support\Facades\Http;

class MailService
{
    public function send(
        string $recipient,
        string $subject,
        string $template,
        bool $shouldQueue,
        string|null $trigger,
        array $data,
    ): PromiseInterface|Response {
        $input = json_encode([
            'recipient' => $recipient,
            'subject' => $subject,
            'template' => $template,
            'variables' => $data,
            'enqueue' => $shouldQueue,
            'trigger' => $trigger ?? 'web',
        ]);

        return Http::acceptJson()
                   ->withToken(config('mail.mailers.mailcarrier.token'))
                   ->withBody($input)
                   ->post(config('mail.mailers.mailcarrier.endpoint'));
    }
}

You can now call this code from anywhere within your application, for instance a command example:

<?php

namespace App\Console\Commands;

use App\Services\MailService;
use Illuminate\Console\Command;

class SendTestEmailCommand extends Command
{
    protected $signature = 'send:test-email';
    protected $description = 'Send test email';

    public function handle()
    {
        $mailService = resolve(MailService::class);

        $mailService->send(
            recipient: '[email protected]',
            subject: 'Test Email via MailCarrier',
            template: 'your-template-name',
            shouldQueue: false,
            trigger: null,
            data: [
                'name' => 'Your Name',
                'url' => 'https://google.com',
            ]
        );
    }
}

[danilopolani]

Hi! Thank you for the suggestion, the idea is to create SDKs for various languages and framework in the future, along with a Laravel integration.
Thank you for the feedback and happy to see you're liking MailCarrier 😄