com.mailgun.api.v3

Interface MailgunDomainsApi

All Superinterfaces:

MailgunApi

public interface MailgunDomainsApi
extends MailgunApi

The domains API allows you to create, access, and validate domains programmatically.

See Also:

Domains

Method Summary

Modifier and Type	Method and Description
ResponseWithMessage	createNewCredentials(String domain, DomainCredentials request) Creates a new set of SMTP credentials for the defined domain.
feign.Response	createNewCredentialsFeignResponse(String domain, DomainCredentials request) Creates a new set of SMTP credentials for the defined domain.
DomainResponse	createNewDomain(DomainRequest request) Create a new domain.
feign.Response	createNewDomainFeignResponse(DomainRequest request) Create a new domain.
ResponseWithMessage	deleteCredentials(String domain, String login) Deletes the defined SMTP credentials.
feign.Response	deleteCredentialsFeignResponse(String domain, String login) Deletes the defined SMTP credentials.
ResponseWithMessage	deleteDomain(String domain) Delete a domain from your account.
feign.Response	deleteDomainFeignResponse(String domain) Delete a domain from your account.
DomainConnectionResponse	getDomainConnectionSettings(String domain) Returns delivery connection settings for the defined domain.
feign.Response	getDomainConnectionSettingsFeignResponse(String domain) Returns delivery connection settings for the defined domain.
DomainListResponse	getDomainsList() Returns a list of domains under your account (limit to 100 entries).
DomainListResponse	getDomainsList(DomainsParametersFilter filter) Returns a list of domains under your account.
feign.Response	getDomainsListFeignResponse() Returns a list of domains under your account (limit to 100 entries).
feign.Response	getDomainsListFeignResponse(DomainsParametersFilter filter) Returns a list of domains under your account.
DomainTrackingResponse	getDomainTrackingSettings(String domain) Returns tracking settings for a domain.
feign.Response	getDomainTrackingSettingsFeignResponse(String domain) Returns tracking settings for a domain.
SingleDomainResponse	getSingleDomain(String domain) Returns a single domain, including credentials and DNS records.
feign.Response	getSingleDomainFeignResponse(String domain) Returns a single domain, including credentials and DNS records.
ResponseWithMessage	updateCredentials(String domain, String login, String password) Updates the specified SMTP credentials.
feign.Response	updateCredentialsFeignResponse(String domain, String login, String password) Updates the specified SMTP credentials.
UpdateDomainClickTrackingSettingsResponse	updateDomainClickTrackingSettings(String domain, YesNoHtml active) Updates the click tracking settings for a domain.
feign.Response	updateDomainClickTrackingSettingsFeignResponse(String domain, YesNoHtml active) Updates the click tracking settings for a domain.
UpdateDomainConnectionResponse	updateDomainConnectionSettings(String domain, DomainConnectionRequest request) Updates the specified delivery connection settings for the defined domain.
feign.Response	updateDomainConnectionSettingsFeignResponse(String domain, DomainConnectionRequest request) Updates the specified delivery connection settings for the defined domain.
UpdateDomainOpenTrackingSettingsResponse	updateDomainOpenTrackingSettings(String domain, YesNo active) Updates the open tracking settings for a domain.
feign.Response	updateDomainOpenTrackingSettingsFeignResponse(String domain, YesNo active) Updates the open tracking settings for a domain.
UpdateDomainUnsubscribeTrackingSettingsResponse	updateDomainUnsubscribeConnectionSettings(String domain, DomainUnsubscribeConnectionSettingsRequest request) Updates unsubscribe tracking settings for a domain.
feign.Response	updateDomainUnsubscribeConnectionSettingsFeignResponse(String domain, DomainUnsubscribeConnectionSettingsRequest request) Updates unsubscribe tracking settings for a domain.
DomainResponse	verifyDomain(String domain) Verifies and returns a single domain, including credentials and DNS records.
feign.Response	verifyDomainFeignResponse(String domain) Verifies and returns a single domain, including credentials and DNS records.

Methods inherited from interface com.mailgun.api.MailgunApi

getApiVersion

Method Detail

getDomainsList

DomainListResponse getDomainsList()

Returns a list of domains under your account (limit to 100 entries).

Returns:

DomainListResponse

getDomainsListFeignResponse

feign.Response getDomainsListFeignResponse()

Returns a list of domains under your account (limit to 100 entries).

Returns:

Response

getDomainsList

DomainListResponse getDomainsList(DomainsParametersFilter filter)

Returns a list of domains under your account.

Parameters:

filter - DomainsParametersFilter

Returns:

DomainListResponse

getDomainsListFeignResponse

feign.Response getDomainsListFeignResponse(DomainsParametersFilter filter)

Returns a list of domains under your account.

Parameters:

filter - DomainsParametersFilter

Returns:

Response

getSingleDomain

SingleDomainResponse getSingleDomain(String domain)

Returns a single domain, including credentials and DNS records.

Parameters:

domain - Name of the domain

Returns:

SingleDomainResponse

getSingleDomainFeignResponse

feign.Response getSingleDomainFeignResponse(String domain)

Returns a single domain, including credentials and DNS records.

Parameters:

domain - Name of the domain

Returns:

Response

verifyDomain

DomainResponse verifyDomain(String domain)

Verifies and returns a single domain, including credentials and DNS records. If the domain is successfully verified the domain’s state will be ‘active’. For more information on verifying domains, visit: @see Verifying Your Domain

Parameters:

domain - Name of the domain

Returns:

DomainResponse

verifyDomainFeignResponse

feign.Response verifyDomainFeignResponse(String domain)

Verifies and returns a single domain, including credentials and DNS records. If the domain is successfully verified the domain’s state will be ‘active’. For more information on verifying domains, visit: @see Verifying Your Domain

Parameters:

domain - Name of the domain

Returns:

Response

createNewDomain

DomainResponse createNewDomain(DomainRequest request)

Create a new domain.

Parameters:

request - DomainRequest

Returns:

DomainResponse

createNewDomainFeignResponse

feign.Response createNewDomainFeignResponse(DomainRequest request)

Create a new domain.

Parameters:

request - DomainRequest

Returns:

Response

deleteDomain

ResponseWithMessage deleteDomain(String domain)

Delete a domain from your account.

Parameters:

domain - Name of the domain

Returns:

ResponseWithMessage

deleteDomainFeignResponse

feign.Response deleteDomainFeignResponse(String domain)

Delete a domain from your account.

Parameters:

domain - Name of the domain

Returns:

Response

createNewCredentials

ResponseWithMessage createNewCredentials(String domain,
                                         DomainCredentials request)

Creates a new set of SMTP credentials for the defined domain.

Parameters:

domain - Name of the domain

request - DomainCredentials

Returns:

ResponseWithMessage

createNewCredentialsFeignResponse

feign.Response createNewCredentialsFeignResponse(String domain,
                                                 DomainCredentials request)

Creates a new set of SMTP credentials for the defined domain.

Parameters:

domain - Name of the domain

request - DomainCredentials

Returns:

Response

updateCredentials

ResponseWithMessage updateCredentials(String domain,
                                      String login,
                                      String password)

Updates the specified SMTP credentials. Currently only the password can be changed.

Parameters:

domain - Name of the domain

login - Login

password - A password for the SMTP credentials. (Length Min 5, Max 32)

Returns:

ResponseWithMessage

updateCredentialsFeignResponse

feign.Response updateCredentialsFeignResponse(String domain,
                                              String login,
                                              String password)

Updates the specified SMTP credentials. Currently only the password can be changed.

Parameters:

domain - Name of the domain

login - Login

password - A password for the SMTP credentials. (Length Min 5, Max 32)

Returns:

Response

deleteCredentials

ResponseWithMessage deleteCredentials(String domain,
                                      String login)

Deletes the defined SMTP credentials.

Parameters:

domain - Name of the domain

login - Login

Returns:

ResponseWithMessage

deleteCredentialsFeignResponse

feign.Response deleteCredentialsFeignResponse(String domain,
                                              String login)

Deletes the defined SMTP credentials.

Parameters:

domain - Name of the domain

login - Login

Returns:

Response

getDomainConnectionSettings

DomainConnectionResponse getDomainConnectionSettings(String domain)

Returns delivery connection settings for the defined domain.

Parameters:

domain - Name of the domain

Returns:

DomainConnectionResponse

getDomainConnectionSettingsFeignResponse

feign.Response getDomainConnectionSettingsFeignResponse(String domain)

Returns delivery connection settings for the defined domain.

Parameters:

domain - Name of the domain

Returns:

Response

updateDomainConnectionSettings

UpdateDomainConnectionResponse updateDomainConnectionSettings(String domain,
                                                              DomainConnectionRequest request)

Updates the specified delivery connection settings for the defined domain.

Parameters:

domain - Name of the domain

request - DomainConnectionRequest

Returns:

UpdateDomainConnectionResponse

updateDomainConnectionSettingsFeignResponse

feign.Response updateDomainConnectionSettingsFeignResponse(String domain,
                                                           DomainConnectionRequest request)

Updates the specified delivery connection settings for the defined domain.

Parameters:

domain - Name of the domain

request - DomainConnectionRequest

Returns:

Response

getDomainTrackingSettings

DomainTrackingResponse getDomainTrackingSettings(String domain)

Returns tracking settings for a domain.

Parameters:

domain - Name of the domain

Returns:

DomainTrackingResponse

getDomainTrackingSettingsFeignResponse

feign.Response getDomainTrackingSettingsFeignResponse(String domain)

Returns tracking settings for a domain.

Parameters:

domain - Name of the domain

Returns:

Response

updateDomainOpenTrackingSettings

UpdateDomainOpenTrackingSettingsResponse updateDomainOpenTrackingSettings(String domain,
                                                                          YesNo active)

Updates the open tracking settings for a domain.

Parameters:

domain - Name of the domain

active - YesNo

Returns:

UpdateDomainOpenTrackingSettingsResponse

updateDomainOpenTrackingSettingsFeignResponse

feign.Response updateDomainOpenTrackingSettingsFeignResponse(String domain,
                                                             YesNo active)

Updates the open tracking settings for a domain.

Parameters:

domain - Name of the domain

active - YesNo

Returns:

Response

updateDomainClickTrackingSettings

UpdateDomainClickTrackingSettingsResponse updateDomainClickTrackingSettings(String domain,
                                                                            YesNoHtml active)

Updates the click tracking settings for a domain.

Parameters:

domain - Name of the domain

active - YesNoHtml

If set to YES, links will be overwritten and pointed to our servers so we can track clicks.

If set to HTML_ONLY, links will only be rewritten in the HTML part of a message.

Returns:

UpdateDomainClickTrackingSettingsResponse

updateDomainClickTrackingSettingsFeignResponse

feign.Response updateDomainClickTrackingSettingsFeignResponse(String domain,
                                                              YesNoHtml active)

Updates the click tracking settings for a domain.

Parameters:

domain - Name of the domain

active - YesNoHtml

If set to YES, links will be overwritten and pointed to our servers so we can track clicks.

If set to HTML_ONLY, links will only be rewritten in the HTML part of a message.

Returns:

Response

updateDomainUnsubscribeConnectionSettings

UpdateDomainUnsubscribeTrackingSettingsResponse updateDomainUnsubscribeConnectionSettings(String domain,
                                                                                          DomainUnsubscribeConnectionSettingsRequest request)

Updates unsubscribe tracking settings for a domain.

Parameters:

domain - Name of the domain

request - DomainUnsubscribeConnectionSettingsRequest

Returns:

UpdateDomainUnsubscribeTrackingSettingsResponse

updateDomainUnsubscribeConnectionSettingsFeignResponse

feign.Response updateDomainUnsubscribeConnectionSettingsFeignResponse(String domain,
                                                                      DomainUnsubscribeConnectionSettingsRequest request)

Updates unsubscribe tracking settings for a domain.

Parameters:

domain - Name of the domain

request - DomainUnsubscribeConnectionSettingsRequest

Returns:

Response