Extension:Mailgun

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
Mailgun
Release status: beta
Description Allows MediaWiki to use the Mailgun API service to send emails
Author(s)
Latest version 1.0
Database changes No
Composer mailgun/mailgun-php
License GNU General Public License 2.0 or later
Download

  • $wgMailgunAPIKey
  • $wgMailgunDomain
Translate the Mailgun extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

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

Installation[edit]

  • Download and place the file(s) in a directory called Mailgun in your extensions/ folder.
  • Only when installing from git run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (See T173141 for potential complications.)
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'Mailgun' );
    
  • Configure as required.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

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[edit]

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[edit]