Skip to content
Capell CMS

Newsletter

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

Field Value
Composer package capell-app/newsletter
Package slug newsletter
Product group Capell Marketing & Growth
Tier premium
Bundle marketing-growth
Runtime contexts admin, frontend
Capell version ^1.0
Catalogue role extension
Release channel Labs
Source repository capell-app/packages
Source path packages/newsletter
Docs source packages/newsletter/docs
Manifest capell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Newsletter is an Available, Schema-owning Capell package in the Capell Marketing & Growth product group. It ships as capell-app/newsletter and extends these surfaces: admin, frontend.

Newsletter adds subscriber consent, double opt-in, segments, preference routes, and provider handoff for Mailchimp, Kit, and Campaign Monitor.

Visitors can subscribe, confirm, update preferences, and unsubscribe. Expired confirmation and preference links offer a private, rate-limited email reissue, while unsubscribe links never expire and remain single-use.

Evidence: src/Actions/SubscribeFromPublicRequestAction.php, src/Actions/RequestDoubleOptInAction.php, src/Actions/EvaluateNewsletterSegmentAction.php, src/Contracts/NewsletterProviderAdapter.php, routes/web.php, tests/Feature/PublicSubscribeControllerTest.php, tests/Feature/PublicTokenReissueTest.php, tests/Feature/PreferenceCenterPublicOutputSafetyTest.php, src/Actions/CreateUnsubscribeTokenAction.php.

Status details:

  • Status: Available
  • Tier: premium
  • Bundle: marketing-growth
  • Composer package: capell-app/newsletter
  • Namespace: Capell\Newsletter
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: Provider and send-handoff contracts separate subscriber lifecycle rules from external email APIs and queued synchronization.

For teams: Teams keep consent and audience rules in Capell while using their email provider for campaign authoring, delivery, and provider-side reporting.

Evidence: src/Contracts/NewsletterProviderAdapter.php, src/Contracts/NewsletterSendHandoff.php, src/Actions/SyncSubscriberToProviderAction.php, tests/Integration/Actions/ProviderAdaptersTest.php, docs/overview.admin.md, src/Actions/EvaluateNewsletterSegmentAction.php, src/Jobs/HandoffNewsletterSendJob.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Subscribers admin index Subscribers admin index Create/edit subscriber form Create/edit subscriber form
  • Subscribers admin index (admin, required).
  • Create/edit subscriber form (admin, required).
  • Provider connections admin index and form (admin, required).
  • Provider audiences admin index and form (admin, required).
  • Provider interest mappings admin index and form (admin, required).
  • Form mappings admin index and form (admin, required).
  • Newsletter tags admin index and form (admin, required).
  • Segments admin index and form (admin, required).
  • Import batches admin index (admin, required).
  • Sync attempts admin index (admin, required).
  • Newsletter overview stats (admin, required).
  • Subscription confirmation route response (frontend, required).
  • Unsubscribe route response (frontend, required).

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\Newsletter\Providers\NewsletterServiceProvider, Capell\Newsletter\Providers\AdminServiceProvider.
  • Config files: packages/newsletter/config/capell-newsletter.php.
  • Migrations: packages/newsletter/database/migrations/2026_05_10_190861_01_create_newsletter_provider_connections_table.php, packages/newsletter/database/migrations/2026_05_10_190861_02_create_newsletter_subscribers_table.php, packages/newsletter/database/migrations/2026_05_10_190861_03_create_newsletter_provider_audiences_table.php, packages/newsletter/database/migrations/2026_05_10_190861_04_create_newsletter_consent_events_table.php, packages/newsletter/database/migrations/2026_05_10_190861_05_create_newsletter_provider_interest_mappings_table.php, packages/newsletter/database/migrations/2026_05_10_190861_06_create_newsletter_provider_subscribers_table.php, packages/newsletter/database/migrations/2026_05_10_190861_07_create_newsletter_public_tokens_table.php, packages/newsletter/database/migrations/2026_05_10_190861_08_create_newsletter_segments_table.php, packages/newsletter/database/migrations/2026_05_10_190861_09_create_newsletter_sync_attempts_table.php, packages/newsletter/database/migrations/2026_05_10_190861_10_create_newsletter_form_mappings_table.php, packages/newsletter/database/migrations/2026_05_10_190861_11_create_newsletter_import_batches_table.php, packages/newsletter/database/migrations/2026_05_10_190861_12_create_newsletter_processed_webhook_events_table.php, packages/newsletter/database/migrations/2026_05_31_120000_13_create_newsletter_sends_table.php, packages/newsletter/database/migrations/2026_07_10_120000_14_add_handoff_state_to_newsletter_sends_table.php.
  • Settings migrations: packages/newsletter/database/settings/2026_07_11_000001_create_newsletter_settings.php.
  • Settings classes: NewsletterSettings.
  • Models: ConsentEvent, FormMapping, ImportBatch, NewsletterSend, ProviderAudience, ProviderConnection, ProviderInterestMapping, ProviderSubscriber, PublicToken, Segment, Subscriber, SyncAttempt.
  • Filament classes: ScopesNewsletterResourcesToAssignedSites, FormMappingResource, CreateFormMapping, EditFormMapping, ListFormMappings, ImportBatchResource, ListImportBatches, NewsletterSendResource, CreateNewsletterSend, EditNewsletterSend, ListNewsletterSends, NewsletterTagResource, and 27 more.
  • Route files: packages/newsletter/routes/web.php.
  • Policies: AbstractNewsletterResourcePolicy, FormMappingPolicy, ImportBatchPolicy, NewsletterSendPolicy, ProviderAudiencePolicy, ProviderConnectionPolicy, ProviderInterestMappingPolicy, SegmentPolicy, SubscriberPolicy, SyncAttemptPolicy.
  • Extension contracts: NewsletterAudienceProvider, NewsletterProviderAdapter, NewsletterSegmentProvider, NewsletterSendHandoff.
  • Events: NewsletterSendHandoffRequested, SubscriberConfirmed, SubscriberUnsubscribed.
  • Listeners: SubscribeFromFormSubmission.
  • Actions: AnonymizeNewsletterSubscriberAction, ApplyNewsletterTagsAction, AssertNewsletterSendHandoffAvailableAction, BuildDueNewsletterSendsAction, BuildListUnsubscribeHeadersAction, BuildNewsletterHealthDiagnosticsAction, BuildNewsletterSendHandoffPayloadAction, ConfirmSubscriberAction, CreatePreferenceCenterTokenAction, CreateUnsubscribeTokenAction, DeleteSubscriberImportFilesAction, EvaluateNewsletterSegmentAction, and 26 more.
  • Data objects: ConfirmSubscriberResultData, ConsentEvidenceData, FormMappingData, PreferenceCenterData, PreferenceCenterResolutionData, PreferenceCenterSegmentData, PreferenceCenterUpdateData, ProviderAudienceData, ProviderInterestData, ProviderSubscriberData, ProviderSyncResultData, ProviderWebhookEventData, and 3 more.
  • Jobs: HandoffNewsletterSendJob, PrepareSubscriberCsvImportJob, ProcessSubscriberImportChunkJob, SyncSubscriberToProviderJob.
  • Command signatures: newsletter:handoff-due-sends, newsletter:sync-retry-due.
  • Manifest action API: applyNewsletterTags: Capell\Newsletter\Actions\ApplyNewsletterTagsAction, buildDueNewsletterSends: Capell\Newsletter\Actions\BuildDueNewsletterSendsAction, buildListUnsubscribeHeaders: Capell\Newsletter\Actions\BuildListUnsubscribeHeadersAction, buildNewsletterSendHandoffPayload: Capell\Newsletter\Actions\BuildNewsletterSendHandoffPayloadAction, confirmSubscriber: Capell\Newsletter\Actions\ConfirmSubscriberAction, createPreferenceCenterToken: Capell\Newsletter\Actions\CreatePreferenceCenterTokenAction, createUnsubscribeToken: Capell\Newsletter\Actions\CreateUnsubscribeTokenAction, evaluateNewsletterSegment: Capell\Newsletter\Actions\EvaluateNewsletterSegmentAction, exportSubscribers: Capell\Newsletter\Actions\ExportSubscribersAction, handleProviderWebhook: Capell\Newsletter\Actions\HandleProviderWebhookAction, importSubscribers: Capell\Newsletter\Actions\ImportSubscribersAction, parseSubscriberCsvRows: Capell\Newsletter\Actions\ParseSubscriberCsvRowsAction, and 16 more.
  • Scheduled commands: newsletter:handoff-due-sends (everyMinute), newsletter:sync-retry-due (everyFiveMinutes).
  • Console command classes: HandoffDueNewsletterSendsCommand, RequeueDueProviderSyncAttemptsCommand.
  • Manifest contributions: admin-resource: Capell\Newsletter\Manifest\NewsletterAdminResourcesContribution, console-command: Capell\Newsletter\Manifest\NewsletterConsoleCommandsContribution, dashboard-widget: Capell\Newsletter\Manifest\NewsletterOverviewFilamentWidgetContribution, health-check: Capell\Newsletter\Manifest\NewsletterHealthContribution, model: Capell\Newsletter\Manifest\NewsletterModelsContribution, overview-stat: Capell\Newsletter\Manifest\NewsletterOverviewStatsContribution, route: Capell\Newsletter\Manifest\NewsletterFrontendRoutesContribution, scheduled-job: Capell\Newsletter\Manifest\NewsletterSendHandoffScheduleContribution, scheduled-job: Capell\Newsletter\Manifest\NewsletterSyncRetryScheduleContribution, setting: Capell\Newsletter\Manifest\NewsletterSettingsContribution.
  • Health checks: Capell\Newsletter\Health\NewsletterHealthCheck.
  • Blade views: packages/newsletter/resources/views/expired-token.blade.php, packages/newsletter/resources/views/preference-center.blade.php, packages/newsletter/resources/views/token-reissue-requested.blade.php, packages/newsletter/resources/views/unsubscribe-confirm.blade.php.
  • Cache tags: newsletter.

Data Model

Section titled “Data Model”
  • Required tables: newsletter_provider_connections, newsletter_subscribers, newsletter_provider_audiences, newsletter_consent_events, newsletter_provider_interest_mappings, newsletter_provider_subscribers, newsletter_public_tokens, newsletter_segment_subscriber, newsletter_segments, newsletter_sync_attempts, newsletter_form_mappings, newsletter_import_batches, and 2 more.
  • Models: ConsentEvent, FormMapping, ImportBatch, NewsletterSend, ProviderAudience, ProviderConnection, ProviderInterestMapping, ProviderSubscriber, PublicToken, Segment, Subscriber, SyncAttempt.
  • Core record references in migrations: sites via site_id.
  • Migration files: 2026_05_10_190861_01_create_newsletter_provider_connections_table.php, 2026_05_10_190861_02_create_newsletter_subscribers_table.php, 2026_05_10_190861_03_create_newsletter_provider_audiences_table.php, 2026_05_10_190861_04_create_newsletter_consent_events_table.php, 2026_05_10_190861_05_create_newsletter_provider_interest_mappings_table.php, 2026_05_10_190861_06_create_newsletter_provider_subscribers_table.php, 2026_05_10_190861_07_create_newsletter_public_tokens_table.php, 2026_05_10_190861_08_create_newsletter_segments_table.php, 2026_05_10_190861_09_create_newsletter_sync_attempts_table.php, 2026_05_10_190861_10_create_newsletter_form_mappings_table.php, 2026_05_10_190861_11_create_newsletter_import_batches_table.php, 2026_05_10_190861_12_create_newsletter_processed_webhook_events_table.php, and 2 more.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: migrations declare cascade-on-delete relationships and null-on-delete relationships; no timed pruning or retention schedule is declared in capell.json.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core, capell-app/form-builder, capell-app/frontend, capell-app/tags.
  • Admin navigation: declares admin-resource: NewsletterAdminResourcesContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: dashboard-widget: NewsletterOverviewFilamentWidgetContribution, overview-stat: NewsletterOverviewStatsContribution.
  • Permissions: none declared in capell.json.
  • Public routes: loads routes/web.php; registers NewsletterFrontendRoutesContribution.
  • Database changes: package migrations are declared.
  • Config: config/capell-newsletter.php.
  • Settings: Capell\Newsletter\Settings\NewsletterSettings.
  • Queues or schedules: scheduled commands newsletter:handoff-due-sends (everyMinute), newsletter:sync-retry-due (everyFiveMinutes); queue jobs HandoffNewsletterSendJob, PrepareSubscriberCsvImportJob, ProcessSubscriberImportChunkJob, SyncSubscriberToProviderJob.
  • Cache tags: newsletter.
  • Commands: newsletter:handoff-due-sends, newsletter:sync-retry-due.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/form-builder, capell-app/frontend, capell-app/tags.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/capell-newsletter.php, Capell\Newsletter\Settings\NewsletterSettings.
  • Review middleware, throttling, signatures, and public-output safety in routes/web.php before exposing routes.
  • Register the host scheduler so these declared commands run at their documented frequencies: newsletter:handoff-due-sends (everyMinute), newsletter:sync-retry-due (everyFiveMinutes).
  • Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
  • Custom write integrations must preserve invalidation for newsletter cache tags.

Troubleshooting

Section titled “Troubleshooting”
Symptom Likely cause Check Fix
Package surface is missing after install Provider or manifest is not loaded Confirm capell.json, package composer.json, and provider registration Reinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing table Package migrations have not run Check the tables listed in Data Model Run host migrations and rerun the focused package test
Route returns unexpected output Route cache, middleware, or signed URL setup does not match the package route file Check the route files listed in Technical Shape Clear route cache and verify middleware before exposing public routes
Background work does not run Queue worker or declared schedule is not active Check the jobs and scheduled commands listed in Technical Shape Start the queue worker or host scheduler, then run the focused command or package test
Public output leaks unexpected state Render data, cache variation, or authoring boundary has regressed Check public Blade, cache tags, and public-output safety tests Move data loading out of Blade and rerun the package public-output tests

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/newsletter.
  2. Run the required setup: php artisan migrate.
  3. Open the Subscribers admin index and confirm the admin workflow loads.

Next Steps

Section titled “Next Steps”