Open main menu

Extension:User Rights Email Notification

MediaWiki extensions manual
OOjs UI icon advanced.svg
User Rights Email Notification
Release status: unmaintained
Implementation Notify, User rights
Description This extension provides a customisable email notification for registered users upon a change in their group memberships.
Author(s) Rob Church
Latest version 1.0
MediaWiki 1.5+
License GNU General Public License 2.0
Download Template:WikimediaDownload/svn
readme
Translate the User Rights Email Notification extension if it is available at translatewiki.net
Check usage and version matrix.

The User Rights Email Notification extension provides a customisable email notification for registered users upon a change in their group memberships.

Skip to the Download

Contents

IntroductionEdit

The user rights email notification extension provides a clean and customisable means to send email messages to one or more registered users upon a change to their group memberships. The behaviour of the extension can be controlled using configuration options within the "LocalSettings.php" file for MediaWiki.

InstallationEdit

  • Download and place the file(s) in a directory called User Rights Email Notification in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/User Rights Email Notification/User Rights Email Notification.php";
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Editing the notification emailEdit

When preparing the email message to be sent to each recipient, the extension relies upon two system messages. You will need to create these if you wish to customise them, as detailed below:

  • MediaWiki:Userrightsnotifysubject

This file contains the subject line for the email.
$1 is replaced with the wiki site name from $wgSitename.

  • MediaWiki:Userrightsnotifybody

This file contains the body text for the email.
$1 is replaced with the username of the recipient;
$2 is replaced with the wiki site name from $wgSitename;
$3 is replaced with the username of the user who made the change;
$4 is replaced with the time and date of the change;
$5 is replaced with a comma-delimited list of groups added;
$6 is replaced with a comma-delimited list of groups removed.

Further configurationEdit

To change the sender email address used (the default is the same as $wgPasswordSender), set the $wgUserRightsNotif['sender'] variable in LocalSettings.php.

NotesEdit

  • On wikis where email address authentication is present and active(1), then no email is sent unless the recipient's email address is validated.

(1) => MediaWiki 1.5 and later

Change LogEdit

Version 1.0

29/03/2006 - Initial release