| 1 |
efrain |
1 |
# Moodle - Local Reminders
|
|
|
2 |
---
|
|
|
3 |
|
|
|
4 |
|
|
|
5 |
|
|
|
6 |
[](https://travis-ci.org/isuru89/moodle-reminders-for-calendar-events)
|
|
|
7 |
|
|
|
8 |
This plugin will send email reminders for [Moodle](https://moodle.org/) calendar events.
|
|
|
9 |
|
|
|
10 |
Reminders are very useful for both students as well as teachers to recall their scheduled events and activities before the actual moment.
|
|
|
11 |
|
|
|
12 |
[Screenshots](https://moodle.org/plugins/local_reminders)
|
|
|
13 |
|
|
|
14 |
## Features
|
|
|
15 |
|
|
|
16 |
General Features:
|
|
|
17 |
|
|
|
18 |
* Ability to send reminders for site, user, course, group and activity calendar events.
|
|
|
19 |
* Pre-defined and customizable reminders schedule (1, 3 and 7 days in-advance).
|
|
|
20 |
* Ability to select roles eligible for receiving reminder emails.
|
|
|
21 |
|
|
|
22 |
|
|
|
23 |
In addition to that, there are lot of new features introduced in v2 of the plugin which is required to have Moodle 3.5 or later.
|
|
|
24 |
|
|
|
25 |
* Send reminders to users who unable to complete an expired activity.
|
|
|
26 |
* Send email reminders when a calendar event is created, updated or removed.
|
|
|
27 |
* Ability to enable/disable and scheduling reminders per activity basis.
|
|
|
28 |
* No reminders after a user has completed activity.
|
|
|
29 |
* Added event location / timezone information to the reminder email.
|
|
|
30 |
* New category event type support
|
|
|
31 |
* Improved email style
|
|
|
32 |
|
|
|
33 |
And many bug fixes too.
|
|
|
34 |
|
|
|
35 |
|
|
|
36 |
## Compatibility
|
|
|
37 |
|
|
|
38 |
Plugin v2+ works in any Moodle versin 3.5 or above.
|
|
|
39 |
|
|
|
40 |
[See here for older versions](https://moodle.org/plugins/pluginversions.php?plugin=local_reminders)
|
|
|
41 |
|
|
|
42 |
## Installation
|
|
|
43 |
|
|
|
44 |
To install this plugin, you must be an administrator of your Moodle site.
|
|
|
45 |
|
|
|
46 |
1. Downlod an appropriate version from [here](https://moodle.org/plugins/pluginversions.php?plugin=local_reminders) based on your installed Moodle version.
|
|
|
47 |
2. Go to Moodle `Site administration` > `Plugins` > `Install plugins`
|
|
|
48 |
3. Upload the downloaded zip file to the provided box.
|
|
|
49 |
4. Click `Show more...` and select `Local plugin (local)` under plugin type.
|
|
|
50 |
5. Click `Install plugin from ZIP file`
|
|
|
51 |
5. Provide your reminders settings once asked.
|
|
|
52 |
6. That's it!
|
|
|
53 |
|
|
|
54 |
Also don't forget to show your love for this plugin in [here](https://moodle.org/plugins/view.php?id=397) by clicking `Add to favourites`.
|
|
|
55 |
|
|
|
56 |
## Plugin Settings
|
|
|
57 |
|
|
|
58 |
Reminders are sent using Moodle's Scheduled tasks (since v3.5), and you can specify the running interval in `Site administration` > `Server` > `Scheduled tasks` > `Local Reminders`. By default, it has set to run in every 15 minutes.
|
|
|
59 |
|
|
|
60 |
**Note:** If you are using a Moodle version before 3.5, then you must edit `$plugin->cron` value in `version.php` file before uploading it for installation. This value is indicated in seconds.
|
|
|
61 |
|
|
|
62 |
To customize the plugin settings, go to `Site administration` > `Plugins` > `Reminders`.
|
|
|
63 |
|
|
|
64 |
Each setting and its functionality is described below.
|
|
|
65 |
|
|
|
66 |
* Common Settings
|
|
|
67 |
|
|
|
68 |
| Setting | Description | Default |
|
|
|
69 |
|---|---|---|
|
|
|
70 |
| Enabled | enable/disable reminder plugin. Not a single reminder will be sent. This is provided to temporary disable plugin without uninstalling it. | yes |
|
|
|
71 |
| Message Title Prefix | The text to prepend for each and every reminder email subject. Email subject will take format of `[${TITLE_PREFIX}] ${Subject}` | `Moodle-Reminder` |
|
|
|
72 |
| Send As | Indicated the from user field of every reminder. You could use either as Moodle admin user or No reply address. | Site Admin |
|
|
|
73 |
| No Reply Name | This will indicate No reply user name for email when you chose the option `No Reply Address` for `Send As` option. | `No Reply` |
|
|
|
74 |
| Filter Calendar Events | Which calendar events to be filtered | Only visible events |
|
|
|
75 |
|
|
|
76 |
* Changelog Events Change Reminders
|
|
|
77 |
|
|
|
78 |
| Setting | Description | Default |
|
|
|
79 |
|---|---|---|
|
|
|
80 |
| Send when Event Created | If checked, then a reminder will sent for the newly created calendar events immediately. | false |
|
|
|
81 |
| Send when Event Updated | If checked, then a reminder will sent for the updated calendar events immediately. | false |
|
|
|
82 |
| Send when Event Removed | If checked, then a reminder will sent for the removed calendar events immediately. | false |
|
|
|
83 |
|
|
|
84 |
In addition to above, user can control reminders for calendar event changes per event type. Under each event type, there is an option called `Enable for calendar change events` which allows user to enable/disable based on the event type.
|
|
|
85 |
|
|
|
86 |
**Note**: per event type settings are considered only _after_ above change type setting considered.
|
|
|
87 |
|
|
|
88 |
* Activity Event Reminders
|
|
|
89 |
|
|
|
90 |
| Setting | Description | Default |
|
|
|
91 |
|---|---|---|
|
|
|
92 |
| No reminders once completed | enable/disable sending reminders if a user has completed activity. If checked, he/she won't receive reminders anymore once completed. | true |
|
|
|
93 |
| Activity Overdue Reminders | enable/disable sending reminders for users who still have not completed expired events | true |
|
|
|
94 |
|
|
|
95 |
## Changelog
|
|
|
96 |
|
|
|
97 |
#### v2.2.1
|
|
|
98 |
* No reminders for hidden courses (#78)
|
|
|
99 |
* Fixed coursecat deprecation warning (#76)
|
|
|
100 |
* Fixed no-reply address not correctly being in the reminder emails (#77)
|
|
|
101 |
* Fixed disabled course reminders are still sending issue (#84)
|
|
|
102 |
|
|
|
103 |
#### v2.2
|
|
|
104 |
* Option to show/hide activity plugin name in reminder email subject (#71)
|
|
|
105 |
* Support reminder customization for course and BigBlueButton events (#69, #70)
|
|
|
106 |
|
|
|
107 |
#### v2.1.2
|
|
|
108 |
* Php 7.0 compatibility (#66)
|
|
|
109 |
|
|
|
110 |
#### v2.1.1
|
|
|
111 |
* Check for custom completion status of activities (#62)
|
|
|
112 |
|
|
|
113 |
#### v2.1
|
|
|
114 |
* Reminder interval customization per activity instance (#57)
|
|
|
115 |
* Support for course category events (#40)
|
|
|
116 |
|
|
|
117 |
#### v2.0
|
|
|
118 |
* Ability to send reminders after event completed for overdue students (#3)
|
|
|
119 |
* Ability to enable/disable reminders per activity (#48)
|
|
|
120 |
* Reminder email messages when calendar event created/changed/removed (#21)
|
|
|
121 |
* Prevent sending more email reminders once a student has completed the activity
|
|
|
122 |
* Added timezone/location to the email due dates (#32)
|
|
|
123 |
* Improved email style (#31)
|
|
|
124 |
* Additional cron task to clean old reminder data (#37)
|
|
|
125 |
* Send reminders only to students who can submit assignment (#47)
|
|
|
126 |
|
|
|
127 |
#### v1.7
|
|
|
128 |
* Excluded suspended users from course/activity events (#27)
|
|
|
129 |
* Renamed admin cron function so that conflicting with legacy (#26)
|
|
|
130 |
* Totara conflicting class name issue fixed (#25)
|
|
|
131 |
* Support for moodle v3.8
|
|
|
132 |
|
|
|
133 |
#### v1.6.2
|
|
|
134 |
* Fixed issue of conflicting class name
|
|
|
135 |
|
|
|
136 |
#### v1.6.1
|
|
|
137 |
* Fix login redirect loop in Moodle v3.5, 3.6 and 3.7.
|
|
|
138 |
|
|
|
139 |
#### v1.6
|
|
|
140 |
* Support for Moodle v3.5 and above.
|
|
|
141 |
* Migrated to new Moodle task API.
|
|
|
142 |
|
|
|
143 |
#### v1.5.1
|
|
|
144 |
* Fixed a bug where group reminders are not assigned when the event instance is empty
|
|
|
145 |
|
|
|
146 |
#### v1.5
|
|
|
147 |
* support for moodle 3.0+
|
|
|
148 |
* Ability to change mail sent user through configurations (#14)
|
|
|
149 |
* Notice: undefined variable when opening admin settings page in Moodle 2.9 (#12)
|
|
|
150 |
* Event reminders sent for individual quiz overrides (#11)
|
|
|
151 |
* Fix time formatting when user has set 24hour format in calendar preferences
|
|
|
152 |
* Fix cron errors resulting from new role (thanks to [colin-umn]: https://github.com/colin-umn)
|
|
|
153 |
* Fix cron error caused by $courseroleids (thanks to [cdsmith-umn]: https://github.com/cdsmith-umn)
|
|
|
154 |
|
|
|
155 |
#### v1.4.2
|
|
|
156 |
* support for moodle 2.9+
|
|
|
157 |
* ability to specify a custom schedule for sending reminders for any event type.
|
|
|
158 |
|
|
|
159 |
#### v1.4.1
|
|
|
160 |
* support for moodle 2.8 (thanks to [jojoob]: https://github.com/jojoob)
|
|
|
161 |
* course specific settings added for reminders (thanks to [jojoob]: https://github.com/jojoob)
|
|
|
162 |
|
|
|
163 |
#### v1.4
|
|
|
164 |
* now works in Moodle 2.7.*
|
|
|
165 |
* fixed bug sending reminders repeatedly to users.
|
|
|
166 |
|
|
|
167 |
#### v1.3.1
|
|
|
168 |
* bug fixes
|
|
|
169 |
* prevent users receiving alerts for an activity that they can't see. (Contributed by Julian Boulen)
|
|
|
170 |
* exception handling
|
|
|
171 |
|
|
|
172 |
#### v1.3
|
|
|
173 |
* now works in Moodle 2.5.*
|
|
|
174 |
* time zone adjustment based on recipient of the reminder
|
|
|
175 |
* reminder messages for activities (such as quizes, assignments, etc) are enhanced and visibility of some fields are restricted according to the constraints of such activities (eg: showing description field)
|
|
|
176 |
|
|
|
177 |
#### v1.2
|
|
|
178 |
* now works in Moodle 2.4.*
|
|
|
179 |
* fixed bug when sending reminders based on groups
|
|
|
180 |
* group reminder message content has been made richer by including course and activity details.
|
|
|
181 |
* added a setting to define the prefix for messages being sent, and added another setting to define to show/hide group name in the group reminder message.
|
|
|
182 |
* cron cycle interval for this plugin has been reduced from 1-hour to 15-minutes.
|
|
|
183 |
|
|
|
184 |
#### v1.1
|
|
|
185 |
* fixed bug of repeatedly sending reminders for same event.
|
|
|
186 |
* removed 'Only hidden events from calendar' option from the settings page.
|
|
|
187 |
* removed unused constants from the plugin.
|
|
|
188 |
* improved cron trace of the plugin for ignored events.
|
|
|
189 |
|
|
|
190 |
#### v1.0.1
|
|
|
191 |
* changed default settings
|
|
|
192 |
* removed usage of deprecated functions
|
|
|
193 |
|
|
|
194 |
## License
|
|
|
195 |
|
|
|
196 |
[GNU GPL v3 or later](http://www.gnu.org/copyleft/gpl.html)
|