API Email — Valider une adresse e-mail

Support DQE
Support DQE
  • Mise à jour

Utilisez cet endpoint pour valider une adresse e-mail — en vérifiant l'existence de son domaine, sa syntaxe, et éventuellement son statut d'activité.

Documentation Email associée :

Requête GET

Endpoint

https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/?Email={EMAIL}&Licence={LICENCE_CODE}&Rectify={RECTIFY}&extendedsyntax={SYNTAX}&checkuser={CHECKUSER}&TimeOut={TIME}

Remplacez les valeurs entre accolades par vos propres informations :

Paramètre Valeur Description Obligatoire/Optionnel
SERVER_ADDRESS {SERVER_ADDRESS} Adresse du serveur DQE qui traitera les données. Obligatoire
Licence {LICENCE_CODE} Code de licence attribué à votre compte. Obligatoire
Email {EMAIL} Adresse e-mail à valider. Obligatoire
Rectify {RECTIFY} y pour proposer une correction de domaine lorsque le domaine saisi est inconnu ; n sinon. Optionnel. Valeur par défaut : n.
extendedsyntax {SYNTAX} y pour accepter les adresses e-mail à syntaxe étendue ; n pour limiter les vérifications aux adresses e-mail standard. Optionnel. Valeur par défaut : n.
checkuser {CHECKUSER} y pour vérifier la partie avant le signe @ ; n pour ne vérifier que le domaine. Optionnel. Valeur par défaut : y.
TimeOut {TIME} Durée maximale de la requête pour la vérification des données, en secondes. Exemple : 0.5 pour 500 ms. Optionnel

Requête POST

Endpoint

https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/

Ajoutez les paramètres suivants dans le corps de la requête en utilisant x-www-form-urlencoded.

Paramètre Valeur Description Obligatoire/Optionnel
Licence {LICENCE_CODE} Code de licence attribué à votre compte. Obligatoire
Email {EMAIL} Adresse e-mail à valider. Obligatoire
Rectify {RECTIFY} y pour proposer une correction de domaine lorsque le domaine saisi est inconnu ; n sinon. Optionnel. Valeur par défaut : n.
extendedsyntax {SYNTAX} y pour accepter les adresses e-mail à syntaxe étendue ; n pour limiter les vérifications aux adresses e-mail standard. Optionnel. Valeur par défaut : n.
checkuser {CHECKUSER} y pour vérifier la partie avant le signe @ ; n pour ne vérifier que le domaine. Optionnel. Valeur par défaut : y.
TimeOut {TIME} Durée maximale de la requête pour la vérification des données, en secondes. Exemple : 0.5 pour 500 ms. Optionnel

Réponse

Réponse de succès

La vérification de niveau 1 vérifie l'existence du domaine et valide la syntaxe de l'e-mail.

La réponse JSON est un dictionnaire dont la clé 1 contient les champs suivants :

Clé Description Type
Redressement 1 : domaine corrigé ; 0 : aucune correction appliquée. INTEGER(1)
eMailOrigine Adresse e-mail saisie par l'utilisateur. STRING(255)
IdError Code retour de la validation. Voir le tableau des codes IdError ci-dessous. STRING(16)
eMail Adresse e-mail corrigée si Rectify=y. STRING(1024)

Exemple :

{
  "1": {
    "Redressement": 0,
    "eMailOrigine": "test@tesdedet.com",
    "IdError": "92",
    "eMail": "test@tesdedet.com"
  }
}

La vérification de niveau 2 vérifie en plus le statut d'activité de l'adresse e-mail. Le champ suivant peut être ajouté :

Clé Description Type
CodeActivite Fournit des informations sur le statut d'activité de l'e-mail. Voir le tableau des codes CodeActivite ci-dessous. STRING(3)

Exemple avec le niveau 2 :

{
  "1": {
    "Redressement": 0,
    "eMailOrigine": "test@tesdedet.com",
    "IdError": "92",
    "eMail": "test@tesdedet.com",
    "CodeActivite": "200"
  }
}

Codes IdError

Code Description Message d'interface suggéré
00 E-mail valide. Valid email
01 E-mail correct mais le nom n'a pas pu être vérifié. Valid email
02 Adresse e-mail introuvable pour ce domaine. Please check your email address
03 Boîte de réception pleine (soft bounce). Please check your email address
04 E-mail vide. Please check your email address
91 Erreur de syntaxe. Please check your email address
92 Domaine inconnu. Please check your email address
93 E-mail ou domaine sur liste noire. Please check your email address
94 Nom d'utilisateur non autorisé. Please check your email address
95 Adresse e-mail temporaire jetable. Please check your email address
99 Service indisponible. Valid email

Codes CodeActivite

Considérez M comme le mois en cours.

Code Description
100 L'e-mail a été livré une fois.
200 L'e-mail est valide.
201 L'e-mail était actif le mois dernier.
202 L'e-mail était actif entre M-1 et M-2.
203 L'e-mail était actif entre M-2 et M-3.
204 L'e-mail était actif entre M-3 et M-4.
206 L'e-mail était actif entre M-4 et M-6.
209 L'e-mail était actif entre M-6 et M-9.
212 L'e-mail était actif entre M-9 et M-12.
300 E-mail inactif.

Réponse d'erreur

Type d'erreur Type de réponse
Paramètre Licence manquant ** LICENCE KO **
Paramètre Licence vide ** LICENCE KO **
Numéro de licence incorrect unauthorized_client
Paramètre Email manquant ou vide IdError = 04
Erreur de frappe dans un paramètre IdError = 04

Voir aussi

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0