Extension:Newsletter
 Release status: stable |
|
|---|---|
 |
|
| Implementation | User interface, Notify |
| Description | Enables users to publish and subscribe to newsletters |
| Author(s) | Tina Johnson, Tony Thomas |
| Latest version | 1.2.1 (2017-07-09) |
| MediaWiki | 1.25+ |
| PHP | 5.4+ |
| Database changes | Yes |
| Tables | nl_issues nl_newsletters nl_publishers nl_subscriptions |
| License | GNU General Public License 2.0 or later |
| Download | |
| Help | Help:Extension:Newsletter/en |
|
|
| Quarterly downloads | 8 (Ranked 125th) |
| Translate the Newsletter extension if it is available at translatewiki.net | |
| Issues | Open tasks · Report a bug |
The Newsletter extension provides a catalog of newsletters registered in a given wiki, an easy way for publishers to announce new issues, and an easy way for users to subscribe/unsubscribe and be notified via web or email when new issues are announced. A "newsletter" is defined as a publication that has a name, a wiki home page, and a single or central wiki page for each issue or edition. For user documentation, check Help:Extension:Newsletter.
You can test the extension at test.wikipedia.org. We welcome feedback and contributions!
Functionality
Special:Newsletters
- List of newsletters that are registered with the service, with their basic information, generated automatically.
- Registered users can subscribe to newsletters in order to receive notifications about new issues announced, via web or email, according to their Echo preferences. It is not expected to offer delivery to user talk pages.
- Registered users can check the newsletters they have subscribed to, and they can unsubscribe.
Special:RegisterNewsletter
- Administrators can add existing newsletters to the system. They must provide the title of the newsletter; a link to an existing wiki page that serves as main page; and a description.
Special:ManageNewsletter
- Publishers can announce issues for newsletters that have been added into the system via Special:RegisterNewsletter. Echo notifications are sent to subscribers when an issue is announced.
- Administrators, existing publishers, and other users granted the rights can add and remove publishers. They must provide the name of the newsletter and username of the publisher. (This is separate from Special:UserRights; the right exists only in relation to a specific newsletter.)
- Administrators, existing publishers and other users granted the rights can also view, add, and remove subscribers from newsletters.
Requirements
- Install Echo - Newsletter extension makes use of Echo notifications to notify subscribed users of new issues when announced by the newsletters, and to notify new publishers and subscribers added.
- In order be registered with the service, a newsletter must have a name, a central "home page" and in order to publish issues/editions and issue notifications, each issue must have its own page (or central page, such as a table of contents).
Installation
- Download and move the extracted
Newsletterfolder 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/Newsletter - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'Newsletter' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
User rights
By default, only users in 'sysop' group have this permissions.
You can set up the user rights in LocalSettings.php.
| Right | Description |
|---|---|
| newsletter-create | Register newsletters |
| newsletter-delete | Delete newsletters |
| newsletter-manage | Add or remove publishers or subscribers from newsletters |
| newsletter-restore | Restore a newsletter |
For example, the following configuration would allow any user to do anything they want with the Newsletter extension, such as creating a new newsletter, deleting an existing newsletter, or managing an existing newsletter by adding or removing publishers.
$wgGroupPermissions['*']['newsletter-create'] = true;
$wgGroupPermissions['*']['newsletter-delete'] = true;
$wgGroupPermissions['*']['newsletter-manage'] = true;
$wgGroupPermissions['*']['newsletter-restore'] = true;
History
This extension was created in 2013, then modified heavily as part of a Google Summer of Code 2015 project. Its development team is formed mostly by volunteers, and we welcome new contributors. After a lot of additional work by other contributors, it was made available to Wikimedia users on July 2017.
See also
- Movement broadcasting (use cases)
- Extension:EmailPage
- Extension:MassMessage
- Extension:TranslationNotifications
- Extension:EmailNotifications
 | 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. |