View source for Extension:MassMessage

<languages/>
{{Extension|templatemode=
|status          = stable
|type1           = special
|type2           = api
|author          = [[User:Legoktm|Kunal Mehta]], [[User:wctaiwan|wctaiwan]]
|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.5.0
|update          = 2023-01-08
|compatibility policy = rel
|mediawiki       = <translate><!--T:12--> 1.25+, use <tvar name=1>REL1_X</tvar> branches for your version of MediaWiki</translate>
|php             =
|schema-registry =
|download        = {{WikimediaDownload|phab=EMAM}}
|readme          = 
|changelog       = 
|tags            = 
|example         = 
|compatibility   = 
|phabricator     = MassMessage
|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><!--T:31--> For help on how to use the extension, see <tvar name=ext-massmsg>{{ll|Help:Extension:MassMessage}}</tvar>.</translate>
<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=required}}

<translate>
== Configuration parameters == <!--T:3-->

<!--T:13-->
; Namespaces to post in</translate>:
<translate>
<!--T:4-->
When posting messages, only post them in the specified namespaces. All talk namespaces are already whitelisted.
</translate>

<syntaxhighlight lang="php">
$wgNamespacesToPostIn = [ NS_PROJECT ];
</syntaxhighlight>

<translate>
<!--T:14-->
; Namespaces to convert</translate>:
<translate>
<!--T:5-->
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.</translate>

<syntaxhighlight lang="php">
$wgNamespacesToConvert = [ NS_USER => NS_USER_TALK ];
</syntaxhighlight>

<translate>
<!--T:15-->
; 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 name=ext-renameuser>Extension:Renameuser</tvar>|rename]] the account. You can ''override'' the default account name by specifying (for example):</translate>

<syntaxhighlight lang="php">
$wgMassMessageAccountUsername = 'MessengerBot';
</syntaxhighlight>

<translate>
<!--T:16-->
; Enable global messaging</translate>:
<translate>
<!--T:7-->
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.
</translate>

<syntaxhighlight lang="php">
$wgAllowGlobalMessaging = true;
</syntaxhighlight>

<translate>
== Maintenance script == <!--T:22-->

<!--T:23-->
You can send messages from the command line with
</translate>

{{pre|1=
php sendMessages.php --pagelist &lt;<translate><!--T:24--> page list file</translate>> --subject &lt;<translate><!--T:25--> subject file</translate>> --message &lt;<translate><!--T:26--> message file</translate>>
}}

<translate>
<!--T:27-->
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--> Lets a user send out messages. By default assigned to the "sysop" user group.</translate>

<translate>
== Notes == <!--T:17-->

<!--T:19-->
Extensions which integrate with this one: [[<tvar name=echo>Special:MyLanguage/Extension:Echo</tvar>|Echo]], [[<tvar name=threads>Special:MyLanguage/Extension:LiquidThreads</tvar>|LiquidThreads]].

== Interface == <!--T:28-->

<!--T:29-->
This extension is visible in three places:

<!--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:}}]]