API-Übersicht
Mit RealSender können Sie E-Mail-Nachrichten über eine API (Programmierschnittstelle) versenden.
So können Sie E-Mails direkt aus Ihrer Anwendung versenden, ohne den Umweg über SMTP (Simple Mail Transfer Protocol). Aktuell unterstützen wir nur POST-Anfragen.
Serveradresse:
https://rsXXX-api.realsender.com/mail/send
Erforderliche/obligatorische Parameter:
| Parameter |
Beschreibung |
| apiuser |
Benutzername für Authentifizierung |
| API-Passwort |
Authentifizierungspasswort |
| aus |
Absender-E-Mail-Adresse |
| Zu |
E-Mail-Adresse des Empfängers |
| Thema |
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 Fehlerfall erhalten Sie eine Fehlermeldung wie diese:
{"success":false,"errorMsgs":["Bitte geben Sie den Wert für 'subject' an."]}
API-Details
API-Details
Der Inhalt muss im internationalen Zeichensatz UTF-8.
Um dies zu testen, fügen Sie „€uro“ in den Betreff ein und senden Sie die E-Mail ab. Bei einem falschen Zeichensatz erhalten Sie folgende JSON-Warnung:
{"success":false,"errorMsgs":["Der Wert 'subject' ist nicht korrekt kodiert. Er muss UTF-8-kodiert sein."]}
Je nachdem, ob Sie eines oder beide Felder „text“ und/oder „html“ ausgefüllt haben, werden die Nachrichten mit einem der folgenden „Content-Type“-Typen gesendet:
| Parameter |
Beschreibung |
| Text |
text/plain (nur Text) |
| html |
text/html (nur HTML) |
| text+html |
multipart/alternative (sowohl Text als auch HTML) legen fest, welcher Teil angezeigt wird. |
Nicht erforderliche/optionale Parameter:
| Parameter |
Beschreibung |
| Vorname |
Absenderbeschreibung |
| umbenennen |
Empfängerbeschreibung |
| Antwort an |
E-Mail-Adresse, an die die Antworten gesendet werden |
| Rückweg |
Die E-Mail-Adresse, an die die unzustellbaren E-Mails gesendet werden sollen, muss in der Liste der autorisierten Absender von RealSender aufgeführt sein. |
| cc |
E-Mail-Adresse in Kopie |
| ccname |
Beschreibung der Kohlekopie |
| bcc |
E-Mail-Adresse in Blindkopie |
| bccname |
Beschreibung der Blindkopie |
| befestigen |
Anzuhängende Datei(en) – können mehrfach im Formular vorhanden sein – maximale Größe 3 MB. Der Dateiinhalt muss Teil der Multipart-HTTP-POST-Anfrage sein. enctype="multipart/form-data" ist für INPUT TYPE=FILE erforderlich. |
Die Felder „An“, „Cc“ und „Bcc“ können entweder eine einzelne E-Mail-Adresse oder eine durch Kommas getrennte Liste von E-Mail-Adressen.
!! Bei RealSender ist die Gesamtzahl der Empfänger pro E-Mail auf 25 begrenzt (sie kann auf bis zu 100 erhöht werden).
Die Serverantworten erfolgen im JSON-Format (JavaScript Object Notation):
| Beschreibung |
Antwort |
| E-Mail gesendet |
{"success":true} |
| E-Mail nicht gesendet |
{"success":false,"errorMsgs":["..."]} |
API-Beispiele
API-Beispiele
POST-Anfrage
ohne cURL mit PHP
<?php $url = 'https://rsXXX-api.realsender.com/mail/send'; $data = array('apiuser' =>'die von uns bereitgestellte', 'apipass' => 'die von uns bereitgestellte', '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'); // Verwenden Sie den Schlüssel 'http', auch wenn Sie die Anfrage an https:// senden... $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
CURL-Methode
curl -d 'apiuser=der von uns bereitgestellte Benutzername&apipass=der von uns bereitgestellte Benutzername&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, …) –
Methode ohne CURL 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' => 'der von uns bereitgestellte Benutzername', 'apipass' => 'das von uns bereitgestellte Passwort', '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'); 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=die von uns bereitgestellte API-ID' \ -F 'apipass=die von uns bereitgestellte API-ID' \ -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