README

Official Laravel SDK for MailCraft — open source transactional email with AI-generated content.

Installation

composer require mailcraft/mailcraft-laravel

Laravel auto-discovers the service provider and facade.

Configuration

Publish the config file:

php artisan vendor:publish --tag=mailcraft-config

Add your API key to .env:

MAILCRAFT_API_KEY=mc_your_api_key_here

If self-hosting:

MAILCRAFT_BASE_URL=https://your-mailcraft-instance.com

Usage

Fluent API (recommended)

use MailCraft\Facades\MailCraft;

MailCraft::create('welcome')
    ->to('john@example.com')
    ->data(['name' => 'John', 'plan' => 'Pro'])
    ->prompt('Mention dedicated support')
    ->action('Get Started', 'https://app.example.com')
    ->action('View Docs', 'https://docs.example.com', 'secondary')
    ->send();

Classic API

$result = MailCraft::send([
    'type'    => 'welcome',
    'to'      => 'john@example.com',
    'data'    => ['name' => 'John', 'plan' => 'Pro'],
    'prompt'  => 'Mention dedicated support',
    'actions' => [
        ['label' => 'Get Started', 'url' => 'https://app.example.com'],
    ],
]);

With Dependency Injection

use MailCraft\MailCraftClient;

class WelcomeController extends Controller
{
    public function __construct(private MailCraftClient $mail) {}

    public function send(): void
    {
        $this->mail->create('welcome')
            ->to('john@example.com')
            ->data(['name' => 'John'])
            ->send();
    }
}

Without Laravel (standalone)

use MailCraft\MailCraftClient;

$client = new MailCraftClient('mc_your_api_key');

$client->create('welcome')
    ->to('john@example.com')
    ->data(['name' => 'John'])
    ->send();

Fluent Builder Methods

Options (Classic API)

Response

['id' => 'log_abc123', 'status' => 'sent']
// status: "sent" | "failed" | "fallback"

Error Handling

use MailCraft\Facades\MailCraft;
use MailCraft\MailCraftException;

try {
    MailCraft::create('welcome')
        ->to('john@example.com')
        ->send();
} catch (MailCraftException $e) {
    $e->getStatusCode(); // 401, 400, 502, etc.
    $e->getMessage();    // "Invalid API key"
    $e->getBody();       // Parsed response body
}

Self-Hosted

MAILCRAFT_BASE_URL=https://mail.internal.example.com

Or pass directly:

$client = new MailCraftClient('mc_your_key', 'https://mail.internal.example.com');

License

MIT