E-Mail-API-Dokumentation: SMTP und IMAP.
Verbinden Sie Ihr eigenes SMTP- und IMAP-Postfach mit einem Konto- und einem Postfach-API-Schlüssel. Verwenden Sie beide in HTTP-Anfragen, um das ausgewählte Postfach zu senden, zu lesen und zu verwalten.
https://api.mailbridgeapi.comAPI- und Produktänderungen verfolgen.
Prüfen Sie veröffentlichte Änderungen an Endpoints, Dokumentation und Plattform, bevor Sie eine Integration anpassen.
Änderungsprotokoll öffnenBauen mit einem KI-Assistenten?
Nutzen Sie unsere durchsuchbare Wissensdatenbank, Volltextreferenz und schreibgeschützte API, um Ihrem Assistenten eine quellengestützte MailBridgeAPI-Dokumentation zur Verfügung zu stellen.
Entdecken Sie die WissensdatenbankIhre erste Anfrage, in drei Schritten
Lesen Sie zunächst Ihren Posteingang. Sobald Sie eine erfolgreiche Antwort sehen, können Sie versuchen, eine Nachricht zu senden.
Schließen Sie Ihre Schlüssel an
Fügen Sie den API-Schlüssel Ihres Kontos und den Schlüssel für ein konfiguriertes Postfach ein. Klicken Sie auf „Verbinden“.
Rufen Sie Ihren Posteingang ab
Öffnen Sie „E-Mails abrufen“, behalten Sie INBOX bei und beginnen Sie mit 0, und klicken Sie dann auf „E-Mails abrufen“.
Lesen Sie das Ergebnis
HTTP 200 bedeutet, dass der Server geantwortet hat. result.error = „0“ zeigt Erfolg an; E-Mails befinden sich in result.emaillist.
Probieren Sie die API mit Ihrem Postfach aus
Verbinden Sie Ihren Kontoschlüssel, wählen Sie ein Postfach aus und führen Sie dann unten eine Anfrage aus. Diese Anfragen nutzen den Live-Dienst MailBridgeAPI.
Schlüssel bleiben im Speicher dieser Seite und werden beim Trennen oder Neuladen gelöscht. Anfragen werden über den Server dieser Website an MailBridgeAPI weitergeleitet.
MEHR ALS SENDEN UND EMPFANGEN
Professionelle Endpoints für Ihr Postfach.
Prüfen Sie die Konfiguration, Aktivität und einzelne Nachrichten, erstellen Sie Berichte und validieren Sie Sendungen vor SMTP. Alle Endpoints verwenden dieselben Schlüssel.
Header für neue Integrationen verwenden
Senden Sie den Kontoschlüssel in X-API-Key und den Postfachschlüssel in X-Mailbox-Key. apikey und apikeybox bleiben kompatibel. Speichern Sie beide serverseitig.
X-API-KeyX-Mailbox-Key/mailbox/status/Postfachstatus
Prüft SMTP, IMAP und Funktionen ohne Zugangsdaten offenzulegen.
Für Einrichtung, Monitoring und Support.
Anfragebeispiel+
<?php
$params = [
];
$query = http_build_query($params);
$url = 'https://api.mailbridgeapi.com/mailbox/status/' . ($query === '' ? '' : '?' . $query);
$headers = [
'X-API-Key: ' . getenv('MAILBRIDGE_API_KEY'),
'X-Mailbox-Key: ' . getenv('MAILBRIDGE_BOX_KEY'),
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);Mit verbundenen Schlüsseln testenLIVE
Führen Sie den Endpoint aus.
/email/sent/Gesendete E-Mails
Paginierte Historie mit Filtern für Status, Empfänger, Datum und Quelle.
Für Zustellübersichten und SMTP-Fehler.
pageper_pagestatusrecipientfromtosourceinclude_bodyAnfragebeispiel+
<?php
$params = [
'page' => '1',
'per_page' => '5',
'status' => 'all',
];
$query = http_build_query($params);
$url = 'https://api.mailbridgeapi.com/email/sent/' . ($query === '' ? '' : '?' . $query);
$headers = [
'X-API-Key: ' . getenv('MAILBRIDGE_API_KEY'),
'X-Mailbox-Key: ' . getenv('MAILBRIDGE_BOX_KEY'),
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);Mit verbundenen Schlüsseln testenLIVE
Führen Sie den Endpoint aus.
/email/received/Empfangene E-Mails
Gespeicherte Nachrichten mit Pagination und Filtern.
Für Support, CRM und Verarbeitung.
pageper_pagesenderfromtoinclude_bodyAnfragebeispiel+
<?php
$params = [
'page' => '1',
'per_page' => '5',
];
$query = http_build_query($params);
$url = 'https://api.mailbridgeapi.com/email/received/' . ($query === '' ? '' : '?' . $query);
$headers = [
'X-API-Key: ' . getenv('MAILBRIDGE_API_KEY'),
'X-Mailbox-Key: ' . getenv('MAILBRIDGE_BOX_KEY'),
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);Mit verbundenen Schlüsseln testenLIVE
Führen Sie den Endpoint aus.
/email/message/Nachrichtendetail
Eine gesendete oder empfangene Nachricht per MailBridgeAPI-ID abrufen.
Vollständigen Inhalt nur bei Bedarf laden.
directionidAnfragebeispiel+
<?php
$params = [
'direction' => 'sent',
'id' => '',
];
$query = http_build_query($params);
$url = 'https://api.mailbridgeapi.com/email/message/' . ($query === '' ? '' : '?' . $query);
$headers = [
'X-API-Key: ' . getenv('MAILBRIDGE_API_KEY'),
'X-Mailbox-Key: ' . getenv('MAILBRIDGE_BOX_KEY'),
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);Mit verbundenen Schlüsseln testenLIVE
Führen Sie den Endpoint aus.
/email/activity/Postfachaktivität
Summen und tägliche Datenreihe für 1 bis 90 Tage.
Für Diagramme und Berichte.
daysAnfragebeispiel+
<?php
$params = [
'days' => '30',
];
$query = http_build_query($params);
$url = 'https://api.mailbridgeapi.com/email/activity/' . ($query === '' ? '' : '?' . $query);
$headers = [
'X-API-Key: ' . getenv('MAILBRIDGE_API_KEY'),
'X-Mailbox-Key: ' . getenv('MAILBRIDGE_BOX_KEY'),
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);Mit verbundenen Schlüsseln testenLIVE
Führen Sie den Endpoint aus.
/email/validate/Preflight-Validierung
Empfänger, Betreff, Inhalt, Format und SMTP prüfen, ohne zu senden.
Fehler vor /sendemail/ erkennen.
recipient_emailmail_subjectmail_bodyformatAnfragebeispiel+
<?php
$payload = [
'recipient_email' => 'developer@example.com',
'mail_subject' => 'Preflight validation',
'mail_body' => 'This payload is validated without sending an email.',
'format' => 'text',
];
$headers = [
'X-API-Key: ' . getenv('MAILBRIDGE_API_KEY'),
'X-Mailbox-Key: ' . getenv('MAILBRIDGE_BOX_KEY'),
];
$headers[] = 'Content-Type: application/json';
$ch = curl_init('https://api.mailbridgeapi.com/email/validate/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_POSTFIELDS => json_encode($payload, JSON_THROW_ON_ERROR),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);Mit verbundenen Schlüsseln testenLIVE
Führen Sie den Endpoint aus.
/mailbox/insights/Postfach-Einblicke
Zuverlässigkeit, Empfangsvolumen, letzte Aktivität und Fehler in einer Ansicht.
Für Statusseiten, Warnungen und Betriebsansichten.
daysAnfragebeispiel+
<?php
$params = [
'days' => '30',
];
$query = http_build_query($params);
$url = 'https://api.mailbridgeapi.com/mailbox/insights/' . ($query === '' ? '' : '?' . $query);
$headers = [
'X-API-Key: ' . getenv('MAILBRIDGE_API_KEY'),
'X-Mailbox-Key: ' . getenv('MAILBRIDGE_BOX_KEY'),
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);Mit verbundenen Schlüsseln testenLIVE
Führen Sie den Endpoint aus.
/email/search/Einheitliche E-Mail-Suche
Gesendete und empfangene Metadaten nach ID, Betreff oder Adresse durchsuchen.
Konversationen in beiden Richtungen finden.
querydirectionpageper_pagefromtoAnfragebeispiel+
<?php
$params = [
'query' => 'invoice',
'direction' => 'all',
'page' => '1',
'per_page' => '10',
];
$query = http_build_query($params);
$url = 'https://api.mailbridgeapi.com/email/search/' . ($query === '' ? '' : '?' . $query);
$headers = [
'X-API-Key: ' . getenv('MAILBRIDGE_API_KEY'),
'X-Mailbox-Key: ' . getenv('MAILBRIDGE_BOX_KEY'),
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);Mit verbundenen Schlüsseln testenLIVE
Führen Sie den Endpoint aus.
Wählen Sie, was Sie tun möchten
Lesen Sie bis zu 30 E-Mails aus einem IMAP-Ordner.
Senden Sie eine E-Mail aus Ihrem verbundenen Postfach.
Lesen Sie die Opt-out-Datensätze, um Ihre Kontaktliste zu aktualisieren.
Zwei Schlüssel. Zwei verschiedene Jobs.
Verwenden Sie bei jeder Anfrage beide Werte. Ihr E-Mail-Passwort wird in API-Anfragen nicht verwendet.
apikeyKonto-API-Schlüssel
Identifiziert Ihr Konto. Finden Sie es in Ihrem MailBridgeAPI-Dashboard.
apikeyboxPostfach-API-Schlüssel
Wählt das Postfach zum Senden oder Lesen aus. Dies ist der Wert apikeybox in Ihrem Dashboard.
Für Anfragen sind zwei Werte erforderlich: apikey identifiziert Ihr Konto; apikeybox wählt ein konfiguriertes Postfach aus. Beispiele verwenden die dokumentierten Anforderungsparameter. Behalten Sie Schlüssel in serverseitigen Umgebungsvariablen bei.
Authentifizierung — Optional
Für GET-Endpunkte können Abfrageparameter in Protokollen angezeigt werden. Die veröffentlichte Referenz beschreibt auch die Bearer-Authentifizierung für den Kontoschlüssel; Überprüfen Sie die Unterstützung Ihrer Integration, bevor Sie sie übernehmen.
/getemail/E-Mails abrufen
Lesen Sie Nachrichten aus einem ausgewählten IMAP-Ordner. Das Ergebnis enthält eine UID-geschlüsselte Karte unter result.emaillist. Jede Seite enthält bis zu 30 Nachrichten; Erhöhen Sie Start um 30, um die nächste Seite abzurufen.
Probieren Sie diesen Endpunkt ausLIVE
Verbinden Sie oben den API-Schlüssel Ihres Kontos, um diesen Endpunkt auszuprobieren.
Gehen Sie zu API-VerbindungVorschau anfordern
{
"method": "GET",
"url": "https://api.mailbridgeapi.com/getemail/",
"parameters": {
"apikey": "YOUR_CONNECTED_API_KEY",
"apikeybox": "YOUR_SELECTED_MAILBOX_KEY",
"mbox": "INBOX",
"start": "0"
}
}Ihre Antwort wird hier angezeigt, nachdem Sie die Anfrage ausgeführt haben.
Beginnen Sie mit diesen Parametern
| Parameter | Erforderlich | Beschreibung |
|---|---|---|
apikey | Erforderlich | Konto-API-Schlüssel. |
apikeybox | Erforderlich | API-Schlüssel des verbundenen IMAP-Postfachs. |
mbox | Erforderlich | Name des IMAP-Ordners, z. B. INBOX, Gesendet oder Entwürfe. |
Alle optionalen Parameter+
Fügen Sie diese nur hinzu, wenn Sie die entsprechende Funktion benötigen.
| Parameter | Erforderlich | Beschreibung |
|---|---|---|
start | Optional | Nullbasierter Index; Der Standardwert ist 0. Bis zu 30 Nachrichten pro Seite. |
Beispiel anfordern
<?php
$query = http_build_query([
'apikey' => getenv('MAILBRIDGE_API_KEY'),
'apikeybox' => getenv('MAILBRIDGE_BOX_KEY'),
'mbox' => 'INBOX',
'start' => '0'
]);
$ch = curl_init('https://api.mailbridgeapi.com/getemail/?' . $query);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);So lesen Sie diese Antwort
Nachrichten werden nach ihrem IMAP UID unter result.emaillist gruppiert. Betreff (Objekt) und Text können URL-codiert sein. Dekodieren Sie diese Felder, bevor Sie sie als Text anzeigen.
Eine leere E-Mail-Liste kann eine gültige, erfolgreiche Antwort sein. Überprüfen Sie den ausgewählten Ordner und starten Sie den Index.
Beispielantwort+
{
"result": {
"error": "0",
"emaillist": {
"50123": {
"id": 50123,
"object": "Hello%20there",
"body": "%3Cp%3EHello%3C%2Fp%3E",
"email1": "jane@example.com",
"email2": "hello@yourcompany.com",
"timestamp": 1736505600,
"date": "10/01/2025 - 09:20:00",
"size": 42,
"attachment": null,
"loop": 0
}
}
}
}/sendemail/Senden Sie eine E-Mail
Senden Sie eine E-Mail über die SMTP-Verbindung des ausgewählten Postfachs. Unterstützt HTML, Text, CC-Empfänger, Anhänge, Inline-Bilder und eine optionale Fußzeile zum Abbestellen.
Optionale Archivierung im Gesendet-Ordner
Aktivieren Sie gesendete Kopien für das Postfach im Dashboard, um erfolgreiche API-Sendungen über einen separaten IMAP-Hintergrundauftrag zu archivieren. Der SMTP-Versand bleibt unabhängig: Ein IMAP-Problem macht aus einem akzeptierten Versand keinen API-Fehler. Setzen Sie skip_sent_copy=1 bei jeder Anfrage, die niemals archiviert werden darf.
Probieren Sie diesen Endpunkt ausLIVE
Verbinden Sie oben den API-Schlüssel Ihres Kontos, um diesen Endpunkt auszuprobieren.
Gehen Sie zu API-VerbindungVorschau anfordern
{
"method": "POST",
"url": "https://api.mailbridgeapi.com/sendemail/",
"parameters": {
"apikey": "YOUR_CONNECTED_API_KEY",
"apikeybox": "YOUR_SELECTED_MAILBOX_KEY",
"mail_subject": "Hallo von MailBridgeAPI",
"mail_body": "Dies ist eine Test-E-Mail, die von meinem verbundenen Postfach gesendet wurde.",
"format": "text"
}
}Ihre Antwort wird hier angezeigt, nachdem Sie die Anfrage ausgeführt haben.
Beginnen Sie mit diesen Parametern
| Parameter | Erforderlich | Beschreibung |
|---|---|---|
apikey | Erforderlich | Konto-API-Schlüssel. |
apikeybox | Erforderlich | API-Schlüssel des zu verwendenden SMTP-Postfachs. |
recipient_email | Erforderlich | E-Mail-Adresse des primären Empfängers. |
mail_subject | Erforderlich | E-Mail-Betreff. |
mail_body | Erforderlich | HTML- oder Nur-Text-Nachrichtentext. |
Alle optionalen Parameter+
Fügen Sie diese nur hinzu, wenn Sie die entsprechende Funktion benötigen.
| Parameter | Erforderlich | Beschreibung |
|---|---|---|
sender_email | Optional | Überschreiben Sie die Absenderadresse. Standardmäßig wird der Absender des SMTP-Postfachs verwendet. Ihr Provider muss die Adresse zulassen. |
sender_name | Optional | Überschreiben Sie den Anzeigenamen des Absenders. |
reply_email | Optional | Antwortadresse; Der Standardwert ist sender_email. |
reply_name | Optional | Anzeigename des Antwortempfängers. |
email_cc1, email_cc2, email_cc3 | Optional | Bis zu drei CC-Empfänger. |
format | Optional | HTML (Standard) oder Text. |
charset | Optional | Nachrichtenzeichensatz; Der Standardwert ist UTF-8. |
attachmentBase64_1, attachmentBase64_2 | Optional | Anhangsinhalte kodiert als base64. |
attachmentBase64_name_1, attachmentBase64_name_2 | Optional | Dateinamen für die entsprechenden Anhänge. |
embeddedImage | Optional | Öffentliche Bild-URL zum Inline-Einbetten. |
embeddedImage_cid | Optional | Inhalts-ID, auf die in HTML mit cid:YOUR_CID verwiesen wird. |
unsubscribe | Optional | Auf 1 setzen, um die konfigurierte Abmeldefußzeile anzuhängen; Standard 0. |
from_source | Optional | Eine optionale Quellenbezeichnung für Ihren Versand. |
skip_sent_copy | Optional | Auf 1 setzen, damit diese Nachricht nicht in den konfigurierten IMAP-Ordner „Gesendet“ kopiert wird, auch wenn die Archivierung aktiviert ist. |
allow_self_signed | Optional | Auf „Ja“ setzen, um selbstsignierte TLS-Zertifikate zuzulassen. Bei normaler Zertifikatsvalidierung weglassen. |
Beispiel anfordern
<?php
$payload = [
'apikey' => getenv('MAILBRIDGE_API_KEY'),
'apikeybox' => getenv('MAILBRIDGE_BOX_KEY'),
'recipient_email' => 'jane@example.com',
'mail_subject' => 'Hello, possibilities.',
'mail_body' => 'Your next idea starts here.',
'format' => 'text',
];
$ch = curl_init('https://api.mailbridgeapi.com/sendemail/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
// Check $data['result']['error'], not only the HTTP status.
print_r($data);So lesen Sie diese Antwort
Überprüfen Sie result.error = „0“ und result.sent = „OK“. Der SMTP-Server hat den Versand akzeptiert; Dies garantiert nicht die Zustellung an den Posteingang des Empfängers.
Beispielantwort+
{
"result": {
"error": "0",
"sent": "OK",
"id": "msg_example"
}
}/email/unsubscribed/Datensätze abbestellen
Rufen Sie bis zu 500 Abmelde-bezogene Sendedatensätze für ein Postfach unter result.customer ab. Optional nach Empfänger-E-Mail filtern. Der Startparameter ist reserviert und kann ignoriert werden.
Probieren Sie diesen Endpunkt ausLIVE
Verbinden Sie oben den API-Schlüssel Ihres Kontos, um diesen Endpunkt auszuprobieren.
Gehen Sie zu API-VerbindungVorschau anfordern
{
"method": "GET",
"url": "https://api.mailbridgeapi.com/email/unsubscribed/",
"parameters": {
"apikey": "YOUR_CONNECTED_API_KEY",
"apikeybox": "YOUR_SELECTED_MAILBOX_KEY"
}
}Ihre Antwort wird hier angezeigt, nachdem Sie die Anfrage ausgeführt haben.
Beginnen Sie mit diesen Parametern
| Parameter | Erforderlich | Beschreibung |
|---|---|---|
apikey | Erforderlich | Konto-API-Schlüssel. |
apikeybox | Erforderlich | API-Schlüssel des SMTP-Postfachs. |
Alle optionalen Parameter+
Fügen Sie diese nur hinzu, wenn Sie die entsprechende Funktion benötigen.
| Parameter | Erforderlich | Beschreibung |
|---|---|---|
email | Optional | Filtern Sie Datensätze nach der E-Mail-Adresse des Empfängers. |
start | Optional | Reservierter Index; kann von der aktuellen Implementierung ignoriert werden. |
Beispiel anfordern
<?php
$query = http_build_query([
'apikey' => getenv('MAILBRIDGE_API_KEY'),
'apikeybox' => getenv('MAILBRIDGE_BOX_KEY'),
'email' => 'jane@example.com'
]);
$ch = curl_init('https://api.mailbridgeapi.com/email/unsubscribed/?' . $query);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$response = curl_exec($ch);
if ($response === false) {
$message = curl_error($ch);
curl_close($ch);
throw new RuntimeException($message);
}
curl_close($ch);
$data = json_decode($response, true, 512, JSON_THROW_ON_ERROR);
print_r($data);So lesen Sie diese Antwort
Die Datensätze liegen unter result.customer. Verwenden Sie „recipientEmail“, um Ihre Liste zu aktualisieren. Dieser Endpunkt liest Opt-out-Datensätze; Es wird kein Kontakt selbst abgemeldet.
Beispielantwort+
{
"result": {
"error": "0",
"customer": [
{
"recipientEmail": "jane@example.com",
"subject": "Monthly update",
"unsubscribeaskedDate": "2025-01-11"
}
]
}
}Antworten und Fehler
200 | Anfrage bearbeitet. Überprüfen Sie result.error auf das Anbieterergebnis. |
400 | Erforderliche Parameter fehlen. |
401 | Ungültiger oder abgelaufener API-Schlüssel oder ein deaktiviertes Konto. |
500 | Fehler beim SMTP-/IMAP-Anbieter oder ein interner Fehler. |
Wenn etwas schief geht
401 / ungültiger Schlüssel+
Überprüfen Sie beide Schlüssel, das ausgewählte Postfach und den aktiven Status des Kontos.
SMTP-Verbindungsfehler+
Überprüfen Sie den SMTP-Host, den Port, die Authentifizierung und die Absenderberechtigungen im Dashboard.
IMAP-Verbindungsfehler+
Überprüfen Sie den IMAP-Zugriff, die Anmeldeinformationen und den genauen Ordnernamen.
Es wurden keine Nachrichten zurückgegeben+
Versuchen Sie INBOX mit Start = 0. Der Ordner ist möglicherweise leer.
Timeout nach dem Senden+
Überprüfen Sie Ihr Dashboard oder den Ordner „Gesendet“, bevor Sie es erneut versuchen. Möglicherweise hat der Versand bereits stattgefunden.
Tarifbegrenzungen
Veröffentlichte Grenzwerte: Senden und Abmelden – 120 Anfragen/Minute; IMAP-Abruf – 60 Anfragen/Minute. Es gelten auch die eigenen Limits Ihres Anbieters. Behandeln Sie Fehler und vermeiden Sie blinde Wiederholungsversuche, die zu doppelten E-Mails führen können.
Codebeispiele sind Beispiele. Live-Anfragen werden nur ausgeführt, wenn Sie explizit einen Endpunkttest senden.