adamcmoore/laravel-newsletter-emailoctopus

EmailOctopus Driver for Spatie Laravel Newsletter

0.1 2024-03-19 13:28 UTC

Requires

• php: ^8.0|^8.1|^8.2
• goran-popovic/email-octopus-php: ^1
• spatie/laravel-newsletter: ^5.1

Requires (Dev)

• illuminate/collections: ^10
• phpunit/phpunit: ^10
• vlucas/phpdotenv: ^5.6

MIT

• Adam Moore

• newsletter
• laravel
• emailoctopus

README

Installation

composer require adamcmoore/laravel-newsletter-emailoctopus

Usage

This package is a driver for Spatie Newsletter.

To use this driver set your config/newsletter.php to include the below:

<?php

return [
    'driver' => AcMoore\LaravelNewsletter\Drivers\EmailOctopusDriver::class,
    'driver_arguments' => [
        'api_key' => env('EMAIL_OCTOPUS_API_KEY'),
    ],
    'default_list_name' =>  'default',
    'lists' => [
        'default' => [
            'id' => env('EMAIL_OCTOPUS_LIST_ID'),
        ],
    ],
];

Documentation for full usage can be found on the Spatie Newsletter GitHub page.

Testing

Clone tests/.env.example to tests/.env and set the required config values.

For all tests to pass you should ensure your testing list has Double opt-in enabled.