Email API — Eine E-Mail-Adresse validieren

Support DQE
Support DQE
  • Aktualisiert
E-Mail-Validierung - Classic API

Der DQEEMAILLOOKUP-Endpunkt validiert eine E-Mail-Adresse und meldet ihre Syntax und Domain-Existenz, mit optionalem Korrekturvorschlag und Aktivitätsstatus.

Wann dieser Endpunkt verwendet wird - Rufen Sie DQEEMAILLOOKUP auf, sobald der Benutzer eine vollständige E-Mail-Adresse eingegeben hat (oder das Feld verlassen hat), um zu bestätigen, dass sie gültig und zustellbar ist, bevor Sie sie speichern. Um stattdessen Vervollständigungsvorschläge während der Eingabe anzuzeigen, siehe Email-API — E-Mail-Adressvorschläge →

DQEEMAILLOOKUP

Anfrage

Sowohl GET als auch POST werden unterstützt.

{SERVER_ADDRESS} und {LICENCE_CODE} werden von DQE bei der Kontoerstellung bereitgestellt. Wenden Sie sich an Ihren DQE-Kundenbetreuer, um diese Zugangsdaten zu erhalten.
GEThttps://{SERVER_ADDRESS}/DQEEMAILLOOKUP/?Email={EMAIL}&Licence={LICENCE_CODE}&Rectify={RECTIFY}&extendedsyntax={SYNTAX}&checkuser={CHECKUSER}&TimeOut={TIME}

Codebeispiele

Gültige Adresse, keine Korrektur angewendet

curl "https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/?Email=test%40tesdedet.com&Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/?" + new URLSearchParams({ Email: "test@tesdedet.com", Licence: "{LICENCE_CODE}" })) .then(r => r.json()) .then(data => console.log(data));
import requests response = requests.get( "https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/", params={ "Email": "test@tesdedet.com", "Licence": "{LICENCE_CODE}", }, ) print(response.json())
<?php $params = http_build_query([ 'Email' => 'test@tesdedet.com', 'Licence' => '{LICENCE_CODE}', ]); $ch = curl_init("https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/?{$params}"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); $data = json_decode($response, true);
const axios = require('axios'); axios.get('https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/', { params: { Email: 'test@tesdedet.com', Licence: '{LICENCE_CODE}' } }) .then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient(); String url = "https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/" + "?Email=test%40tesdedet.com&Licence={LICENCE_CODE}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create(url)) .GET() .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());
using var client = new HttpClient(); var url = "https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/" + "?Email=test%40tesdedet.com&Licence={LICENCE_CODE}"; var response = await client.GetAsync(url); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);
package main import ( "fmt" "io" "net/http" ) func main() { url := "https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/" + "?Email=test%40tesdedet.com&Licence={LICENCE_CODE}" resp, err := http.Get(url) if err != nil { panic(err) } defer resp.Body.Close() body, _ := io.ReadAll(resp.Body) fmt.Println(string(body)) }
POSThttps://{SERVER_ADDRESS}/DQEEMAILLOOKUP/

Senden Sie alle Parameter im Request-Body im Format application/x-www-form-urlencoded. Die Serveradresse bleibt in der URL.

Codebeispiele

Gültige Adresse, keine Korrektur angewendet

curl -X POST "https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "Email=test@tesdedet.com" \ -d "Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/", { method: "POST", headers: { "Content-Type": "application/x-www-form-urlencoded" }, body: new URLSearchParams({ Email: "test@tesdedet.com", Licence: "{LICENCE_CODE}" }) }) .then(r => r.json()) .then(data => console.log(data));
import requests response = requests.post( "https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/", data={ "Email": "test@tesdedet.com", "Licence": "{LICENCE_CODE}", }, ) print(response.json())
<?php $ch = curl_init("https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/"); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([ 'Email' => 'test@tesdedet.com', 'Licence' => '{LICENCE_CODE}', ])); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); $data = json_decode($response, true);
const axios = require('axios'); const qs = require('querystring'); axios.post('https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/', qs.stringify({ Email: 'test@tesdedet.com', Licence: '{LICENCE_CODE}' })) .then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient(); String form = "Email=test%40tesdedet.com&Licence={LICENCE_CODE}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/")) .header("Content-Type", "application/x-www-form-urlencoded") .POST(HttpRequest.BodyPublishers.ofString(form)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());
using var client = new HttpClient(); var form = new Dictionary<string, string> { ["Email"] = "test@tesdedet.com", ["Licence"] = "{LICENCE_CODE}" }; var response = await client.PostAsync( "https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/", new FormUrlEncodedContent(form)); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);
package main import ( "fmt" "io" "net/http" "net/url" ) func main() { form := url.Values{} form.Set("Email", "test@tesdedet.com") form.Set("Licence", "{LICENCE_CODE}") resp, err := http.PostForm("https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/", form) if err != nil { panic(err) } defer resp.Body.Close() body, _ := io.ReadAll(resp.Body) fmt.Println(string(body)) }

Parameter

Parameter Beschreibung Erf / Opt
Email Zu validierende E-Mail-Adresse. Erforderlich
Licence Ihr DQE-Lizenzschlüssel. Wenden Sie sich an den Support, falls Sie noch keinen haben. Erforderlich
Rectify y, um eine Domain-Korrektur vorzuschlagen, wenn die eingegebene Domain unbekannt ist; andernfalls n.
Standard: n
Optional
extendedsyntax y, um E-Mail-Adressen mit erweiterter Syntax zu akzeptieren; n, um die Prüfung auf Standard-E-Mail-Adressen zu beschränken.
Standard: n
Optional
checkuser y, um den Teil vor dem @-Zeichen zu prüfen; n, um nur die Domain zu prüfen.
Standard: y
Optional
TimeOut Maximale Abfragezeit für die Datenprüfung, in Sekunden. Beispiel: 0.5 für 500 ms.
Standard: 6
Optional

Antwort

Bei Erfolg gibt die API ein JSON-Objekt mit einem einzigen Schlüssel "1" zurück — ein Legacy-Artefakt der Implementierung dieses Endpunkts — das die eigentlichen Ergebnisfelder unten umschließt.

Level 1 vs. Level 2 - Redressement, eMailOrigine, IdError und eMail werden immer zurückgegeben (Level-1-Prüfung: Domain-Existenz und Syntax). CodeActivite wird nur hinzugefügt, wenn Ihre Lizenz die Aktivitätsstatusprüfung umfasst (Level-2-Prüfung) — bei fehlender Berechtigung wird es vollständig aus der Antwort weggelassen, statt leer zurückgegeben zu werden.
Schlüssel Beschreibung Typ
Redressement 1, wenn die Domain korrigiert wurde; 0, wenn nicht. Integer
eMailOrigine Vom Benutzer eingegebene E-Mail-Adresse. String
IdError Rückgabecode der Validierung. Siehe die IdError-Codes unten. String
eMail Korrigierte E-Mail-Adresse, wenn Redressement=1. String
CodeActivite Aktivitätsstatus der E-Mail-Adresse — nur bei Level-2-Prüfung vorhanden. Siehe die CodeActivite-Codes unten. String

Antwortbeispiel

Level 1 (Standard)
{ "1": { "Redressement": 0, "eMailOrigine": "test@tesdedet.com", "IdError": "92", "eMail": "test@tesdedet.com" } }
Level 2 (mit Aktivitätsstatus)
{ "1": { "Redressement": 0, "eMailOrigine": "test@tesdedet.com", "IdError": "92", "eMail": "test@tesdedet.com", "CodeActivite": "200" } }

Antwortcodes

IdError-Codes

Code Beschreibung Vorgeschlagene UI-Nachricht
00 Gültige E-Mail. Gültige E-Mail
01 Korrekte E-Mail, aber der Name konnte nicht geprüft werden. Gültige E-Mail
02 E-Mail-Adresse für diese Domain nicht gefunden. Bitte überprüfen Sie Ihre E-Mail-Adresse
03 Postfach ist voll (Soft Bounce). Bitte überprüfen Sie Ihre E-Mail-Adresse
04 Leere E-Mail. Bitte überprüfen Sie Ihre E-Mail-Adresse
91 Syntaxfehler. Bitte überprüfen Sie Ihre E-Mail-Adresse
92 Unbekannte Domain. Bitte überprüfen Sie Ihre E-Mail-Adresse
93 E-Mail oder Domain auf der Sperrliste. Bitte überprüfen Sie Ihre E-Mail-Adresse
94 Nicht autorisierter Benutzername. Bitte überprüfen Sie Ihre E-Mail-Adresse
95 Temporäre Wegwerf-E-Mail-Adresse. Bitte überprüfen Sie Ihre E-Mail-Adresse
99 Dienst nicht verfügbar. Gültige E-Mail

CodeActivite-Codes

Betrachten Sie M als den aktuellen Monat.

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

Fehler

Fehlertyp Antwort
Fehlender Licence-Parameter ** LICENCE KO **
Leerer Licence-Parameter ** LICENCE KO **
Falsche Lizenznummer unauthorized_client
Fehlender oder leerer Email-Parameter Normale 200-Antwort mit IdError = 04
Tippfehler im Parameter Normale 200-Antwort mit IdError = 04

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.

Konsole öffnen

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich