Download the PHP package remp/crm-remp-mailer-module without Composer

On this page you can find all versions of the php package remp/crm-remp-mailer-module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of remp/crm-remp-mailer-module

Informations about the package crm-remp-mailer-module

CRM REMP Mailer Module

Translation status @ Weblate

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.

Enabling and configuring module

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

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:

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):

Configurable services

You can disallow subscription to newsletters for users which haven't been confirmed yet (based on users.confirmed_at DB column). The feature is disabled by default and you can enable it by adding following snippet to your config.neon:

API documentation

All examples use http://crm.press as a base domain. Please change the host to the one you use before executing the examples.

All examples use XXX as a default value for authorization token, please replace it with the real tokens:

API responses can contain following HTTP codes:

Value Description
200 OK Successful response, default value
400 Bad Request Invalid request (missing required parameters)
403 Forbidden The authorization failed (provided token was not valid)
404 Not found Referenced resource wasn't found

If possible, the response includes application/json encoded payload with message explaining the error further.

POST /api/v1/mailer/subscribe

API endpoint calls REMP Mailer api endpoint and subscribes user to given mail type and variant.

Headers:
Name Value Required Description
Authorization Bearer String yes User token.
Example:

Response:

POST /api/v1/mailer/unsubscribe

API endpoint calls REMP Mailer api endpoint and unsubscribes user to given mail type and variant.

Headers:
Name Value Required Description
Authorization Bearer String yes User token.
Example:

Response:

All versions of crm-remp-mailer-module with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package remp/crm-remp-mailer-module contains the following files

Loading the files please wait ....