Extension:Mailgun

MediaWiki extensions manual

File:OOjs UI icon advanced.svg Mailgun Release status: beta
Description	Allows MediaWiki to use the Mailgun API service to send emails
Author(s)	Tony Thomas Derick Alangi
Latest version	1.0
MediaWiki	>= 1.34.0
Database changes	No
Composer	mediawiki/mailgun
License	GNU General Public License 2.0 or later
Download	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate>
Parameters $wgMailgunDomain $wgMailgunAPIKey $wgMailgunEndpoint
Hooks used AlternateUserMailer
Quarterly downloads
Public wikis using
Translate the Mailgun extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The Mailgun extension allows MediaWiki to send emails through Mailgun API service.

Installation

• <translate> [[<tvar name=2>Special:ExtensionDistributor/Mailgun</tvar>|Download]] and move the extracted <tvar name=name>Mailgun</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
  <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Mailgun
• <translate> Only when installing from Git, run <tvar name=composer>Composer</tvar> to install PHP dependencies, by issuing <tvar name=code>composer install --no-dev</tvar> in the extension directory.</translate> <translate> (See <tvar name=phab><translate> task <tvar name=1>T173141</tvar></translate></tvar> for potential complications.)</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'Mailgun' );
  

• Configure as required.
• File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Configuration

You need to have an account on www.mailgun.com and your custom domain verified with it to use Mailgun for sending/receiving mails. Instructions to do the same can be found in the Mailgun documentation.

Security warning: Please do not paste your Mailgun keys directly in your Mailgun/extension.json

Once you have your domain verified, you will get your Mailgun API key to mass send emails. You should configure your API key and domain in LocalSettings.php:

$wgMailgunAPIKey = "key-asdfasdfasdf";
$wgMailgunDomain = "example.in";

Test your settings

Go to Special:EmailUser and send an email to your own address to verify the working of the mailer. You should be able to see logs of email sessions in your Mailgun logs.

See also

• Manual:Mailgun