README

A simple all-in-one solution for managing email list subscribers in PHP.

Supported

Mailchimp (Example)
Campaign Monitor (Example)
ConvertKit (Example)
ActiveCampaign (Example)
Omnisend (Example)

Installation

This package is available on Packagist and can be installed via Composer like so:

composer require sebkay/arbalest

Usage

First, create the Arbalest\Arbalest instance. This is the object you'll use to manage subscribers.

Second, provide the Arbalest instance a service. For example Mailchimp (Arbalest\Services\Mailchimp).

Then you can either subscribe or unsubscribe email addresses like so:

// Single
$arbalest->subscribe('test@test.com');

$arbalest->unsubscribe('test@test.com');

// Multiple
$arbalest->subscribeAll([
    'test_1@test.com',
    'test_2@test.com',
    'test_3@test.com',
]);

$arbalest->unsubscribeAll([
    'test_1@test.com',
    'test_2@test.com',
    'test_3@test.com',
]);

Example (Mailchimp)

use Arbalest\Arbalest;
use Arbalest\Services\Mailchimp;

try {
    $arbalest = new Arbalest(
        new Mailchimp([
            'api_key'  => '12345',
            'server'   => 'us2',
            'list_id'  => 'abcde',
        ])
    );

    $arbalest->subscribe('test@test.com');
} catch (\Exception $e) {
    // Do something on error
}

Methods

These are the public methods available on Arbalest\Arbalest.

Method	@return
`subscribe(string $email_address)`	`bool`
`unsubscribe(string $email_address)`	`bool`
`subscribeAll(array $email_addresses)`	`bool`
`unsubscribeAll(array $email_addresses)`	`bool`

Coming Soon

Hubspot
GetResponse
Drip
Constant Contact
MailerLite
Sendinblue
AWeber
GetResponse

sebkay / arbalest

Maintainers

Details