MediaWiki extensions manual
MassMessage
Release status: stable
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 Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.25+, use REL1_X branches for your version of MediaWiki
License GNU General Public License 2.0 or later
Download
Help Help:Extension:MassMessage
Parameters
  • $wgNamespacesToConvert
  • $wgMassMessageAccountUsername
  • $wgNamespacesToPostIn
  • $wgAllowlistedMassMessageTargets
  • $wgAllowGlobalMessaging
  • $wgMassMessageWikiAliases
Hooks used
  • ParserFirstCallInit
  • APIQuerySiteInfoStatisticsInfo
  • RenameUserPreRename
  • UserGetReservedNames
  • BeforeEchoEventInsert
  • SkinTemplateNavigation
  • BeforePageDisplay
  • ListDefinedTags
  • ChangeTagsListActive
  • EmailConfirmed
Hooks provided
  • MassMessageJobBeforeMessageSent
Quarterly downloads 54 (Ranked 118th)
Public wikis using 1,039 (Ranked 257th)
Translate the MassMessage extension if it is available at translatewiki.net
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

  • 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 file: 
    wfLoadExtension( 'MassMessage' );
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters

Namespaces to post in

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

$wgNamespacesToPostIn = [ 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 = [ 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

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

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

Notes

If you are using MediaWiki 1.25 – 1.34, MassMessage requires $wgContentHandlerUseDB to be enabled.

Extensions which integrate with this one: Echo, LiquidThreads.

Interface

This extension is visible in three places:

  • Special:CreateMassMessageList, to create delivery lists.
  • Wiki pages with the MassMessageListContent content model, which represent delivery lists. These are automatically categorised under Category:MassMessage delivery lists.
  • Special:MassMessage, to send a message to a delivery list.

See also

  • Extension:MassMessageEmail - Emails users instead of posting on their talk pages.
This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.