Email API — Eine E-Mail-Adresse validieren (REST)

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Restful-Endpunkt, um eine E-Mail-Adresse zu validieren und Informationen zu Syntax, Domäne, Zustellbarkeit und Aktivitätsstatus zurückzugeben.

Siehe auch: Restful Email Swagger-Dokumentation

GET-Anfrage

Endpunkt

GET https://{SERVER_ADDRESS}/{VERSION}/email/lookup?email={EMAIL}&rectify={RECTIFY}&extendedSyntax={EXTENDED_SYNTAX}&checkUser={CHECK_USER}&timeout={TIMEOUT}

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

Parameter Beschreibung Pflicht/Optional
email Zu validierende E-Mail-Adresse. Pflicht
rectify true, um bei unbekannter Domäne eine Domänenkorrektur vorzuschlagen; sonst false. Optional
extendedSyntax true, um E-Mail-Adressen mit erweiterter Syntax zu akzeptieren; false, um die Prüfung auf Standard-E-Mail-Adressen zu beschränken. Optional
checkUser true, um den Teil vor dem @-Zeichen zu prüfen; false, um nur die Domäne zu prüfen. Optional
timeout Maximale Abfragezeit für die Überprüfung, in Sekunden. Optional

POST-Anfrage

Endpunkt

POST https://{SERVER_ADDRESS}/{VERSION}/email/lookup

Senden Sie die folgenden Parameter im Anfragetext als JSON.

Parameter Beschreibung Pflicht/Optional
email Zu validierende E-Mail-Adresse. Pflicht
rectify true, um bei unbekannter Domäne eine Domänenkorrektur vorzuschlagen; sonst false. Optional
extendedSyntax true, um E-Mail-Adressen mit erweiterter Syntax zu akzeptieren; false, um die Prüfung auf Standard-E-Mail-Adressen zu beschränken. Optional
checkUser true, um den Teil vor dem @-Zeichen zu prüfen; false, um nur die Domäne zu prüfen. Optional
timeout Maximale Abfragezeit für die Überprüfung, in Sekunden. Optional

Beispiel:

{
  "email": "test@example.com",
  "rectify": true,
  "extendedSyntax": false,
  "checkUser": true,
  "timeout": 0.5
}

Antwort

Erfolgsantwort

Die JSON-Antwort enthält Validierungsdetails für die angegebene E-Mail-Adresse.

Schlüssel Beschreibung Typ
IdError Von der API zurückgegebener Fehlercode. INTEGER
Error Mit dem Validierungsergebnis verbundene Fehlermeldung. STRING
Formatted Normalisierte und formatierte E-Mail-Adresse. STRING
LocalPart Teil vor dem @-Symbol. STRING
Domain Domänenname der E-Mail. STRING
Tld Top-Level-Domain. STRING
IsValid Gibt an, ob die E-Mail-Syntax gültig ist. BOOLEAN
IsDisposable Gibt an, ob die E-Mail zu einem Wegwerf-Anbieter gehört. BOOLEAN
IsCatchAll Gibt an, ob die Domäne alle E-Mails akzeptiert. BOOLEAN
IsFree Gibt an, ob der Anbieter kostenlos ist. BOOLEAN
IsRole Gibt an, ob es sich um eine funktionsbasierte Adresse handelt. BOOLEAN
IsDeliverable Gibt an, ob die E-Mail-Adresse zustellbar ist. BOOLEAN
HasSuggestedCorrection Gibt an, ob ein Korrekturvorschlag verfügbar ist. BOOLEAN
SuggestedCorrection Vorgeschlagene korrigierte E-Mail-Adresse. STRING
DomainExists Gibt an, ob die Domäne existiert. BOOLEAN
HasMxRecords Gibt an, ob MX-Einträge verfügbar sind. BOOLEAN

Beispiel:

{
  "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
}

Fehlerantwort

Fehlertyp Antworttyp
Fehlende oder ungültige Authentifizierung 401 Unauthorized
Fehlender Parameter email 400 Bad Request
Ungültige E-Mail-Syntax Validierungsfehlerantwort

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich