Interface: IIPPoolsClient
August 12, 2026 · View on GitHub
mailgun.js / Modules / definitions / Interfaces / IIPPoolsClient
Interface: IIPPoolsClient
definitions.Interfaces.IIPPoolsClient
Table of contents
Methods
- addIp
- addIps
- create
- delegate
- destroy
- get
- linkedDomains
- list
- removeDomainPool
- removeIp
- removeIpFromDomainPool
- revokeDelegation
- unlinkDomainPool
- update
Methods
addIp
▸ addIp(poolId, ip): Promise<IpPoolUpdateResult>
Parameters
| Name | Type |
|---|---|
poolId | string |
ip | string |
Returns
Promise<IpPoolUpdateResult>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:17
addIps
▸ addIps(poolId, ips): Promise<IpPoolUpdateResult>
Parameters
| Name | Type |
|---|---|
poolId | string |
ips | string[] |
Returns
Promise<IpPoolUpdateResult>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:21
create
▸ create(data): Promise<IpPoolCreateResult>
Parameters
| Name | Type |
|---|---|
data | IpPoolCreateData |
Returns
Promise<IpPoolCreateResult>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:13
delegate
▸ delegate(poolId, subAccountId): Promise<MessageResponseWithStatus>
Parameters
| Name | Type |
|---|---|
poolId | string |
subAccountId | string |
Returns
Promise<MessageResponseWithStatus>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:19
destroy
▸ destroy(poolId, data): Promise<IpPoolUpdateResult>
Parameters
| Name | Type |
|---|---|
poolId | string |
data | IpPoolDeleteData |
Returns
Promise<IpPoolUpdateResult>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:15
get
▸ get(poolId): Promise<IpPoolDetails>
Parameters
| Name | Type |
|---|---|
poolId | string |
Returns
Promise<IpPoolDetails>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:12
linkedDomains
▸ linkedDomains(poolId, query?): Promise<IpPoolLinkedDomains>
Parameters
| Name | Type |
|---|---|
poolId | string |
query? | IpPoolLinkedDomainsQuery |
Returns
Promise<IpPoolLinkedDomains>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:16
list
▸ list(): Promise<IpPoolListResult>
Returns
Promise<IpPoolListResult>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:11
removeDomainPool
▸ removeDomainPool(domain): Promise<MessageResponseWithStatus>
Parameters
| Name | Type |
|---|---|
domain | string |
Returns
Promise<MessageResponseWithStatus>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:27
removeIp
▸ removeIp(poolId, ip): Promise<IpPoolUpdateResult>
Parameters
| Name | Type |
|---|---|
poolId | string |
ip | string |
Returns
Promise<IpPoolUpdateResult>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:18
removeIpFromDomainPool
▸ removeIpFromDomainPool(domain, ip, replacementPoolId?): Promise<MessageResponseWithStatus>
Parameters
| Name | Type |
|---|---|
domain | string |
ip | string |
replacementPoolId? | string |
Returns
Promise<MessageResponseWithStatus>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:22
revokeDelegation
▸ revokeDelegation(poolId, subAccountId): Promise<IpPoolUpdateResult>
Parameters
| Name | Type |
|---|---|
poolId | string |
subAccountId | string |
Returns
Promise<IpPoolUpdateResult>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:20
unlinkDomainPool
▸ unlinkDomainPool(domain, replacementPoolId): Promise<MessageResponseWithStatus>
Parameters
| Name | Type |
|---|---|
domain | string |
replacementPoolId | string |
Returns
Promise<MessageResponseWithStatus>
Defined in
Interfaces/IPPools/IIPPoolsClient.ts:28
update
▸ update(poolId, data): Promise<IpPoolUpdateResult>
Parameters
| Name | Type |
|---|---|
poolId | string |
data | IpPoolUpdateData |
Returns
Promise<IpPoolUpdateResult>