com.mailgun.api.v4

Interface MailgunSeedListApi

All Superinterfaces:

MailgunApi

public interface MailgunSeedListApi
extends MailgunApi

A seed list is an object that provides the mailing list for your inbox placement test. It also acts as a container for all the results of those tests and will aggregate the stats of all the tests.

When you create a seed list you will be provided a mailing list. You may adjust this mailing list as you see fit, but you must send to the target_email otherwise a placement test will not be run.

See Also:

Inbox Placement

Method Summary

Modifier and Type	Method and Description
feign.Response	deleteResultFeignResponse(String rid) Delete a result.
feign.Response	deleteSeedListFeignResponse(String targetEmail) Delete a seed list.
SeedListItem	generateSeedList(SeedListRequest request) Generate a seed list.
feign.Response	generateSeedListFeignResponse(SeedListRequest request) Generate a seed list.
SeedListsResponse	getAllSeedLists() Get a list of all of your seed lists.
SeedListsResponse	getAllSeedLists(SeedListsPageRequest filter) Get a list of all of your seed lists.
feign.Response	getAllSeedListsFeignResponse() Get a list of all of your seed lists.
feign.Response	getAllSeedListsFeignResponse(SeedListsPageRequest filter) Get a list of all of your seed lists.
static ApiVersion	getApiVersion()
feign.Response	getAvailableResultFiltersFeignResponse() Get Available Result Filters.
SeedListsAttributesResponse	getResultsAttribute(String attribute) Get all values of a specific attribute of your results lists.
feign.Response	getResultsAttributeFeignResponse(String attribute) Get all values of a specific attribute of your results lists.
SeedListsAttributesResponse	getResultsAttributes() Get all iterable attributes of results.
feign.Response	getResultsAttributesFeignResponse() Get all iterable attributes of results.
feign.Response	getResultsFeignResponse() Get List results.
SingleSeedListResponse	getSeedList(String targetEmail) Get a single seed list.
feign.Response	getSeedListFeignResponse(String targetEmail) Get a single seed list.
SeedListsFiltersResponse	getSeedListFilters() Get all available filters for seed lists.
feign.Response	getSeedListFiltersFeignResponse() Get all available filters for seed lists.
SeedListsAttributesResponse	getSeedListsAttribute(String attribute) Get all values of a specific attribute of your seed lists.
feign.Response	getSeedListsAttributeFeignResponse(String attribute) Get all values of a specific attribute of your seed lists.
SeedListsAttributesResponse	getSeedListsAttributes() Get all iterable attributes of seed lists.
feign.Response	getSeedListsAttributesFeignResponse() Get all iterable attributes of seed lists.
feign.Response	getSpecificResultFeignResponse(String rid) Get a specific result.
SeedListItem	updateSeedList(String targetEmail, SeedListRequest request) Update a seed list.
feign.Response	updateSeedListFeignResponse(String targetEmail, SeedListRequest request) Update a seed list.

Method Detail

getApiVersion

static ApiVersion getApiVersion()

Specified by:

getApiVersion in interface MailgunApi

generateSeedList

SeedListItem generateSeedList(SeedListRequest request)

Generate a seed list.

Parameters:

request - SeedListRequest

Returns:

SeedListItem

generateSeedListFeignResponse

feign.Response generateSeedListFeignResponse(SeedListRequest request)

Generate a seed list.

Parameters:

request - SeedListRequest

Returns:

Response

updateSeedList

SeedListItem updateSeedList(String targetEmail,
                            SeedListRequest request)

Update a seed list.

Parameters:

targetEmail - target email

request - SeedListRequest

Returns:

SeedListItem

updateSeedListFeignResponse

feign.Response updateSeedListFeignResponse(String targetEmail,
                                           SeedListRequest request)

Update a seed list.

Parameters:

targetEmail - target email

request - SeedListRequest

Returns:

Response

getAllSeedLists

SeedListsResponse getAllSeedLists()

Get a list of all of your seed lists.

Returns:

SeedListsResponse

getAllSeedListsFeignResponse

feign.Response getAllSeedListsFeignResponse()

Get a list of all of your seed lists.

Returns:

Response

getAllSeedLists

SeedListsResponse getAllSeedLists(SeedListsPageRequest filter)

Get a list of all of your seed lists.

Parameters:

filter - SeedListsPageRequest

Returns:

SeedListsResponse

getAllSeedListsFeignResponse

feign.Response getAllSeedListsFeignResponse(SeedListsPageRequest filter)

Get a list of all of your seed lists.

Parameters:

filter - SeedListsPageRequest

Returns:

Response

getSeedList

SingleSeedListResponse getSeedList(String targetEmail)

Get a single seed list.

Parameters:

targetEmail - target email

Returns:

SingleSeedListResponse

getSeedListFeignResponse

feign.Response getSeedListFeignResponse(String targetEmail)

Get a single seed list.

Parameters:

targetEmail - target email

Returns:

Response

getSeedListsAttributes

SeedListsAttributesResponse getSeedListsAttributes()

Get all iterable attributes of seed lists. You can use this endpoint to find all attributes that are available for listing values of.

Returns:

SeedListsAttributesResponse

getSeedListsAttributesFeignResponse

feign.Response getSeedListsAttributesFeignResponse()

Get all iterable attributes of seed lists. You can use this endpoint to find all attributes that are available for listing values of.

Returns:

Response

getSeedListsAttribute

SeedListsAttributesResponse getSeedListsAttribute(String attribute)

Get all values of a specific attribute of your seed lists.

Parameters:

attribute - specific attribute

Returns:

SeedListsAttributesResponse

getSeedListsAttributeFeignResponse

feign.Response getSeedListsAttributeFeignResponse(String attribute)

Get all values of a specific attribute of your seed lists.

Parameters:

attribute - specific attribute

Returns:

Response

getSeedListFilters

SeedListsFiltersResponse getSeedListFilters()

Get all available filters for seed lists.

Returns:

SeedListsFiltersResponse

getSeedListFiltersFeignResponse

feign.Response getSeedListFiltersFeignResponse()

Get all available filters for seed lists.

Returns:

Response

deleteSeedListFeignResponse

feign.Response deleteSeedListFeignResponse(String targetEmail)

Delete a seed list.

Parameters:

targetEmail - target email

Returns:

Response

getResultsFeignResponse

feign.Response getResultsFeignResponse()

Get List results.

Returns:

Response

getAvailableResultFiltersFeignResponse

feign.Response getAvailableResultFiltersFeignResponse()

Get Available Result Filters.

Returns:

Response

getResultsAttributes

SeedListsAttributesResponse getResultsAttributes()

Get all iterable attributes of results.

Returns:

SeedListsAttributesResponse

getResultsAttributesFeignResponse

feign.Response getResultsAttributesFeignResponse()

Get all iterable attributes of results.

Returns:

Response

getResultsAttribute

SeedListsAttributesResponse getResultsAttribute(String attribute)

Get all values of a specific attribute of your results lists.

Parameters:

attribute - specific attribute

Returns:

SeedListsAttributesResponse

getResultsAttributeFeignResponse

feign.Response getResultsAttributeFeignResponse(String attribute)

Get all values of a specific attribute of your results lists.

Parameters:

attribute - specific attribute

Returns:

Response

getSpecificResultFeignResponse

feign.Response getSpecificResultFeignResponse(String rid)

Get a specific result.

Parameters:

rid - unique identifier for a results

Returns:

Response

deleteResultFeignResponse

feign.Response deleteResultFeignResponse(String rid)

Delete a result.

Parameters:

rid - unique identifier for a results

Returns:

Response