Open main menu

Extension:SendGrid

This page is a translated version of the page Extension:SendGrid and the translation is 13% complete.

Other languages:
English • ‎español • ‎français • ‎svenska • ‎中文 • ‎日本語
MediaWiki 拡張機能マニュアル
OOjs UI icon advanced.svg
SendGrid
リリースの状態: 安定
実装 通知
説明 Enables MediaWiki to use the SendGrid API for email distribution.
作者 Derick Alangi (X-Savitartalk)
最新バージョン 2.2 (2019-04-28)
互換性ポリシー master
MediaWiki 1.33+
PHP 5.6+
データベースの変更 いいえ
Composer sendgrid/sendgrid
ライセンス GNU 一般公衆利用許諾書 2.0 以降
ダウンロード
README
translatewiki.net で翻訳を利用できる場合は、SendGrid 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
問題点 未解決のタスク · バグを報告

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

インストール

  • ダウンロードして、ファイルを extensions/ フォルダー内の SendGrid という名前のディレクトリ内に配置します。
  • 以下のコードを LocalSettings.php の末尾に追加します:
    wfLoadExtension( 'SendGrid' );
    
  •   完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

MediaWiki 1.24 以前を稼働させている利用者へ:

上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。 この拡張機能をこれらの過去のバージョン (MediaWiki 1.24 以前) にインストールする必要がある場合は、wfLoadExtension( 'SendGrid' ); の代わりに以下を使用する必要があります:

require_once "$IP/extensions/SendGrid/SendGrid.php";
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";


Test your settings

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 ).