ElasticEmail.VerificationsApi

All URIs are relative to https://api.elasticemail.com/v4

Method	HTTP request	Description
verifications_by_email_delete	DELETE /verifications/{email}	Delete Email Verification Result
verifications_by_email_get	GET /verifications/{email}	Get Email Verification Result
verifications_by_email_post	POST /verifications/{email}	Verify Email
verifications_files_by_id_delete	DELETE /verifications/files/{id}	Delete File Verification Result
verifications_files_by_id_result_download_get	GET /verifications/files/{id}/result/download	Download File Verification Result
verifications_files_by_id_result_get	GET /verifications/files/{id}/result	Get Detailed File Verification Result
verifications_files_by_id_verification_post	POST /verifications/files/{id}/verification	Start verification
verifications_files_post	POST /verifications/files	Upload File with Emails
verifications_files_result_get	GET /verifications/files/result	Get Files Verification Results
verifications_get	GET /verifications	Get Emails Verification Results

verifications_by_email_delete

verifications_by_email_delete(email)

Delete Email Verification Result

Delete a result with given email if exists. Required Access Level: VerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)
    email = 'email_example' # str | Email address to verification

    try:
        # Delete Email Verification Result
        api_instance.verifications_by_email_delete(email)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_by_email_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	Email address to verification

Return type

void (empty response body)

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifications_by_email_get

EmailValidationResult verifications_by_email_get(email)

Get Email Verification Result

Returns a result of verified email. Required Access Level: ViewVerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.email_validation_result import EmailValidationResult
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)
    email = 'email_example' # str | Email address to view verification result of

    try:
        # Get Email Verification Result
        api_response = api_instance.verifications_by_email_get(email)
        print("The response of VerificationsApi->verifications_by_email_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_by_email_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	Email address to view verification result of

Return type

EmailValidationResult

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifications_by_email_post

EmailValidationResult verifications_by_email_post(email)

Verify Email

Verify single email address and returns result of verification. Required Access Level: VerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.email_validation_result import EmailValidationResult
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)
    email = 'email_example' # str | Email address to verify

    try:
        # Verify Email
        api_response = api_instance.verifications_by_email_post(email)
        print("The response of VerificationsApi->verifications_by_email_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_by_email_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
email	str	Email address to verify

Return type

EmailValidationResult

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifications_files_by_id_delete

verifications_files_by_id_delete(id)

Delete File Verification Result

Delete Verification Results if they exist. Required Access Level: VerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)
    id = 'E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F' # str | ID of the exported file

    try:
        # Delete File Verification Result
        api_instance.verifications_files_by_id_delete(id)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_files_by_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of the exported file

Return type

void (empty response body)

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifications_files_by_id_result_download_get

bytearray verifications_files_by_id_result_download_get(id)

Download File Verification Result

Download verification results as a ZIP file. Required Access Level: ViewVerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)
    id = 'id_example' # str | Verification ID to download

    try:
        # Download File Verification Result
        api_response = api_instance.verifications_files_by_id_result_download_get(id)
        print("The response of VerificationsApi->verifications_files_by_id_result_download_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_files_by_id_result_download_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Verification ID to download

Return type

bytearray

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/*

HTTP response details

Status code	Description	Response headers
200	A ZIP file with verification details	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifications_files_by_id_result_get

VerificationFileResultDetails verifications_files_by_id_result_get(id, limit=limit, offset=offset)

Get Detailed File Verification Result

Returns status and results (if verified) of file with given ID. Required Access Level: ViewVerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.verification_file_result_details import VerificationFileResultDetails
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)
    id = 'id_example' # str | ID of the Verification to display status of
    limit = 56 # int | Maximum number of returned email verification results (optional)
    offset = 56 # int | How many result items should be returned ahead (optional)

    try:
        # Get Detailed File Verification Result
        api_response = api_instance.verifications_files_by_id_result_get(id, limit=limit, offset=offset)
        print("The response of VerificationsApi->verifications_files_by_id_result_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_files_by_id_result_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of the Verification to display status of
limit	int	Maximum number of returned email verification results	[optional]
offset	int	How many result items should be returned ahead	[optional]

Return type

VerificationFileResultDetails

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifications_files_by_id_verification_post

verifications_files_by_id_verification_post(id)

Start verification

Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)
    id = 'id_example' # str | File ID to start verification

    try:
        # Start verification
        api_instance.verifications_files_by_id_verification_post(id)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_files_by_id_verification_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	File ID to start verification

Return type

void (empty response body)

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifications_files_post

VerificationFileResult verifications_files_post(file=file)

Upload File with Emails

Uploads a CSV file with list of emails that can then be triggered for verification. An 'email' column is required. Required Access Level: VerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.verification_file_result import VerificationFileResult
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)
    file = None # bytearray |  (optional)

    try:
        # Upload File with Emails
        api_response = api_instance.verifications_files_post(file=file)
        print("The response of VerificationsApi->verifications_files_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_files_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
file	bytearray		[optional]

Return type

VerificationFileResult

Authorization

apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifications_files_result_get

List[VerificationFileResult] verifications_files_result_get()

Get Files Verification Results

Returns a list of uploaded files, their statuses and results. Required Access Level: ViewVerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.verification_file_result import VerificationFileResult
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)

    try:
        # Get Files Verification Results
        api_response = api_instance.verifications_files_result_get()
        print("The response of VerificationsApi->verifications_files_result_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_files_result_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[VerificationFileResult]

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifications_get

List[EmailValidationResult] verifications_get(limit=limit, offset=offset)

Get Emails Verification Results

Returns a results of all verified single emails. Required Access Level: ViewVerifyEmails

Example

Api Key Authentication (apikey):

import ElasticEmail
from ElasticEmail.models.email_validation_result import EmailValidationResult
from ElasticEmail.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elasticemail.com/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = ElasticEmail.Configuration(
    host = "https://api.elasticemail.com/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Enter a context with an instance of the API client
with ElasticEmail.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ElasticEmail.VerificationsApi(api_client)
    limit = 100 # int | Maximum number of returned items. (optional)
    offset = 20 # int | How many items should be returned ahead. (optional)

    try:
        # Get Emails Verification Results
        api_response = api_instance.verifications_get(limit=limit, offset=offset)
        print("The response of VerificationsApi->verifications_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VerificationsApi->verifications_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	Maximum number of returned items.	[optional]
offset	int	How many items should be returned ahead.	[optional]

Return type

List[EmailValidationResult]

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

VerificationsApi.md

Latest commit

History

VerificationsApi.md

File metadata and controls

ElasticEmail.VerificationsApi

verifications_by_email_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifications_by_email_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifications_by_email_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifications_files_by_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifications_files_by_id_result_download_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifications_files_by_id_result_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifications_files_by_id_verification_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifications_files_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifications_files_result_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

verifications_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details