Extension:Inbox
Appearance
From mediawiki.org
Release status: experimental |
|
|---|---|
| Author(s) | Stephane Bisson (Sbisson (WMF) talk ) |
| MediaWiki | >= 1.41.0 |
| Database changes | Yes |
|
|
| Licence | GNU General Public License 3.0 or later |
| Download | |
| Translate the Inbox extension if it is available at translatewiki.net | |
| Issues | Open tasks · Report a bug |
Inbox allows a user to see all emails that MediaWiki has sent to them on a single page, Special:Inbox.
Warning Warning: This extension should only be used for development or testing of email-related features and should never be installed on a production or public wiki.
Installation
[edit ]- Download and move the extracted
Inboxfolder to yourextensions/directory.
Developers and code contributors should install the extension from Git instead, using:cdextensions/ gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/Inbox - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'Inbox' ); $wgInboxEnabled = true;
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Yes Done – Navigate to
Special:Versionon your wiki to verify that the extension is successfully installed.
Usage
[edit ]The Inbox extension can be used to test email-related features. It captures emails sent by MediaWiki and displays them on Special:Inbox. If $wgInboxSkipRegularEmail is set to true, it also prevents MediaWiki from trying to actually send emails, which is helpful if you don't have email sending set up locally.
To test an email-related feature:
- Go to Special:ChangeEmail and set an email address on your account.
- This doesn't have to be a real email address, you can use something like
yourname@example.org.
- This doesn't have to be a real email address, you can use something like
- You will see a message saying you have to confirm your email address.
- Go to Special:Inbox. You should see the confirmation email there.
- Open the confirmation email and follow the confirmation link.
- All emails MediaWiki sends to your email address will now appear at Special:Inbox.
Note that Special:Inbox only displays emails sent to the current user's email address, it doesn't show all emails. If you're expecting an email to show up on Special:Inbox but you're not seeing it, check that your user account's email address is the same as the address the email was sent to.
Configuration
[edit ]| Setting | Default | Comment |
|---|---|---|
$wgInboxEnabled
|
false
|
Whether to enable the extension. If this is false, the extension does nothing. |
$wgInboxSkipRegularEmail
|
false
|
If false, emails are both displayed on Special:Inbox and also actually sent as real emails. If true, emails are only displayed on Special:Inbox and are not sent as real emails. |
$wgInboxHideProductionWarningBanner
|
false
|
If false, a warning banner is displayed on every page warning that the Inbox extension is installed, and that it should not be installed on a production wiki. If true, this banner is not displayed. |
Categories:
- Experimental extensions
- Extensions with invalid or missing type
- AlternateUserMailer extensions
- BeforePageDisplay extensions
- LoadExtensionSchemaUpdates extensions
- OutputPageCheckLastModified extensions
- SkinTemplateNavigation::Universal extensions
- GPL licensed extensions
- Extensions in Wikimedia version control
- All extensions