API Mail
L'API Mail vous permet d'envoyer des mails en PHP avec l'assurance qu'ils arriveront dans la boîte de réception de votre destinataire.
Nous nous chargeons d'ajouter toutes les en-têtes et de formater votre texte correctement.
Mise en place de l'API Mail
- Télécharger le fichier
MailAPI.class.php
, - modifier la classe en ajoutant les informations d'authentification de l'API (voir paragraphe ci-après),
- inclure la classe
MailAPI.class.php
dans votre script PHP, - appeler la fonction statique :
sendMail()
.
Les informations d'authentification de l'API Mail sont les lignes 5 et 6 : API_USER = ''
et API_HASH = ''
de la classe MailAPI.class.php
. Il faut les compléter en renseignant l'USER et le HASH que vous trouverez dans l'onglet " Options" de la page d'administration de votre site.
Fonctionnement de l'API Mail
La fonction statique sendMail()
prend trois ou quatre paramètres :
- l'adresse mail du destinataire,
- l'objet du mail,
- le message du mail,
- l'adresse mail à laquelle vous souhaitez que l'on vous réponde (facultatif).
Le résultat renvoyé par la fonction sendMail()
est un tableau composé de deux clés :
- la clé
is_error
est un booléan qui indique s'il y a eu une erreur lors de la requête à l'API Mail, - la clé
return
contient :- soit une description de l'erreur en cas d'erreur (bad arguments, bad user, not subscribed ou bad hash),
- soit un tableau récapitulatif des données du mail si la requête a été acceptée par l'API Mail. La clé
result
de ce dernier tableau contient la valeur de retour de la fonctionmail()
de PHP :true
si la mail a été envoyé,false
sinon.
Exemple d'utilisation de l'API Mail
Après avoir renseigné votre USER et votre HASH dans la class MailAPI.class.php
, les deux lignes suivantes suffisent à envoyer un mail :
require_once('MailAPI.class.php');
$result = MailAPI::sendMail('example@example.com', 'objet du mail', 'message du mail');