MAILBRIDGEAPI / DOCUMENTATION

Documentation API e-mail : SMTP et IMAP.

Connectez votre propre boîte SMTP et IMAP à une clé API de compte et une clé API de boîte. Utilisez les deux dans vos requêtes HTTP pour envoyer, lire et gérer la boîte sélectionnée.

URL de basehttps://api.mailbridgeapi.com

Suivez les changements de l’API et du produit.

Consultez les mises à jour publiées des endpoints, de la documentation et de la plateforme avant de modifier une intégration.

Ouvrir le changelog

Construire avec un assistant IA ?

Utilisez notre base de connaissances consultable, notre référence en texte intégral et notre API en lecture seule pour fournir à votre assistant une documentation MailBridgeAPI basée sur la source.

Explorez la base de connaissances

Votre première demande, en trois étapes

Commencez par lire votre boîte de réception. Une fois que vous voyez une réponse réussie, vous pouvez essayer d’envoyer un message.

Connectez vos clés

Collez la clé API de votre compte et la clé d'une boîte mail configurée. Cliquez sur Connecter.

Récupérez votre boîte de réception

Ouvrez « Récupérer les e-mails », conservez INBOX et démarrez 0, puis cliquez sur Récupérer les e-mails.

Lire le résultat

HTTP 200 signifie que le serveur a répondu. result.error = « 0 » indique le succès ; les e-mails sont à l'intérieur de result.emaillist.

VOYEZ LA CONNEXION

Une boîte mail devient une API utilisable par tous vos projets.

MailBridgeAPI relie de façon sécurisée votre boîte SMTP et IMAP à deux clés API. Vos applications appellent ensuite des endpoints clairs pour envoyer des emails et traiter les messages reçus, sans utiliser le mot de passe de la boîte.

01Votre boîte mailyou@company.comVotre adresse et fournisseur

MailBridgeAPI

Clé API de la boîtembox_••••7F3A

Liée et prête

03Endpoints disponibles

POST /sendemail/

GET /getemail/

GET /email/unsubscribed/

04Vos projets

Site webCRMAutomatisation

Votre projet conserve les clés API côté serveur. Le mot de passe de la boîte reste dans la configuration MailBridgeAPI.

EXPLORATEUR D'API INTERACTIF Non connecté

Essayez l'API avec votre boîte mail

Connectez votre clé de compte, choisissez une boîte mail, puis exécutez une requête ci-dessous. Ces requêtes utilisent le service live MailBridgeAPI.

Les clés restent dans la mémoire de cette page et sont effacées lors de la déconnexion ou du rechargement. Les demandes transitent par le serveur de ce site Web jusqu'à MailBridgeAPI.

BIEN PLUS QUE L’ENVOI ET LA RÉCEPTION

Des endpoints professionnels pour piloter votre boîte mail.

Contrôlez la configuration, consultez l’activité, retrouvez un message, créez des rapports et validez un envoi avant le passage par SMTP. Tous les endpoints utilisent les mêmes clés de compte et de boîte.

Utilisez les headers pour les nouvelles intégrations

Envoyez la clé du compte dans X-API-Key et la clé de la boîte dans X-Mailbox-Key. Les paramètres apikey et apikeybox restent disponibles pour la compatibilité. Conservez les deux valeurs côté serveur.

X-API-KeyX-Mailbox-Key

GET/mailbox/status/

État de la boîte mail

Vérifiez la configuration SMTP et IMAP ainsi que les fonctions disponibles, sans exposer les identifiants ni les mots de passe.

Idéal pour les écrans de configuration, le monitoring et le diagnostic.

Paramètres utilesAucun paramètre supplémentaire.

Exemple de requête+

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

Tester avec vos clés connectéesLIVE

Réponse JSON reçue

Lancez l’endpoint pour afficher sa réponse.

GET/email/sent/

Historique des emails envoyés

Récupérez un journal paginé avec des filtres par statut, destinataire, date et source.

Créez un tableau de livraison et repérez rapidement les erreurs SMTP.

Paramètres utiles

pageper_pagestatusrecipientfromtosourceinclude_body

Exemple de requête+

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

Tester avec vos clés connectéesLIVE

Réponse JSON reçue

Lancez l’endpoint pour afficher sa réponse.

GET/email/received/

Historique des emails reçus

Consultez les messages déjà enregistrés par MailBridgeAPI avec pagination et filtres par expéditeur ou date.

Alimentez un support, une timeline CRM ou une file de traitement.

Paramètres utiles

pageper_pagesenderfromtoinclude_body

Exemple de requête+

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

Tester avec vos clés connectéesLIVE

Réponse JSON reçue

Lancez l’endpoint pour afficher sa réponse.

GET/email/message/

Détail d’un message

Récupérez un email envoyé ou reçu grâce à son identifiant MailBridgeAPI.

Chargez le contenu complet uniquement lorsque l’utilisateur ouvre le message.

Paramètres utiles

directionid

Exemple de requête+

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

Tester avec vos clés connectéesLIVE

Réponse JSON reçue

Lancez l’endpoint pour afficher sa réponse.

GET/email/activity/

Activité de la boîte

Obtenez les totaux envoyés, acceptés, en erreur et reçus ainsi qu’une série quotidienne de 1 à 90 jours.

Alimentez graphiques, contrôles de santé et rapports opérationnels.

Paramètres utiles

days

Exemple de requête+

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

Tester avec vos clés connectéesLIVE

Réponse JSON reçue

Lancez l’endpoint pour afficher sa réponse.

POST/email/validate/

Validation avant envoi

Validez le destinataire, le sujet, le corps, le format et la configuration SMTP sans envoyer d’email.

Détectez les erreurs avant d’appeler /sendemail/.

Paramètres utiles

recipient_emailmail_subjectmail_bodyformat

Exemple de requête+

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

Tester avec vos clés connectéesLIVE

Réponse JSON reçue

Lancez l’endpoint pour afficher sa réponse.

GET/mailbox/insights/

Indicateurs de la boîte

Obtenez la fiabilité des envois, le volume reçu, l’activité récente et la dernière erreur dans une seule vue.

Alimentez les écrans de santé, alertes et tableaux opérationnels.

Paramètres utiles

days

Exemple de requête+

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

Tester avec vos clés connectéesLIVE

Réponse JSON reçue

Lancez l’endpoint pour afficher sa réponse.

GET/email/search/

Recherche email unifiée

Recherchez les emails envoyés et reçus par identifiant, sujet ou adresse, sans charger le contenu.

Retrouvez rapidement une conversation dans les deux sens.

Paramètres utiles

querydirectionpageper_pagefromto

Exemple de requête+

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

Tester avec vos clés connectéesLIVE

Réponse JSON reçue

Lancez l’endpoint pour afficher sa réponse.

Télécharger la spécification OpenAPI 3.1Importez le contrat complet dans Postman, Insomnia, Swagger UI ou votre générateur de code.

Choisissez ce que vous voulez faire

Récupérer des e-mails

Lisez jusqu'à 30 e-mails à partir d'un dossier IMAP.

GET

Envoyer un email

Envoyez un e-mail depuis votre boîte mail connectée.

POST

Désabonnement des enregistrements

Lisez les enregistrements de désinscription pour mettre à jour votre liste de contacts.

GET

Deux clés. Deux métiers différents.

Utilisez les deux valeurs à chaque demande. Votre mot de passe de messagerie n'est pas utilisé dans les requêtes API.

apikey

Clé API du compte

Identifie votre compte. Trouvez-le dans votre tableau de bord MailBridgeAPI.

apikeybox

Clé API de boîte mail

Sélectionne la boîte mail à partir de laquelle envoyer ou lire. Il s'agit de la valeur apikeybox dans votre tableau de bord.

Les demandes nécessitent deux valeurs : apikey identifie votre compte ; apikeybox sélectionne une boîte mail configurée. Les exemples utilisent les paramètres de requête documentés. Conservez les clés dans les variables d'environnement côté serveur.

Authentification — Facultatif

Pour les points de terminaison GET, les paramètres de requête peuvent apparaître dans les journaux. La référence publiée décrit également l'authentification Bearer pour la clé de compte ; vérifiez le support dans votre intégration avant de l’adopter.

GET/getemail/

Récupérer des e-mails

Lire les messages d'un dossier IMAP sélectionné. Le résultat contient une carte à clé UID sous result.emaillist. Chaque page contient jusqu'à 30 messages ; incrémentez le début de 30 pour récupérer la page suivante.

Essayez ce point de terminaisonLIVE

Connectez la clé API de votre compte ci-dessus pour essayer ce point de terminaison.

Accédez à la connexion API

Demander un aperçu

{
  "method": "GET",
  "url": "https://api.mailbridgeapi.com/getemail/",
  "parameters": {
    "apikey": "YOUR_CONNECTED_API_KEY",
    "apikeybox": "YOUR_SELECTED_MAILBOX_KEY",
    "mbox": "INBOX",
    "start": "0"
  }
}

Réponse en direct

Votre réponse apparaîtra ici après avoir exécuté la demande.

Commencez par ces paramètres

Paramètre	Obligatoire	Descriptif
`apikey`	Obligatoire	Clé API du compte.
`apikeybox`	Obligatoire	Clé API de la boîte mail IMAP connectée.
`mbox`	Obligatoire	Nom du dossier IMAP, tel que INBOX, Envoyé ou Brouillons.

Tous les paramètres facultatifs+

Ajoutez-les uniquement lorsque vous avez besoin de la fonctionnalité correspondante.

Paramètre	Obligatoire	Descriptif
`start`	Facultatif	Index de base zéro ; la valeur par défaut est 0. Jusqu'à 30 messages par page.

Exemple de demande

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

Exemple uniquement – aucune demande en direct

Comment lire cette réponse

Les messages sont regroupés par leur IMAP UID sous result.emaillist. Le sujet (objet) et le corps peuvent être codés en URL. Décodez ces champs avant de les afficher sous forme de texte.

Une liste de diffusion vide peut être une réponse valide et réussie. Vérifiez le dossier sélectionné et démarrez l'index.

Exemple de réponse+

{
  "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/

Envoyer un email

Envoyez un e-mail via la connexion SMTP de la boîte mail sélectionnée. Prend en charge le HTML, le texte, les destinataires CC, les pièces jointes, les images en ligne et un pied de page de désabonnement facultatif.

Archivage facultatif dans les messages envoyés

Activez les copies envoyées pour la boîte mail dans la dashboard afin d’archiver les envois API réussis avec une tâche IMAP séparée. L’envoi SMTP reste indépendant : un problème IMAP ne transforme jamais un envoi accepté en erreur API. Ajoutez skip_sent_copy=1 à toute requête qui ne doit jamais être archivée.

Essayez ce point de terminaisonLIVE

Connectez la clé API de votre compte ci-dessus pour essayer ce point de terminaison.

Accédez à la connexion API

E-mail du destinataire *Sujet *Message *Format des messages

Paramètres facultatifs+

E-mail de l'expéditeurNom de l'expéditeurE-mail de réponseNom de réponseDestinataire CC 1Destinataire CC 2Destinataire CC 3Jeu de caractèresNom du fichier de la pièce jointe 1Pièce jointe 1 (base64)Nom du fichier de la pièce jointe 2Pièce jointe 2 (base64)URL de l'image en ligneID de contenu d'image intégréeLibellé source

Inclure le pied de page de désabonnementAutoriser les certificats TLS auto-signésLaissez désactivé pour la validation normale du certificat.L'explorateur accepte jusqu'à 1 Mo par requête. Gardez les pièces jointes de test petites.

Je comprends que cela envoie un véritable e-mail au destinataire indiqué ci-dessus.

Il s'agit d'un envoi en direct, pas d'une simulation. Les limites d’envoi de votre fournisseur s’appliquent.

Demander un aperçu

{
  "method": "POST",
  "url": "https://api.mailbridgeapi.com/sendemail/",
  "parameters": {
    "apikey": "YOUR_CONNECTED_API_KEY",
    "apikeybox": "YOUR_SELECTED_MAILBOX_KEY",
    "mail_subject": "Bonjour de MailBridgeAPI",
    "mail_body": "Ceci est un email de test envoyé depuis ma boîte mail connectée.",
    "format": "text"
  }
}

Réponse en direct

Votre réponse apparaîtra ici après avoir exécuté la demande.

Commencez par ces paramètres

Paramètre	Obligatoire	Descriptif
`apikey`	Obligatoire	Clé API du compte.
`apikeybox`	Obligatoire	Clé API de la boîte mail SMTP à utiliser.
`recipient_email`	Obligatoire	Adresse e-mail du destinataire principal.
`mail_subject`	Obligatoire	Objet de l'e-mail.
`mail_body`	Obligatoire	Corps du message HTML ou texte brut.

Tous les paramètres facultatifs+

Ajoutez-les uniquement lorsque vous avez besoin de la fonctionnalité correspondante.

Paramètre	Obligatoire	Descriptif
`sender_email`	Facultatif	Remplacez l'adresse de l'expéditeur ; par défaut, l'expéditeur de la boîte mail SMTP. Votre fournisseur doit autoriser l'adresse.
`sender_name`	Facultatif	Remplacez le nom d’affichage de l’expéditeur.
`reply_email`	Facultatif	Adresse de réponse ; la valeur par défaut est sender_email.
`reply_name`	Facultatif	Nom d’affichage de la réponse à.
`email_cc1, email_cc2, email_cc3`	Facultatif	Jusqu'à trois destinataires CC.
`format`	Facultatif	html (par défaut) ou texte.
`charset`	Facultatif	Jeu de caractères du message ; la valeur par défaut est UTF-8.
`attachmentBase64_1, attachmentBase64_2`	Facultatif	Contenu de la pièce jointe codé sous la forme base64.
`attachmentBase64_name_1, attachmentBase64_name_2`	Facultatif	Noms de fichiers pour les pièces jointes correspondantes.
`embeddedImage`	Facultatif	URL de l’image publique à intégrer en ligne.
`embeddedImage_cid`	Facultatif	Content ID référencé en HTML à l'aide de cid:YOUR_CID.
`unsubscribe`	Facultatif	Définissez sur 1 pour ajouter le pied de page de désabonnement configuré ; par défaut 0.
`from_source`	Facultatif	Une étiquette source facultative pour votre envoi.
`skip_sent_copy`	Facultatif	Définissez sur 1 pour empêcher que ce message soit copié dans le dossier IMAP des messages envoyés, même si l’archivage est activé.
`allow_self_signed`	Facultatif	Définissez sur oui pour autoriser les certificats TLS auto-signés. Omettre pour la validation normale du certificat.

Exemple de demande

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

Exemple uniquement – aucune demande en direct

Comment lire cette réponse

Vérifiez result.error = "0" et result.sent = "OK". Le serveur SMTP a accepté l'envoi ; cela ne garantit pas la livraison dans la boîte de réception du destinataire.

Exemple de réponse+

{
  "result": {
    "error": "0",
    "sent": "OK",
    "id": "msg_example"
  }
}

GET/email/unsubscribed/

Désabonnement des enregistrements

Récupérez jusqu'à 500 enregistrements d'envoi liés au désabonnement pour une boîte mail sous result.customer. Filtrez éventuellement par e-mail du destinataire. Le paramètre start est réservé et peut être ignoré.

Essayez ce point de terminaisonLIVE

Connectez la clé API de votre compte ci-dessus pour essayer ce point de terminaison.

Accédez à la connexion API

Demander un aperçu

{
  "method": "GET",
  "url": "https://api.mailbridgeapi.com/email/unsubscribed/",
  "parameters": {
    "apikey": "YOUR_CONNECTED_API_KEY",
    "apikeybox": "YOUR_SELECTED_MAILBOX_KEY"
  }
}

Réponse en direct

Votre réponse apparaîtra ici après avoir exécuté la demande.

Commencez par ces paramètres

Paramètre	Obligatoire	Descriptif
`apikey`	Obligatoire	Clé API du compte.
`apikeybox`	Obligatoire	Clé API de la boîte mail SMTP.

Tous les paramètres facultatifs+

Ajoutez-les uniquement lorsque vous avez besoin de la fonctionnalité correspondante.

Paramètre	Obligatoire	Descriptif
`email`	Facultatif	Filtrez les enregistrements par adresse e-mail du destinataire.
`start`	Facultatif	Index réservé ; peut être ignoré par l’implémentation actuelle.

Exemple de demande

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

Exemple uniquement – aucune demande en direct

Comment lire cette réponse

Les enregistrements sont inférieurs à result.customer. Utilisez ReceiverEmail pour mettre à jour votre liste. Ce point de terminaison lit les enregistrements de désinscription ; il ne désabonne pas lui-même un contact.

Exemple de réponse+

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

Réponses et erreurs

`200`	Demande traitée. Inspectez result.error pour le résultat du fournisseur.
`400`	Les paramètres requis sont manquants.
`401`	Clé API invalide ou expirée, ou compte désactivé.
`500`	Échec du fournisseur SMTP/IMAP ou erreur interne.

Si quelque chose ne va pas

401 / clé invalide+

Vérifiez les deux clés, la boîte mail sélectionnée et l'état actif du compte.

Échec de la connexion SMTP+

Vérifiez les autorisations de l'hôte SMTP, du port, de l'authentification et de l'expéditeur dans le tableau de bord.

Échec de la connexion IMAP+

Vérifiez l'accès IMAP, les informations d'identification et le nom exact du dossier.

Aucun message renvoyé+

Essayez INBOX avec start = 0. Le dossier est peut-être vide.

Délai d'attente après l'envoi+

Vérifiez votre tableau de bord ou votre dossier Envoyés avant de réessayer. L'envoi a peut-être déjà eu lieu.

Limites de taux

Limites publiées : envoi et récupération de désabonnement — 120 requêtes/minute ; Récupération IMAP — 60 requêtes/minute. Les propres limites de votre fournisseur s’appliquent également. Gérez les échecs et évitez de réessayer les envois aveuglément, ce qui peut créer des e-mails en double.

Les exemples de code sont des exemples. Les requêtes en direct s'exécutent uniquement lorsque vous soumettez explicitement un test de point de terminaison.

Documentation API e-mail : SMTP et IMAP.

Suivez les changements de l’API et du produit.

Construire avec un assistant IA ?

Votre première demande, en trois étapes

Connectez vos clés

Récupérez votre boîte de réception

Lire le résultat

Une boîte mail devient une API utilisable par tous vos projets.

Essayez l'API avec votre boîte mail

Des endpoints professionnels pour piloter votre boîte mail.

Utilisez les headers pour les nouvelles intégrations

État de la boîte mail

Historique des emails envoyés

Historique des emails reçus

Détail d’un message

Activité de la boîte

Validation avant envoi

Indicateurs de la boîte

Recherche email unifiée

Choisissez ce que vous voulez faire

Deux clés. Deux métiers différents.

Clé API du compte

Clé API de boîte mail

Récupérer des e-mails

Commencez par ces paramètres

Exemple de demande

Comment lire cette réponse

Envoyer un email

Archivage facultatif dans les messages envoyés

Commencez par ces paramètres

Exemple de demande

Comment lire cette réponse

Désabonnement des enregistrements

Commencez par ces paramètres

Exemple de demande

Comment lire cette réponse

Réponses et erreurs

Si quelque chose ne va pas

Limites de taux

Connectez votre propre boîte mail à des clés API, puis pilotez-la via des endpoints.

Envoyer via votre boîte

Lire votre boîte mail

Utiliser les données de votre boîte