All packages
Notifications for Laravel
Artisan commands
| Command | Does |
|---|---|
notifications:sweep {--only=} | Expire stale claims, release due mail (held, trailing, retries, held interop mail), start due digests, fire due reminders and escalations. --only=claims,deliveries,digests,reminders,escalations — reminders fires reminders only, escalations escalations only; an unknown part exits 2 naming the valid ones. Prints the SweepReport. |
notifications:prune | Force-delete old rows in chunks: read and archived (or deleted) inbox items, terminal deliveries, finished digest runs with no live entry, terminal reminders with no pending or firing escalation (after the prune.* durations), and receipts after idempotency.ttl. |
notifications:types | The registry: key, category, channels, priority, flags, window, reminder rules. |
notifications:doctor | Checks the setup and exits non-zero on an error (see below). |
notifications:install | Publishes the config and the migrations (refuses when a configured table exists) and prints the schedule lines and trait snippets. |
notifications:reminders:sync {type?} | Backfill (reminders()->backfill()): schedules reminders for every subject of a type’s class — every type with reminder rules when omitted — and prints <key>: n subject(s) synced. A type without reminder rules throws InvalidReminderRuleException. |
php artisan notifications:sweep
php artisan notifications:sweep --only=deliveries,digests
php artisan notifications:prune
php artisan notifications:types
php artisan notifications:doctor
php artisan notifications:install
php artisan notifications:reminders:sync contract.expiringScheduling
Nothing is auto-scheduled:
// routes/console.php
use Illuminate\Support\Facades\Schedule;
Schedule::command('notifications:sweep')->everyMinute()->withoutOverlapping(10)->onOneServer();
Schedule::command('notifications:prune')->daily();From PHP
$report = Notifications::sweep(); // SweepReport: deliveries, digests, reminders, escalations, expired
Notifications::sweep(['reminders', 'escalations']);
$pruned = Notifications::prune(); // PruneReport: inboxItems, deliveries, digestRuns, reminders, receipts, total()
Notifications::deliveries()->dispatchDue(); // int
Notifications::digests()->sendDue(); // int
Notifications::reminders()->fireDue(); // FiredReminders: reminders, escalationsWhat the doctor checks
| Level | Finding |
|---|---|
| error | notifications.key_type differs from options.key_type. |
| info | The queue connection is sync: mail, digests and fan-out run inline. Also prints the schedule line. |
| warning | The preference lock store uses the array or file driver — not shared across servers. |
| warning | List-Unsubscribe is on but the links are not https: mail gets List-Unsubscribe without the one-click List-Unsubscribe-Post header. Set an https APP_URL. |
| warning | The mail rate limit counts in an array or file cache store — not shared across servers (set cache.limiter). |
| error | A config value that does not read (e.g. invalid default quiet hours). |
| error | A type whose subject has no policy while the ability is not defined — the first send throws. |
| error / warning | Interop: a map to an unknown type or a broken time-critical guard (errors); a mapped ancestor class that also matches time-critical notifications, a digestible mapped type, a subject type without subjectFrom() (warnings). |
| error / warning | The user model cannot be mailed (error) or is not Authenticatable (warning). |
Show your open-source love
This package is free and MIT-licensed. If it saves you time, a one-off donation or a Patreon membership keeps it maintained, tested and documented.
More ways to support, including cryptoBy donating, you agree to our donation terms.
Want this built into your product?
We integrate our packages into custom Laravel and AI builds. Tell us what you're working on and we'll reply within 48 hours.