Documentation de l'API TempMail

API REST v1 & Webhooks

TempMailg Documentation de l'API développeur

Utilisez cette documentation pour générer votre clé API personnelle, connecter l'hôte API utilisateur dédié, lire les messages de la boîte de réception, gérer les boîtes de réception possédées et intégrer Temp Mail dans vos propres applications ou automatisations.

Authentification par jeton Bearer Webhooks en temps réel Alias Gmail et Outlook Réponses JSON
URL de base de l'API utilisateur HTTPS
Format de requête Utilisez votre clé API uniquement dans l'en-tête d'authentification Bearer et gardez les URL de point de terminaison propres.

Gestion de la boîte aux lettres

Récupérer les domaines autorisés, créer ou changer de boîtes aux lettres, choisir les durées de vie permises, et supprimer les adresses possédées.

GET https://v1.tempmailg.com/api/domains?type={type}
#

Lister les domaines autorisés

Listez les domaines disponibles pour créer des e‑mails temporaires. Filtrez par type pour ne voir que les domaines gratuits, premium ou personnalisés pris en charge par votre plan d’abonnement.

Paramètres 1
Paramètre Emplacement Type Statut Description
type query string optionnel
Filtre de niveau de domaine. L'omission utilise tout lorsque l'accès premium-domain est activé, sinon gratuit. Valeurs reconnues : free, basic, pro, premium, custom, ultimate, all
Par défaut: Dépendant du compte
Obtenir les domaines autorisés
curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "data": {
        "requested_type": "free",
        "plan": "pro",
        "plan_name": "Pro Plan",
        "allowed_types": [
            "free",
            "basic",
            "pro",
            "premium",
            "custom",
            "ultimate",
            "all"
        ],
        "domains": [
            {
                "domain": "example.com",
                "type": "Free",
                "custom": false
            }
        ]
    }
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
data.requested_type string
Filtre de domaine appliqué.
data.plan string
Étiquette du plan actuel.
data.plan_name string
Nom lisible du plan actuel.
data.allowed_types array<string>
Filtres de domaine disponibles pour ce compte. Un filtre reconnu peut néanmoins être interdit selon votre forfait.
data.domains array
Domaines sélectionnables après filtrage; un tableau vide est valide.
data.domains[].domain string
Nom de domaine sélectionnable.
data.domains[].type string
Étiquette du niveau de domaine lisible.
data.domains[].custom boolean
Indique si c'est un domaine personnalisé.
POST https://v1.tempmailg.com/api/emails
#

Créer une boîte aux lettres temporaire

Créez une boîte aux lettres temporaire détenue. Omettez le nom d'utilisateur et le domaine pour une génération aléatoire, ou fournissez un nom d'utilisateur personnalisé autorisé et un domaine autorisé. Le paramètre provider peut sélectionner la génération d'alias Gmail ou Outlook.

Paramètres 8
Paramètre Emplacement Type Statut Description
username body string optionnel
Nom d'utilisateur personnalisé optionnel : de 2 à 64 caractères ASCII, lettres, chiffres, points, soulignés ou traits d'union. Nécessite une autorisation de plan ; custom_username est également accepté.
Par défaut: Généré aléatoirement
domain body string optionnel
L'un des domaines autorisés renvoyés par GET /domains. L'omission choisit un domaine autorisé aléatoire.
Par défaut: Domaine autorisé aléatoire
lifetime body string optionnel
valeurs autorisées :
10m — 10 Minutes 1h — 1 Heure 2h — 2 Heures 1d — 1 jour 1w — 1 Semaine 1m — 30 jours 3m — 90 jours 6m — 180 jours 1y — 365 jours unlimited — Illimité
Par défaut: Durée de vie par défaut du plan
provider body string optionnel
Fournisseur de boîte aux lettres : standard, gmail_alias, ou outlook_alias.
Par défaut: standard
pin_enabled body boolean optionnel
Protection par code PIN facultative pour la nouvelle boîte aux lettres, lorsque votre forfait le permet. Cela ne modifie pas le code PIN d'une boîte aux lettres existante.
Par défaut: false
pin body string optionnel
Requis lorsque pin_enabled est vrai : un code PIN de 6 à 8 chiffres, envoyé sous forme de chaîne pour préserver les zéros initiaux.
pin_confirmation body string optionnel
Requis lorsque pin_enabled est vrai. Doit correspondre exactement au pin.
Idempotency-Key header string optionnel
Requis pour la création ou la suppression protégée par PIN : une clé stable de 16 à 128 caractères. Réessayez la même requête avec la même clé pour éviter un travail en double.
Paramètres du corps optionnels : username (nom d'utilisateur personnalisé si autorisé par le forfait), domain (domaine autorisé, p. ex. example.com), lifetime (valeurs autorisées : 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Omettez la durée de vie, ou laissez‑la vide, pour utiliser la Durée de vie d'e‑mail par défaut configurée pour votre plan mensuel/annuel actuel. Envoyez une durée de vie autorisée telle que 1h pour remplacer cette valeur par défaut. Illimité n’est utilisé que lorsqu’il est configuré comme valeur par défaut du plan ou explicitement demandé et autorisé. Les paramètres du corps mailbox_lifetime et email_lifetime sont également acceptés; la première valeur non vide l'emporte dans cet ordre: lifetime, mailbox_lifetime, email_lifetime. Les valeurs invalides ou non autorisées renvoient HTTP 422 au lieu de sélectionner silencieusement une valeur par défaut.
Créer une boîte aux lettres
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2301,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-20T02:18:13+00:00",
        "expires_in_seconds": 86399.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:13+00:00",
        "email_token": "encrypted-email-token"
    }
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
data.id integer
ID de boîte aux lettres. Les ID, adresses et jetons générés diffèrent pour chaque boîte aux lettres.
data.pin_protected boolean
Indique si cette boîte aux lettres possède une protection par code PIN. Aucun code PIN ou hachage de code PIN n'est renvoyé.
data.email string
Adresse complète de la boîte aux lettres générée.
data.domain string
Domaine de la boîte aux lettres générée.
data.provider string
Fournisseur de boîte aux lettres : standard, gmail_alias, ou outlook_alias.
data.expire_at string|null
Expiration effective sous forme d'un horodatage ISO-8601, ou null pour une boîte aux lettres illimitée.
data.expires_in_seconds number|null
Secondes restantes non négatives lorsqu'elles sont calculées ; des secondes fractionnaires sont possibles. Null signifie illimité, pas zéro.
data.mailbox_state string
État actuel de la boîte aux lettres : actif, en pause, expiré ou inactif.
data.receiving_enabled boolean
Indique si cette boîte aux lettres accepte actuellement les messages entrants.
data.message_count integer
Nombre total de messages connu ; il peut refléter la dernière synchronisation de la boîte aux lettres.
data.unread_message_count integer
Nombre de messages non lus connus ; il peut refléter la dernière synchronisation de la boîte aux lettres.
data.last_message_received_at string|null
Dernière heure connue du message reçu au format ISO-8601, ou null lorsqu'indisponible.
data.message_count_synced_at string|null
Dernière heure de synchronisation du nombre de messages au format ISO-8601, ou null avant la synchronisation.
data.created_at string|null
Heure de création de la boîte aux lettres au format ISO-8601.
data.email_token string
Référence de boîte aux lettres chiffrée opaque. Elle ne remplace pas l'authentification Bearer, les vérifications de propriété ou l'autorisation par code PIN.
data.pin_grant object
Conditionnel : la création de boîte aux lettres protégée par PIN active renvoie cette autorisation de lecture ; la création ordinaire non protégée l'ommet.
data.pin_grant.mailbox_id integer
ID de boîte aux lettres auquel la concession de lecture conditionnelle est liée.
data.pin_grant.unlock_token string
Jeton de lecture opaque pour X-Mailbox-Unlock avec les mêmes informations d'identification du propriétaire. Gardez-le privé et en mémoire ; une autorisation de lecture n'autorise pas la suppression.
data.pin_grant.scope string
La portée lue pour l'octroi de création conditionnelle.
data.pin_grant.idle_timeout_seconds integer
Temps d'inactivité autorisé pour l'autorisation de lecture, généralement 3600 secondes.
data.pin_grant.absolute_timeout_seconds integer
Durée de vie maximale de l'autorisation de lecture, généralement 86400 secondes.
data.pin_grant.expires_at string
Expiration actuelle du droit de lecture au format ISO-8601.
data.pin_grant.absolute_expires_at string
Expiration absolue du droit de lecture au format ISO-8601. Les changements de sécurité peuvent révoquer le droit plus tôt.
POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}
#

Mettre à jour / Changer de boîte aux lettres

Créez ou sélectionnez une boîte aux lettres avec le nouveau nom d'utilisateur et domaine après avoir vérifié la propriété de la boîte aux lettres actuelle. Cela ne renomme pas l'ancienne boîte aux lettres ni ne modifie sa durée de vie sur place. Lorsque la destination diffère, l'ancienne boîte aux lettres reste dans l'historique et peut être mise en pause par les limites de boîtes aux lettres actives. Réutiliser votre propre destination active réapplique sa durée de vie demandée ou la valeur par défaut du plan.

Paramètres 9
Paramètre Emplacement Type Statut Description
email path string obligatoire
Adresse e-mail complète actuelle de la boîte aux lettres possédée à changer. URL-encodez chaque segment de chemin ; encodez un signe plus comme %2B.
username path string obligatoire
Nouveau nom d'utilisateur souhaité : 2 à 64 caractères alphanumériques ; soumis à l'autorisation de nom d'utilisateur personnalisé.
domain path string obligatoire
Nouveau nom de domaine autorisé.
lifetime body string optionnel
valeurs autorisées :
10m — 10 Minutes 1h — 1 Heure 2h — 2 Heures 1d — 1 jour 1w — 1 Semaine 1m — 30 jours 3m — 90 jours 6m — 180 jours 1y — 365 jours unlimited — Illimité
Par défaut: Durée de vie par défaut du plan
pin_enabled body boolean optionnel
Protection par code PIN facultative pour la nouvelle boîte aux lettres, lorsque votre forfait le permet. Cela ne modifie pas le code PIN d'une boîte aux lettres existante.
Par défaut: false
pin body string optionnel
Requis lorsque pin_enabled est vrai : un code PIN de 6 à 8 chiffres, envoyé sous forme de chaîne pour préserver les zéros initiaux.
pin_confirmation body string optionnel
Requis lorsque pin_enabled est vrai. Doit correspondre exactement au pin.
Idempotency-Key header string optionnel
Requis pour la création ou la suppression protégée par PIN : une clé stable de 16 à 128 caractères. Réessayez la même requête avec la même clé pour éviter un travail en double.
X-Mailbox-Unlock header string optionnel
En-tête, boîtes aux lettres protégées uniquement : utilisez un unlock_token en lecture. D’abord POST pin et scope=read à l’URL de déverrouillage du PIN. Conservez votre authentification Bearer normale. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Utiliser une adresse e-mail de boîte aux lettres appartenant à l'utilisateur existante dans {email}. Paramètre de corps optionnel : lifetime (valeurs autorisées : 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Omettez la durée de vie, ou laissez‑la vide, pour utiliser la Durée de vie d'e‑mail par défaut configurée pour votre plan mensuel/annuel actuel. Envoyez une durée de vie autorisée telle que 1h pour remplacer cette valeur par défaut. Illimité n’est utilisé que lorsqu’il est configuré comme valeur par défaut du plan ou explicitement demandé et autorisé. Les paramètres du corps mailbox_lifetime et email_lifetime sont également acceptés; la première valeur non vide l'emporte dans cet ordre: lifetime, mailbox_lifetime, email_lifetime. Les valeurs invalides ou non autorisées renvoient HTTP 422 au lieu de sélectionner silencieusement une valeur par défaut.
Mettre à jour la boîte aux lettres appartenant à l'utilisateur
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2302,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-19T02:28:13+00:00",
        "expires_in_seconds": 599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:13+00:00",
        "email_token": "encrypted-email-token"
    }
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
data.id integer
ID de boîte aux lettres. Les ID, adresses et jetons générés diffèrent pour chaque boîte aux lettres.
data.pin_protected boolean
Indique si cette boîte aux lettres possède une protection par code PIN. Aucun code PIN ou hachage de code PIN n'est renvoyé.
data.email string
Adresse complète de la boîte aux lettres générée.
data.domain string
Domaine de la boîte aux lettres générée.
data.provider string
Fournisseur de boîte aux lettres : standard, gmail_alias, ou outlook_alias.
data.expire_at string|null
Expiration effective sous forme d'un horodatage ISO-8601, ou null pour une boîte aux lettres illimitée.
data.expires_in_seconds number|null
Secondes restantes non négatives lorsqu'elles sont calculées ; des secondes fractionnaires sont possibles. Null signifie illimité, pas zéro.
data.mailbox_state string
État actuel de la boîte aux lettres : actif, en pause, expiré ou inactif.
data.receiving_enabled boolean
Indique si cette boîte aux lettres accepte actuellement les messages entrants.
data.message_count integer
Nombre total de messages connu ; il peut refléter la dernière synchronisation de la boîte aux lettres.
data.unread_message_count integer
Nombre de messages non lus connus ; il peut refléter la dernière synchronisation de la boîte aux lettres.
data.last_message_received_at string|null
Dernière heure connue du message reçu au format ISO-8601, ou null lorsqu'indisponible.
data.message_count_synced_at string|null
Dernière heure de synchronisation du nombre de messages au format ISO-8601, ou null avant la synchronisation.
data.created_at string|null
Heure de création de la boîte aux lettres au format ISO-8601.
data.email_token string
Référence de boîte aux lettres chiffrée opaque. Elle ne remplace pas l'authentification Bearer, les vérifications de propriété ou l'autorisation par code PIN.
data.pin_grant object
Conditionnel : la création de boîte aux lettres protégée par PIN active renvoie cette autorisation de lecture ; la création ordinaire non protégée l'ommet.
data.pin_grant.mailbox_id integer
ID de boîte aux lettres auquel la concession de lecture conditionnelle est liée.
data.pin_grant.unlock_token string
Jeton de lecture opaque pour X-Mailbox-Unlock avec les mêmes informations d'identification du propriétaire. Gardez-le privé et en mémoire ; une autorisation de lecture n'autorise pas la suppression.
data.pin_grant.scope string
La portée lue pour l'octroi de création conditionnelle.
data.pin_grant.idle_timeout_seconds integer
Temps d'inactivité autorisé pour l'autorisation de lecture, généralement 3600 secondes.
data.pin_grant.absolute_timeout_seconds integer
Durée de vie maximale de l'autorisation de lecture, généralement 86400 secondes.
data.pin_grant.expires_at string
Expiration actuelle du droit de lecture au format ISO-8601.
data.pin_grant.absolute_expires_at string
Expiration absolue du droit de lecture au format ISO-8601. Les changements de sécurité peuvent révoquer le droit plus tôt.
DELETE https://v1.tempmailg.com/api/emails/{email}
#

Supprimer la boîte aux lettres

Supprimez une boîte aux lettres détenue et lancez son nettoyage des messages et des fichiers. Les enregistrements de boîte aux lettres conservés peuvent être supprimés de manière douce en interne ; l'adresse n'est plus utilisable via l'API.

Paramètres 3
Paramètre Emplacement Type Statut Description
email path string obligatoire
Adresse e-mail complète de la boîte aux lettres possédée à supprimer. Encodez l'adresse en URL ; encodez le signe plus comme %2B.
X-Mailbox-Unlock header string optionnel
En-tête, boîtes aux lettres protégées uniquement : utilisez le jeton de déverrouillage à usage unique de suppression. D'abord POST le pin, scope=delete et l'action/target_id renvoyés par la réponse 423 à l'URL de déverrouillage du PIN. Un jeton de lecture ne peut pas supprimer. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string optionnel
Requis pour la création ou la suppression protégée par PIN : une clé stable de 16 à 128 caractères. Réessayez la même requête avec la même clé pour éviter un travail en double.
Supprimer la boîte aux lettres appartenant à l'utilisateur
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "message": "Email has been successfully deleted."
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
message string
Résultat de la suppression. Une ressource manquante renvoie HTTP 404.

Alias Gmail et Outlook

Générez des boîtes aux lettres d'alias Gmail et Outlook/Hotmail à haute réputation.

POST https://v1.tempmailg.com/api/gmail-alias/emails
#

Créer un alias Gmail

Créer une nouvelle boîte aux lettres temporaire d'alias Gmail appartenant à l'utilisateur authentifié.

Paramètres 8
Paramètre Emplacement Type Statut Description
mode body string optionnel
Mode de génération : auto, dot, plus ou plus_dot. Accepte également gmail_alias_mode. Si la sélection du style n'est pas autorisée, auto est utilisé.
Par défaut: auto
username body string optionnel
Suffixe d'alias personnalisé optionnel : 2 à 32 lettres ou chiffres ASCII, normalisés en minuscules ; soumis à l'autorisation de la fonctionnalité. Accepte également custom_username ou alias_username.
Par défaut: Généré automatiquement
domain body string optionnel
Utilisez aléatoire, gmail.com ou googlemail.com ; alias_domain est également accepté. L'omission ou l'absence d'autorisation de sélection de domaine utilise aléatoire.
Par défaut: random
lifetime body string optionnel
valeurs autorisées :
10m — 10 Minutes 1h — 1 Heure 2h — 2 Heures 1d — 1 jour 1w — 1 Semaine 1m — 30 jours 3m — 90 jours 6m — 180 jours 1y — 365 jours unlimited — Illimité
Par défaut: Durée de vie par défaut du plan
pin_enabled body boolean optionnel
Protection par code PIN facultative pour la nouvelle boîte aux lettres, lorsque votre forfait le permet. Cela ne modifie pas le code PIN d'une boîte aux lettres existante.
Par défaut: false
pin body string optionnel
Requis lorsque pin_enabled est vrai : un code PIN de 6 à 8 chiffres, envoyé sous forme de chaîne pour préserver les zéros initiaux.
pin_confirmation body string optionnel
Requis lorsque pin_enabled est vrai. Doit correspondre exactement au pin.
Idempotency-Key header string optionnel
Requis pour la création ou la suppression protégée par PIN : une clé stable de 16 à 128 caractères. Réessayez la même requête avec la même clé pour éviter un travail en double.
Nécessite que l'autorisation Gmail Alias API soit activée sur votre plan d'abonnement ou débloquée via un forfait de crédits API. Paramètres optionnels : mode (auto, dot, plus, plus_dot), username (nom d'utilisateur d'alias personnalisé), domain (ex. gmail.com, googlemail.com), lifetime (valeurs autorisées : 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Omettez la durée de vie, ou laissez‑la vide, pour utiliser la Durée de vie d'e‑mail par défaut configurée pour votre plan mensuel/annuel actuel. Envoyez une durée de vie autorisée telle que 1h pour remplacer cette valeur par défaut. Illimité n’est utilisé que lorsqu’il est configuré comme valeur par défaut du plan ou explicitement demandé et autorisé. Les paramètres du corps mailbox_lifetime et email_lifetime sont également acceptés; la première valeur non vide l'emporte dans cet ordre: lifetime, mailbox_lifetime, email_lifetime. Les valeurs invalides ou non autorisées renvoient HTTP 422 au lieu de sélectionner silencieusement une valeur par défaut.
Créer une boîte aux lettres d'alias Gmail
curl --request POST \
  --url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2305,
        "pin_protected": false,
        "email": "example+alias123@gmail.com",
        "domain": "gmail.com",
        "provider": "gmail_alias",
        "expire_at": "2026-11-19T03:18:13+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:13+00:00",
        "email_token": "encrypted-email-token"
    }
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
data.id integer
ID de boîte aux lettres. Les ID, adresses et jetons générés diffèrent pour chaque boîte aux lettres.
data.pin_protected boolean
Indique si cette boîte aux lettres possède une protection par code PIN. Aucun code PIN ou hachage de code PIN n'est renvoyé.
data.email string
Adresse complète de la boîte aux lettres générée.
data.domain string
Domaine de la boîte aux lettres générée.
data.provider string
Fournisseur de boîte aux lettres : standard, gmail_alias, ou outlook_alias.
data.expire_at string|null
Expiration effective sous forme d'un horodatage ISO-8601, ou null pour une boîte aux lettres illimitée.
data.expires_in_seconds number|null
Secondes restantes non négatives lorsqu'elles sont calculées ; des secondes fractionnaires sont possibles. Null signifie illimité, pas zéro.
data.mailbox_state string
État actuel de la boîte aux lettres : actif, en pause, expiré ou inactif.
data.receiving_enabled boolean
Indique si cette boîte aux lettres accepte actuellement les messages entrants.
data.message_count integer
Nombre total de messages connu ; il peut refléter la dernière synchronisation de la boîte aux lettres.
data.unread_message_count integer
Nombre de messages non lus connus ; il peut refléter la dernière synchronisation de la boîte aux lettres.
data.last_message_received_at string|null
Dernière heure connue du message reçu au format ISO-8601, ou null lorsqu'indisponible.
data.message_count_synced_at string|null
Dernière heure de synchronisation du nombre de messages au format ISO-8601, ou null avant la synchronisation.
data.created_at string|null
Heure de création de la boîte aux lettres au format ISO-8601.
data.email_token string
Référence de boîte aux lettres chiffrée opaque. Elle ne remplace pas l'authentification Bearer, les vérifications de propriété ou l'autorisation par code PIN.
data.pin_grant object
Conditionnel : la création de boîte aux lettres protégée par PIN active renvoie cette autorisation de lecture ; la création ordinaire non protégée l'ommet.
data.pin_grant.mailbox_id integer
ID de boîte aux lettres auquel la concession de lecture conditionnelle est liée.
data.pin_grant.unlock_token string
Jeton de lecture opaque pour X-Mailbox-Unlock avec les mêmes informations d'identification du propriétaire. Gardez-le privé et en mémoire ; une autorisation de lecture n'autorise pas la suppression.
data.pin_grant.scope string
La portée lue pour l'octroi de création conditionnelle.
data.pin_grant.idle_timeout_seconds integer
Temps d'inactivité autorisé pour l'autorisation de lecture, généralement 3600 secondes.
data.pin_grant.absolute_timeout_seconds integer
Durée de vie maximale de l'autorisation de lecture, généralement 86400 secondes.
data.pin_grant.expires_at string
Expiration actuelle du droit de lecture au format ISO-8601.
data.pin_grant.absolute_expires_at string
Expiration absolue du droit de lecture au format ISO-8601. Les changements de sécurité peuvent révoquer le droit plus tôt.
GET https://v1.tempmailg.com/api/outlook-alias/domains
#

Domaines d'alias Outlook

Récupérer les domaines d'alias Outlook / Hotmail actifs disponibles pour la génération de boîtes aux lettres.

Nécessite que l'autorisation Outlook Alias API soit activée sur votre forfait d'abonnement ou débloquée via un forfait de crédits API. Indique si la sélection de domaine spécifique est débloquée dans votre forfait.
Obtenir les domaines d'alias Outlook
curl --request GET \
  --url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "data": {
        "domains": [
            {
                "domain": "outlook.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            },
            {
                "domain": "hotmail.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            }
        ]
    }
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
data.domains array
Domaines Outlook/Hotmail actifs ; un tableau vide est valide.
data.domains[].domain string
Nom de domaine disponible.
data.domains[].type string
Étiquette de fournisseur lisible.
data.domains[].selectable boolean
Si votre compte peut choisir explicitement ce domaine.
data.domains[].locked boolean
Indique si la sélection explicite de domaine est verrouillée pour votre compte.
data.domains[].disabled_reason string|null
Raison pour laquelle la sélection du domaine est verrouillée, ou null lorsqu'elle est sélectionnable.
POST https://v1.tempmailg.com/api/outlook-alias/emails
#

Créer un alias Outlook

Créer une nouvelle boîte aux lettres alias Outlook / Hotmail temporaire appartenant à l'utilisateur authentifié.

Paramètres 7
Paramètre Emplacement Type Statut Description
domain body string optionnel
Utilisez aléatoire ou un domaine provenant de GET /outlook-alias/domains ; outlook_alias_domain est également accepté. Sans autorisation de sélection, aléatoire est utilisé.
Par défaut: Domaine disponible aléatoire
username body string optionnel
Suffixe d'alias personnalisé optionnel : 2 à 32 lettres ou chiffres ASCII, normalisés en minuscules ; soumis à l'autorisation de la fonctionnalité. Accepte également custom_username ou alias_username.
Par défaut: Généré automatiquement
lifetime body string optionnel
valeurs autorisées :
10m — 10 Minutes 1h — 1 Heure 2h — 2 Heures 1d — 1 jour 1w — 1 Semaine 1m — 30 jours 3m — 90 jours 6m — 180 jours 1y — 365 jours unlimited — Illimité
Par défaut: Durée de vie par défaut du plan
pin_enabled body boolean optionnel
Protection par code PIN facultative pour la nouvelle boîte aux lettres, lorsque votre forfait le permet. Cela ne modifie pas le code PIN d'une boîte aux lettres existante.
Par défaut: false
pin body string optionnel
Requis lorsque pin_enabled est vrai : un code PIN de 6 à 8 chiffres, envoyé sous forme de chaîne pour préserver les zéros initiaux.
pin_confirmation body string optionnel
Requis lorsque pin_enabled est vrai. Doit correspondre exactement au pin.
Idempotency-Key header string optionnel
Requis pour la création ou la suppression protégée par PIN : une clé stable de 16 à 128 caractères. Réessayez la même requête avec la même clé pour éviter un travail en double.
Nécessite que l'autorisation Outlook Alias API soit activée sur votre forfait d'abonnement ou débloquée via un forfait de crédits API. Paramètres optionnels : domain (ex. outlook.com, hotmail.com), username (nom d'utilisateur d'alias personnalisé), lifetime (valeurs autorisées : 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Omettez la durée de vie, ou laissez‑la vide, pour utiliser la Durée de vie d'e‑mail par défaut configurée pour votre plan mensuel/annuel actuel. Envoyez une durée de vie autorisée telle que 1h pour remplacer cette valeur par défaut. Illimité n’est utilisé que lorsqu’il est configuré comme valeur par défaut du plan ou explicitement demandé et autorisé. Les paramètres du corps mailbox_lifetime et email_lifetime sont également acceptés; la première valeur non vide l'emporte dans cet ordre: lifetime, mailbox_lifetime, email_lifetime. Les valeurs invalides ou non autorisées renvoient HTTP 422 au lieu de sélectionner silencieusement une valeur par défaut.
Créer une boîte aux lettres d'alias Outlook
curl --request POST \
  --url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2306,
        "pin_protected": false,
        "email": "example+alias45@outlook.com",
        "domain": "outlook.com",
        "provider": "outlook_alias",
        "expire_at": "2026-11-19T03:18:13+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:13+00:00",
        "email_token": "encrypted-email-token"
    }
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
data.id integer
ID de boîte aux lettres. Les ID, adresses et jetons générés diffèrent pour chaque boîte aux lettres.
data.pin_protected boolean
Indique si cette boîte aux lettres possède une protection par code PIN. Aucun code PIN ou hachage de code PIN n'est renvoyé.
data.email string
Adresse complète de la boîte aux lettres générée.
data.domain string
Domaine de la boîte aux lettres générée.
data.provider string
Fournisseur de boîte aux lettres : standard, gmail_alias, ou outlook_alias.
data.expire_at string|null
Expiration effective sous forme d'un horodatage ISO-8601, ou null pour une boîte aux lettres illimitée.
data.expires_in_seconds number|null
Secondes restantes non négatives lorsqu'elles sont calculées ; des secondes fractionnaires sont possibles. Null signifie illimité, pas zéro.
data.mailbox_state string
État actuel de la boîte aux lettres : actif, en pause, expiré ou inactif.
data.receiving_enabled boolean
Indique si cette boîte aux lettres accepte actuellement les messages entrants.
data.message_count integer
Nombre total de messages connu ; il peut refléter la dernière synchronisation de la boîte aux lettres.
data.unread_message_count integer
Nombre de messages non lus connus ; il peut refléter la dernière synchronisation de la boîte aux lettres.
data.last_message_received_at string|null
Dernière heure connue du message reçu au format ISO-8601, ou null lorsqu'indisponible.
data.message_count_synced_at string|null
Dernière heure de synchronisation du nombre de messages au format ISO-8601, ou null avant la synchronisation.
data.created_at string|null
Heure de création de la boîte aux lettres au format ISO-8601.
data.email_token string
Référence de boîte aux lettres chiffrée opaque. Elle ne remplace pas l'authentification Bearer, les vérifications de propriété ou l'autorisation par code PIN.
data.pin_grant object
Conditionnel : la création de boîte aux lettres protégée par PIN active renvoie cette autorisation de lecture ; la création ordinaire non protégée l'ommet.
data.pin_grant.mailbox_id integer
ID de boîte aux lettres auquel la concession de lecture conditionnelle est liée.
data.pin_grant.unlock_token string
Jeton de lecture opaque pour X-Mailbox-Unlock avec les mêmes informations d'identification du propriétaire. Gardez-le privé et en mémoire ; une autorisation de lecture n'autorise pas la suppression.
data.pin_grant.scope string
La portée lue pour l'octroi de création conditionnelle.
data.pin_grant.idle_timeout_seconds integer
Temps d'inactivité autorisé pour l'autorisation de lecture, généralement 3600 secondes.
data.pin_grant.absolute_timeout_seconds integer
Durée de vie maximale de l'autorisation de lecture, généralement 86400 secondes.
data.pin_grant.expires_at string
Expiration actuelle du droit de lecture au format ISO-8601.
data.pin_grant.absolute_expires_at string
Expiration absolue du droit de lecture au format ISO-8601. Les changements de sécurité peuvent révoquer le droit plus tôt.

Messages et pièces jointes

Récupérez les boîtes de réception entrantes, lisez les messages HTML/texte complets et diffusez les pièces jointes.

GET https://v1.tempmailg.com/api/messages?email={email}
#

Lister les messages de la boîte aux lettres

Récupérer les résumés de messages disponibles et les métadonnées de la boîte aux lettres. Les analyses standard de la boîte de réception renvoient un lot récent de jusqu'à 25 messages ; il ne s'agit pas d'un point de terminaison paginé d'historique complet. Utilisez GET /messages/{messageId} pour les corps complets et les pièces jointes.

Paramètres 2
Paramètre Emplacement Type Statut Description
email query string obligatoire
Adresse e-mail complète de la boîte aux lettres détenue pour lire les messages. Encodez la valeur de la requête en URL ; encodez le signe plus comme %2B.
X-Mailbox-Unlock header string optionnel
En-tête, boîtes aux lettres protégées uniquement : utilisez un unlock_token en lecture. D’abord POST pin et scope=read à l’URL de déverrouillage du PIN. Conservez votre authentification Bearer normale. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
L'e-mail doit appartenir à votre compte. Les résumés standard et Gmail contiennent les champs OTP et verification-link ; Outlook inclut également from_name, snippet, received_at et has_attachments. La synchronisation du fournisseur et la mise en cache peuvent retarder les nouveaux messages et les décomptes.
Lire les messages de la boîte aux lettres
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages?email=demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "mailbox": "demo123@example.com",
    "email_token": "encrypted-email-token",
    "messages": [
        {
            "is_seen": false,
            "subject": "Welcome to Temp Mail",
            "from": "Example Sender",
            "from_email": "hello@example.org",
            "receivedAt": "2026-11-19 02:18:13",
            "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
            "otp": null,
            "otp_locked": false,
            "verification_link": null,
            "verification_link_locked": false
        }
    ],
    "mailbox_provider": "standard",
    "mailbox_state": "active",
    "expire_at": "2026-11-20T02:18:13+00:00",
    "expires_in_seconds": 86399.75,
    "receiving_enabled": true,
    "mailbox_limit": {
        "limit": 50,
        "limit_label": "50",
        "active_count": 1,
        "paused_count": 0,
        "paused_mailboxes": [],
        "remaining": 49,
        "remaining_label": "49",
        "reached": false,
        "blocked": false,
        "provider": "standard"
    },
    "message_count": 1,
    "unread_message_count": 1,
    "last_message_received_at": "2026-11-19T02:18:13+00:00",
    "message_count_synced_at": "2026-11-19T02:18:13+00:00"
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
mailbox string
Adresse de boîte aux lettres dont les messages ont été demandés.
email_token string
Référence de boîte aux lettres chiffrée opaque ; une authentification normale est toujours requise.
mailbox_provider string
Fournisseur de boîte aux lettres : standard, gmail_alias, ou outlook_alias.
messages array
Résumés de messages. Une boîte de réception vide renvoie un tableau vide ; récupérez un seul message pour son corps et ses pièces jointes.
expire_at string|null
Expiration effective sous forme d'un horodatage ISO-8601, ou null pour une boîte aux lettres illimitée.
expires_in_seconds number|null
Secondes restantes non négatives lorsqu'elles sont calculées ; des secondes fractionnaires sont possibles. Null signifie illimité, pas zéro.
mailbox_state string
État actuel de la boîte aux lettres : actif, en pause, expiré ou inactif.
receiving_enabled boolean
Indique si cette boîte aux lettres accepte actuellement les messages entrants.
message_count integer
Nombre total de messages connu ; il peut refléter la dernière synchronisation de la boîte aux lettres.
unread_message_count integer
Nombre de messages non lus connus ; il peut refléter la dernière synchronisation de la boîte aux lettres.
last_message_received_at string|null
Dernière heure connue du message reçu au format ISO-8601, ou null lorsqu'indisponible.
message_count_synced_at string|null
Dernière heure de synchronisation du nombre de messages au format ISO-8601, ou null avant la synchronisation.
mailbox_limit.limit integer
Limite de boîte aux lettres active pour ce fournisseur ; -1 signifie illimité.
mailbox_limit.limit_label string
Étiquette d'affichage pour la limite de boîte aux lettres.
mailbox_limit.active_count integer
Nombre de boîtes aux lettres actives pour ce fournisseur.
mailbox_limit.paused_count integer
Nombre de boîtes aux lettres en pause pour ce fournisseur.
mailbox_limit.paused_mailboxes array<string>
Adresses suspendues en raison de la limite de boîte aux lettres.
mailbox_limit.remaining integer
Emplacements de boîtes aux lettres actives restants ; -1 signifie illimité. Ce n’est pas le quota de requêtes API.
mailbox_limit.remaining_label string
Afficher le libellé des emplacements de boîte aux lettres restants.
mailbox_limit.reached boolean
Indique si la limite de boîtes aux lettres actives a été atteinte.
mailbox_limit.blocked boolean
Indique si la limite de boîtes aux lettres actives est nulle.
mailbox_limit.provider string|null
Fournisseur auquel la limite de boîte aux lettres s'applique.
messages[].id string
ID de message opaque utilisé par les points de terminaison de message unique, de suppression et de pièce jointe.
messages[].is_seen boolean
Si le message est marqué comme lu.
messages[].subject string
Objet du message.
messages[].from string
Nom d'affichage ou adresse de l'expéditeur.
messages[].from_email string
Adresse e‑mail de l’expéditeur.
messages[].receivedAt string
Heure de réception dans le fuseau horaire de l'application, formatée au format YYYY-MM-DD HH:mm:ss.
messages[].otp string|null
Code à usage unique détecté lorsqu'il est disponible et autorisé; sinon null.
messages[].otp_locked boolean
Indique si un code à usage unique détecté est masqué par les autorisations de la fonction.
messages[].verification_link string|null
URL de vérification détectée lorsqu'elle est disponible et autorisée ; sinon null.
messages[].verification_link_locked boolean
Si un lien de vérification détecté est masqué par les autorisations de fonctionnalité.
messages[].from_name string|null
Champ de résumé Outlook : nom de l'expéditeur d'origine. Absent des résumés Standard et Gmail.
messages[].snippet string|null
Champ de résumé Outlook : aperçu court du message.
messages[].received_at string|null
Champ de résumé Outlook: heure de réception au format ISO-8601, lorsqu’elle est connue.
messages[].has_attachments boolean
Champ de résumé Outlook : indique si les métadonnées de la pièce jointe existent. La disponibilité du téléchargement est vérifiée séparément.
GET https://v1.tempmailg.com/api/messages/{messageId}
#

Obtenir un message unique

Récupérer un message possédé par son ID de message opaque. Retourne les formats du corps et les métadonnées des pièces jointes. Les champs du corps dépendent du format du message ; Outlook ajoute les champs spécifiques au fournisseur répertoriés ci-dessous.

Paramètres 2
Paramètre Emplacement Type Statut Description
messageId path string obligatoire
ID de message unique renvoyé dans la liste des messages.
X-Mailbox-Unlock header string optionnel
En-tête, boîtes aux lettres protégées uniquement : utilisez un unlock_token en lecture. D’abord POST pin et scope=read à l’URL de déverrouillage du PIN. Conservez votre authentification Bearer normale. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Lire un message
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "data": {
        "is_seen": true,
        "subject": "Welcome to Temp Mail",
        "from": "Example Sender",
        "from_email": "hello@example.org",
        "to": "demo123@example.com",
        "mailbox_provider": "standard",
        "receivedAt": "2026-11-19 02:18:13",
        "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
        "html": true,
        "html_content": "<p>Hello from the inbox.</p>",
        "text_content": "<pre>Hello from the inbox.</pre>",
        "content": "<p>Hello from the inbox.</p>",
        "attachments": [
            {
                "name": "file.txt",
                "extension": "txt",
                "size": 91,
                "url": "https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt"
            }
        ]
    }
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
data.id string
ID de message opaque.
data.is_seen boolean
État de lecture du message. La lecture peut le marquer comme vu ; les données en cache peuvent refléter un état antérieur.
data.subject string
Objet du message.
data.from string
Nom d'affichage ou adresse de l'expéditeur.
data.from_email string
Adresse e‑mail de l’expéditeur.
data.to string
Adresse de la boîte aux lettres du destinataire.
data.mailbox_provider string
Fournisseur de boîte aux lettres : standard, gmail_alias, ou outlook_alias.
data.receivedAt string
Heure de réception dans le fuseau horaire de l'application, formatée au format YYYY-MM-DD HH:mm:ss.
data.html boolean
Indique si le message possède un corps HTML.
data.html_content string
Corps HTML lorsqu'il est présent. Les messages standard sans HTML peuvent omettre ce champ. Considérez le contenu du message comme non fiable.
data.text_content string
Corps du texte lorsqu'il est présent ; les messages standard peuvent contenir du texte échappé dans un élément pre ou omettre ce champ.
data.content string
Corps préféré pour l'affichage, généralement HTML lorsqu'il est disponible.
data.attachments array
Métadonnées de la pièce jointe, ou un tableau vide. Les téléchargements nécessitent une authentification normale et l'autorisation PIN applicable.
data.attachments[].name string
Nom de fichier à encoder en URL comme un seul segment de chemin lors du téléchargement.
data.attachments[].size integer
Taille de la pièce jointe en octets.
data.attachments[].url string
URL de téléchargement de l'API Utilisateur Authentifié ajoutée aux pièces jointes avec un nom de fichier. Une URL ne garantit pas que le fichier local soit disponible.
data.attachments[].extension string
Champ de métadonnées Standard/Gmail : extension de fichier lorsqu'elle est fournie.
data.attachments[].id string
Champ de métadonnées Outlook : ID de pièce jointe du fournisseur.
data.attachments[].content_type string
Champ de métadonnées Outlook : type de contenu MIME.
data.from_name string|null
Champ de détail Outlook : nom de l’expéditeur original.
data.to_email string|null
Champ de détail Outlook : adresse du destinataire d'origine.
data.received_at string|null
Champ de détail Outlook: heure de réception au format ISO-8601.
data.has_html boolean
Champ de détail Outlook : indique si un corps HTML existe.
DELETE https://v1.tempmailg.com/api/messages/{messageId}
#

Supprimer le message

Supprimer un seul message appartenant à l'utilisateur

Paramètres 3
Paramètre Emplacement Type Statut Description
messageId path string obligatoire
Chaîne d'ID de message unique à supprimer définitivement.
X-Mailbox-Unlock header string optionnel
En-tête, boîtes aux lettres protégées uniquement : utilisez le jeton de déverrouillage à usage unique de suppression. D'abord POST le pin, scope=delete et l'action/target_id renvoyés par la réponse 423 à l'URL de déverrouillage du PIN. Un jeton de lecture ne peut pas supprimer. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string optionnel
Requis pour la création ou la suppression protégée par PIN : une clé stable de 16 à 128 caractères. Réessayez la même requête avec la même clé pour éviter un travail en double.
Supprimer un message
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": true,
    "message": "Message was deleted successfully."
}
Champs de réponse
Champ Type Description
status boolean
Si l'opération a réussi.
message string
Résultat de la suppression. Une ressource manquante renvoie HTTP 404.
GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}
#

Télécharger la pièce jointe

Télécharger une pièce jointe d'un message possédé.

Paramètres 3
Paramètre Emplacement Type Statut Description
messageId path string obligatoire
ID du message contenant le fichier.
filename path string obligatoire
Nom de fichier et extension de la pièce jointe à télécharger.
X-Mailbox-Unlock header string optionnel
En-tête, boîtes aux lettres protégées uniquement : utilisez un unlock_token en lecture. D’abord POST pin et scope=read à l’URL de déverrouillage du PIN. Conservez votre authentification Bearer normale. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Le succès renvoie les octets du fichier, pas du JSON. Les fichiers trop volumineux renvoient HTTP 403 ; les fichiers locaux manquants ou indisponibles renvoient HTTP 404. Encodez le nom de fichier en URL comme un seul segment de chemin. Les métadonnées de la pièce jointe seules ne garantissent pas la disponibilité du téléchargement.
Télécharger une pièce jointe
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY' \
  --output file.txt
Comportement de téléchargement Ce point de terminaison renvoie le fichier demandé directement au lieu d'un corps JSON.
Champs de réponse
Champ Type Description
Content-Disposition header
La réponse réussie télécharge le nom de fichier demandé.
body binary
Octets de fichier en cas de succès, pas JSON. Les erreurs renvoient du JSON avec un statut non 2xx.

Limites de débit & quotas

Surveillez les budgets de requêtes en temps réel, les limites de taux et les quotas de compte sans consommer de crédits.

GET https://v1.tempmailg.com/api/rate-limit
#

Limite de débit et quota

Vérifiez votre limite de débit actuelle et l'état de votre quota sans consommer d'utilisation d'API. Ce point de terminaison est sans quota et ne déduit pas les crédits d'API mensuels (limite de protection contre les abus : 60 requêtes/min).

X-RateLimit-* décrit le budget de requêtes indiqué ; X-Quota-* décrit la capacité mensuelle et achetée lorsqu'elle est disponible. X-Mailbox-RateLimit-* indique le budget séparé de création/mise à jour de boîte aux lettres. Un rejet uniquement de boîte aux lettres utilise la portée de la boîte aux lettres et sa propre fenêtre de nouvelle tentative. Les rejets de limite à la minute peuvent omettre les informations de quota. Retry-After est inclus uniquement pour une nouvelle tentative temporisée ; l'accès désactivé peut nécessiter un changement de compte. Dans cette réponse de statut réussie, data.limit, data.remaining et data.reset décrivent le budget minute du compte, pas les crédits dépensables. L'objet data.quota décrit l'allocation mensuelle, les soldes de crédit et l'utilisation. Les champs existants data.monthly_limit, data.monthly_remaining et data.purchased_credits restent des alias des champs quota correspondants. Une vérification de statut réussie n'autorise pas une autre opération API. Les opérations nécessitent toujours un accès activé, un quota disponible et l'admission à travers toutes les limites applicables. L'instantané du quota ne garantit pas la capacité déjà réservée par une requête en cours.
Vérifier l'état de la limite de débit
curl --request GET \
  --url 'https://v1.tempmailg.com/api/rate-limit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Réponse illustrative utilisant des données synthétiques. Les ID, adresses, jetons, horodatages, limites et comptes du plan varient. Les durées d'échantillon ne remplacent pas la valeur par défaut de votre plan. Les descriptions des champs de réponse identifient les champs nullables et spécifiques au fournisseur.

Exemple de réponse
200 OK • JSON
{
    "status": "success",
    "data": {
        "limit": 60,
        "remaining": 45,
        "reset": 32,
        "plan": "premium",
        "monthly_limit": 50000,
        "monthly_remaining": 48210,
        "purchased_credits": 5000,
        "quota": {
            "enabled": true,
            "user_api_status": true,
            "plan_name": "Premium Plan",
            "period": "2026-10",
            "base_limit": 50000,
            "extra_requests": 0,
            "monthly_limit": 50000,
            "monthly_remaining": 48210,
            "used": 1790,
            "purchased_credits": 5000,
            "bonus_credits": 1000,
            "direct_purchased_credits": 4000,
            "remaining": 53210,
            "unlimited": false,
            "usage_percent": 3,
            "reset_at": "2026-11-01T00:00:00+00:00"
        }
    }
}
Champs de réponse
Champ Type Description
data.limit integer|string
Limite de requêtes-par-minute du compte. La chaîne unlimited indique un budget de minutes illimité ; cela est indépendant du quota mensuel.
data.remaining integer|string
Créneaux de budget de minutes restants du compte, ou la chaîne illimitée. Une valeur positive ne signifie pas que les crédits API restent.
data.reset integer
Secondes pour la fenêtre d'une minute du compte, pas la réinitialisation du quota mensuel. Les budgets de minute désactivés ou illimités peuvent conserver une valeur nominale de 60 secondes ; cela ne promet pas l'accès après l'attente.
data.plan string
Étiquette du plan actuel. Le nom lisible du plan est fourni séparément dans data.quota.plan_name.
data.quota.enabled boolean
Indique si l'accès global et plan/crédit à l'API est activé. Cela n'indique pas la capacité restante ni ne remplace le commutateur API de l'utilisateur.
data.quota.user_api_status boolean
Si l'utilisateur a activé son commutateur API utilisateur. Les opérations nécessitent ce commutateur ainsi qu'un accès activé et une capacité disponible.
data.quota.plan_name string
Nom lisible du plan actuel.
data.quota.period string
Période d'utilisation du mois calendaire au format YYYY-MM, en utilisant le fuseau horaire de l'application ; pas nécessairement la période de facturation de l'abonnement.
data.quota.base_limit integer
Allocation de base du plan mensuel. Une valeur de -1 signifie illimitée.
data.quota.extra_requests integer
Allocation mensuelle supplémentaire accordée pour la période d'utilisation actuelle ; distincte des crédits achetés.
data.quota.monthly_limit integer
Allocation de base plus les demandes supplémentaires de la période en cours. Une valeur de -1 signifie illimité. Les crédits achetés ne sont pas inclus.
data.quota.monthly_remaining integer|null
Allocation mensuelle finie restante, ou null lorsque le quota mensuel est illimité. Null ne doit pas être interprété comme zéro.
data.quota.used integer
Opérations API réussies et comptées pendant la période d'utilisation actuelle, y compris les opérations utilisant des crédits. Les vérifications d'état n'augmentent pas cette valeur.
data.quota.purchased_credits integer
Solde de crédit actuel, incluant les crédits bonus du plan actif. Les crédits bonus ne doivent pas être ajoutés à ce solde une seconde fois.
data.quota.bonus_credits integer
Part active du bonus du plan du solde de crédit ; une ventilation des purchased_credits, pas de capacité supplémentaire.
data.quota.direct_purchased_credits integer
Solde de crédit excluant la partie bonus du plan actif. Cette valeur plus bonus_credits équivaut à purchased_credits.
data.quota.remaining integer|null
Allocation mensuelle restante plus le solde de crédit actuel, sans double comptage des bonus. Null signifie quota mensuel illimité. Les autorisations de fonctionnalités individuelles et les autres limites de requêtes s’appliquent toujours.
data.quota.unlimited boolean
Indique si le quota mensuel est illimité. Cela ne rend pas le budget de minutes du compte ou les autres limites de fonctionnalités illimités.
data.quota.usage_percent integer
Pourcentage arrondi compatible tableau de bord de 0 à 100 : utilisé divisé par utilisé plus restant, multiplié par 100. Il inclut la capacité de crédit disponible, ainsi la recharge peut diminuer le pourcentage. Il est 0 pour un quota illimité ou un pool de taille zéro ; ce n’est pas le pourcentage de limitation de débit par minute ni une décision d'accès.
data.quota.reset_at string
Horodatage ISO-8601 avec décalage horaire pour la réinitialisation du quota du mois calendaire suivant. Ce n'est pas la date d'expiration de l'abonnement, et la réinitialisation mensuelle ne reconstitue pas les crédits achetés.
status string
Le succès littéral pour ce point de terminaison d'état. Les autres points de terminaison de boîte aux lettres réussis utilisent le booléen true.
data.monthly_limit integer
Alias de compatibilité du champ data.quota correspondant ; ne l'ajoutez pas de nouveau lors du calcul des soldes.
data.monthly_remaining integer|null
Alias de compatibilité du champ data.quota correspondant ; ne l'ajoutez pas de nouveau lors du calcul des soldes.
data.purchased_credits integer
Alias de compatibilité du champ data.quota correspondant ; ne l'ajoutez pas de nouveau lors du calcul des soldes.

Protection du code PIN de la boîte aux lettres

Entrez le code PIN pour continuer. Votre boîte aux lettres reste déverrouillée tant qu'elle est active pendant cette session du site web.

Acceptez-vous les cookies ?

Nous utilisons des cookies pour améliorer votre expérience de navigation. En utilisant ce site, vous consentez à notre politique en matière de cookies.

Plus