tobymaxham/kraut-newsletter

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

A package to manage newsletters in larave 5

v1.0 2015-07-21 00:32 UTC

This package is auto-updated.

Last update: 2021-11-23 22:01:26 UTC


README

Total Downloads Latest Stable Version Latest Unstable Version License

A package to manage newsletter in Laravel 5.

Installation

Register the Service Provider

// config/app.php
'providers' => [
    ...
    'TobyMaxham\Newsletter\NewsletterServiceProvider',
    ...
];

Documentation

We currently have essentially no documentation at the moment, but are working on it, and are open to pull requests.

How to use

Register a new subscriber

// Simply add a new subscriber.
Newsletter::subscribe('Heiko@nothing-on-website.net');

// Attach the subscriber on a NewsletterList.
Newsletter::subscribe('francis@clouding.net', 'Evil Mailing');

// Add some user informations
Newsletter::subscribe('Heiko@nothing-on-website.net', ['firstname' => 'Heiko'], 'The Simple List');

Also you can remove a subscriber.

// Remove from all Newsletter Lists and delete from subscriber
Newsletter::unsubscribe('francis@clouding.net');

// Only remove from a special list
Newsletter::unsubscribe('abraham@krauts.ru', 'Free Tutorials');

The name

By using this package you'll get more time to eat kraut.

License

TobyMaxham'S Kraut Newsletter is licensed under The MIT License (MIT).