Skip to content
Snippets Groups Projects
Torsten Kunst's avatar
Torsten Kunst authored
5ed862d1
History

ZMS Messaging

pipeline status coverage report

ZMS HTTP messaging

Use this library to messaging email and notifications.

Requirements

  • PHP 7.3+

Installation

The variable $WEBROOT represents the parent path to install the application.

    cd $WEBROOT
    git clone https://gitlab.com/eappointment/zmsmessaging.git
    cd zmsmessaging
    make live
    cp config.example.php config.php

Development

For development, additional modules are required. Commits from a live environment require to ignore the pre-commit hooks. For local development do

    ...
    make dev
    ...

Configuration

Edit the config.php and add/change settings for accessing the API.

Usage

To start sending emails or SMS notifications from a database queue, the following scripts can be integrated into a cron job that processes the jobs at a desired interval.

To start a dispatch, the parameter --send should be set. If you also want an output of the sent jobs, the parameter --verbose can be added. A DryRun is obtained by using only the --verbose parameter without --send.

php -d mail.add_x_header=0 $BIN/mail_queue.php --send "$@"
php -d mail.add_x_header=0 $BIN/notification_queue.php --send "$@"

Testing

To test application run the following command:

bin/test

For a detailed project description, see https://gitlab.com/eappointment/eappointment

Consent

On this website, we use the web analytics service Matomo to analyze and review the use of our website. Through the collected statistics, we can improve our offerings and make them more appealing for you. Here, you can decide whether to allow us to process your data and set corresponding cookies for these purposes, in addition to technically necessary cookies. Further information on data protection—especially regarding "cookies" and "Matomo"—can be found in our privacy policy. You can withdraw your consent at any time.