mailbridgeAPI
InloggenAan de slag
MAILBRIDGEAPI / DOCUMENTATIE

Documentatie voor de e-mail-API: SMTP en IMAP.

Verander een SMTP- en IMAP-mailbox in een API. Roep HTTP-endpoints aan om berichten te verzenden, uw inbox op te halen en uitschrijvingen te beheren.

Basis-URLhttps://api.mailbridgeapi.com

Bouwen met een AI-assistent?

Gebruik onze doorzoekbare kennisbank, volledige tekstreferentie en alleen-lezen API om uw assistent brongebaseerde MailBridgeAPI documentatie te geven.

Verken de kennisbank

Uw eerste aanvraag, in drie stappen

Begin met het lezen van uw inbox. Zodra u een succesvol antwoord ziet, kunt u proberen een bericht te verzenden.

01

Sluit uw sleutels aan

Plak de API-sleutel van uw account en de sleutel voor één geconfigureerde mailbox. Klik op Verbinden.

02

Haal je inbox op

Open “E-mails ophalen”, behoud INBOX en begin op 0, en klik vervolgens op E-mails ophalen.

03

Lees het resultaat

HTTP 200 betekent dat de server heeft geantwoord. result.error = "0" geeft succes aan; e-mails staan ​​in result.emaillist.

INTERACTIEVE API-VERKENNING Niet verbonden

Probeer de API met uw mailbox

Koppel uw accountsleutel, kies een mailbox en voer hieronder een verzoek in. Deze verzoeken maken gebruik van de live service MailBridgeAPI.

Sleutels blijven in het geheugen van deze pagina en worden gewist wanneer de verbinding wordt verbroken of opnieuw wordt geladen. Verzoeken gaan via de server van deze website naar MailBridgeAPI.

Kies wat je wilt doen

E-mails ophalen

Lees tot 30 e-mails vanuit een IMAP-map.

GET
Stuur een e-mail

Stuur één e-mail vanuit uw aangesloten mailbox.

POST
Afmelden van records

Lees de opt-outgegevens om uw contactenlijst bij te werken.

GET

Twee sleutels. Twee verschillende banen.

Gebruik beide waarden bij elk verzoek. Uw e-mailwachtwoord wordt niet gebruikt in API-verzoeken.

apikey

Account-API-sleutel

Identificeert uw account. Vind het in uw MailBridgeAPI dashboard.

apikeybox

Mailbox API-sleutel

Selecteert de mailbox waaruit u wilt verzenden of lezen. Dit is de apikeybox-waarde in uw dashboard.

Voor verzoeken zijn twee waarden vereist: apikey identificeert uw account; apikeybox selecteert een geconfigureerde mailbox. In voorbeelden worden de gedocumenteerde aanvraagparameters gebruikt. Bewaar sleutels in omgevingsvariabelen aan de serverzijde.

AuthenticatieOptioneel

Voor GET-eindpunten kunnen queryparameters in logboeken verschijnen. De gepubliceerde referentie beschrijft ook Bearer authenticatie voor de accountsleutel; verifieer de ondersteuning bij uw integratie voordat u deze adopteert.

GET/getemail/

E-mails ophalen

Berichten lezen uit een geselecteerde IMAP-map. Het resultaat bevat een kaart met UID-sleutel onder result.emaillist. Elke pagina bevat maximaal 30 berichten; begin met 30 om de volgende pagina op te halen.

Probeer dit eindpuntLIVE

Sluit de API-sleutel van uw account hierboven aan om dit eindpunt te proberen.

Ga naar API-verbinding
Hiermee worden live gegevens uit uw geselecteerde mailbox gelezen. Er wordt niets verzonden.
Voorbeeld aanvragen
{
  "method": "GET",
  "url": "https://api.mailbridgeapi.com/getemail/",
  "parameters": {
    "apikey": "YOUR_CONNECTED_API_KEY",
    "apikeybox": "YOUR_SELECTED_MAILBOX_KEY",
    "mbox": "INBOX",
    "start": "0"
  }
}
Live reactie

Uw antwoord verschijnt hier nadat u het verzoek heeft uitgevoerd.

Begin met deze parameters

ParameterVereistBeschrijving
apikeyVereistAccount-API-sleutel.
apikeyboxVereistAPI-sleutel van de aangesloten IMAP-mailbox.
mboxVereistIMAP-mapnaam, zoals INBOX, Verzonden of Concepten.
Alle optionele parameters+

Voeg deze alleen toe als je de bijbehorende functie nodig hebt.

ParameterVereistBeschrijving
startOptioneelOp nul gebaseerde index; standaard ingesteld op 0. Maximaal 30 berichten per pagina.

Voorbeeld aanvragen

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());
Alleen een voorbeeld: geen liveverzoeken

Hoe deze reactie te lezen

Berichten worden gegroepeerd op hun IMAP UID onder result.emaillist. Onderwerp (object) en hoofdtekst kunnen URL-gecodeerd zijn. Decodeer deze velden voordat u ze als tekst weergeeft.

Een lege e-maillijst kan een geldig, succesvol antwoord zijn. Controleer de geselecteerde map en start de index.

Voorbeeld reactie+
{
  "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/

Stuur een e-mail

Stuur een e-mail via de SMTP-verbinding van de geselecteerde mailbox. Ondersteunt HTML, tekst, CC-ontvangers, bijlagen, inline afbeeldingen en een optionele voettekst voor afmelden.

Probeer dit eindpuntLIVE

Sluit de API-sleutel van uw account hierboven aan om dit eindpunt te proberen.

Ga naar API-verbinding
Optionele parameters+
Laat uitgeschakeld voor normale certificaatvalidatie.De verkenner accepteert maximaal 1 MB per verzoek. Houd testbijlagen klein.
Dit is een live verzending, geen simulatie. De verzendlimieten van uw provider zijn van toepassing.
Voorbeeld aanvragen
{
  "method": "POST",
  "url": "https://api.mailbridgeapi.com/sendemail/",
  "parameters": {
    "apikey": "YOUR_CONNECTED_API_KEY",
    "apikeybox": "YOUR_SELECTED_MAILBOX_KEY",
    "mail_subject": "Hallo vanaf MailBridgeAPI",
    "mail_body": "Dit is een test-e-mail verzonden vanuit mijn aangesloten mailbox.",
    "format": "text"
  }
}
Live reactie

Uw antwoord verschijnt hier nadat u het verzoek heeft uitgevoerd.

Begin met deze parameters

ParameterVereistBeschrijving
apikeyVereistAccount-API-sleutel.
apikeyboxVereistAPI-sleutel van de te gebruiken SMTP-mailbox.
recipient_emailVereistE-mailadres van primaire ontvanger.
mail_subjectVereistE-mailonderwerp.
mail_bodyVereistHTML- of tekstberichttekst.
Alle optionele parameters+

Voeg deze alleen toe als je de bijbehorende functie nodig hebt.

ParameterVereistBeschrijving
sender_emailOptioneelOverschrijf het afzenderadres; standaard ingesteld op de afzender van de SMTP-mailbox. Uw provider moet het adres toestaan.
sender_nameOptioneelOverschrijf de weergavenaam van de afzender.
reply_emailOptioneelAntwoordadres; standaard ingesteld op sender_email.
reply_nameOptioneelAntwoord-aan weergavenaam.
email_cc1, email_cc2, email_cc3OptioneelMaximaal drie CC-ontvangers.
formatOptioneelhtml (standaard) of tekst.
charsetOptioneelBerichttekenset; standaard ingesteld op UTF-8.
attachmentBase64_1, attachmentBase64_2OptioneelInhoud van bijlage gecodeerd als base64.
attachmentBase64_name_1, attachmentBase64_name_2OptioneelBestandsnamen voor de bijbehorende bijlagen.
embeddedImageOptioneelOpenbare afbeeldings-URL om inline in te sluiten.
embeddedImage_cidOptioneelContent ID waarnaar wordt verwezen in HTML met cid:YOUR_CID.
unsubscribeOptioneelStel in op 1 om de geconfigureerde afmeldingsvoettekst toe te voegen; standaard 0.
from_sourceOptioneelEen optioneel bronlabel voor uw verzending.
allow_self_signedOptioneelStel in op Ja om zelfondertekende TLS-certificaten toe te staan. Laat dit weg voor normale certificaatvalidatie.

Voorbeeld aanvragen

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);
Alleen een voorbeeld: geen liveverzoeken

Hoe deze reactie te lezen

Controleer result.error = "0" en result.sent = "OK". De SMTP-server heeft de verzending geaccepteerd; dit garandeert geen bezorging in de inbox van de ontvanger.

Voorbeeld reactie+
{
  "result": {
    "error": "0",
    "sent": "OK",
    "id": "msg_example"
  }
}
GET/email/unsubscribed/

Afmelden van records

Haal maximaal 500 afmeldingsgerelateerde verzendrecords op voor een mailbox onder result.customer. Optioneel filteren op e-mailadres van de ontvanger. De startparameter is gereserveerd en kan worden genegeerd.

Probeer dit eindpuntLIVE

Sluit de API-sleutel van uw account hierboven aan om dit eindpunt te proberen.

Ga naar API-verbinding
Hiermee worden live gegevens uit uw geselecteerde mailbox gelezen. Er wordt niets verzonden.
Voorbeeld aanvragen
{
  "method": "GET",
  "url": "https://api.mailbridgeapi.com/email/unsubscribed/",
  "parameters": {
    "apikey": "YOUR_CONNECTED_API_KEY",
    "apikeybox": "YOUR_SELECTED_MAILBOX_KEY"
  }
}
Live reactie

Uw antwoord verschijnt hier nadat u het verzoek heeft uitgevoerd.

Begin met deze parameters

ParameterVereistBeschrijving
apikeyVereistAccount-API-sleutel.
apikeyboxVereistAPI-sleutel van de SMTP-mailbox.
Alle optionele parameters+

Voeg deze alleen toe als je de bijbehorende functie nodig hebt.

ParameterVereistBeschrijving
emailOptioneelFilter records op e-mailadres van de ontvanger.
startOptioneelGereserveerde index; kunnen door de huidige implementatie worden genegeerd.

Voorbeeld aanvragen

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());
Alleen een voorbeeld: geen liveverzoeken

Hoe deze reactie te lezen

Records liggen onder result.customer. Gebruik receiverEmail om uw lijst bij te werken. Dit eindpunt leest opt-outrecords; het meldt een contactpersoon zelf niet af.

Voorbeeld reactie+
{
  "result": {
    "error": "0",
    "customer": [
      {
        "recipientEmail": "jane@example.com",
        "subject": "Monthly update",
        "unsubscribeaskedDate": "2025-01-11"
      }
    ]
  }
}

Reacties en fouten

200Verzoek verwerkt. Inspecteer result.error voor het providerresultaat.
400Vereiste parameters ontbreken.
401Ongeldige of verlopen API-sleutel, of een gedeactiveerd account.
500SMTP/IMAP-providerfout of een interne fout.

Als er iets misgaat

401 / ongeldige sleutel+

Controleer beide sleutels, de geselecteerde mailbox en de actieve status van het account.

SMTP-verbindingsfout+

Controleer de SMTP-host, poort, authenticatie en afzendermachtigingen in het dashboard.

IMAP-verbindingsfout+

Controleer IMAP-toegang, inloggegevens en de exacte mapnaam.

Er zijn geen berichten geretourneerd+

Probeer INBOX met start = 0. De map is mogelijk leeg.

Time-out na verzending+

Controleer uw dashboard of de map Verzonden voordat u het opnieuw probeert. Het kan zijn dat de verzending al heeft plaatsgevonden.

Tarieflimieten

Gepubliceerde limieten: verzenden en ophalen van abonnementen — 120 verzoeken/minuut; IMAP-ophalen — 60 verzoeken/minuut. De eigen limieten van uw provider zijn ook van toepassing. Handel fouten af ​​en voorkom dat u blindelings opnieuw verzendt, waardoor dubbele e-mails kunnen ontstaan.

Codevoorbeelden zijn voorbeelden. Live-aanvragen worden alleen uitgevoerd als u expliciet een eindpunttest indient.