Release status: stable
|Description||Enables MediaWiki to use the SendGrid API for email distribution.|
|Author(s)||Derick Alangi (X-Savitartalk)|
|Compatibility policy||Snapshots releases along with MediaWiki. Master is not backward compatible.|
|License||GNU General Public License 2.0 or later|
|Quarterly downloads||12 (Ranked 156th)|
|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.
- Download and place the file(s) in a directory called
- Add the following code at the bottom of your
wfLoadExtension( 'SendGrid' );
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.24 or earlier:
The instructions above describe the new way of installing this extension using
If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of
wfLoadExtension( 'SendGrid' );, you need to use:
extensions/SendGrid/folder so that composer can pick up and install the required SendGrid dependencies for the extension to run smoothly.
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.
Configuration on MediaWiki-VagrantEdit
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 settingsEdit
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 firstname.lastname@example.org via sendgrid.net ).
Usage by production wikisEdit
This extension is used by wikis listed here: https://wikiapiary.com/wiki/Extension:SendGrid (via WikiApiary)
Errors or exceptionsEdit
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