Dokumenty API sprawdzania poprawności wiadomości e-mail
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/verifyParametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| input | string | Tak | Adres e-mail lub domena do weryfikacji (np. test@example.com lub example.com) |
Pola odpowiedzi
| Pole | Opis |
|---|---|
| valid | Wskazuje, czy format wiadomości e-mail jest poprawny |
| block | Wskazuje, czy wiadomość e-mail powinna zostać zablokowana (prawda, jeśli wartość disposable, privacy, applePrivateEmail, deliverable lub catch_all jest prawdziwa). |
| disposable | Określa, czy adres e-mail jest tymczasowy czy jednorazowy. |
| privacy | Określa, czy serwer pocztowy korzysta z aliasu e-mail lub forwardera. |
| applePrivateEmail | Wskazuje, czy adres e-mail jest adresem Apple Private. |
| deliverable | Sprawdza, czy skrzynka pocztowa istnieje i może odbierać wiadomości e-mail |
| domain | Część domenowa adresu e-mail |
| email_address | Adres e-mail |
| catch_all | Wskazuje, 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_found | Wskazuje, czy domena ma prawidłowe serwery pocztowe (rekordy MX). |
| remaining_credits | Liczba 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/batchParametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| inputs | array of strings | Tak | Tablica 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/deliverableParametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| input | string | Tak | Adres 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
| Pole | Opis |
|---|---|
| valid | Wskazuje, czy format wiadomości e-mail jest poprawny |
| deliverable | Sprawdza, czy skrzynka pocztowa istnieje i może odbierać wiadomości e-mail |
| mx_found | Wskazuje, czy domena ma prawidłowe serwery pocztowe (rekordy MX). |
| catch_all | Wskazuje, 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_address | Adres e-mail |
| remaining_credits | Liczba 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.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
Lista czarna ma zawsze pierwszeństwo: adres z listy czarnej pozostaje zablokowany nawet gdy jest na liście białej.
Co jest sprawdzane
Szybka ściąga
| Lista biała włączona | Na liście czarnej | Na liście białej | wartość block |
|---|---|---|---|
| Nie | Tak | — | true |
| Nie | Nie | — | Normalnie |
| Tak | Tak | Dowolny | true |
| Tak | Nie | Tak | false |
| Tak | Nie | Nie | true |
Punkty końcowe list API
Wszystkie punkty końcowe list wymagają nagłówka: X-API-Key: your-api-key
Lista czarna
/v1/blacklist/v1/blacklist/v1/blacklistLista biała
/v1/whitelist/v1/whitelist/v1/whitelist/v1/whitelist/enabled/v1/whitelist/enabledFormat wartości
user@example.com— E-mail: poprawny format, np. user@example.comexample.com— Domena: 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ędzie | Opis | Wejście | Kredyty |
|---|---|---|---|
| verify_email | Pełna weryfikacja wiadomości e-mail, w tym kontrola składni, MX, SMTP, jednorazowości, prywatności i dostarczalności. | { email: string } | 1 |
| verify_domain | Pełna weryfikacja domen, w tym rekordów MX, jednorazowych, prywatności i wykrywania catch-all. | { domain: string } | 1 |
| check_deliverability | Szybkie sprawdzanie tylko dostarczalności przy użyciu weryfikacji MX i SMTP bez zewnętrznych wywołań API | { email: string } | 1 |
| verify_batch | Weryfikacja wsadowa do 100 wiadomości e-mail lub domen w jednym żądaniu | { inputs: string[] } | 1 per item |
| validate_email_syntax | Szybka lokalna walidacja składni względem RFC 5322 bez połączeń sieciowych | { email: string } | 0 (free) |