Erweiterung:SendGrid

From mediawiki.org
This page is a translated version of the page Extension:SendGrid and the translation is 25% complete.
MediaWiki-Erweiterungen
SendGrid
Freigabestatus: stabil
Einbindung Benachrichtigung
Beschreibung Ermöglicht MediaWiki, die SendGrid-API für die E-Mail-Verteilung zu verwenden.
Autor(en) Derick Alangi (X-SavitarDiskussion)
Letzte Version 4.0
Kompatibilitätspolitik Snapshots werden zusammen mit MediaWiki veröffentlicht. Der Master ist nicht abwärtskompatibel.
MediaWiki 1.39+
PHP 7.4+
Composer sendgrid/sendgrid
Lizenz GNU General Public License 2.0 oder neuer
Herunterladen
README
  • $wgSendGridAPIKey
Quarterly downloads 9 (Ranked 131st)
Übersetze die SendGrid-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Probleme Offene Aufgaben · Einen Fehler melden

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

Installation

  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens SendGrid im Ordner extensions/ ablegen.
    Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SendGrid
  • Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:
    wfLoadExtension( 'SendGrid' );
    
  • Yes Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
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.

Konfiguration

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.

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


Teste deine Einstellungen

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