lsuonline / lsuce-block_quickmail

6 stars 37 forks source link

Quickmail (v2)

Quickmail is a Moodle block plugin that provides selective, bulk messaging for Moodle courses and sites. Developed by Louisiana State University :tiger:, Geaux Tigers!!!

Overview

Quickmail is a convenient way to select enrolled users in your Moodle course and message them. You can select (or exclude) recipients individually, by role, or even by group. Additionally, you can use Quickmail at the administrative level to select and message users within the entire site.

Please note that these are the docs for Quickmail v2. This second version is much different than the original version in the way it operates and saves data. If you are wanting to install the original version, please see the Quickmail v1 branch of this plugin.

It is highly recommended that you review the features below and make sure this plugin will work for you, and that you backup any existing data before installing!!

Installation

Note: In order for this block to send messages you need to have CRON working and running properly on your server. If you don't have CRON running regularly, do not install (or upgrade) this block!

Quickmail should be installed like any other block. See the Moodle Docs page on plugin installation for more info. You can also find Quickmail on the official Moodle Plugin Directory.

If you are upgrading from v1 to v2, a data migration script is included in this plugin which will format your existing data to the new structure. Note: Signatures and Alternate Emails are not carried over, however, and will have to be re-created manually.

Features

Contributions

Contributions of any form are welcome. GitHub pull requests are preferred. Report any bugs or requests through our GitHub issue tracker.

Tests

To run PHPUnit tests: vendor/bin/phpunit -c blocks/quickmail/phpunit.xml

License

Quickmail adopts the same license that Moodle does.