Extension:SendGrid

Příručka k rozšířením MediaWiki

SendGrid Stav rozšíření: stabilní
Implementace	Oznámení
Popis	Umožňuje MediaWiki používat API SendGrid pro distribuci e-mailů.
Autoři	Derick Alangi (X-Savitardiskuse)
Nejnovější verze	4.0
Zásady kompatibility	Vydání snímků současně s MediaWiki. Hlavní vývojová větev není zpětně kompatibilní.
MediaWiki	1.40+
PHP	7.4+
Composer	sendgrid/sendgrid
Licence	GNU General Public License 2.0 nebo novější
Stáhnout	Stáhněte si rozšíření Git [?]: Procházení úložiště (GitHub) Kontrola kódu Gerrit Zobrazení historie Git Stáhněte si zdrojový soubor tarball README
Parametry $wgSendGridAPIKey
Použité háčky (hooks) AlternateUserMailer
Přeložte rozšíření SendGrid, používá-li lokalizaci z translatewiki.net
Problémy	Otevřené úkoly · Nahlásit chybu

Rozšíření SendGrid umožňuje MediaWiki odesílat e-maily prostřednictvím služby API SendGrid.

Instalace

• Stáhněte soubor/y a vložte je do adresáře pojmenovaného SendGrid ve vaší složce extensions/.
  Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SendGrid
  

• Na konec vašeho souboru LocalSettings.php přidejte následující kód:

  wfLoadExtension( 'SendGrid' );
  

• Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.

Instalace Vagrant:

• Pokud používáte Vagrant , instalujte s těmito parametry vagrant roles enable sendgrid --provision

Budete muset spustit composer update ve složce extensions/SendGrid/, aby composer mohl stáhnout a nainstalovat požadované závislosti SendGrid pro hladký chod rozšíření.

Konfigurace

Pro úspěšné odesílání e-mailů přes SendGrid pomocí tohoto rozšíření musíte mít účet na www.sendgrid.com a platný klíč API. Pokyny k vygenerování klíče API naleznete v dokumentaci ke klíči SendGrid API.

Bezpečnostní varování: Nevkládejte klíč SendGrid API přímo do souboru SendGrid/extension.json, protože by to byla zranitelnost, která by umožnila někomu jinému použít váš účet/klíč k odesílání e-mailů nebo provádění jiných nekalých činností.

V nastavení účtu SendGrid vygenerujte klíč API. S platným klíčem API nakonfigurujte svůj klíč API v LocalSettings.php :

$wgSendGridAPIKey = "YOUR_API_KEY_HERE";

Pokud toto rozšíření používáte se SMTP, nezapomeňte nakonfigurovat SMTP takto:

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

Otestujte si nastavení

Přejděte na Special:EmailUser a odešlete e-mail na svou vlastní adresu, abyste ověřili, zda rozšíření funguje. Z zadané adresy obdržíte e-mail a zkontrolujete, zda byl odeslán prostřednictvím rozhraní SendGrid API (například: váš název rozšíření@domain.com via sendgrid.net).

Chyby nebo výjimky

Pokud se odeslání e-mailu nepodaří a dojde k výjimce, ujistěte se, že hodnota $wgPasswordSender odpovídá identifikátoru odesílatele e-mailu použitému ve vašem účtu SendGrid.

Všimněte si změny: https://gerrit.wikimedia.org/r/c/mediawiki/extensions/SendGrid/+/833121