Skip to content

dynamik-dev/listmonk-php

Repository files navigation

Listmonk PHP

A PHP SDK for the Listmonk email platform.

CI

Requirements

  • PHP 8.4+

Installation

composer require dynamik-dev/listmonk-php

Quick Start

use DynamikDev\Listmonk\Listmonk;

$listmonk = new Listmonk(
    baseUrl: 'https://listmonk.example.com',
    username: 'api',
    password: 'your-api-token',
);

Create a subscriber

$subscriber = $listmonk->subscribers()->create(
    email: 'user@example.com',
    name: 'John Doe',
    lists: [1, 2],
);

Send a campaign

$campaign = $listmonk->campaigns()->create(
    name: 'Welcome Campaign',
    subject: 'Welcome to our newsletter!',
    lists: [1],
    body: '<p>Hello {{ .Subscriber.Name }}!</p>',
);

$listmonk->campaigns()->start($campaign->id);

Public subscription (no auth required)

$listmonk->public()->subscribe(
    email: 'user@example.com',
    name: 'John Doe',
    listUuids: ['abc-123-def'],
);

Documentation

For full documentation, visit docs.dynamik.dev/listmonk-php

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages