Installation¶

System requirements¶

Requirements:

PHP 8.0 or newer
Ibexa DXP 4.1 or newer

Install using composer¶

Add composer registry:

composer config repositories.gitlab.com/612647 '{"type": "composer", "url": "https://gitlab.com/api/v4/group/612647/-/packages/composer/packages.json"}'

Install package version:

composer req xrow/newsletter-bundle:1.0.0

Bundle configuration¶

Add the bundle to config/bundles.php and be strict on the order:

    Xrow\NewsletterBundle\XrowNewsletterBundle::class => ['all' => true],

Route configuration¶

Register the routes in config/routes/xrow_newsletter.yaml:

xrow_newsletter:
    resource: '@XrowNewsletterBundle/Resources/config/routing.yml'

Database creation¶

Preview and create the database tables:

bin/console doctrine:schema:update --dump-sql
bin/console doctrine:schema:update --force

Settings¶

Configure your settings like that:

adapter: either newsletter.sendgrid or newsletter.maileon are supported.
recaptcha_sitekey: reCAPTCHA API key needed by the subscribe form.
recaptcha_secretkey: reCAPTCHA secret needed by the subscribe form.
maileon: Provides the possibility to configure Maileon multiple accounts.
system: Make a mapping between Siteaccess and the corresponding list ID and channel name.

Basic example for Sendgrid:

xrow_newsletter:
    adapter: newsletter.sendgrid
    sendgrid_apikey: SG.jellyjellyjelly_jelly.jelly_Jelly-jellY

The configuration for all siteaccesses can be seen in the AdminUI at https://admin.example.com/systeminfo#ibexa-tab-systeminfo-xrow_newsletter#tab (only supports Maileon adapter).

Last update: February 13, 2023