Sous-sections de l'envoi via l'API

Présentation de l'API

RealSender vous permet d'envoyer des e-mails 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). Pour l'instant, nous ne prenons en charge que les requêtes POST.


Adresse du serveur :
https://rsXXX-api.realsender.com/mail/send


Paramètres obligatoires :

Paramètre
Description
apiuser nom d'utilisateur d'authentification
apipass mot de passe d'authentification
de adresse e-mail de l'expéditeur
à adresse e-mail du destinataire
sujet objet de l'e-mail
texte corps du message en texte brut
html corps du message électronique 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'erreurs, vous obtiendrez quelque chose comme ceci :
{"success":false,"errorMsgs":["Please provide the 'subject' value."]}


Détails de l'API

Détails de l'API

Le contenu doit être envoyé en utilisant le jeu de caractères international UTF-8.
Pour le tester, ajoutez « €uro » dans votre objet et envoyez-le. Si le jeu de caractères est incorrect, vous recevrez cet avertissement au format JSON :

{"success":false,"errorMsgs":["The 'subject' value is not correctly encoded. It must be UTF-8 encoded."]}


Selon que vous ayez renseigné le champ « text » ou les deux champs « text » et « html », les messages seront envoyés en utilisant l'un des types de contenu suivants :

Paramètre
Description
texte texte brut (texte uniquement)
html text/html (html uniquement)
texte+html multipart/alternative (à la fois texte et HTML)
: ce sont les paramètres de votre client de messagerie qui déterminent quelle partie s'affiche

Paramètres non obligatoires/facultatifs :

Paramètre
Description
nom Description de l'expéditeur
toname description du destinataire
Répondre à adresse e-mail à laquelle les réponses seront envoyées
chemin de retour adresse e-mail qui recevra les messages rejetés :
; elle doit figurer parmi les expéditeurs autorisés de RealSender
cc adresse e-mail en copie carbone
ccname Description de la copie carbone
cc adresse e-mail en copie cachée
bccname Description de la copie cachée
joindre Fichier(s) à joindre – peut apparaître plusieurs fois dans le formulaire – taille maximale de 3 Mo
Le contenu du fichier doit faire partie de la requête HTTP POST multipart
L'attribut enctype=« multipart/form-data » est obligatoire pour les éléments 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) :

Description
Réponse
e-mail envoyé {"success":true}
L'e-mail n'a PAS été envoyé {"success":false,"errorMsgs":["..."]}

Exemples d'API

Exemples d'API

Requête POST
Méthode sans CURL avec PHP

<?php
$url = 'https://rsXXX-api.realsender.com/mail/send';
$data = array('apiuser' => 'the one we provided you', 'apipass' => 'the one we provided you', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => 'subject of the message', 'text' => 'email body in plain text', 'html' => 'email body in HTML format');

// use key 'http' even if you send the request to 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);
?>

Requête POST
Méthode CURL

curl -d 'apiuser=celui que nous vous avons fourni&apipass=celui que nous vous avons fourni you&from=sender@example.com&to=recipient@example.com&subject=objet 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/send

Exemples d'API avec pièces jointes

Exemples d'API avec pièces jointes

Requête POST avec pièces jointes (max. 5 : 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' => 'the one we provided you',
              'apipass' => 'the one we provided you',
              'from' => 'sender@example.com',
              'to' => 'recipient@example.com',
              'subject' => 'subject of the message',
              'text' => 'email body in plain text',
              'html' => 'email body in HTML format');
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=objet 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