This page is a translated version of the page Extension:SendGrid and the translation is 15% complete.
MediaWiki扩展手册
SendGrid
发行状态: 稳定版
实现 通知
描述 Enables MediaWiki to use the SendGrid API for email distribution.
作者 Derick Alangi (X-Savitar讨论)
最新版本 4.0
兼容性政策 快照跟随MediaWiki发布。 master分支不向后兼容。
MediaWiki 1.39+
PHP 7.4+
Composer sendgrid/sendgrid
许可协议 GNU通用公眾授權條款2.0或更新版本
下載
README
  • $wgSendGridAPIKey
季度下載量 3 (Ranked 151st)
前往translatewiki.net翻譯SendGrid扩展
問題 开启的任务 · 报告错误

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

安裝

  • 下载文件,并将其放置在您extensions/文件夹中的SendGrid目录内。
    开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SendGrid
  • 将下列代码放置在您的LocalSettings.php 的底部:
    wfLoadExtension( 'SendGrid' );
    
  •   完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
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

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.

  警告: 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

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"
];


測試你的設定

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

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

Errors or exceptions

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