mailbridgeAPI
AnmeldenJetzt starten
MAILBRIDGEAPI / DOKUMENTATION

E-Mail-API-Dokumentation: SMTP und IMAP.

Verwandeln Sie ein SMTP- und IMAP-Postfach in eine API. Rufen Sie HTTP-Endpunkte zum Senden, Abrufen und Verwalten von Abmeldungen auf.

Basis-URLhttps://api.mailbridgeapi.com

Bauen 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 Wissensdatenbank

Ihre 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.

01

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“.

02

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“.

03

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.

INTERAKTIVER API-EXPLORER Nicht verbunden

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.

Wählen Sie, was Sie tun möchten

E-Mails abrufen

Lesen Sie bis zu 30 E-Mails aus einem IMAP-Ordner.

GET
Senden Sie eine E-Mail

Senden Sie eine E-Mail aus Ihrem verbundenen Postfach.

POST
Datensätze abbestellen

Lesen Sie die Opt-out-Datensätze, um Ihre Kontaktliste zu aktualisieren.

GET

Zwei Schlüssel. Zwei verschiedene Jobs.

Verwenden Sie bei jeder Anfrage beide Werte. Ihr E-Mail-Passwort wird in API-Anfragen nicht verwendet.

apikey

Konto-API-Schlüssel

Identifiziert Ihr Konto. Finden Sie es in Ihrem MailBridgeAPI-Dashboard.

apikeybox

Postfach-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.

GET/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-Verbindung
Dies liest Live-Daten aus Ihrem ausgewählten Postfach. Es wird nichts gesendet.
Vorschau anfordern
{
  "method": "GET",
  "url": "https://api.mailbridgeapi.com/getemail/",
  "parameters": {
    "apikey": "YOUR_CONNECTED_API_KEY",
    "apikeybox": "YOUR_SELECTED_MAILBOX_KEY",
    "mbox": "INBOX",
    "start": "0"
  }
}
Live-Antwort

Ihre Antwort wird hier angezeigt, nachdem Sie die Anfrage ausgeführt haben.

Beginnen Sie mit diesen Parametern

ParameterErforderlichBeschreibung
apikeyErforderlichKonto-API-Schlüssel.
apikeyboxErforderlichAPI-Schlüssel des verbundenen IMAP-Postfachs.
mboxErforderlichName 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.

ParameterErforderlichBeschreibung
startOptionalNullbasierter Index; Der Standardwert ist 0. Bis zu 30 Nachrichten pro Seite.

Beispiel anfordern

const params = new URLSearchParams({
  apikey: process.env.MAILBRIDGE_API_KEY,
  apikeybox: process.env.MAILBRIDGE_BOX_KEY,
  mbox: 'INBOX',
  start: '0'
});
const response = await fetch(
  'https://api.mailbridgeapi.com/getemail/?' + params
);
console.log(await response.json());
Nur Beispiel – keine Live-Anfragen

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
      }
    }
  }
}
POST/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.

Probieren Sie diesen Endpunkt ausLIVE

Verbinden Sie oben den API-Schlüssel Ihres Kontos, um diesen Endpunkt auszuprobieren.

Gehen Sie zu API-Verbindung
Optionale Parameter+
Für die normale Zertifikatsvalidierung deaktiviert lassen.Der Explorer akzeptiert bis zu 1 MB pro Anfrage. Halten Sie Testanhänge klein.
Dies ist ein Live-Versand, keine Simulation. Es gelten die Sendelimits Ihres Anbieters.
Vorschau 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"
  }
}
Live-Antwort

Ihre Antwort wird hier angezeigt, nachdem Sie die Anfrage ausgeführt haben.

Beginnen Sie mit diesen Parametern

ParameterErforderlichBeschreibung
apikeyErforderlichKonto-API-Schlüssel.
apikeyboxErforderlichAPI-Schlüssel des zu verwendenden SMTP-Postfachs.
recipient_emailErforderlichE-Mail-Adresse des primären Empfängers.
mail_subjectErforderlichE-Mail-Betreff.
mail_bodyErforderlichHTML- oder Nur-Text-Nachrichtentext.
Alle optionalen Parameter+

Fügen Sie diese nur hinzu, wenn Sie die entsprechende Funktion benötigen.

ParameterErforderlichBeschreibung
sender_emailOptionalÜberschreiben Sie die Absenderadresse. Standardmäßig wird der Absender des SMTP-Postfachs verwendet. Ihr Provider muss die Adresse zulassen.
sender_nameOptionalÜberschreiben Sie den Anzeigenamen des Absenders.
reply_emailOptionalAntwortadresse; Der Standardwert ist sender_email.
reply_nameOptionalAnzeigename des Antwortempfängers.
email_cc1, email_cc2, email_cc3OptionalBis zu drei CC-Empfänger.
formatOptionalHTML (Standard) oder Text.
charsetOptionalNachrichtenzeichensatz; Der Standardwert ist UTF-8.
attachmentBase64_1, attachmentBase64_2OptionalAnhangsinhalte kodiert als base64.
attachmentBase64_name_1, attachmentBase64_name_2OptionalDateinamen für die entsprechenden Anhänge.
embeddedImageOptionalÖffentliche Bild-URL zum Inline-Einbetten.
embeddedImage_cidOptionalInhalts-ID, auf die in HTML mit cid:YOUR_CID verwiesen wird.
unsubscribeOptionalAuf 1 setzen, um die konfigurierte Abmeldefußzeile anzuhängen; Standard 0.
from_sourceOptionalEine optionale Quellenbezeichnung für Ihren Versand.
allow_self_signedOptionalAuf „Ja“ setzen, um selbstsignierte TLS-Zertifikate zuzulassen. Bei normaler Zertifikatsvalidierung weglassen.

Beispiel anfordern

const response = await fetch(
  'https://api.mailbridgeapi.com/sendemail/',
  {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      apikey: process.env.MAILBRIDGE_API_KEY,
      apikeybox: process.env.MAILBRIDGE_BOX_KEY,
      recipient_email: 'jane@example.com',
      mail_subject: 'Hello, possibilities.',
      mail_body: 'Your next idea starts here.',
      format: 'text'
    })
  }
);
const data = await response.json();
// Check data.result.error, not just HTTP status.
console.log(data);
Nur Beispiel – keine Live-Anfragen

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"
  }
}
GET/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-Verbindung
Dies liest Live-Daten aus Ihrem ausgewählten Postfach. Es wird nichts gesendet.
Vorschau anfordern
{
  "method": "GET",
  "url": "https://api.mailbridgeapi.com/email/unsubscribed/",
  "parameters": {
    "apikey": "YOUR_CONNECTED_API_KEY",
    "apikeybox": "YOUR_SELECTED_MAILBOX_KEY"
  }
}
Live-Antwort

Ihre Antwort wird hier angezeigt, nachdem Sie die Anfrage ausgeführt haben.

Beginnen Sie mit diesen Parametern

ParameterErforderlichBeschreibung
apikeyErforderlichKonto-API-Schlüssel.
apikeyboxErforderlichAPI-Schlüssel des SMTP-Postfachs.
Alle optionalen Parameter+

Fügen Sie diese nur hinzu, wenn Sie die entsprechende Funktion benötigen.

ParameterErforderlichBeschreibung
emailOptionalFiltern Sie Datensätze nach der E-Mail-Adresse des Empfängers.
startOptionalReservierter Index; kann von der aktuellen Implementierung ignoriert werden.

Beispiel anfordern

const params = new URLSearchParams({
  apikey: process.env.MAILBRIDGE_API_KEY,
  apikeybox: process.env.MAILBRIDGE_BOX_KEY,
  email: 'jane@example.com'
});
const response = await fetch(
  'https://api.mailbridgeapi.com/email/unsubscribed/?' + params
);
console.log(await response.json());
Nur Beispiel – keine Live-Anfragen

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

200Anfrage bearbeitet. Überprüfen Sie result.error auf das Anbieterergebnis.
400Erforderliche Parameter fehlen.
401Ungültiger oder abgelaufener API-Schlüssel oder ein deaktiviertes Konto.
500Fehler 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.