Filament Newsletter

https://github.com/jeffersongoncalves/filament-newsletter
Admin
Filament Newsletter is a Filament plugin for composing, scheduling, and sending newsletters to...
Tokens:1,603
Snippets:30
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/README.md

Install the package via Composer. Requires Filament ^5.0 (version 3.x of the plugin).

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

--------------------------------

### Publish Configuration

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/README.md

Publish the configuration file. This step is optional.

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

--------------------------------

### Run Tests

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/README.md

Run the test suite.

```bash
composer test
```

--------------------------------

### Publish Translations

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/README.md

Publish the translation files. This step is optional.

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

--------------------------------

### Register Plugin in Panel Provider

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/README.md

Register the plugin in your panel provider by adding FilamentNewsletterPlugin::make() to the plugins array.

```php
use JeffersonGoncalves\FilamentNewsletter\FilamentNewsletterPlugin;

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

--------------------------------

### Register FilamentNewsletterPlugin

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/resources/boost/skills/filament-newsletter-development/SKILL.md

Add the plugin to your panel configuration to enable Filament Newsletter features.

```php
use JeffersonGoncalves\FilamentNewsletter\FilamentNewsletterPlugin;

FilamentNewsletterPlugin::make();
```

--------------------------------

### Add ScheduleNewsletterTableAction

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/resources/boost/skills/filament-newsletter-development/SKILL.md

Use this action to schedule a newsletter for future delivery from a table.

```php
use JeffersonGoncalves\FilamentNewsletter\Actions\ScheduleNewsletterTableAction;

ScheduleNewsletterTableAction::make();
```

--------------------------------

### Add SendingStatusTableAction

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/resources/boost/skills/filament-newsletter-development/SKILL.md

Use this action to inspect the delivery status of a newsletter from a table.

```php
use JeffersonGoncalves\FilamentNewsletter\Actions\SendingStatusTableAction;

SendingStatusTableAction::make();
```

--------------------------------

### Add SendNewsletterTableAction

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/resources/boost/skills/filament-newsletter-development/SKILL.md

Use this action to send a newsletter immediately from a table.

```php
use JeffersonGoncalves\FilamentNewsletter\Actions\SendNewsletterTableAction;

SendNewsletterTableAction::make();
```

--------------------------------

### Override Resources in config/filament-newsletter.php

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/resources/boost/skills/filament-newsletter-development/SKILL.md

Customize the Newsletter or EmailGroup resources by specifying custom classes in the configuration file.

```php
// config/filament-newsletter.php
return [
    'resources' => [
        'newsletter' => \App\Filament\Resources\CustomNewsletterResource::class,
        'email_group' => \JeffersonGoncalves\FilamentNewsletter\Resources\EmailGroupResource::class,
    ],
];
```

--------------------------------

### Add SendTestNewsletterTableAction

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/resources/boost/skills/filament-newsletter-development/SKILL.md

Use this action to trigger a test send for a newsletter from a table.

```php
use JeffersonGoncalves\FilamentNewsletter\Actions\SendTestNewsletterTableAction;

SendTestNewsletterTableAction::make();
```

--------------------------------

### Add CheckBrokenLinksTableAction

Source: https://github.com/jeffersongoncalves/filament-newsletter/blob/3.x/resources/boost/skills/filament-newsletter-development/SKILL.md

Use this action to verify links within a newsletter from a table.

```php
use JeffersonGoncalves\FilamentNewsletter\Actions\CheckBrokenLinksTableAction;

CheckBrokenLinksTableAction::make();
```
Tokens:
Raw