mailbridgeAPI
DEMOInloggenMailbox koppelen
MAILBRIDGEAPI / DOCUMENTATIE

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

Koppel uw eigen SMTP- en IMAP-mailbox aan een account- en mailbox-API-sleutel. Gebruik beide in HTTP-aanvragen om de gekozen mailbox te verzenden, lezen en beheren.

Basis-URLhttps://api.mailbridgeapi.com

Volg API- en productwijzigingen.

Bekijk gepubliceerde updates van endpoints, documentatie en het platform voordat u een integratie wijzigt.

Wijzigingslogboek openen

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.

BEKIJK DE VERBINDING

Eén mailbox wordt een API voor al uw projecten.

MailBridgeAPI koppelt uw SMTP- en IMAP-mailbox veilig aan twee API-sleutels. Uw toepassingen gebruiken duidelijke endpoints om e-mail te verzenden en ontvangen berichten te verwerken zonder het mailboxwachtwoord te gebruiken.

01Uw mailboxyou@company.comUw adres en provider
02MailBridgeAPI
API-sleutel van mailboxmbox_••••7F3A
Gekoppeld en klaar
03Beschikbare endpoints
POST /sendemail/
GET /getemail/
GET /email/unsubscribed/
04Uw projecten
WebsiteCRMAutomatisering
Uw project bewaart de API-sleutels op de server. Het mailboxwachtwoord blijft in de MailBridgeAPI-configuratie.
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.

TWEE MANIEREN OM ONTVANGEN E-MAIL TE LEZEN

Kies live mailbox-toegang of de MailBridgeAPI-geschiedenis.

De twee ontvangst-endpoints hebben een verschillend doel. Gebruik het directe IMAP-endpoint voor de actuele inhoud van een map en het uniforme endpoint voor providergerichte toegang en activiteitsfuncties.

GET /getemail/

Lees de IMAP-mailbox live

MailBridgeAPI opent de ingestelde IMAP-verbinding wanneer de aanvraag wordt uitgevoerd en geeft de huidige berichten uit de gekozen map terug.

  • Geen AI- of automatisch antwoordconfiguratie nodig.
  • Kies de map met mbox en blader met start in groepen van maximaal 30 berichten.
  • Lezen maakt geen record in de ontvangen MailBridgeAPI-geschiedenis.
GET /getemail/
GET /email/received/

Gebruik het uniforme ontvangst-endpoint

Dit endpoint biedt één gepagineerd formaat, maar de bron van de berichten hangt af van de provider.

  • Gmail, Microsoft, Zoho en Yahoo via OAuth worden rechtstreeks bij de provider gelezen.
  • Standaard SMTP/IMAP en Apple geven reeds geïmporteerde MailBridgeAPI-geschiedenis terug.
  • Gebruik bij standaard IMAP zonder automatisering /getemail/ voor directe mailbox-toegang.
GET /email/received/
Welk endpoint moet ik gebruiken?

Gebruik /getemail/ voor een live IMAP-map. Gebruik /email/received/ voor paginering, filters, details, zoeken en activiteit. Bij standaard IMAP bevat de uniforme geschiedenis alleen reeds geïmporteerde berichten.

MEER DAN VERZENDEN EN ONTVANGEN

Professionele endpoints voor uw mailbox.

Controleer configuratie en activiteit, zoek een bericht, bouw rapporten en valideer een verzending vóór SMTP. Alle endpoints gebruiken dezelfde sleutels.

Gebruik headers voor nieuwe integraties

Stuur de accountsleutel in X-API-Key en de mailboxsleutel in X-Mailbox-Key. apikey en apikeybox blijven compatibel. Bewaar beide op uw server.

X-API-KeyX-Mailbox-Key
GET/mailbox/status/

Mailboxstatus

Controleer SMTP, IMAP en functies zonder inloggegevens bloot te geven.

Voor configuratie, monitoring en support.

Nuttige parametersGeen extra parameters.
Aanvraagvoorbeeld+
<?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);
Test met uw gekoppelde sleutelsLIVE

Koppel hierboven beide sleutels.

JSON-respons

Voer het endpoint uit om de respons te zien.

GET/email/sent/

Verzonden e-mails

Gepagineerde historie met filters voor status, ontvanger, datum en bron.

Bouw dashboards en vind SMTP-fouten.

Nuttige parameters
pageper_pagestatusrecipientfromtosourceinclude_body
Aanvraagvoorbeeld+
<?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);
Test met uw gekoppelde sleutelsLIVE

Koppel hierboven beide sleutels.

JSON-respons

Voer het endpoint uit om de respons te zien.

GET/email/received/

Uniforme toegang tot ontvangen e-mail

Ontvang een gepagineerde lijst. OAuth-providers worden live gelezen; standaard IMAP en Apple gebruiken geïmporteerde geschiedenis.

Gebruik /getemail/ om een standaard IMAP-map direct te lezen.

Nuttige parameters
pageper_pagesenderfromtoinclude_body
Aanvraagvoorbeeld+
<?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);
Test met uw gekoppelde sleutelsLIVE

Koppel hierboven beide sleutels.

JSON-respons

Voer het endpoint uit om de respons te zien.

GET/email/message/

Berichtdetails

Haal één verzonden of ontvangen bericht op via de MailBridgeAPI-id.

Laad volledige inhoud alleen wanneer nodig.

Nuttige parameters
directionid
Aanvraagvoorbeeld+
<?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);
Test met uw gekoppelde sleutelsLIVE

Koppel hierboven beide sleutels.

JSON-respons

Voer het endpoint uit om de respons te zien.

GET/email/activity/

Mailboxactiviteit

Totalen en dagelijkse reeks voor 1 tot 90 dagen.

Voor grafieken en rapportage.

Nuttige parameters
days
Aanvraagvoorbeeld+
<?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);
Test met uw gekoppelde sleutelsLIVE

Koppel hierboven beide sleutels.

JSON-respons

Voer het endpoint uit om de respons te zien.

POST/email/validate/

Validatie vóór verzending

Valideer ontvanger, onderwerp, inhoud, formaat en SMTP zonder te verzenden.

Vind fouten vóór /sendemail/.

Nuttige parameters
recipient_emailmail_subjectmail_bodyformat
Aanvraagvoorbeeld+
<?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);
Test met uw gekoppelde sleutelsLIVE

Koppel hierboven beide sleutels.

Alleen validatie — er wordt geen e-mail verzonden.
JSON-respons

Voer het endpoint uit om de respons te zien.

GET/mailbox/insights/

Mailboxinzichten

Bekijk betrouwbaarheid, ontvangen volume, recente activiteit en de laatste fout samen.

Voor statuspagina’s, meldingen en operationele schermen.

Nuttige parameters
days
Aanvraagvoorbeeld+
<?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);
Test met uw gekoppelde sleutelsLIVE

Koppel hierboven beide sleutels.

JSON-respons

Voer het endpoint uit om de respons te zien.

OpenAPI 3.1-specificatie downloadenImporteer het contract in Postman, Insomnia, Swagger UI of een codegenerator.

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.

Authenticatie — Optioneel

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

Lees de gekozen IMAP-map live wanneer de aanvraag wordt uitgevoerd. Dit endpoint vereist geen AI of automatische antwoorden en is niet afhankelijk van de ontvangen MailBridgeAPI-geschiedenis. Het resultaat bevat een UID-index onder result.emaillist; elke pagina bevat maximaal 30 berichten, verhoog daarna start met 30.

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

<?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);
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.

Optionele archivering in de map Verzonden

Schakel verzonden kopieën voor de mailbox in het dashboard in om geslaagde API-verzendingen via een afzonderlijke IMAP-achtergrondtaak te archiveren. SMTP-verzending blijft onafhankelijk: een IMAP-probleem verandert een geaccepteerde verzending nooit in een API-fout. Voeg skip_sent_copy=1 toe aan elke aanvraag die nooit mag worden gearchiveerd.

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.
skip_sent_copyOptioneelStel in op 1 om te voorkomen dat dit bericht naar de ingestelde IMAP-map Verzonden wordt gekopieerd, ook als archivering is ingeschakeld.
allow_self_signedOptioneelStel in op Ja om zelfondertekende TLS-certificaten toe te staan. Laat dit weg voor normale certificaatvalidatie.

Voorbeeld aanvragen

<?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);
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

<?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);
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.

UW MAILBOX. UW API-SLEUTELS. UW AANVRAGEN.

Koppel uw eigen mailbox aan API-sleutels en bestuur hem via endpoints.

MailBridgeAPI koppelt de SMTP- en IMAP-mailbox die u bezit of mag gebruiken aan een account- en mailbox-API-sleutel. Elke aanvraag kiest diezelfde mailbox: verzend via het adres, lees berichten of verwerk ze in toepassingen.

Bekijk de documentatie
Uw eigen mailboxapikey + apikeyboxEndpoint-aanvraagActie via die mailbox
POST /sendemail/

Via uw mailbox verzenden

Een POST-aanvraag gebruikt de SMTP-verbinding van de door apikeybox gekozen mailbox.

GET /getemail/

Uw mailbox lezen

Een GET-aanvraag gebruikt dezelfde mailboxsleutel om berichten uit IMAP-mappen op te halen.

UW LOGICA. UW AUTOMATISERING.

Mailboxgegevens gebruiken

Uw geautoriseerde toepassing verwerkt het resultaat in workflows, automatiseringen, CRM, support of AI-systemen.

Koppel alleen een mailbox die u bezit of mag gebruiken. De provider moet compatibele SMTP- of IMAP-toegang toestaan; diens limieten blijven gelden.