README

Filament Newsletter

A Filament plugin for composing, scheduling, and sending newsletters to subscriber email groups, with delivery tracking and broken-link checks.

Compatibility

Installation

You can install the package via composer:

composer require jeffersongoncalves/filament-newsletter:"^3.0"

Publish the configuration (optional):

php artisan vendor:publish --tag="filament-newsletter-config"

Publish the translations (optional):

php artisan vendor:publish --tag="filament-newsletter-translations"

Usage

Register the plugin in your panel provider:

use JeffersonGoncalves\FilamentNewsletter\FilamentNewsletterPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentNewsletterPlugin::make(),
        ]);
}

Newsletters

The Newsletter resource lets you compose a newsletter with rich text, Markdown, or raw HTML content, attach files, target one or more email groups, and:

• Send test — deliver a single copy to an arbitrary email address before sending to your list.
• Send now — send the newsletter to every subscriber of the selected email groups immediately.
• Schedule — pick a date and time and the newsletter status moves to scheduled.
• Sending status — a read-only breakdown of sent vs. failed deliveries for the newsletter.
• Check broken links — scans the newsletter content for broken URLs and reports them.

Email Groups

The Email Group resource manages named subscriber lists. Each group shows the number of confirmed, still-subscribed members, and has a relation manager for its members where you can toggle a member's unsubscribed state or remove them.

Localization

Translations are provided for:

• English (en)
• Brazilian Portuguese (pt_BR)

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Jefferson Gonçalves
• All Contributors

License

The MIT License (MIT). Please see License File for more information.