com.mailgun.api.v3

Interface MailgunTagsApi

All Superinterfaces:

MailgunApi

public interface MailgunTagsApi
extends MailgunApi

The tags API

Mailgun lets you tag each outgoing message with a custom value and provides statistics on the tag level.

Tags are created on the fly but they are subject to a limit.

Note: Unicode characters are not allowed in tags. Any unicode characters found in tags are stripped from the tag. If tag is entirely unicode characters, the tag is ignored.

See Also:

Tags

Method Summary

Modifier and Type	Method and Description
ResponseWithMessage	deleteTag(String domain, String tag) Deletes the tag.
feign.Response	deleteTagFeignResponse(String domain, String tag) Deletes the tag.
TagsResult	getAllTags(String domain) Returns a list of tags for a domain.
TagsResult	getAllTags(String domain, Integer limit) Returns a list of tags for a domain.
feign.Response	getAllTagsFeignResponse(String domain) Returns a list of tags for a domain.
feign.Response	getAllTagsFeignResponse(String domain, Integer limit) Returns a list of tags for a domain.
TagsItem	getTag(String domain, String tag) Returns a given tag.
feign.Response	getTagFeignResponse(String domain, String tag) Returns a given tag.
TagStatsResult	getTagStatistics(String domain, String tag, StatisticsOptions statisticsOptions) Returns statistics for a given tag.
feign.Response	getTagStatisticsFeignResponse(String domain, String tag, StatisticsOptions statisticsOptions) Returns statistics for a given tag.
TagCountriesResponse	listTagCountries(String domain, String tag) Returns a list of countries of origin for a given domain for different event types.
feign.Response	listTagCountriesFeignResponse(String domain, String tag) Returns a list of countries of origin for a given domain for different event types.
TagDevicesResponse	listTagDevices(String domain, String tag) Returns a list of devices for a given domain that have triggered event types.
feign.Response	listTagDevicesFeignResponse(String domain, String tag) Returns a list of devices for a given domain that have triggered event types.
TagProvidersResponse	listTagProviders(String domain, String tag) Returns a list of email providers for a given domain for different event types.
feign.Response	listTagProvidersFeignResponse(String domain, String tag) Returns a list of email providers for a given domain for different event types.
ResponseWithMessage	updateTag(String domain, String tag, TagUpdateRequest tagUpdateRequest) Updates a given tag with the information provided.
feign.Response	updateTagFeignResponse(String domain, String tag, TagUpdateRequest tagUpdateRequest) Updates a given tag with the information provided.

Methods inherited from interface com.mailgun.api.MailgunApi

getApiVersion

Method Detail

getAllTags

TagsResult getAllTags(String domain)

Returns a list of tags for a domain.

Default number of entries to return: 100.

Parameters:

domain - Name of the domain

Returns:

TagsResult

getAllTagsFeignResponse

feign.Response getAllTagsFeignResponse(String domain)

Returns a list of tags for a domain.

Default number of entries to return: 100.

Parameters:

domain - Name of the domain

Returns:

Response

getAllTags

TagsResult getAllTags(String domain,
                      Integer limit)

Returns a list of tags for a domain.

Parameters:

domain - Name of the domain

limit - Number of entries to return.

Returns:

TagsResult

getAllTagsFeignResponse

feign.Response getAllTagsFeignResponse(String domain,
                                       Integer limit)

Returns a list of tags for a domain.

Parameters:

domain - Name of the domain

limit - Number of entries to return.

Returns:

Response

getTag

TagsItem getTag(String domain,
                String tag)

Returns a given tag.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

TagsItem

getTagFeignResponse

feign.Response getTagFeignResponse(String domain,
                                   String tag)

Returns a given tag.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

Response

updateTag

ResponseWithMessage updateTag(String domain,
                              String tag,
                              TagUpdateRequest tagUpdateRequest)

Updates a given tag with the information provided.

Parameters:

domain - Name of the domain

tag - Name of the tag

tagUpdateRequest - TagUpdateRequest

Returns:

ResponseWithMessage

updateTagFeignResponse

feign.Response updateTagFeignResponse(String domain,
                                      String tag,
                                      TagUpdateRequest tagUpdateRequest)

Updates a given tag with the information provided.

Parameters:

domain - Name of the domain

tag - Name of the tag

tagUpdateRequest - TagUpdateRequest

Returns:

Response

getTagStatistics

TagStatsResult getTagStatistics(String domain,
                                String tag,
                                StatisticsOptions statisticsOptions)

Returns statistics for a given tag.

Parameters:

domain - Name of the domain

tag - Name of the tag

statisticsOptions - StatisticsOptions

Returns:

TagStatsResult

getTagStatisticsFeignResponse

feign.Response getTagStatisticsFeignResponse(String domain,
                                             String tag,
                                             StatisticsOptions statisticsOptions)

Returns statistics for a given tag.

Parameters:

domain - Name of the domain

tag - Name of the tag

statisticsOptions - StatisticsOptions

Returns:

Response

deleteTag

ResponseWithMessage deleteTag(String domain,
                              String tag)

Deletes the tag.

Note: The statistics for the tag are not destroyed.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

ResponseWithMessage

deleteTagFeignResponse

feign.Response deleteTagFeignResponse(String domain,
                                      String tag)

Deletes the tag.

Note: The statistics for the tag are not destroyed.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

Response

listTagCountries

TagCountriesResponse listTagCountries(String domain,
                                      String tag)

Returns a list of countries of origin for a given domain for different event types.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

TagCountriesResponse

listTagCountriesFeignResponse

feign.Response listTagCountriesFeignResponse(String domain,
                                             String tag)

Returns a list of countries of origin for a given domain for different event types.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

Response

listTagProviders

TagProvidersResponse listTagProviders(String domain,
                                      String tag)

Returns a list of email providers for a given domain for different event types.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

TagProvidersResponse

listTagProvidersFeignResponse

feign.Response listTagProvidersFeignResponse(String domain,
                                             String tag)

Returns a list of email providers for a given domain for different event types.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

Response

listTagDevices

TagDevicesResponse listTagDevices(String domain,
                                  String tag)

Returns a list of devices for a given domain that have triggered event types.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

TagDevicesResponse

listTagDevicesFeignResponse

feign.Response listTagDevicesFeignResponse(String domain,
                                           String tag)

Returns a list of devices for a given domain that have triggered event types.

Parameters:

domain - Name of the domain

tag - Name of the tag

Returns:

Response