Interface: IMailingListsClient
September 4, 2026 · View on GitHub
mailgun.js / Modules / definitions / Interfaces / IMailingListsClient
Interface: IMailingListsClient
definitions.Interfaces.IMailingListsClient
Table of contents
Properties
Methods
Properties
members
• members: IMailListsMembers
Defined in
Interfaces/MailingLists/MailingListsClient.ts:10
Methods
cancelValidation
▸ cancelValidation(mailListAddress): Promise<MailingListCancelValidationResult>
Parameters
| Name | Type |
|---|---|
mailListAddress | string |
Returns
Promise<MailingListCancelValidationResult>
Defined in
Interfaces/MailingLists/MailingListsClient.ts:19
create
▸ create(data): Promise<MailingList>
Parameters
| Name | Type |
|---|---|
data | CreateUpdateList |
Returns
Promise<MailingList>
Defined in
Interfaces/MailingLists/MailingListsClient.ts:14
destroy
▸ destroy(mailListAddress): Promise<DestroyedList>
Parameters
| Name | Type |
|---|---|
mailListAddress | string |
Returns
Promise<DestroyedList>
Defined in
Interfaces/MailingLists/MailingListsClient.ts:16
get
▸ get(mailListAddress): Promise<MailingList>
Parameters
| Name | Type |
|---|---|
mailListAddress | string |
Returns
Promise<MailingList>
Defined in
Interfaces/MailingLists/MailingListsClient.ts:13
list
▸ list(query?): Promise<MailingListResult>
Parameters
| Name | Type |
|---|---|
query? | ListsQuery |
Returns
Promise<MailingListResult>
Defined in
Interfaces/MailingLists/MailingListsClient.ts:11
listByAddress
▸ listByAddress(query?): Promise<MailingListByAddressResult>
Parameters
| Name | Type |
|---|---|
query? | ListsByAddressQuery |
Returns
Promise<MailingListByAddressResult>
Defined in
Interfaces/MailingLists/MailingListsClient.ts:12
update
▸ update(mailListAddress, data): Promise<MailingList>
Parameters
| Name | Type |
|---|---|
mailListAddress | string |
data | CreateUpdateList |
Returns
Promise<MailingList>
Defined in
Interfaces/MailingLists/MailingListsClient.ts:15
validate
▸ validate(mailListAddress): Promise<StartValidationResult>
Parameters
| Name | Type |
|---|---|
mailListAddress | string |
Returns
Promise<StartValidationResult>
Defined in
Interfaces/MailingLists/MailingListsClient.ts:17
validationResult
▸ validationResult(mailListAddress): Promise<MailingListValidationResult>
Parameters
| Name | Type |
|---|---|
mailListAddress | string |
Returns
Promise<MailingListValidationResult>