Temp Mail API Documentation - Boomlify

Complete API reference for temporary email service integration

POST`/api/v1/emails/create`

Créer une nouvelle adresse email temporaire Prend maintenant en charge le paramètre optionnel custom_username pour créer des emails avec des adresses personnalisées.

Parameters:

custom_username (query, optional): Nom d'utilisateur personnalisé optionnel pour l'adresse email. Peut contenir des lettres, des chiffres, des points, des tirets et des underscores. Doit contenir entre 3 et 30 caractères. Si omis, un nom d'utilisateur aléatoire sera généré. - Example: john.doe
time (query, optional): Temps d'expiration - Example: permanent
domain (query, optional): Domaine personnalisé optionnel pour l'adresse email. Doit être un domaine vérifié dans votre compte (utilisez l'endpoint custom_domains pour vérifier). Si non spécifié, un domaine public aléatoire sera utilisé. - Example: mail.yourdomain.com
create_as_dashboard (query, optional): 💎 Fonction Premium - Définissez sur "true" pour créer un email de type tableau de bord stocké dans la base de données avec une expiration fixe de 2 mois au lieu d'un email API basé sur le temps. Omettez ou définissez sur "false" pour les emails basés sur le temps (par défaut). Les emails du tableau de bord coûtent 15 crédits. Les utilisateurs du niveau gratuit recevront une erreur 403. - Example: true

Error Responses:

INVALID_USERNAME (400): La validation du nom d'utilisateur personnalisé a échoué. Doit contenir entre 3 et 30 caractères avec uniquement des caractères valides.
EMAIL_IN_USE (409): Le nom d'utilisateur personnalisé est déjà pris. Choisissez un nom d'utilisateur différent.
DOMAIN_NOT_FOUND (400): Le domaine spécifié n'existe pas ou n'est pas vérifié. Vérifiez-le d'abord dans votre compte.
DOMAIN_NOT_VERIFIED (400): Le domaine existe mais n'est pas encore vérifié. Terminez d'abord la vérification du domaine.
DAILY_LIMIT_EXCEEDED (429): Vous avez atteint votre limite quotidienne pour ce type d'email

Auth Required: Yes | Rate Limited: Yes | Group: Quickstart

GET`/api/v1/emails`

Lister tous vos emails temporaires actifs

Parameters:

include_expired (query, optional): Inclure les emails expirés - Example: true
permanent_only (query, optional): Afficher uniquement vos boîtes permanentes sauvegardées. Coûte 2 crédits par requête. - Example: true
include_permanent (query, optional): Inclure vos boîtes permanentes sauvegardées avec les récentes. Coûte 2 crédits par requête. - Example: true
limit (query, optional): Nombre d'emails à retourner - Example: 50

Error Responses:

INSUFFICIENT_CREDITS (402): Retourné lors de la tentative de lister les boîtes permanentes sauvegardées mais le compte manque de crédits.

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails/{id}`

Obtenir les détails d'un email spécifique

Parameters:

id (path, required): ID de l'email - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): L'ID de l'email est invalide ou l'email a expiré

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails/{id}/messages`

Obtenir les messages pour un email spécifique

Parameters:

id (path, required): ID de l'email - Example: 550e8400-e29b-41d4-a716-446655440000
limit (query, optional): Nombre de messages à retourner - Example: 50
offset (query, optional): Nombre de messages à ignorer - Example: 0

Error Responses:

EMAIL_NOT_FOUND (404): L'ID de l'email est invalide ou l'email a expiré
INVALID_LIMIT (400): Le paramètre limite est hors de la plage valide

Auth Required: Yes | Rate Limited: No | Group: Emails

DELETE`/api/v1/emails/{id}`

Supprimer un email par ID. Prend en charge à la fois les emails API basés sur le temps (en mémoire, supprimés immédiatement) et les emails du tableau de bord (persistants en base de données, supprimés immédiatement). Retourne 404 si l'email n'est pas trouvé ou déjà supprimé.

Parameters:

id (path, required): ID de l'email (format UUID). Peut être un ID d'email API basé sur le temps ou un ID d'email du tableau de bord créé avec create_as_dashboard=true - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): L'email n'existe pas ou a déjà été supprimé

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails`

💎 Fonction Premium - Lister tous les emails, y compris les emails créés dans le tableau de bord. Cet endpoint fusionne les emails créés via l'API avec vos emails du tableau de bord dans une seule réponse. Coûte 2 crédits par requête. Nécessite un plan Basic ou supérieur.

Parameters:

include_dashboard (query, required): Doit être défini sur "true" pour accéder aux emails du tableau de bord. Cela active la fonction premium et facture 2 crédits. - Example: true
include_expired (query, optional): Inclure les emails expirés dans la réponse (emails API et emails du tableau de bord) - Example: false
limit (query, optional): Nombre maximum d'emails à retourner (max : 100) - Example: 50

Error Responses:

TIER_RESTRICTED (403): Il s'agit d'une fonction premium. Les utilisateurs du niveau gratuit ne peuvent pas accéder aux emails du tableau de bord via l'API.
INSUFFICIENT_CREDITS (402): Cette opération coûte 2 crédits. Veuillez ajouter plus de crédits à votre compte.

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}`

💎 Fonction Premium - Obtenir des informations détaillées sur un email spécifique du tableau de bord. Si l'email n'est pas trouvé dans le stockage API, il recherche vos emails du tableau de bord. Coûte 1 crédit par requête. Nécessite un plan Basic ou supérieur.

Parameters:

id (path, required): ID de l'email du tableau de bord (format UUID) - Copiez ceci depuis votre tableau de bord ou depuis l'endpoint list-dashboard-emails - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Doit être "true" pour rechercher les emails du tableau de bord. Facture 1 crédit. - Example: true

Error Responses:

TIER_RESTRICTED (403): L'accès aux emails du tableau de bord nécessite un plan payant
INSUFFICIENT_CREDITS (402): Cette opération coûte 1 crédit
EMAIL_NOT_FOUND (404): L'email demandé n'a pas été trouvé ou a expiré

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}/messages`

💎 Fonction Premium - Récupérer tous les messages reçus pour un email du tableau de bord avec support de pagination. Utilise le cache pour des temps de réponse rapides. Coûte 1 crédit par requête. Nécessite un plan Basic ou supérieur.

Parameters:

id (path, required): ID de l'email du tableau de bord - L'UUID de l'email pour lequel vous souhaitez récupérer les messages - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Doit être "true" pour accéder aux messages de l'email du tableau de bord. Facture 1 crédit. - Example: true
limit (query, optional): Nombre maximum de messages à retourner par page (max : 100) - Example: 20
offset (query, optional): Nombre de messages à ignorer pour la pagination (par exemple, offset=20 avec limit=20 obtient la page 2) - Example: 0

Error Responses:

TIER_RESTRICTED (403): L'accès aux emails du tableau de bord nécessite un plan payant
INSUFFICIENT_CREDITS (402): Cette opération coûte 1 crédit
EMAIL_NOT_FOUND (404): L'email demandé n'a pas été trouvé ou a expiré

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}/telegram-forwarding`

Premium Feature - Get Telegram forwarding status for a specific owned mailbox. Supports dashboard mailboxes and permanent API mailboxes. Ownership is checked through the existing cached mailbox lookup paths, and forwarding state is returned from the forwarding cache. Costs 2 credits per request. Requires Basic plan or higher.

Parameters:

id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding status you want to inspect - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Must be set to "true" to access Telegram forwarding mailbox status. Charges 2 credits. - Example: true

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot access dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/{id}/telegram-forwarding`

Premium Feature - Enable or disable Telegram forwarding for an owned mailbox. Supports dashboard mailboxes and permanent API mailboxes, while reusing the existing forwarding cache and write-through persistence path. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.

Parameters:

id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding you want to update - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Must be set to "true" to update Telegram mailbox forwarding. Charges 2 credits. - Example: true
is_enabled (body, required): Boolean body field. Set true to enable forwarding or false to disable forwarding. - Example: true

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot update dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/telegram-forwarding/bulk-enable`

Premium Feature - Bulk enable Telegram forwarding for multiple owned mailboxes in one API request. Supports dashboard mailboxes and permanent API mailboxes, reuses the existing per-email forwarding enable flow, and respects the active-forwarding limit. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.

Parameters:

include_dashboard (query, required): Must be set to "true" to bulk enable Telegram mailbox forwarding. Charges 2 credits. - Example: true
email_ids (body, required): Body field containing a non-empty array of owned mailbox IDs. In the test form, you can enter a single mailbox ID or a JSON array. - Example: ["550e8400-e29b-41d4-a716-446655440000"]

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot bulk enable dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits total per bulk request.
NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
EMAIL_NOT_FOUND (404): No matching forwardable mailboxes were found.

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/create`

💎 Fonction Premium - Créer un nouvel email avec un nom d'utilisateur personnalisé optionnel. Les emails du tableau de bord (create_as_dashboard=true) sont stockés dans la base de données avec une expiration fixe de 2 mois et coûtent 15 crédits. Les emails API basés sur le temps prennent en charge les options de temps personnalisées (10min, 1hour, 1day, permanent). Les deux prennent en charge custom_username. Nécessite un plan Basic ou supérieur.

Parameters:

create_as_dashboard (query, optional): Définissez sur "true" pour créer un email de type tableau de bord stocké dans la base de données avec une expiration fixe de 2 mois. Si omis, crée un email API basé sur le temps en mémoire. Les deux prennent en charge custom_username. - Example: true
custom_username (query, optional): Nom d'utilisateur personnalisé optionnel pour l'adresse email. Peut contenir des lettres, des chiffres, des points, des tirets et des underscores. Doit contenir entre 3 et 30 caractères. Si omis, un nom d'utilisateur aléatoire sera généré. - Example: john.doe
domain (query, optional): Nom de domaine personnalisé optionnel pour l'adresse email. Si non spécifié, un domaine public aléatoire sera utilisé. - Example: mail.yourdomain.com

Error Responses:

TIER_RESTRICTED (403): La création d'emails du tableau de bord nécessite un plan payant
INSUFFICIENT_CREDITS (402): Cette opération coûte 15 crédits
INVALID_USERNAME (400): La validation du nom d'utilisateur personnalisé a échoué. Doit contenir entre 3 et 30 caractères avec uniquement des caractères valides.
EMAIL_IN_USE (409): Le nom d'utilisateur personnalisé est déjà pris. Choisissez un nom d'utilisateur différent.
INVALID_TIME_PARAMETER (400): Le temps doit être l'un de : 10min, 1hour, 1day, permanent

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/account/usage`

Obtenir vos statistiques d'utilisation de l'API

Error Responses:

UNAUTHORIZED (401): La clé API est requise et doit être valide

Auth Required: Yes | Rate Limited: No | Group: Account

GET`/api/v1/account/info`

Obtenir les informations de votre compte

Error Responses:

UNAUTHORIZED (401): La clé API est requise et doit être valide

Auth Required: Yes | Rate Limited: No | Group: Account

GET`/api/v1/account/credits`

Obtenir des informations détaillées sur le solde des crédits et l'utilisation

Error Responses:

UNAUTHORIZED (401): La clé API est requise et doit être valide

Auth Required: Yes | Rate Limited: No | Group: Account

Hub de Documentation et de Test de l’API Temp Mail

Consultez la doc, testez les endpoints et copiez le code — sur une seule page.

URL de base :

https://v1.boomlify.com

Démarrage rapide

E‑mails

💎 Dashboard API (Premium)

Compte

POST /api/v1/emails/create

Créer une nouvelle adresse email temporaire Prend maintenant en charge le paramètre optionnel custom_username pour créer des emails avec des adresses personnalisées.

Authentification requiseLimité en taux

Documentation

Paramètres

requête

custom_username

Nom d'utilisateur personnalisé optionnel pour l'adresse email. Peut contenir des lettres, des chiffres, des points, des tirets et des underscores. Doit contenir entre 3 et 30 caractères. Si omis, un nom d'utilisateur aléatoire sera généré.

Exemple : john.doe

⚠️ ⚠️ Doit contenir entre 3 et 30 caractères. Ne peut pas commencer/se terminer par des caractères spéciaux. Doit être unique. Retourne 409 si déjà pris.

requête

time

Temps d'expiration

Exemple : permanent

⚠️ Doit être l'un de : 10min, 1hour, 1day, permanent

requête

domain

Domaine personnalisé optionnel pour l'adresse email. Doit être un domaine vérifié dans votre compte (utilisez l'endpoint custom_domains pour vérifier). Si non spécifié, un domaine public aléatoire sera utilisé.

Exemple : mail.yourdomain.com

⚠️ ⚠️ Doit être un domaine personnalisé vérifié ou un domaine public. Retourne 400 si non disponible.

requête

create_as_dashboard

💎 Fonction Premium - Définissez sur "true" pour créer un email de type tableau de bord stocké dans la base de données avec une expiration fixe de 2 mois au lieu d'un email API basé sur le temps. Omettez ou définissez sur "false" pour les emails basés sur le temps (par défaut). Les emails du tableau de bord coûtent 15 crédits. Les utilisateurs du niveau gratuit recevront une erreur 403.

Exemple : true

⚠️ ⚠️ Doit être "true" ou omis. Les emails du tableau de bord nécessitent un plan Basic ou supérieur. Expiration fixe de 2 mois (le paramètre temps est ignoré).

Exemples d’erreur

400

INVALID_USERNAME

Le nom d'utilisateur doit contenir au moins 3 caractères

La validation du nom d'utilisateur personnalisé a échoué. Doit contenir entre 3 et 30 caractères avec uniquement des caractères valides.

409

EMAIL_IN_USE

L'adresse email "[email protected]" est déjà utilisée

Le nom d'utilisateur personnalisé est déjà pris. Choisissez un nom d'utilisateur différent.

400

DOMAIN_NOT_FOUND

Le domaine "custom.domain" n'est pas disponible. Il doit être soit un domaine personnalisé vérifié dans votre compte, soit un domaine public.

Le domaine spécifié n'existe pas ou n'est pas vérifié. Vérifiez-le d'abord dans votre compte.

400

DOMAIN_NOT_VERIFIED

Le domaine personnalisé "custom.domain" n'est pas vérifié. Statut actuel : en attente

Le domaine existe mais n'est pas encore vérifié. Terminez d'abord la vérification du domaine.

429

DAILY_LIMIT_EXCEEDED

Limite quotidienne dépassée pour les emails d'1 heure

Vous avez atteint votre limite quotidienne pour ce type d'email

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

requête

include_expired

Inclure les emails expirés

Exemple : true

⚠️ Doit être "true" ou "false"

requête

permanent_only

Afficher uniquement vos boîtes permanentes sauvegardées. Coûte 2 crédits par requête.

Exemple : true

⚠️ Doit être "true" ou "false"

requête

include_permanent

Inclure vos boîtes permanentes sauvegardées avec les récentes. Coûte 2 crédits par requête.

Exemple : true

⚠️ Doit être "true" ou "false"

requête

limit

Nombre d'emails à retourner

Exemple : 50

⚠️ Maximum 100 emails

Exemples d’erreur

402

INSUFFICIENT_CREDITS

Ajoutez des crédits pour lister les boîtes permanentes.

Retourné lors de la tentative de lister les boîtes permanentes sauvegardées mais le compte manque de crédits.

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

cheminObligatoire

ID de l'email

Exemple : 550e8400-e29b-41d4-a716-446655440000

⚠️ Doit être un UUID valide

Exemples d’erreur

404

EMAIL_NOT_FOUND

L'email demandé n'a pas été trouvé ou a expiré

L'ID de l'email est invalide ou l'email a expiré

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

cheminObligatoire

ID de l'email

Exemple : 550e8400-e29b-41d4-a716-446655440000

⚠️ Doit être un UUID valide

requête

limit

Nombre de messages à retourner

Exemple : 50

⚠️ Maximum 100 messages

requête

offset

Nombre de messages à ignorer

Exemple : 0

⚠️ Doit être un entier non négatif

Exemples d’erreur

404

EMAIL_NOT_FOUND

L'email demandé n'a pas été trouvé ou a expiré

L'ID de l'email est invalide ou l'email a expiré

400

INVALID_LIMIT

La limite doit être entre 1 et 100

Le paramètre limite est hors de la plage valide

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

cheminObligatoire

ID de l'email (format UUID). Peut être un ID d'email API basé sur le temps ou un ID d'email du tableau de bord créé avec create_as_dashboard=true

Exemple : 550e8400-e29b-41d4-a716-446655440000

⚠️ Doit être un UUID valide

Exemples d’erreur

404

EMAIL_NOT_FOUND

L'email demandé n'a pas été trouvé ou a expiré

L'email n'existe pas ou a déjà été supprimé

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

requêteObligatoire

include_dashboard

Doit être défini sur "true" pour accéder aux emails du tableau de bord. Cela active la fonction premium et facture 2 crédits.

Exemple : true

⚠️ Doit être "true" - Les utilisateurs du niveau gratuit recevront une erreur 403

requête

include_expired

Inclure les emails expirés dans la réponse (emails API et emails du tableau de bord)

Exemple : false

requête

limit

Nombre maximum d'emails à retourner (max : 100)

Exemple : 50

⚠️ Doit être entre 1 et 100

Exemples d’erreur

403

TIER_RESTRICTED

L'accès aux emails du tableau de bord nécessite un plan payant (Basic ou supérieur)

Il s'agit d'une fonction premium. Les utilisateurs du niveau gratuit ne peuvent pas accéder aux emails du tableau de bord via l'API.

402

INSUFFICIENT_CREDITS

2 crédits nécessaires pour lister les emails du tableau de bord

Cette opération coûte 2 crédits. Veuillez ajouter plus de crédits à votre compte.

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

cheminObligatoire

ID de l'email du tableau de bord (format UUID) - Copiez ceci depuis votre tableau de bord ou depuis l'endpoint list-dashboard-emails

Exemple : 550e8400-e29b-41d4-a716-446655440000

⚠️ Doit être un UUID valide provenant de vos emails du tableau de bord

requêteObligatoire

include_dashboard

Doit être "true" pour rechercher les emails du tableau de bord. Facture 1 crédit.

Exemple : true

Exemples d’erreur

403

TIER_RESTRICTED

Fonction Premium

L'accès aux emails du tableau de bord nécessite un plan payant

402

INSUFFICIENT_CREDITS

1 crédit nécessaire pour accéder à l'email du tableau de bord

Cette opération coûte 1 crédit

404

EMAIL_NOT_FOUND

Email non trouvé

L'email demandé n'a pas été trouvé ou a expiré

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

cheminObligatoire

ID de l'email du tableau de bord - L'UUID de l'email pour lequel vous souhaitez récupérer les messages

Exemple : 550e8400-e29b-41d4-a716-446655440000

⚠️ Doit être un UUID valide provenant de vos emails du tableau de bord

requêteObligatoire

include_dashboard

Doit être "true" pour accéder aux messages de l'email du tableau de bord. Facture 1 crédit.

Exemple : true

requête

limit

Nombre maximum de messages à retourner par page (max : 100)

Exemple : 20

⚠️ Doit être entre 1 et 100

requête

offset

Nombre de messages à ignorer pour la pagination (par exemple, offset=20 avec limit=20 obtient la page 2)

Exemple : 0

⚠️ Doit être un entier non négatif

Exemples d’erreur

403

TIER_RESTRICTED

Fonction Premium

L'accès aux emails du tableau de bord nécessite un plan payant

402

INSUFFICIENT_CREDITS

1 crédit nécessaire pour accéder aux messages de l'email du tableau de bord

Cette opération coûte 1 crédit

404

EMAIL_NOT_FOUND

Email non trouvé

L'email demandé n'a pas été trouvé ou a expiré

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

cheminObligatoire

Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding status you want to inspect

Exemple : 550e8400-e29b-41d4-a716-446655440000

⚠️ Must be an owned dashboard mailbox ID or permanent API mailbox ID

requêteObligatoire

include_dashboard

Must be set to "true" to access Telegram forwarding mailbox status. Charges 2 credits.

Exemple : true

⚠️ Must be "true" - Free tier users will receive a 403 error

Exemples d’erreur

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot access dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to access dashboard email Telegram forwarding status

This operation costs 2 credits. Please add more credits to your account.

404

EMAIL_NOT_FOUND

Email not found

The requested mailbox was not found, is unsupported, or has expired

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

cheminObligatoire

Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding you want to update

Exemple : 550e8400-e29b-41d4-a716-446655440000

⚠️ Must be an owned dashboard mailbox ID or permanent API mailbox ID

requêteObligatoire

include_dashboard

Must be set to "true" to update Telegram mailbox forwarding. Charges 2 credits.

Exemple : true

⚠️ Must be "true" - Free tier users will receive a 403 error

corpsObligatoire

is_enabled

Boolean body field. Set true to enable forwarding or false to disable forwarding.

Exemple : true

⚠️ Must be a boolean value

Exemples d’erreur

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot update dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to update dashboard email Telegram forwarding

This operation costs 2 credits. Please add more credits to your account.

400

NO_TELEGRAM_BINDING

No active Telegram binding found. Please bind your Telegram account first.

Forwarding cannot be enabled until the account has an active verified Telegram binding.

403

FORWARDING_LIMIT_EXCEEDED

Forwarding limit exceeded

The user has reached the plan limit for active Telegram forwardings.

404

EMAIL_NOT_FOUND

Email not found

The requested mailbox was not found, is unsupported, or has expired

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

requêteObligatoire

include_dashboard

Must be set to "true" to bulk enable Telegram mailbox forwarding. Charges 2 credits.

Exemple : true

⚠️ Must be "true" - Free tier users will receive a 403 error

corpsObligatoire

email_ids

Body field containing a non-empty array of owned mailbox IDs. In the test form, you can enter a single mailbox ID or a JSON array.

Exemple : ["550e8400-e29b-41d4-a716-446655440000"]

⚠️ Must resolve to a non-empty array of owned dashboard mailbox IDs or permanent API mailbox IDs. The bulk limit is 150 IDs per request.

Exemples d’erreur

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot bulk enable dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to bulk enable dashboard email Telegram forwarding

This operation costs 2 credits total per bulk request.

400

NO_TELEGRAM_BINDING

No active Telegram binding found. Please bind your Telegram account first.

Forwarding cannot be enabled until the account has an active verified Telegram binding.

403

FORWARDING_LIMIT_EXCEEDED

Forwarding limit exceeded

The user has reached the plan limit for active Telegram forwardings.

404

EMAIL_NOT_FOUND

Email not found

No matching forwardable mailboxes were found.

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Paramètres

requête

create_as_dashboard

Définissez sur "true" pour créer un email de type tableau de bord stocké dans la base de données avec une expiration fixe de 2 mois. Si omis, crée un email API basé sur le temps en mémoire. Les deux prennent en charge custom_username.

Exemple : true

⚠️ ⚠️ Les emails du tableau de bord coûtent 15 crédits. Expiration fixe de 2 mois (pas de paramètre temps). Les utilisateurs du niveau gratuit recevront une erreur 403. Omettez ce paramètre pour créer un email API basé sur le temps avec des options de temps personnalisées.

requête

custom_username

Exemple : john.doe

⚠️ ⚠️ Doit contenir entre 3 et 30 caractères. Ne peut pas commencer/se terminer par des caractères spéciaux. Doit être unique parmi tous vos emails. Si déjà pris, retourne 409 Conflict.

requête

domain

Nom de domaine personnalisé optionnel pour l'adresse email. Si non spécifié, un domaine public aléatoire sera utilisé.

Exemple : mail.yourdomain.com

⚠️ Doit être un domaine vérifié dans votre compte

Exemples d’erreur

403

TIER_RESTRICTED

Fonction Premium

La création d'emails du tableau de bord nécessite un plan payant

402

INSUFFICIENT_CREDITS

15 crédits nécessaires pour créer un email du tableau de bord

Cette opération coûte 15 crédits

400

INVALID_USERNAME

Le nom d'utilisateur doit contenir au moins 3 caractères

La validation du nom d'utilisateur personnalisé a échoué. Doit contenir entre 3 et 30 caractères avec uniquement des caractères valides.

409

EMAIL_IN_USE

L'adresse email "[email protected]" est déjà utilisée

Le nom d'utilisateur personnalisé est déjà pris. Choisissez un nom d'utilisateur différent.

400

INVALID_TIME_PARAMETER

Paramètre de temps invalide

Le temps doit être l'un de : 10min, 1hour, 1day, permanent

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Exemples d’erreur

401

UNAUTHORIZED

Clé API invalide ou manquante

La clé API est requise et doit être valide

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Exemples d’erreur

401

UNAUTHORIZED

Clé API invalide ou manquante

La clé API est requise et doit être valide

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Documentation

Exemples d’erreur

401

UNAUTHORIZED

Clé API invalide ou manquante

La clé API est requise et doit être valide

Requête d’exemple

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

Extraits de code

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Limite : 60 RPMHub API

Tester l’API