Extension:MassMessage: Difference between revisions

**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.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	Download extension ; Git [?]: Download Git master; browse repository (Phabricator · GitHub); commit history; repository contributors (GitHub); code review;
Help	Help:Extension:MassMessage
	Parameters $wgNamespacesToConvert; $wgMassMessageAccountUsername; $wgNamespacesToPostIn; $wgAllowlistedMassMessageTargets; $wgAllowGlobalMessaging; $wgMassMessageWikiAliases;
	Added rights massmessage;
	Hooks used APIQuerySiteInfoStatisticsInfo; BeforeEchoEventInsert; BeforePageDisplay; ChangeTagsListActive; ListDefinedTags; ParserFirstCallInit; RejectParserCacheValue; SkinTemplateNavigation::Universal; UserGetReservedNames;
	Hooks provided MassMessageJobBeforeMessageSent;
Quarterly downloads	55 (Ranked 81st)
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

Browse history interactively

← Older edit

Content deleted Content added

VisualWikitext

Inline

Latest revision as of 15:33, 13 July 2024

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 your extensions/ 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.

@@ Line 1: / Line 1: @@
-<languages />
+<languages/>
 {{Extension|templatemode=
 |status          = stable
@@ Line 7: / Line 7: @@
 |description     = <translate><!--T:10--> Allows a user to easily send a message to a list of users.</translate>
 |image           = Screenshot of MassMessage MediaWiki extension.png
-|version         = 0.4.0
+|version         = 0.5.0
-|update          = 2016-12-06
+|update          = 2023-01-08
 |compatibility policy = rel
-|mediawiki       = <translate><!--T:12--> 1.25+, use REL1_X branches for your version of MediaWiki</translate>
+|mediawiki       = <translate><!--T:12--> 1.25+, use <tvar name=1>REL1_X</tvar> branches for your version of MediaWiki</translate>
 |php             =
-|needs-updatephp = No
 |schema-registry =
-|license         = GPL-2.0+
+|download        = {{WikimediaDownload|phab=EMAM}}
-|download        = {{WikimediaDownload}}
 |readme          =
 |changelog       =
-|parameters      =
-* $wgNamespacesToPostIn
-* $wgAllowGlobalMessaging
-* $wgNamespacesToConvert
-* $wgMassMessageAccountUsername
-* $wgMassMessageWikiAliases
 |tags            =
-|rights          =
-* massmessage
 |example         =
 |compatibility   =
 |phabricator     = MassMessage
-|hook1           = ParserFirstCallInit
-|hook2           = SpecialStatsAddExtra
-|hook3           = APIQuerySiteInfoStatisticsInfo
-|hook4           = RenameUserPreRename
-|hook5           = UserGetReservedNames
-|hook6           = BeforeEchoEventInsert
-|hook7           = SkinTemplateNavigation
-|hook8           = BeforePageDisplay
-|hook9           = ListDefinedTags
-|hook10          = ChangeTagsListActive
 |vagrant-role    = massmessage
+|newhook1 = MassMessageJobBeforeMessageSent
 }}
+<translate><!--T:1--> The <tvar name=1>'''MassMessage'''</tvar> extension allows a user to send a message to a list of pages via special page <tvar name=2>[[Special:MassMessage]]</tvar>.</translate>
-<translate>
+<translate><!--T:31--> For help on how to use the extension, see <tvar name=ext-massmsg>{{ll|Help:Extension:MassMessage}}</tvar>.</translate>
-<!--T:1-->
-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 <tvar|ext-massmsg>{{ll|Help:Extension:MassMessage}}</>. The API documentation can be found at [[<tvar|api-massmsg>Special:MyLanguage/Extension:MassMessage/API</>|Extension:MassMessage/API]].
+<translate><!--T:32--> The API documentation can be found at <tvar name=1>{{ll|Extension:MassMessage/API}}</tvar>.</translate>
+<translate>
 == Installation == <!--T:2-->
 </translate>
-{{ExtensionInstall|registration=yes}}
+{{ExtensionInstall|registration=required}}
 <translate>
 == Configuration parameters == <!--T:3-->
 <!--T:13-->
-; Namespaces to post in</translate>
+; Namespaces to post in</translate>:
 <translate>
 <!--T:4-->
@@ Line 60: / Line 43: @@
 <syntaxhighlight lang="php">
-$wgNamespacesToPostIn = array( NS_PROJECT );
+$wgNamespacesToPostIn = [ NS_PROJECT ];
 </syntaxhighlight>
 <translate>
 <!--T:14-->
-; Namespaces to convert</translate>
+; Namespaces to convert</translate>:
 <translate>
 <!--T:5-->
@@ Line 71: / Line 54: @@
 <syntaxhighlight lang="php">
-$wgNamespacesToConvert = array( NS_USER => NS_USER_TALK );
+$wgNamespacesToConvert = [ NS_USER => NS_USER_TALK ];
 </syntaxhighlight>
 <translate>
 <!--T:15-->
-; Username</translate>
+; Username</translate>:
 <translate>
 <!--T:6-->
-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 [[<tvar|ext-renameuser>Extension:Renameuser</>|rename]] the account. You can ''override'' the default account name by specifying (for example):</translate>
+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 [[<tvar name=ext-renameuser>Extension:Renameuser</tvar>|rename]] the account. You can ''override'' the default account name by specifying (for example):</translate>
 <syntaxhighlight lang="php">
@@ Line 87: / Line 70: @@
 <translate>
 <!--T:16-->
-; Enable global messaging</translate>
+; Enable global messaging</translate>:
 <translate>
 <!--T:7-->
@@ Line 110: / Line 93: @@
 <translate>
 <!--T:27-->
-where each line of <code><page list file></code> contains a page name followed by a wiki (database) name, separated by a tab.
+where each line of <code>&lt;page list file></code> contains a page name followed by a wiki (database) name, separated by a tab.
 == User rights == <!--T:8-->
 </translate>
-*<code>massmessage</code> - <translate><!--T:9-->
+*<code>massmessage</code> - <translate><!--T:9--> Lets a user send out messages. By default assigned to the "sysop" user group.</translate>
-Lets a user send out messages. By default assigned to the "sysop" user group.
+<translate>
 == Notes == <!--T:17-->
-<!--T:18-->
-As of version 0.4.0 (current git master for MediaWiki 1.25), MassMessage requires <tvar|useDB><code>{{wg|ContentHandlerUseDB}}</code></> not to have been explicitly set to false.
 <!--T:19-->
-Extensions which integrate with this one: [[<tvar|echo>Special:MyLanguage/Extension:Echo</>|Echo]], [[<tvar|threads>Special:MyLanguage/Extension:LiquidThreads</>|LiquidThreads]].
+Extensions which integrate with this one: [[<tvar name=echo>Special:MyLanguage/Extension:Echo</tvar>|Echo]], [[<tvar name=threads>Special:MyLanguage/Extension:LiquidThreads</tvar>|LiquidThreads]].
-== See also == <!--T:20-->
+== Interface == <!--T:28-->
-<!--T:21-->
+<!--T:29-->
+This extension is visible in three places:
-* <tvar|email>{{ll|Extension:MassMessageEmail}}</> - Emails users instead of posting on their talk pages.
+<!--T:30-->
+* <tvar name=1>[[Special:CreateMassMessageList]]</tvar>, to create delivery lists.</translate>
+<translate>
+<!--T:33-->
+* Wiki pages with the <tvar name=1><code>MassMessageListContent</code></tvar> content model, which represent delivery lists. These are automatically categorised under <tvar name=2>{{ll|Category:MassMessage delivery lists}}</tvar>.</translate>
+<translate>
+<!--T:34-->
+* <tvar name=1>[[Special:MassMessage]]</tvar>, to send a message to a delivery list.
+== See also == <!--T:20-->
 </translate>
+* {{ll|Extension:MassMessageEmail}} - <translate><!--T:21--> Emails users instead of posting on their talk pages.</translate>
 {{OnWikimedia}}
+{{Used by}}
 [[Category:Notification extensions{{#translation:}}]]
 [[Category:ContentHandler extensions{{#translation:}}]]
+[[Category:Extensions with StructuredDiscussions support{{#translation:}}]]

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	Download extension Git ^[?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review
Help	Help:Extension:MassMessage
Parameters $wgNamespacesToConvert $wgMassMessageAccountUsername $wgNamespacesToPostIn $wgAllowlistedMassMessageTargets $wgAllowGlobalMessaging $wgMassMessageWikiAliases
Added rights massmessage
Hooks used APIQuerySiteInfoStatisticsInfo BeforeEchoEventInsert BeforePageDisplay ChangeTagsListActive ListDefinedTags ParserFirstCallInit RejectParserCacheValue SkinTemplateNavigation::Universal UserGetReservedNames
Hooks provided MassMessageJobBeforeMessageSent
Quarterly downloads	55 (Ranked 81^st)
Public wikis using	1,039 (Ranked 257^th)
Translate the MassMessage extension if it is available at translatewiki.net
Vagrant role	massmessage
Issues	Open tasks · Report a bug