Extension:MassMessage
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.5.0 (2023-01-08) |
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 |
|
|
|
|
Quarterly downloads | 66 (Ranked 76th) |
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 move the extracted
MassMessage
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MassMessage - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'MassMessage' );
- 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
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 extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |
This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |