com.mailgun.api.v3

Interface MailgunIPsApi

All Superinterfaces:

MailgunApi

public interface MailgunIPsApi
extends MailgunApi

The IP API endpoint allows you to access information regarding the IPs allocated to your Mailgun account that are used for outbound sending.

See Also:

IPs

Method Summary

Modifier and Type	Method and Description
ResponseWithMessage	assignIPToDomain(String domain, String ip) Assign a dedicated IP to the domain specified.
feign.Response	assignIPToDomainFeignResponse(String domain, String ip) Assign a dedicated IP to the domain specified.
IPsResult	getAllIPs() Returns a list of IPs assigned to your account.
feign.Response	getAllIPsFeignResponse() Returns a list of IPs assigned to your account.
IPsResult	getDedicatedIPs(boolean dedicated) Return only dedicated IPs if param dedicated set to true, otherwise return all IPs.
feign.Response	getDedicatedIPsFeignResponse(boolean dedicated) Return only dedicated IPs if param dedicated set to true, otherwise return all IPs.
IPsResult	getDomainIPs(String domain) Returns a list of IPs currently assigned to the specified domain.
feign.Response	getDomainIPsFeignResponse(String domain) Returns a list of IPs currently assigned to the specified domain.
IPResult	getSpecifiedIP(String ip) Returns information about the specified IP.
feign.Response	getSpecifiedIPFeignResponse(String ip) Returns information about the specified IP.
ResponseWithMessage	unassignIPFromDomain(String domain, String ip) Unassign an IP from the domain specified.
feign.Response	unassignIPFromDomainFeignResponse(String domain, String ip) Unassign an IP from the domain specified.

Methods inherited from interface com.mailgun.api.MailgunApi

getApiVersion

Method Detail

getAllIPs

IPsResult getAllIPs()

Returns a list of IPs assigned to your account.

Returns:

IPsResult

getAllIPsFeignResponse

feign.Response getAllIPsFeignResponse()

Returns a list of IPs assigned to your account.

Returns:

Response

getDedicatedIPs

IPsResult getDedicatedIPs(boolean dedicated)

Return only dedicated IPs if param dedicated set to true, otherwise return all IPs.

Parameters:

dedicated - dedicated IPs

Returns:

IPsResult

getDedicatedIPsFeignResponse

feign.Response getDedicatedIPsFeignResponse(boolean dedicated)

Return only dedicated IPs if param dedicated set to true, otherwise return all IPs.

Parameters:

dedicated - dedicated IPs

Returns:

Response

getSpecifiedIP

IPResult getSpecifiedIP(String ip)

Returns information about the specified IP.

Parameters:

ip - specified IP

Returns:

IPResult

getSpecifiedIPFeignResponse

feign.Response getSpecifiedIPFeignResponse(String ip)

Returns information about the specified IP.

Parameters:

ip - specified IP

Returns:

Response

getDomainIPs

IPsResult getDomainIPs(String domain)

Returns a list of IPs currently assigned to the specified domain.

Parameters:

domain - Name of the domain

Returns:

IPsResult

getDomainIPsFeignResponse

feign.Response getDomainIPsFeignResponse(String domain)

Returns a list of IPs currently assigned to the specified domain.

Parameters:

domain - Name of the domain

Returns:

Response

assignIPToDomain

ResponseWithMessage assignIPToDomain(String domain,
                                     String ip)

Assign a dedicated IP to the domain specified.

Note: Only dedicated IPs can be assigned to a domain.

Parameters:

domain - Name of the domain

ip - IP address that should be assigned to the domain pool.

Returns:

ResponseWithMessage

assignIPToDomainFeignResponse

feign.Response assignIPToDomainFeignResponse(String domain,
                                             String ip)

Assign a dedicated IP to the domain specified.

Note: Only dedicated IPs can be assigned to a domain.

Parameters:

domain - Name of the domain

ip - IP address that should be assigned to the domain pool.

Returns:

Response

unassignIPFromDomain

ResponseWithMessage unassignIPFromDomain(String domain,
                                         String ip)

Unassign an IP from the domain specified.

Parameters:

domain - Name of the domain

ip - IP address that should be unassign.

Returns:

ResponseWithMessage

unassignIPFromDomainFeignResponse

feign.Response unassignIPFromDomainFeignResponse(String domain,
                                                 String ip)

Unassign an IP from the domain specified.

Parameters:

domain - Name of the domain

ip - IP address that should be unassign.

Returns:

Response