Unterabschnitte zum Thema „Versenden über API“

API-Übersicht

Mit RealSender können Sie E-Mails über eine API (Application Programming Interface) versenden.

Auf diese Weise können Sie die E-Mails direkt aus Ihrer Anwendung versenden, ohne den Umweg über SMTP (Simple Mail Transfer Protocol) zu nehmen. Derzeit unterstützen wir ausschließlich POST-Anfragen.


Serveradresse:
https://rsXXX-api.realsender.com/mail/send


Erforderliche/obligatorische Parameter:

Parameter
Beschreibung
apiuser Benutzername für die Authentifizierung
apipass Authentifizierungspasswort
von E-Mail-Adresse des Absenders
zu E-Mail-Adresse des Empfängers
Betreff Betreff der E-Mail
Text E-Mail-Text im Klartext
html E-Mail-Text im HTML-Format

Wenn alles in Ordnung ist, wird die Nachricht gesendet und Sie erhalten eine positive JSON-Antwort:
{"success":true}

Im Falle von Fehlern wird etwa Folgendes angezeigt:
{"success":false,"errorMsgs":["Please provide the 'subject' value."]}


API-Details

API-Details

Der Inhalt muss im internationalen Zeichensatz UTF-8 gesendet werden.
Um dies zu testen, fügen Sie „€uro“ in Ihre Betreffzeile ein und senden Sie die Nachricht ab. Wenn der Zeichensatz falsch ist, erhalten Sie folgende JSON-Warnung:

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


Je nachdem, ob Sie das Feld „text“ oder beide Felder („text“ und „html“) ausgefüllt haben, werden die Nachrichten mit einem der folgenden „Content-Type“-Angaben versendet :

Parameter
Beschreibung
Text text/plain (nur Text)
html text/html (nur HTML)
Text+HTML multipart/alternative (sowohl Text als auch HTML)
– Die Einstellungen des E-Mail-Clients entscheiden darüber, welcher Teil angezeigt wird

Nicht erforderliche/optionale Parameter:

Parameter
Beschreibung
Absender Absenderbeschreibung
toname Beschreibung des Empfängers
Antworten an E-Mail-Adresse, an die die Antworten gesendet werden
Rückweg E-Mail-Adresse, an die die zurückgewiesenen E-Mails gesendet werden:
. Diese muss in der Liste der autorisierten Absender des RealSenders enthalten sein.
cc E-Mail-Adresse im BCC-Feld
ccname Beschreibung der Durchschrift
bcc E-Mail-Adresse für die Blindkopie
bccname Beschreibung der Blindkopie
anhängen Anhang(e) – können im Formular mehrfach vorkommen – maximale Größe 3 MB
Der Dateiinhalt muss Teil des Multipart-HTTP-POST-Anrufs sein
enctype=“multipart/form-data” ist für INPUT TYPE=FILE erforderlich

Die Felder „An“, „cc“ und „bcc“ können eine einzelne E-Mail-Adresse oder eine durch Kommas getrennte Liste von E-Mail-Adressen enthalten.
!! In RealSender ist die Gesamtzahl der Empfänger pro E-Mail auf 25 begrenzt (sie kann auf bis zu 100 erhöht werden).


Die Antworten des Servers liegen im JSON-Format (JavaScript Object Notation) vor:

Beschreibung
Antwort
E-Mail gesendet {"success":true}
E-Mail wurde NICHT gesendet {"success":false,"errorMsgs":["..."]}

API-Beispiele

API-Beispiele

POST-Anfrage an
CURL-freie Methode mit 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);
?>

POST-Anfrage an
CURL-Methode

curl -d 'apiuser=der von uns bereitgestellte&apipass=der von uns bereitgestellte you&from=sender@example.com&to=recipient@example.com&subject=Betreff der Nachricht&text=E-Mail-Text im Klartext&html=E-Mail-Text im HTML-Format'https://rsXXX-api.realsender.com/mail/send

API-Beispiele mit Anhängen

API-Beispiele mit Anhängen

POST-Anfrage mit Anhängen (max. 5: attach1, attach2, …)
CURL-freie Methode mit 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);
?>

POST-Anfrage mit Anhängen
CURL-Methode

curl -F 'apiuser=der von uns bereitgestellte' \
      -F 'apipass=der von uns bereitgestellte' \
      -F 'from=sender@example.com' \
      -F 'to=recipient@example.com' \
      -F 'subject=Betreff der Nachricht' \
      -F 'text=E-Mail-Text im Klartext' \
      -F 'html=E-Mail-Text im HTML-Format' \
      -F 'attach=@sample.pdf;type=application/pdf' \
      -F 'attach=@sample.txt;type=text/plain' \
      https://rsXXX-api.realsender.com/mail/send