Extension:Mailgun

MediaWiki extensions manual

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	mailgun/mailgun-php
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parameters $wgMailgunDomain $wgMailgunAPIKey $wgMailgunEndpoint
Hooks used AlternateUserMailer
Quarterly downloads	3 (Ranked 137th)
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

• Download and move the extracted Mailgun 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/Mailgun
• Only when installing from Git, run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (See task T173141 for potential complications.)
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'Mailgun' );
  

• Configure as required.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

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