tailored/laravel-newsletter

A Laravel 4 Package for adding newsletter signup (and unsubscribe) functionality to a web site

Laravel Newsletter Signup

A Laravel 4 Package for adding newsletter signup (and unsubscribe) functionality to a web site, _(*1)

Features

• Partials for a signup and an unsubscribe form, that you can include in your own views
• Controller actions to handle the submissions of the forms, which can handle normal (redirects to previous page), or AJAX requests (responds with JSON with status code and message)
• Translation approach for customising labels, buttons, feedback messages and validation errors
• Currently only supports saving to a database through a supplied Eloquent model (migration included), but will hopefully be extended to support mailing list API services in future
• Includes a FrozenNode/Laravel-Administrator config file with Download Signups CSV and Download Unsubscribes CSV buttons. You can filter by dates on the created_at and deleted_at fields to get newly created and newly deleted emails to upload new subscriptions and unsubscriptions to your mailer
• Twitter bootstrap compatible markup and class names for the forms
• Unsubscribing has the affect of deleting (soft delete) the email address from the signups table
• Re-subscribing has the affect of restoring (restore from soft delete) the email address in the signups table

Installation

Add the following to you composer.json file, _(*2)

"fbf/laravel-newsletter-signup": "dev-master"

Run, _(*3)

composer update

Add the following to app/config/app.php, _(*4)

'Fbf\LaravelNewsletterSignup\LaravelNewsletterSignupServiceProvider'

Publish the config, _(*5)

php artisan config:publish fbf/laravel-newsletter-signup

Run the migration, _(*6)

php artisan migrate --package="fbf/laravel-newsletter-signup"

Optionally copy the administrator config to your administrators model config directory, if you have one, _(*7)

Configuration

Coming soon, _(*8)

Usage

There is a route and a view supplied for rendering both the signup and unsubscribe forms, and you can configure the actual view and the actual uri in the config file., _(*9)

However, you will most likely want to just @include one of the partials somewhere in your existing views, for example:, _(*10)

@include('laravel-newsletter-signup::signup')

or, _(*11)

@include('laravel-newsletter-signup::unsubscribe')

This will render the sign up or the unsubscribe form., _(*12)

Administrator

You can use the excellent Laravel Administrator package by frozennode to view and download your signups and unsubscribes., _(*13)

http://administrator.frozennode.com/docs/installation, _(*14)

A ready-to-use model config file for the Signup model (newsletter.php) is provided in the src/config/administrator directory of the package, _(*15)