Extension:SendGrid/pl
 Status wydania: stabilneCategory:Stable extensions/pl |
|
|---|---|
| Realizacja | PowiadomieniaCategory:Notification extensions/pl |
| Opis | Enables MediaWiki to use the SendGrid API for email distribution. |
| Autor(zy) | Derick Alangi (X-Savitardyskusja) |
| Ostatnia wersja | 4.0 |
| Polityka zgodności | Snapshots releases along with MediaWiki. Master nie jest kompatybilny wstecznie. |
| MediaWiki | 1.39+Category:Extensions with manual MediaWiki version |
| PHP | 7.4+ |
| Composer | sendgrid/sendgrid Category:Extensions supporting Composer/pl |
| Licencja | Licencja GNU General Public License 2.0 lub nowsza |
| Pobieranie | Category:Extensions in Wikimedia version control/pl README |
|
|
| Quarterly downloads | 2 (Ranked 92nd) |
| Przetłumacz rozszerzenie SendGrid jeżeli jest dostępne na translatewiki.net | |
| Problemy | Otwarte zadania · Zgłoś błąd |
The SendGrid extension enables MediaWiki to send emails through SendGrid's API service.
Instalacja
- Pobierz i umieść plik(i) w katalogu o nazwie
SendGridw folderzeextensions/.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SendGrid - Dodaj poniższy kod na dole twojego pliku LocalSettings.php:
wfLoadExtension( 'SendGrid' );
Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.
composer update in extensions/SendGrid/ folder so that composer can pick up and install the required SendGrid dependencies for the extension to run smoothly.
Konfiguracja
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.
 Uwaga: | 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"
];
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 ).
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