Sujets abordés dans ce domaine :
Adresse du serveur, paramètres obligatoires, réponses JSON
charset, content-type, paramètres optionnels, réponses JSON
Exemples PHP et curl
Exemples PHP et curl avec pièces jointes
RealSender vous permet d'envoyer des messages électroniques via une API (Interface de Programmation d'Application).
Vous pouvez ainsi envoyer les e-mails directement depuis votre application, sans passer par le protocole SMTP (Simple Mail Transfer Protocol). Actuellement, seules les requêtes POST.
Adresse du serveur :
https://rsXXX-api.realsender.com/mail/send
Paramètres requis/obligatoires :
| apiuser | nom d'utilisateur d'authentification |
| apipass | mot de passe d'authentification |
| depuis | adresse e-mail de l'expéditeur |
| à | adresse e-mail du destinataire |
| sujet | Objet du courriel |
| texte | Corps du courriel en texte brut |
| HTML | Corps de l'e-mail au format HTML |
Si tout se passe bien, le message sera envoyé et vous recevrez une réponse JSON positive :
{"success":true}
En cas d'erreur, vous obtiendrez un résultat similaire à celui-ci :
{"success":false,"errorMsgs":["Veuillez fournir la valeur du sujet."]}
Le contenu doit être envoyé en utilisant l' encodage de caractères international UTF-8.
Pour le tester, ajoutez « €uro » à l'objet et soumettez votre message. Si l'encodage est incorrect, vous recevrez l'avertissement JSON suivant :
{"success":false,"errorMsgs":["La valeur 'subject' n'est pas correctement encodée. Elle doit être encodée en UTF-8."]}
Selon que vous ayez rempli un ou les deux champs « text » et « html », les messages seront envoyés en utilisant l’un de ces « Content-Type » :
| texte | texte/brut (texte uniquement) |
| HTML | texte/html (html uniquement) |
| texte+html | multipart/alternative (texte et HTML) détermineront quelle partie est affichée. |
Paramètres non obligatoires/optionnels :
| nom de famille | description de l'expéditeur |
| nom | description du destinataire |
| répondre | adresse e-mail qui recevra les réponses |
| chemin de retour | L'adresse électronique qui recevra les courriels non retournés doit figurer parmi les expéditeurs autorisés de RealSender. |
| cc | adresse e-mail en copie carbone |
| nom du compte | description de la copie carbone |
| bcc | adresse e-mail en copie cachée |
| nom bcc | description de la copie carbone invisible |
| attacher | Fichier(s) à joindre - peuvent être présents plusieurs fois dans le formulaire - poids maximal de 3 Mo. Le contenu du fichier doit faire partie de la requête HTTP POST multipart . L'enctype « multipart/form-data » est requis pour INPUT TYPE=FILE. |
Les champs À, Cc et Cci peuvent contenir une seule adresse e-mail ou une liste d'adresses e-mail séparées par des virgules.
!! Dans RealSender, le nombre total de destinataires pour chaque e-mail est limité à 25 (il peut être augmenté jusqu'à 100).
Les réponses du serveur sont au format JSON (JavaScript Object Notation) :
| Courriel envoyé | {"succès":true} |
| Courriel non envoyé | {"success":false,"errorMsgs":["..."]} |
Requête POST
sans CURL avec PHP
<?php $url = 'https://rsXXX-api.realsender.com/mail/send'; $data = array('apiuser' =>'celle que nous vous avons fournie', 'apipass' => 'celle que nous vous avons fournie', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => 'sujet du message', 'text' => 'corps de l'e-mail en texte brut', 'html' => 'corps de l'e-mail au format HTML'); // utiliser la clé 'http' même si vous envoyez la requête à https://... $options = array( 'http' => array( 'header' => "Content-type: application/x-www-form-urlencoded\r\n", 'method' => 'POST', 'content' => http_build_query($data), ), ); $context = stream_context_create($options); $result = file_get_contents($url, false, $context); var_dump($result); ?>de requête POST
CURL
curl -d 'apiuser=celui que nous vous avons fourni&apipass=celui que nous vous avons fourni&from=sender@example.com&to=recipient@example.com&subject=sujet du message&text=corps de l'e-mail en texte brut&html=corps de l'e-mail au format HTML'https://rsXXX-api.realsender.com/mail/sendRequête POST avec pièces jointes (5 max : attach1, attach2, …).
Méthode sans CURL avec PHP.
<?php require_once 'HTTP/Request2.php'; $config = array('use_brackets' =>false, ); $request = new HTTP_Request2('https://rsXXX-api.realsender.com/mail/send', HTTP_Request2::METHOD_POST, $config); $data = array('apiuser' => 'celui que nous vous avons fourni', 'apipass' => 'celui que nous vous avons fourni', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => 'sujet du message', 'text' => 'corps de l'e-mail en texte brut', 'html' => 'corps de l'e-mail au format HTML'); foreach ($data as $k => $d) { $request->addPostParameter($k, $d); }; $request->addUpload('attach1', './sample.pdf', 'sample.pdf', 'application/pdf'); $request->addUpload('attach2', './sample.txt', 'sample.txt', 'text/plain'); $result = $request->send(); var_dump($result); ?>Requête POST avec pièces jointes
(méthode CURL)
curl -F 'apiuser=celui que nous vous avons fourni' \ -F 'apipass=celui que nous vous avons fourni' \ -F 'from=sender@example.com' \ -F 'to=recipient@example.com' \ -F 'subject=sujet du message' \ -F 'text=corps de l'e-mail en texte brut' \ -F 'html=corps de l'e-mail au format HTML' \ -F 'attach=@sample.pdf;type=application/pdf' \ -F 'attach=@sample.txt;type=text/plain' \ https://rsXXX-api.realsender.com/mail/send