This Moodle plugin sends an email notification message to the 'Support email' address every time a new Moodle user account is created via the 'Email signup' authentication plugin. The notification message contains some essential details about the account just created (email address, full name and user account name).
The email is sent when the user signs up, not when the user account is confirmed. So the plugin will notify even about accounts that may never be confirmed.
Versions of the plugin up to 1.0.2 works with Moodle 2.7 or later versions. Versions of the plugin from 2.0.0-gdpr-3.6+ onward only work with Moodle 3.6 or later.
This is a standard Moodle Local Plugin, so you can follow the standard installation instructions for Moodle Plugins at https://docs.moodle.org/en/Installing_plugins . Note that if you install this plugin manually at the server, you need to install it inside the 'local' directory at the top of the moodle installation directory.
The plugin has only one configuration setting: the set of authentication plugins that will be monitored to detect user signups. Bear in mind that only those authentication plugins that allow user signups ('Email signup' and 'LDAP' are the only ones in Moodle core), and are enabled in the Moodle site, will be available for selection.
The only other configuration used by the plugin is the Support Contact settings. It uses the standard 'Support name' and 'Support email' Moodle settings as the recipient of the email notification messages it sends.
You can customise the content/wording of the notification messages by
editing the language strings of the plugin, e.g., through the built-in
'Language customisation' mechanism. All the user
table fields and
custom profile fields are available in the $a object as
{$a->signup_valuename}. The syntax of valuename depends on whether
the value comes from the user
table fields or from the custom profile
fields (this is due to an unfortunate limitation of the Moodle
language strings interpolation syntax).
- For the
user
table fields, the syntax for valuename is user_fieldname, where fieldname is one ofuser
table fields likeid
,username
,auth
,firstname
,lastname
, etc. Thepassword
field does not contain the actual password, for security reasons. - For the custom profile fields, the syntax for valuename is profile_profileshortname, where profileshortname is the shortname of the custom profile field.
The following examples may help understand the syntax. Assuming we
have two custom profile fields, whose short names are
signupcategory
and referralcode
, we could use the
following values in the notification message language string (only
some of the user table fields are shown for brevity purposes):
{$a->signup_user_id}
: this will be substituted by the accountid
.{$a->signup_user_username}
: this will be substituted by the accountusername
.{$a->signup_user_lastname}
: this will be substituted by the accountlastname
.{$a->signup_user_city}
: this will be substituted by the accountcity
.{$a->signup_profile_signupcategory}
: this will be substituted by the content of the custom profile field whose shortname issignupcategory
.{$a->signup_profile_referralcode}
: this will be substituted by the content of the custom profile field whose shortname isreferralcode
.