Package: mailerlite

Source: api/packages/mailerlite · imported version 0.4.2. The sections after the README are extracted from the code on every docs build.

README

What does it do

This package is used for integration with MailerLite after dispatching events.

Installing

• composer require ulams/mailerlite

Example

You can set the package status and api key using the Facade

Config::set('ulams_mailer_lite.package_status', PackageStatusEnum::ENABLED);
Config::set('ulams_mailer_lite.api_key', '1234);

or Settings package

$this->actingAs($this->user, 'api')->postJson(
    '/api/admin/config',
    [
        'config' => [
            [
                'key' => 'ulams_mailer_lite.package_status',
                'value' => PackageStatusEnum::ENABLED,
            ],
            [
                'key' => 'ulams_mailer_lite.api_key',
                'value' => '1234',
            ],
        ]
    ]
);

Group names are also configurable.

$this->actingAs($this->user, 'api')->postJson(
    '/api/admin/config',
    [
        'config' => [
            [
                'key' => 'ulams_mailer_lite.group_registered_group',
                'value' => 'registered users',
            ],
            [
                'key' => 'ulams_mailer_lite.group_order_paid',
                'value' => 'order paid',
            ],
            [
                'key' => 'ulams_mailer_lite.group_left_cart',
                'value' => 'left cart',
            ],
        ]
    ]
);

Tests

Run ./vendor/bin/phpunit to run tests.

Test details

Listeners

Handling events

• Ulams\Auth\Events\AccountConfirmed => add to group of registered users (ulams_mailer_lite.group_registered_group)
• Ulams\Cart\Events\ProductBought => add to group of users with paid orders (ulams_mailer_lite.group_order_paid)
• Ulams\Auth\Events\AccountBlocked => remove from all groups
• Ulams\Cart\Events\AbandonedCartEvent => add to the group of users with abandoned carts (ulams_mailer_lite.group_left_cart)
• Ulams\Cart\Events\OrderCreated => remove from the group of users with abandoned carts (ulams_mailer_lite.group_left_cart)

API endpoints

None.

Permissions

None.

Settings

Registered with AdministrableConfig::registerConfig (editable in the admin panel under Configuration → Settings).

Key	Rules	Public	Read-only
ulams_mailer_lite.package_status	required, string, in: . implode(,, PackageStatusEnum::getValues())	no
ulams_mailer_lite.api_key	required, string	no
ulams_mailer_lite.newsletter_field_key	required, string	no
ulams_mailer_lite.group_registered_group	required, string	no
ulams_mailer_lite.group_order_paid	required, string	no
ulams_mailer_lite.group_left_cart	required, string	no

Events

None.

Artisan commands

None.

Scheduled jobs

None.

Environment variables read

None.