Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.03 KB

README.md

File metadata and controls

29 lines (22 loc) · 1.03 KB

Mail System

Webtrees module for sending newsletters at regular intervals.

Make sure to configure the cron job as described in the module settings.

APIs

  • /mail-sys/help: lists the available endpoints.
  • /mail-sys/get: lists all changes in JSON format.
  • /mail-sys/html: a preview of the mail that will be sent.
  • /mail-sys/cron: should be called regularly, it will check if a mail should be sent.
  • /mail-sys/send: force the sending of the newsletter (requires administrator rights).

Translation

All language files are located in /ressouces/lang. You can edit them with a po editor such as Poedit

Development

Nightly builds are available here

This module requires composer and gettext.
To install the PHP dependencies, run

composer install --prefer-dist

To build the module, run

composer archive -f zip --file evang-mailsystem-$(cat version.txt)