Interface: IDomainKeysClient
September 4, 2026 · View on GitHub
mailgun.js / Modules / definitions / Interfaces / IDomainKeysClient
Interface: IDomainKeysClient
definitions.Interfaces.IDomainKeysClient
Table of contents
Methods
Methods
activate
▸ activate(domainName, selector): Promise<ActivateDomainKeyResponse>
Parameters
| Name | Type |
|---|---|
domainName | string |
selector | string |
Returns
Promise<ActivateDomainKeyResponse>
Defined in
Interfaces/Domains/DomainKeys.ts:24
create
▸ create(data): Promise<DomainKeyCreateDataResult>
Parameters
| Name | Type |
|---|---|
data | DomainKeyCreateData |
Returns
Promise<DomainKeyCreateDataResult>
Defined in
Interfaces/Domains/DomainKeys.ts:19
deactivate
▸ deactivate(domainName, selector): Promise<DeactivateDomainKeyResponse>
Parameters
| Name | Type |
|---|---|
domainName | string |
selector | string |
Returns
Promise<DeactivateDomainKeyResponse>
Defined in
Interfaces/Domains/DomainKeys.ts:28
destroy
▸ destroy(domain, selector): Promise<DeletedDomainKeysResult>
Parameters
| Name | Type |
|---|---|
domain | string |
selector | string |
Returns
Promise<DeletedDomainKeysResult>
Defined in
Interfaces/Domains/DomainKeys.ts:20
list
▸ list(domainName): Promise<DomainKeysListResult>
Parameters
| Name | Type |
|---|---|
domainName | string |
Returns
Promise<DomainKeysListResult>
Defined in
Interfaces/Domains/DomainKeys.ts:17
listAll
▸ listAll(query): Promise<DomainKeysListAllResult>
Parameters
| Name | Type |
|---|---|
query | DomainKeysListAllQuery |
Returns
Promise<DomainKeysListAllResult>
Defined in
Interfaces/Domains/DomainKeys.ts:18
updateDKIMAuthority
▸ updateDKIMAuthority(domain, data): Promise<UpdatedDKIMAuthority>
Parameters
| Name | Type |
|---|---|
domain | string |
data | DKIMAuthorityInfo |
Returns
Promise<UpdatedDKIMAuthority>
Defined in
Interfaces/Domains/DomainKeys.ts:29
updateDKIMSelector
▸ updateDKIMSelector(domain, data): Promise<UpdatedDKIMSelectorResult>
Parameters
| Name | Type |
|---|---|
domain | string |
data | DKIMSelectorInfo |
Returns
Promise<UpdatedDKIMSelectorResult>