Validate a single email address
Validates a single email address and returns deliverability checks.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const EmailValidation = await client.emailValidations.create({
email: 'email',
});
console.log(EmailValidation.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
email_validation = client.email_validations.create(
email="email",
)
print(email_validation.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
emailValidation, err := client.EmailValidations.New(
context.TODO(),
telnyx.EmailValidationNewParams{
Email: "email",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", emailValidation.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.emailValidations.EmailValidationCreateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
EmailValidationCreateParams params = EmailValidationCreateParams.builder()
.email("email")
.build();
var response = client.emailValidations().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
email_validation = telnyx.email_validations.create(email: "email")
puts(email_validation)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$email_validation = $client->emailValidations->create(
email: 'email',
);
var_dump($email_validation);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-validations create \
--api-key 'My API Key' \
--email emailcurl --request POST \
--url https://api.telnyx.com/v2/email_validations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "user@example.com"
}
'{
"data": {
"record_type": "email_validation",
"email": "<string>",
"valid": true,
"risk_score": 1,
"checks": {
"syntax": {
"pass": true,
"details": "<string>"
},
"mx": {
"pass": true,
"details": "<string>"
},
"disposable": {
"pass": true,
"details": "<string>"
},
"role_based": {
"pass": true,
"details": "<string>"
},
"typo": {
"pass": true,
"details": "<string>",
"suggestion": "<string>"
}
},
"did_you_mean": "<string>"
}
}{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "email is required"
}
]
}{
"errors": [
{
"code": "10006",
"title": "Not authorized",
"detail": "Invalid API key",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10006"
}
}
]
}{
"errors": [
{
"code": "10036",
"title": "Resource is being processed",
"detail": "A request with this Idempotency-Key is already being processed.",
"source": {
"pointer": "/header/Idempotency-Key"
}
}
]
}{
"errors": [
{
"title": "<string>",
"detail": "<string>",
"source": {},
"meta": {}
}
],
"suppressed": [
{
"to": "jsmith@example.com",
"reason": "<string>",
"scope": "<string>",
"override_allowed": true
}
]
}{
"errors": [
{
"title": "<string>",
"detail": "<string>",
"source": {},
"meta": {}
}
],
"suppressed": [
{
"to": "jsmith@example.com",
"reason": "<string>",
"scope": "<string>",
"override_allowed": true
}
]
}{
"errors": [
{
"code": "10016",
"title": "Service Unavailable",
"detail": "The email domain service is temporarily unavailable. Please try again later."
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.
1 - 255^[A-Za-z0-9_-]{1,255}$Body
Email address to validate. Any non-empty string is accepted; invalid syntax returns valid=false rather than a request error.
Response
Email validation result.
Show child attributes
Show child attributes
Was this page helpful?
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const EmailValidation = await client.emailValidations.create({
email: 'email',
});
console.log(EmailValidation.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
email_validation = client.email_validations.create(
email="email",
)
print(email_validation.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
emailValidation, err := client.EmailValidations.New(
context.TODO(),
telnyx.EmailValidationNewParams{
Email: "email",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", emailValidation.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.emailValidations.EmailValidationCreateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
EmailValidationCreateParams params = EmailValidationCreateParams.builder()
.email("email")
.build();
var response = client.emailValidations().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
email_validation = telnyx.email_validations.create(email: "email")
puts(email_validation)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$email_validation = $client->emailValidations->create(
email: 'email',
);
var_dump($email_validation);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-validations create \
--api-key 'My API Key' \
--email emailcurl --request POST \
--url https://api.telnyx.com/v2/email_validations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "user@example.com"
}
'{
"data": {
"record_type": "email_validation",
"email": "<string>",
"valid": true,
"risk_score": 1,
"checks": {
"syntax": {
"pass": true,
"details": "<string>"
},
"mx": {
"pass": true,
"details": "<string>"
},
"disposable": {
"pass": true,
"details": "<string>"
},
"role_based": {
"pass": true,
"details": "<string>"
},
"typo": {
"pass": true,
"details": "<string>",
"suggestion": "<string>"
}
},
"did_you_mean": "<string>"
}
}{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "email is required"
}
]
}{
"errors": [
{
"code": "10006",
"title": "Not authorized",
"detail": "Invalid API key",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10006"
}
}
]
}{
"errors": [
{
"code": "10036",
"title": "Resource is being processed",
"detail": "A request with this Idempotency-Key is already being processed.",
"source": {
"pointer": "/header/Idempotency-Key"
}
}
]
}{
"errors": [
{
"title": "<string>",
"detail": "<string>",
"source": {},
"meta": {}
}
],
"suppressed": [
{
"to": "jsmith@example.com",
"reason": "<string>",
"scope": "<string>",
"override_allowed": true
}
]
}{
"errors": [
{
"title": "<string>",
"detail": "<string>",
"source": {},
"meta": {}
}
],
"suppressed": [
{
"to": "jsmith@example.com",
"reason": "<string>",
"scope": "<string>",
"override_allowed": true
}
]
}{
"errors": [
{
"code": "10016",
"title": "Service Unavailable",
"detail": "The email domain service is temporarily unavailable. Please try again later."
}
]
}