com.mailgun.api.v4

Interface MailgunEmailVerificationApi

All Superinterfaces:

MailgunApi

public interface MailgunEmailVerificationApi
extends MailgunApi

This API endpoint is an email address verification service.

We will verify the given address based on:

 Mailbox detection
 Syntax checks (RFC defined grammar)
 DNS validation
 Spell checks
 Email Service Provider (ESP) specific local-part grammar (if available).
 

See Also:

Email Validation/Verification

Method Summary

Modifier and Type	Method and Description
String	cancelBulkVerificationJob(String listName) Cancel current running bulk verification job.
feign.Response	cancelBulkVerificationJobFeignResponse(String listName) Cancel current running bulk verification job.
BulkVerificationCreatingResponse	createBulkVerificationJob(String listName, BulkVerificationStatusRequest request) Create a bulk verification job.
feign.Response	createBulkVerificationJobFeignResponse(String listName, BulkVerificationStatusRequest request) Create a bulk verification job.
BulkVerificationCreatingResponse	createBulkVerificationPreview(String listName, BulkVerificationStatusRequest request) Create a bulk verification preview.
feign.Response	createBulkVerificationPreviewFeignResponse(String listName, BulkVerificationStatusRequest request) Create a bulk verification preview.
feign.Response	deleteBulkVerificationPreview(String listName) Delete a bulk verification preview.
static ApiVersion	getApiVersion()
BulkVerificationJobListResponse	getBulkVerificationJobList() Get list of all bulk verification jobs (limit to 500 entries).
BulkVerificationJobListResponse	getBulkVerificationJobList(Integer limit) Get list of all bulk verification jobs.
feign.Response	getBulkVerificationJobListFeignResponse() Get list of all bulk verification jobs (limit to 500 entries).
feign.Response	getBulkVerificationJobListFeignResponse(Integer limit) Get list of all bulk verification jobs.
BulkVerificationJobStatusResponse	getBulkVerificationJobStatus(String listName) Check the current status of a bulk verification job.
feign.Response	getBulkVerificationJobStatusFeignResponse(String listName) Check the current status of a bulk verification job.
BulkVerificationPreviewListResponse	getBulkVerificationPreviewList() Get list of all bulk verification previews.
feign.Response	getBulkVerificationPreviewListFeignResponse() Get list of all bulk verification previews.
BulkVerificationPreviewResponse	getBulkVerificationPreviewStatus(String listName) Check the current status of a bulk verification preview.
feign.Response	getBulkVerificationPreviewStatusFeignResponse(String listName) Check the current status of a bulk verification preview.
AddressValidationResponse	validateAddress(String address) Given an arbitrary address, validates address based off defined checks.
AddressValidationResponse	validateAddress(String address, Boolean providerLookup) Given an arbitrary address, validates address based off defined checks.
feign.Response	validateAddressFeignResponse(String address) Given an arbitrary address, validates address based off defined checks.
feign.Response	validateAddressFeignResponse(String address, Boolean providerLookup) Given an arbitrary address, validates address based off defined checks.
feign.Response	validateAddressPostFeignResponse(String address, Boolean providerLookup) Given an arbitrary address, validates address based off defined checks.
AddressValidationResponse	validateAddressPostRequest(String address) Given an arbitrary address, validates address based off defined checks.
AddressValidationResponse	validateAddressPostRequest(String address, Boolean providerLookup) Given an arbitrary address, validates address based off defined checks.
feign.Response	validateAddressPostRequestFeignResponse(String address) Given an arbitrary address, validates address based off defined checks.

Method Detail

getApiVersion

static ApiVersion getApiVersion()

Specified by:

getApiVersion in interface MailgunApi

validateAddress

AddressValidationResponse validateAddress(String address)

Given an arbitrary address, validates address based off defined checks.

Parameters:

address - An email address to validate. (Maximum: 512 characters)

Returns:

AddressValidationResponse

validateAddressFeignResponse

feign.Response validateAddressFeignResponse(String address)

Given an arbitrary address, validates address based off defined checks.

Parameters:

address - An email address to validate. (Maximum: 512 characters)

Returns:

Response

validateAddressPostRequest

AddressValidationResponse validateAddressPostRequest(String address)

Given an arbitrary address, validates address based off defined checks.

Parameters:

address - An email address to validate. (Maximum: 512 characters)

Returns:

AddressValidationResponse

validateAddressPostRequestFeignResponse

feign.Response validateAddressPostRequestFeignResponse(String address)

Given an arbitrary address, validates address based off defined checks.

Parameters:

address - An email address to validate. (Maximum: 512 characters)

Returns:

Response

validateAddress

AddressValidationResponse validateAddress(String address,
                                          Boolean providerLookup)

Given an arbitrary address, validates address based off defined checks.

Parameters:

address - An email address to validate. (Maximum: 512 characters)

providerLookup - Warning: For advanced users only. The provider_lookup query parameter provides users with the control to allow or prevent Mailgun from reaching out to the mailbox provider. If set to true - A provider lookup will be performed if Mailgun’s internal analysis is insufficient.

Returns:

AddressValidationResponse

validateAddressFeignResponse

feign.Response validateAddressFeignResponse(String address,
                                            Boolean providerLookup)

Given an arbitrary address, validates address based off defined checks.

Parameters:

address - An email address to validate. (Maximum: 512 characters)

providerLookup - Warning: For advanced users only. The provider_lookup query parameter provides users with the control to allow or prevent Mailgun from reaching out to the mailbox provider. If set to true - A provider lookup will be performed if Mailgun’s internal analysis is insufficient.

Returns:

Response

validateAddressPostRequest

AddressValidationResponse validateAddressPostRequest(String address,
                                                     Boolean providerLookup)

Given an arbitrary address, validates address based off defined checks.

Parameters:

address - An email address to validate. (Maximum: 512 characters)

providerLookup - Warning: For advanced users only The provider_lookup query parameter provides users with the control to allow or prevent Mailgun from reaching out to the mailbox provider. If set to true - A provider lookup will be performed if Mailgun’s internal analysis is insufficient.

Returns:

AddressValidationResponse

validateAddressPostFeignResponse

feign.Response validateAddressPostFeignResponse(String address,
                                                Boolean providerLookup)

Given an arbitrary address, validates address based off defined checks.

Parameters:

address - An email address to validate. (Maximum: 512 characters)

providerLookup - Warning: For advanced users only The provider_lookup query parameter provides users with the control to allow or prevent Mailgun from reaching out to the mailbox provider. If set to true - A provider lookup will be performed if Mailgun’s internal analysis is insufficient.

Returns:

Response

getBulkVerificationJobList

BulkVerificationJobListResponse getBulkVerificationJobList()

Get list of all bulk verification jobs (limit to 500 entries).

Returns:

BulkVerificationJobListResponse

getBulkVerificationJobListFeignResponse

feign.Response getBulkVerificationJobListFeignResponse()

Get list of all bulk verification jobs (limit to 500 entries).

Returns:

Response

getBulkVerificationJobList

BulkVerificationJobListResponse getBulkVerificationJobList(Integer limit)

Get list of all bulk verification jobs.

Parameters:

limit - Number of entries to return.

Returns:

BulkVerificationJobListResponse

getBulkVerificationJobListFeignResponse

feign.Response getBulkVerificationJobListFeignResponse(Integer limit)

Get list of all bulk verification jobs.

Parameters:

limit - Number of entries to return.

Returns:

Response

getBulkVerificationJobStatus

BulkVerificationJobStatusResponse getBulkVerificationJobStatus(String listName)

Check the current status of a bulk verification job.

Parameters:

listName - Bulk verification job list name

Returns:

BulkVerificationJobStatusResponse

getBulkVerificationJobStatusFeignResponse

feign.Response getBulkVerificationJobStatusFeignResponse(String listName)

Check the current status of a bulk verification job.

Parameters:

listName - Bulk verification job list name

Returns:

Response

createBulkVerificationJob

BulkVerificationCreatingResponse createBulkVerificationJob(String listName,
                                                           BulkVerificationStatusRequest request)

Create a bulk verification job.

Parameters:

listName - Bulk verification job list name

request - BulkVerificationStatusRequest

Returns:

BulkVerificationCreatingResponse

createBulkVerificationJobFeignResponse

feign.Response createBulkVerificationJobFeignResponse(String listName,
                                                      BulkVerificationStatusRequest request)

Create a bulk verification job.

Parameters:

listName - Bulk verification job list name

request - BulkVerificationStatusRequest

Returns:

Response

cancelBulkVerificationJob

String cancelBulkVerificationJob(String listName)

Cancel current running bulk verification job.

Parameters:

listName - Bulk verification job list name

Returns:

Result status message

cancelBulkVerificationJobFeignResponse

feign.Response cancelBulkVerificationJobFeignResponse(String listName)

Cancel current running bulk verification job.

Parameters:

listName - Bulk verification job list name

Returns:

Response

getBulkVerificationPreviewList

BulkVerificationPreviewListResponse getBulkVerificationPreviewList()

Get list of all bulk verification previews.

Returns:

BulkVerificationPreviewListResponse

getBulkVerificationPreviewListFeignResponse

feign.Response getBulkVerificationPreviewListFeignResponse()

Get list of all bulk verification previews.

Returns:

Response

getBulkVerificationPreviewStatus

BulkVerificationPreviewResponse getBulkVerificationPreviewStatus(String listName)

Check the current status of a bulk verification preview.

Parameters:

listName - Bulk verification preview list name

Returns:

BulkVerificationPreviewResponse

getBulkVerificationPreviewStatusFeignResponse

feign.Response getBulkVerificationPreviewStatusFeignResponse(String listName)

Check the current status of a bulk verification preview.

Parameters:

listName - Bulk verification preview list name

Returns:

Response

createBulkVerificationPreview

BulkVerificationCreatingResponse createBulkVerificationPreview(String listName,
                                                               BulkVerificationStatusRequest request)

Create a bulk verification preview.

Parameters:

listName - Bulk verification preview list name

request - BulkVerificationStatusRequest

Returns:

BulkVerificationCreatingResponse

createBulkVerificationPreviewFeignResponse

feign.Response createBulkVerificationPreviewFeignResponse(String listName,
                                                          BulkVerificationStatusRequest request)

Create a bulk verification preview.

Parameters:

listName - Bulk verification preview list name

request - BulkVerificationStatusRequest

Returns:

Response

deleteBulkVerificationPreview

feign.Response deleteBulkVerificationPreview(String listName)

Delete a bulk verification preview.

Parameters:

listName - Bulk verification preview list name

Returns:

Response