Extension:SendGrid

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:SendGrid and the translation is 33% complete.

Other languages:
English • ‎español • ‎français • ‎svenska • ‎中文 • ‎日本語
Manuel des extensions MediaWiki
OOjs UI icon advanced.svg
SendGrid
État de la version : stable
Implémentation Notify
Description Enables MediaWiki to use the SendGrid API for email distribution.
Auteur(s) Derick N. Alangi (X-Savitartalk)
Dernière version 2.1 (2018-10-20)
Compatibility policy master
MediaWiki 1.31+
PHP 7.0+
Changements
base de données
Non
Composer sendgrid/sendgrid
Licence GNU General Public License 2.0 or later
Téléchargement
README
Accroches utilisées
AlternateUserMailer
Traduisez l’extension SendGrid sur translatewiki.net
Vérifiez la matrice des utilisations et des versions.
Problèmes Tâches ouvertes · Signalez un bug

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

Installation

  • Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé SendGrid dans votre dossier extensions/.
  • Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
    wfLoadExtension( 'SendGrid' );
    
  • Yes Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Pour les utilisateurs de MediaWiki 1.24 ou précédents :

Les instructions ci-dessous décrivent la nouvelle procédure pour installer cette extension en utilisant wfLoadExtension() Si vous avez besoin d'installer cette extension sur les précédentes versions de MediaWiki (1.24 ou précédent), à la place de wfLoadExtension( 'SendGrid' );, vous devez utiliser :

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.

Avertissement Avertissement : Security Warning: Do not paste your SendGrid keys directly in your SendGrid/extension.json as this will be a vulnerability making someone else to be able to use your account to send emails or perform other bad stuff.

Configuration sur MediaWiki-Vagrant

Once your MediaWiki-Vagrant environment is setup correctly, do the following to get SendGrid to work properly with your new environment;

  • Dans votre fenêtre terminal, exécutez : 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";

Testez vos paramètres

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