Extension:MassMessage

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
Deutsch • ‎English • ‎català • ‎dansk • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎sicilianu • ‎suomi • ‎русский • ‎العربية • ‎سنڌي • ‎پښتو • ‎हिन्दी • ‎মেইতেই লোন্ • ‎中文 • ‎日本語 • ‎한국어
MediaWiki extensions manual
Crystal Clear action run.svg
MassMessage
Release status: stable
Screenshot of MassMessage MediaWiki extension.png
Implementation Special page, API
Description Allows a user to easily send a message to a list of users.
Author(s) Kunal Mehta, wctaiwan
Latest version 0.4.0 (2016-12-06)
Compatibility policy release branches
MediaWiki 1.25+, use REL1_X branches for your version of MediaWiki
Database changes No
License GNU General Public License 2.0 or later
Download
Parameters
  • $wgNamespacesToPostIn
  • $wgAllowGlobalMessaging
  • $wgNamespacesToConvert
  • $wgMassMessageAccountUsername
  • $wgMassMessageWikiAliases
Added rights
  • massmessage
Hooks used
ParserFirstCallInit
SpecialStatsAddExtra
APIQuerySiteInfoStatisticsInfo
RenameUserPreRename
UserGetReservedNames
BeforeEchoEventInsert
SkinTemplateNavigation
BeforePageDisplay
ListDefinedTags
ChangeTagsListActive
Translate the MassMessage extension if it is available at translatewiki.net
Check usage and version matrix.
Vagrant role massmessage
Issues Open tasks · Report a bug

The MassMessage extension allows a user to send a message to a list of pages via special page Special:MassMessage. For help on how to use the extension, see Help:Extension:MassMessage . The API documentation can be found at Extension:MassMessage/API.

Installation[edit]

  • Download and place the file(s) in a directory called MassMessage in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'MassMessage' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'MassMessage' );, you need to use:

require_once "$IP/extensions/MassMessage/MassMessage.php";

Configuration parameters[edit]

Namespaces to post in

When posting messages, only post them in the specified namespaces. All talk namespaces are already whitelisted.

$wgNamespacesToPostIn = array( NS_PROJECT );
Namespaces to convert

If you want users to be able to provide a link to a User: page, but have the bot post on their User talk: page you can define that here.

$wgNamespacesToConvert = array( NS_USER => NS_USER_TALK );
Username

What username the bot should post with. By default, this is "MediaWiki message delivery". If the user already exists, the extension will take over the account. It will be impossible for users to rename the account. You can override the default account name by specifying (for example):

$wgMassMessageAccountUsername = 'MessengerBot';
Enable global messaging

Whether to enable sending messages from one wiki to another. If running on a wikifarm setup like Wikimedia, you can disable this on all wikis except one to keep the logs in one place.

$wgAllowGlobalMessaging = true;

Maintenance script[edit]

You can send messages from the command line with

php sendMessages.php --pagelist <page list file> --subject <subject file> --message <message file>

where each line of <page list file> contains a page name followed by a wiki (database) name, separated by a tab.


User rights[edit]

  • massmessage - Lets a user send out messages. By default assigned to the "sysop" user group.

Notes[edit]

As of version 0.4.0 (current git master for MediaWiki 1.25), MassMessage requires $wgContentHandlerUseDB not to have been explicitly set to false.

Extensions which integrate with this one: Echo, LiquidThreads.

See also[edit]