Utilisez cet endpoint Restful pour valider une adresse e-mail et obtenir des informations sur sa syntaxe, son domaine, sa délivrabilité, et son statut d'activité.
Voir aussi : Documentation Swagger Email Restful
Requête GET
Endpoint
GET https://{SERVER_ADDRESS}/{VERSION}/email/lookup?email={EMAIL}&rectify={RECTIFY}&extendedSyntax={EXTENDED_SYNTAX}&checkUser={CHECK_USER}&timeout={TIMEOUT}Remplacez les valeurs entre accolades par vos propres informations.
| Paramètre | Description | Obligatoire/Optionnel |
|---|---|---|
| Adresse e-mail à valider. | Obligatoire | |
| rectify |
true pour proposer une correction de domaine lorsque le domaine saisi est inconnu ; false sinon. |
Optionnel |
| extendedSyntax |
true pour accepter les adresses e-mail à syntaxe étendue ; false pour limiter les vérifications aux adresses e-mail standard. |
Optionnel |
| checkUser |
true pour vérifier la partie avant le signe @ ; false pour ne vérifier que le domaine. |
Optionnel |
| timeout | Durée maximale de la requête pour la vérification, en secondes. | Optionnel |
Requête POST
Endpoint
POST https://{SERVER_ADDRESS}/{VERSION}/email/lookupEnvoyez les paramètres suivants dans le corps de la requête au format JSON.
| Paramètre | Description | Obligatoire/Optionnel |
|---|---|---|
| Adresse e-mail à valider. | Obligatoire | |
| rectify |
true pour proposer une correction de domaine lorsque le domaine saisi est inconnu ; false sinon. |
Optionnel |
| extendedSyntax |
true pour accepter les adresses e-mail à syntaxe étendue ; false pour limiter les vérifications aux adresses e-mail standard. |
Optionnel |
| checkUser |
true pour vérifier la partie avant le signe @ ; false pour ne vérifier que le domaine. |
Optionnel |
| timeout | Durée maximale de la requête pour la vérification, en secondes. | Optionnel |
Exemple :
{
"email": "test@example.com",
"rectify": true,
"extendedSyntax": false,
"checkUser": true,
"timeout": 0.5
}Réponse
Réponse de succès
La réponse JSON contient les détails de validation de l'adresse e-mail fournie.
| Clé | Description | Type |
|---|---|---|
| IdError | Code d'erreur renvoyé par l'API. | INTEGER |
| Error | Message d'erreur associé au résultat de la validation. | STRING |
| Formatted | Adresse e-mail normalisée et formatée. | STRING |
| LocalPart | Partie avant le symbole @. | STRING |
| Domain | Nom de domaine de l'e-mail. | STRING |
| Tld | Domaine de premier niveau. | STRING |
| IsValid | Indique si la syntaxe de l'e-mail est valide. | BOOLEAN |
| IsDisposable | Indique si l'e-mail appartient à un fournisseur jetable. | BOOLEAN |
| IsCatchAll | Indique si le domaine accepte tous les e-mails. | BOOLEAN |
| IsFree | Indique si le fournisseur est gratuit. | BOOLEAN |
| IsRole | Indique si l'adresse est basée sur un rôle. | BOOLEAN |
| IsDeliverable | Indique si l'adresse e-mail est délivrable. | BOOLEAN |
| HasSuggestedCorrection | Indique si une suggestion de correction est disponible. | BOOLEAN |
| SuggestedCorrection | Adresse e-mail corrigée suggérée. | STRING |
| DomainExists | Indique si le domaine existe. | BOOLEAN |
| HasMxRecords | Indique si des enregistrements MX sont disponibles. | BOOLEAN |
Exemple :
{
"IdError": 0,
"Error": "",
"Formatted": "test@gmail.com",
"LocalPart": "test",
"Domain": "gmail.com",
"Tld": "com",
"IsValid": true,
"IsDisposable": false,
"IsCatchAll": false,
"IsFree": true,
"IsRole": false,
"IsDeliverable": true,
"HasSuggestedCorrection": false,
"SuggestedCorrection": "",
"DomainExists": true,
"HasMxRecords": true
}Réponse d'erreur
| Type d'erreur | Type de réponse |
|---|---|
| Authentification manquante ou invalide | 401 Unauthorized |
| Paramètre email manquant | 400 Bad Request |
| Syntaxe d'e-mail invalide | Réponse d'erreur de validation |
Voir aussi
Associé à