MediaWiki extensions manual
Release status: stable
Implementation Notify
Description Enables MediaWiki to use the SendGrid API for email distribution.
Author(s) Derick Alangi (X-Savitartalk)
Latest version 4.0
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.39+
PHP 7.4+
Composer sendgrid/sendgrid
License GNU General Public License 2.0 or later
  • $wgSendGridAPIKey
Quarterly downloads 3 (Ranked 145th)
Translate the SendGrid extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The SendGrid extension enables MediaWiki to send emails through SendGrid's API service.

Installation edit

  • Download and move the extracted SendGrid 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/SendGrid
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'SendGrid' );
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
You will have to run composer update in extensions/SendGrid/ folder so that composer can pick up and install the required SendGrid dependencies for the extension to run smoothly.

Configuration edit

You need to have an account on www.sendgrid.com and a valid API key in order to successfully send emails via SendGrid using this extension. Instructions to generate an API key can be found in the SendGrid API key documentation.

  Warning: Security Warning: Do not put your SendGrid API key directly in the SendGrid/extension.json as this will be a vulnerability allowing someone else to be able to use your account/key to send emails or perform other bad stuff.

Configuration on MediaWiki-Vagrant edit

Once your MediaWiki-Vagrant environment is setup correctly, do the following to get SendGrid to work properly with your new environment;

  • On your terminal, run: vagrant roles enable sendgrid.

In your SendGrid account settings, generate an API key. With a valid API Key, configure your API key in LocalSettings.php :

$wgSendGridAPIKey = "YOUR_API_KEY_HERE";

If you're using this extension with SMTP, make sure to configure your SMTP like below:

$wgSMTP = [
      'host'=> "smtp.yoursmtp.org",
      'IDHost'   => "yourhost.org",
      'port'     => 587,
      'auth'     => true,
      'username' => "yourSMTPusername",
      'password' => "yourSMTPpassword"

Test your settings edit

Go to Special:EmailUser and send an email to your own address to verify that the extension is working. You'll receive an email from the address you inputed and check to see if it's sent via the SendGrid API (for example; Your Name example@domain.com via sendgrid.net ).

Usage by production wikis edit

This extension is used by wikis listed here: https://wikiapiary.com/wiki/Extension:SendGrid (via WikiApiary)

Errors or exceptions edit

If your email fails to send and throws an exception, make sure that $wgPasswordSender matches the email sender identifier used in your SendGrid account.

Notice the change here: https://gerrit.wikimedia.org/r/c/mediawiki/extensions/SendGrid/+/833121