README

Official Laravel integration for SendKit. Adds a sendkit mail transport and webhook handling.

Installation

composer require sendkit/sendkit-laravel

Configuration

Add your API key to .env:

MAIL_MAILER=sendkit
SENDKIT_API_KEY=your-api-key

Optionally publish the config file:

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

Usage

Sending Emails

Use Laravel's standard mail system — it just works:

Mail::to('recipient@example.com')->send(new WelcomeEmail());

Using the SDK Directly

use SendKit\Laravel\Facades\SendKit;

$response = SendKit::emails()->send([
    'from' => 'you@example.com',
    'to' => 'recipient@example.com',
    'subject' => 'Hello',
    'html' => '<h1>Welcome!</h1>',
]);

Contacts

use SendKit\Laravel\Facades\SendKit;

// Create or update a contact (upsert by email)
$contact = SendKit::contacts()->create([
    'email' => 'john@example.com',
    'first_name' => 'John',
    'last_name' => 'Doe',
    'list_ids' => ['list-uuid-1'],
    'properties' => ['COMPANY' => 'Acme'],
]);

// List contacts (paginated)
$contacts = SendKit::contacts()->list();
$contacts = SendKit::contacts()->list(['page' => 2]);

// Get a single contact
$contact = SendKit::contacts()->get('contact-uuid');

// Update a contact
$contact = SendKit::contacts()->update('contact-uuid', [
    'first_name' => 'Johnny',
]);

// Delete a contact
SendKit::contacts()->delete('contact-uuid');

// Add a contact to lists
SendKit::contacts()->addToLists('contact-uuid', ['list-uuid-1', 'list-uuid-2']);

// List a contact's lists
$lists = SendKit::contacts()->listLists('contact-uuid');

// Remove a contact from a list
SendKit::contacts()->removeFromList('contact-uuid', 'list-uuid');

Contact Properties

use SendKit\Laravel\Facades\SendKit;

// Create a property ("string", "number", or "date")
$property = SendKit::contactProperties()->create([
    'key' => 'company',
    'type' => 'string',
    'fallback_value' => 'N/A',
]);

// List all properties
$properties = SendKit::contactProperties()->list();

// Update a property
SendKit::contactProperties()->update('property-uuid', [
    'key' => 'organization',
]);

// Delete a property
SendKit::contactProperties()->delete('property-uuid');

Validating an Email

use SendKit\Laravel\Facades\SendKit;

$result = SendKit::validateEmail('recipient@example.com');

$result['is_valid'];       // "HIGH" or "LOW"
$result['should_block'];   // true if the email should be blocked
$result['block_reason'];   // reason for blocking, or null
$result['evaluations'];    // detailed evaluation results

The evaluations array contains:

has_valid_syntax — whether the email has valid syntax
has_valid_dns — whether the domain has valid DNS records
mailbox_exists — whether the mailbox exists
is_role_address — whether it's a role address (e.g. info@, admin@)
is_disposable — whether it's a disposable email
is_random_input — whether it appears to be random input

Note: Each validation costs credits. A SendKitException with status 402 is thrown when credits are insufficient.

Webhooks

Webhook handling is auto-registered at POST /webhook/sendkit.

Setup

Add your webhook secret to .env:

SENDKIT_WEBHOOK_SECRET=your-webhook-secret

Listening for Events

use SendKit\Laravel\Events\EmailDelivered;

Event::listen(EmailDelivered::class, function ($event) {
    // $event->payload contains the webhook data
});

Available Events

EmailSent — email.sent
EmailDelivered — email.delivered
EmailBounced — email.bounced
EmailComplained — email.complained
EmailOpened — email.opened
EmailClicked — email.clicked
EmailFailed — email.failed
EmailDeliveryDelayed — email.delivery_delayed
EmailRejected — email.rejected
ContactCreated — contact.created
ContactUpdated — contact.updated
ContactDeleted — contact.deleted

sendkit / sendkit-laravel

Maintainers

Package info

Statistics

Security