dynamik-dev / listmonk-php
A full-featured PHP HTTP client for the Listmonk email platform
Installs: 3
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
pkg:composer/dynamik-dev/listmonk-php
Requires
- php: ^8.4
- saloonphp/saloon: ^3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- pestphp/pest: ^3.0
- phpstan/phpstan: ^2.0
README
A PHP SDK for the Listmonk email platform.
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