ghanover / mailman-sync
Sync with mailman list
Installs: 6
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Language:HTML
Requires
- php: >=7.0
- guzzlehttp/guzzle: ^6.3
- illuminate/support: >=5.1
Requires (Dev)
- orchestra/testbench: ~3.1
- phpunit/phpunit: ^6.0
This package is auto-updated.
Last update: 2024-10-07 15:50:05 UTC
README
Introduction
Basic subscribe/unsubscribe functionality to allow for keeping user lists in sync with a mailman list
Installation
Require through composer (until I get off my butt and get it in packagist, you'll have to add the VCS manually)
composer require ghanover/mailman-sync
Or manually edit your composer.json file:
"require": {
"ghanover/mailman-sync": "dev-master"
}
Publish the configuration file:
php artisan vendor:publish
app/config.php
Edit the aliases array to include:
'MailmanGateway' => \MailmanSync\Facades\MailmanGateway::class,
Register Service Provider in providers array:
\MailmanSync\SyncServiceProvider::class,
Config
MAILMAN_ADMIN_URL=http://your.host/mailman/
MAILMAN_LISTS="{\"examplelist\":{\"password\":\"securepassword\"}}"
Usage
Basic example
MailmanGateway::subscribe('mylist', 'user@example.com');
Testing
You can test locally without having to set up mailman by adding MAILMAN_MOCK=true to your .env. This will use local files in storage/app/ to mimic the members list.
At this point in time, the mock feature has no way to test failures.