Email API — Eine E-Mail-Adresse validieren

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um eine E-Mail-Adresse zu validieren – dabei werden die Existenz der Domäne, die Syntax und optional der Aktivitätsstatus geprüft.

Verwandte E-Mail-Dokumentation:

GET-Anfrage

Endpunkt

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

Ersetzen Sie die Werte in geschweiften Klammern durch Ihre eigenen Informationen:

Parameter Wert Beschreibung Pflicht/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Adresse des DQE-Servers, der die Daten verarbeitet. Pflicht
Licence {LICENCE_CODE} Ihrem Konto zugewiesener Lizenzcode. Pflicht
Email {EMAIL} Zu validierende E-Mail-Adresse. Pflicht
Rectify {RECTIFY} y, um bei unbekannter Domäne eine Domänenkorrektur vorzuschlagen; sonst n. Optional. Standardwert: n.
extendedsyntax {SYNTAX} y, um E-Mail-Adressen mit erweiterter Syntax zu akzeptieren; n, um die Prüfung auf Standard-E-Mail-Adressen zu beschränken. Optional. Standardwert: n.
checkuser {CHECKUSER} y, um den Teil vor dem @-Zeichen zu prüfen; n, um nur die Domäne zu prüfen. Optional. Standardwert: y.
TimeOut {TIME} Maximale Abfragezeit für die Datenüberprüfung, in Sekunden. Beispiel: 0.5 für 500 ms. Optional

POST-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/

Fügen Sie die folgenden Parameter im Anfragetext mittels x-www-form-urlencoded hinzu.

Parameter Wert Beschreibung Pflicht/Optional
Licence {LICENCE_CODE} Ihrem Konto zugewiesener Lizenzcode. Pflicht
Email {EMAIL} Zu validierende E-Mail-Adresse. Pflicht
Rectify {RECTIFY} y, um bei unbekannter Domäne eine Domänenkorrektur vorzuschlagen; sonst n. Optional. Standardwert: n.
extendedsyntax {SYNTAX} y, um E-Mail-Adressen mit erweiterter Syntax zu akzeptieren; n, um die Prüfung auf Standard-E-Mail-Adressen zu beschränken. Optional. Standardwert: n.
checkuser {CHECKUSER} y, um den Teil vor dem @-Zeichen zu prüfen; n, um nur die Domäne zu prüfen. Optional. Standardwert: y.
TimeOut {TIME} Maximale Abfragezeit für die Datenüberprüfung, in Sekunden. Beispiel: 0.5 für 500 ms. Optional

Antwort

Erfolgsantwort

Die Stufe-1-Prüfung prüft die Existenz der Domäne und validiert die E-Mail-Syntax.

Die JSON-Antwort ist ein Dictionary mit dem Schlüssel 1, das folgende Felder enthält:

Schlüssel Beschreibung Typ
Redressement 1: Domäne korrigiert; 0: keine Korrektur angewendet. INTEGER(1)
eMailOrigine Vom Benutzer eingegebene E-Mail-Adresse. STRING(255)
IdError Validierungsrückgabecode. Siehe die IdError-Codetabelle unten. STRING(16)
eMail Korrigierte E-Mail-Adresse, wenn Rectify=y. STRING(1024)

Beispiel:

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

Die Stufe-2-Prüfung prüft zusätzlich den Aktivitätsstatus der E-Mail-Adresse. Folgendes Feld kann hinzugefügt werden:

Schlüssel Beschreibung Typ
CodeActivite Liefert Informationen zum Aktivitätsstatus der E-Mail. Siehe die CodeActivite-Codetabelle unten. STRING(3)

Beispiel mit Stufe 2:

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

IdError-Codes

Code Beschreibung Vorgeschlagene UI-Meldung
00 Gültige E-Mail. Valid email
01 Korrekte E-Mail, aber der Name konnte nicht geprüft werden. Valid email
02 E-Mail-Adresse für diese Domäne nicht gefunden. Please check your email address
03 Postfach ist voll (Soft Bounce). Please check your email address
04 Leere E-Mail. Please check your email address
91 Syntaxfehler. Please check your email address
92 Unbekannte Domäne. Please check your email address
93 E-Mail oder Domäne auf der Blacklist. Please check your email address
94 Nicht autorisierter Benutzername. Please check your email address
95 Temporäre Wegwerf-E-Mail-Adresse. Please check your email address
99 Dienst nicht verfügbar. Valid email

CodeActivite-Codes

Dabei steht M für den aktuellen Monat.

Code Beschreibung
100 Die E-Mail wurde einmal zugestellt.
200 Die E-Mail ist gültig.
201 Die E-Mail war im vergangenen Monat aktiv.
202 Die E-Mail war zwischen M-1 und M-2 aktiv.
203 Die E-Mail war zwischen M-2 und M-3 aktiv.
204 Die E-Mail war zwischen M-3 und M-4 aktiv.
206 Die E-Mail war zwischen M-4 und M-6 aktiv.
209 Die E-Mail war zwischen M-6 und M-9 aktiv.
212 Die E-Mail war zwischen M-9 und M-12 aktiv.
300 Inaktive E-Mail.

Fehlerantwort

Fehlertyp Antworttyp
Fehlender Parameter Licence ** LICENCE KO **
Leerer Parameter Licence ** LICENCE KO **
Falsche Lizenznummer unauthorized_client
Fehlender oder leerer Parameter Email IdError = 04
Tippfehler in einem Parameter IdError = 04

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich