Skip to content
Snippets Groups Projects
Commit f0426a3c authored by Torsten Kunst's avatar Torsten Kunst
Browse files

add usage block to readme

parent da1db3ad
No related branches found
No related tags found
No related merge requests found
......@@ -38,6 +38,17 @@ For local development do
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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

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.