Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.46 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.46 KB

CRM REMP Mailer Module

REMP Mailer Module is an integration module connecting CRM with REMP Mailer.

Module adds listener for NotificationEvent to send emails, and attaches widgets to allow users/admins to configure newsletter subscriptions and to see logs of all sent emails in administration.

Installing module

We recommend using Composer for installation and update management.

composer require remp/crm-remp-mailer-module

Enabling and configuring module

Add installed extension to your app/config/config.neon file.

extensions:
	remp_mailer: Crm\RempMailerModule\DI\RempMailerModuleExtension

When added, you need to provide URL of REMP Mailer instance and API token that CRM should use to communicate with Mailer.

Amend your configuration file and replace the example values with real ones:

remp_mailer:
    # Base URL where mailer is hosted.
    host: http://mailer.remp.press

    # API token to communicate with Mailer. By default the token can be acquired in REMP SSO.
    api_token: abcdef123456789

If the configuration is incomplete, initialization will log an error to your configured logger and won't enable the module in CRM.

When everything is ready, make sure you update CRM internal configuration by running following commands (they should always be part of your release process):

php bin/command.php api:generate_access
php bin/command.php application:seed