Dokumenty API sprawdzania poprawności wiadomości e-mail

Status API

Pierwsze kroki

Wszystkie żądania API wymagają uwierzytelnienia przy użyciu klucza API. Klucz API można znaleźć na pulpicie nawigacyjnym.

Nagłówek: "x-api-key: your-api-key"

Pojedyncza weryfikacja

Zweryfikuj pojedynczy adres e-mail lub domenę pod kątem ważności, statusu jednorazowego użytku, usług prywatności i dostarczalności.

Punkt końcowy

GET /v1/verify

Parametry

NazwaTypWymaganeOpis
inputstringTakAdres e-mail lub domena do weryfikacji (np. test@example.com lub example.com)

Pola odpowiedzi

PoleOpis
validWskazuje, czy format wiadomości e-mail jest poprawny
blockWskazuje, czy wiadomość e-mail powinna zostać zablokowana (prawda, jeśli wartość disposable, privacy, applePrivateEmail, deliverable lub catch_all jest prawdziwa).
disposableOkreśla, czy adres e-mail jest tymczasowy czy jednorazowy.
privacyOkreśla, czy serwer pocztowy korzysta z aliasu e-mail lub forwardera.
applePrivateEmailWskazuje, czy adres e-mail jest adresem Apple Private.
deliverableSprawdza, czy skrzynka pocztowa istnieje i może odbierać wiadomości e-mail
domainCzęść domenowa adresu e-mail
email_addressAdres e-mail
catch_allWskazuje, czy domena ma konfigurację poczty e-mail typu "catch-all", która akceptuje wszystkie przychodzące wiadomości e-mail niezależnie od adresu odbiorcy.
mx_foundWskazuje, czy domena ma prawidłowe serwery pocztowe (rekordy MX).
remaining_creditsLiczba kredytów API pozostałych na koncie użytkownika

Czarna lista / Biała lista: Tylko pole blok odzwierciedla członkostwo na liście. Czarna lista → blokuj: prawda; biała lista → blokuj: fałsz; nie na białej liście (po włączeniu) → blokuj: prawda. Nie używaj valid do decydowania o blokowaniu na podstawie list.

Przykładowa odpowiedź

{
  "valid": true,
  "block": false,
  "disposable": false,
  "privacy": false,
  "applePrivateEmail": false,
  "deliverable": true,
  "domain": "example.com",
  "email_address": "test@example.com",
  "catch_all": false,
  "mx_found": true,
  "error": null,
  "remaining_credits": 99
}

Przykłady kodu

curl "https://api.verify-email.app/v1/verify?input=test@example.com" \
  -H "X-API-Key: your-api-key"

Wypróbuj

Do testowania punktów końcowych potrzebny jest klucz API.

Spróbuj z:

Weryfikacja partii

Weryfikacja wielu adresów e-mail lub domen w jednym żądaniu (maksymalnie 100 elementów).

Punkt końcowy

POST /v1/verify/batch

Parametry

NazwaTypWymaganeOpis
inputsarray of stringsTakTablica adresów e-mail lub domen do zweryfikowania

Przykłady kodu

curl -X POST "https://api.verify-email.app/v1/verify/batch" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "inputs": [
      "test1@example.com",
      "test2@example.com"
    ]
  }'

Wypróbuj

Do testowania punktów końcowych potrzebny jest klucz API.

Spróbuj z różnymi domenami:

Sprawdzanie tylko rezultatów

Szybkie sprawdzanie dostarczalności wiadomości e-mail przy użyciu weryfikacji MX i SMTP bez zewnętrznych wywołań API. Zwraca tylko pola związane z dostarczalnością w celu skrócenia czasu odpowiedzi.

Punkt końcowy

GET /v1/verify/deliverable

Parametry

NazwaTypWymaganeOpis
inputstringTakAdres e-mail do sprawdzania dostarczalności (np. test@example.com). Wprowadzanie danych tylko dla domeny nie jest obsługiwane dla tego punktu końcowego.

Pola odpowiedzi

PoleOpis
validWskazuje, czy format wiadomości e-mail jest poprawny
deliverableSprawdza, czy skrzynka pocztowa istnieje i może odbierać wiadomości e-mail
mx_foundWskazuje, czy domena ma prawidłowe serwery pocztowe (rekordy MX).
catch_allWskazuje, czy domena ma konfigurację poczty e-mail typu "catch-all", która akceptuje wszystkie przychodzące wiadomości e-mail niezależnie od adresu odbiorcy.
email_addressAdres e-mail
remaining_creditsLiczba kredytów API pozostałych na koncie użytkownika

Przykładowa odpowiedź

{
  "valid": true,
  "deliverable": true,
  "mx_found": true,
  "catch_all": false,
  "email_address": "test@example.com",
  "remaining_credits": 99
}

Przykłady kodu

curl "https://api.verify-email.app/v1/verify/deliverable?input=test@example.com" \
  -H "X-API-Key: your-api-key"

Wypróbuj

Do testowania punktów końcowych potrzebny jest klucz API.

Spróbuj z:

Lista biała i czarna

Kontroluj, które e-maile i domeny są blokowane, dzięki regułom listy czarnej i białej dla użytkownika. Te listy ustawiają pole block w każdej odpowiedzi weryfikacji.

{}

Pole block

Każda odpowiedź weryfikacji zawiera pole block. Sprawdź je, aby zdecydować, czy zablokować e-mail/domenę według swoich list:

trueE-mail lub jego domena jest na czarnej liście → block: true. Dodanie domeny blokuje wszystkie adresy na niej.
trueLista biała jest włączona, ale e-mail/domeny na niej nie ma → block: true.
falseLista biała jest włączona i e-mail lub jego domena na niej jest → block: false.
Żadna lista nie ma zastosowania → block wynika z normalnego wyniku weryfikacji.

Przegląd

Lista czarna

Zawsze blokuj wybrane e-maile lub całe domeny. Np. dodanie example.com do listy czarnej sprawia, że każdy adres @example.com zwróci block: true — niezależnie od wyniku weryfikacji.

Lista biała

Zezwalaj tylko na wybrane e-maile lub domeny. Gdy lista biała jest włączona, tylko wpisy z listy mają block: false; wszystko inne block: true. Np. dodanie gmail.com zezwala na dowolny @gmail.com, a user@yahoo.com będzie zablokowany. Wyłączona lista biała nie ma skutku.

Możesz dodać pełny e-mail (user@example.com) lub domenę (example.com). Dodanie domeny dotyczy wszystkich adresów na tej domenie. Wielkość liter nie ma znaczenia.

Jak to działa

Kolejność oceny

1
Najpierw lista czarnaJeśli e-mail lub jego domena jest na czarnej liście, wynik to block: true. Dalsza logika list nie jest stosowana.
2
Lista biała (jeśli włączona)Jeśli e-mail/domena jest na liście białej → block: false. W przeciwnym razie → block: true.
3
Lista biała wyłączonaStosują się tylko lista czarna i normalna weryfikacja.

Lista czarna ma zawsze pierwszeństwo: adres z listy czarnej pozostaje zablokowany nawet gdy jest na liście białej.

Co jest sprawdzane

Weryfikacja e-mail — API sprawdza pełny adres i domenę wobec obu list. Dopasowanie stosuje regułę listy.
Weryfikacja domeny — tylko domena jest sprawdzana wobec listy czarnej i (jeśli włączona) białej.

Szybka ściąga

Lista biała włączonaNa liście czarnejNa liście białejwartość block
NieTaktrue
NieNieNormalnie
TakTakDowolnytrue
TakNieTakfalse
TakNieNietrue

Punkty końcowe list API

Wszystkie punkty końcowe list wymagają nagłówka: X-API-Key: your-api-key

Lista czarna

GET/v1/blacklist
Lista wpisów listy czarnej
POST/v1/blacklist
Dodaj e-mail lub domenę · { "value": "..." }
DELETE/v1/blacklist
Usuń wpis · value=...

Lista biała

GET/v1/whitelist
Lista wpisów listy białej
POST/v1/whitelist
Dodaj e-mail lub domenę · { "value": "..." }
DELETE/v1/whitelist
Usuń wpis · value=...
GET/v1/whitelist/enabled
Pobierz stan listy białej · { "enabled": boolean }
PUT/v1/whitelist/enabled
Włącz/wyłącz listę białą · { "enabled": true | false }

Format wartości

  • user@example.comE-mail: poprawny format, np. user@example.com
  • example.comDomena: poprawny format, np. example.com

Nieprawidłowe wartości są odrzucane z kodem 400. Wpisy są przechowywane znormalizowane. Duplikaty łączy się w jeden wpis.

Gdzie stosowane są listy

Reguły list stosuje się po weryfikacji. Odpowiedzi weryfikacji e-mail (pojedynczej i wsadowej) oraz domeny zawierają już listę czarną i białą użytkownika w polu block.

Serwer MCP (integracja z agentem AI)

Zintegruj weryfikację wiadomości e-mail bezpośrednio z agentami AI, takimi jak Cursor i Claude Desktop, przy użyciu protokołu MCP (Model Context Protocol). Asystent AI może weryfikować wiadomości e-mail, sprawdzać domeny i weryfikować składnię bez opuszczania edytora.

Konfiguracja

Dodaj następującą konfigurację do pliku konfiguracyjnego .cursor/mcp.json lub Claude Desktop:

{
  "mcpServers": {
    "email-checker": {
      "url": "https://api.verify-email.app/mcp",
      "headers": {
        "X-API-Key": "your-api-key"
      }
    }
  }
}

Dostępne narzędzia

NarzędzieOpisWejścieKredyty
verify_emailPełna weryfikacja wiadomości e-mail, w tym kontrola składni, MX, SMTP, jednorazowości, prywatności i dostarczalności.{ email: string }1
verify_domainPełna weryfikacja domen, w tym rekordów MX, jednorazowych, prywatności i wykrywania catch-all.{ domain: string }1
check_deliverabilitySzybkie sprawdzanie tylko dostarczalności przy użyciu weryfikacji MX i SMTP bez zewnętrznych wywołań API{ email: string }1
verify_batchWeryfikacja wsadowa do 100 wiadomości e-mail lub domen w jednym żądaniu{ inputs: string[] }1 per item
validate_email_syntaxSzybka lokalna walidacja składni względem RFC 5322 bez połączeń sieciowych{ email: string }0 (free)