Interface: IAccountManagementClient
August 12, 2026 · View on GitHub
mailgun.js / Modules / definitions / Interfaces / IAccountManagementClient
Interface: IAccountManagementClient
definitions.Interfaces.IAccountManagementClient
Table of contents
Methods
- addSandboxAuthorizedRecipient
- createWebhookSigningKey
- getSandboxAuthorizedRecipients
- getWebhookSigningKey
- removeSandboxAuthorizedRecipient
- resendActivationEmail
- updateAccountFeature
- updateAccountSettings
Methods
addSandboxAuthorizedRecipient
▸ addSandboxAuthorizedRecipient(email): Promise<AuthorizedRecipientResult>
Parameters
| Name | Type |
|---|---|
email | string |
Returns
Promise<AuthorizedRecipientResult>
Defined in
Interfaces/AccountManagement/IAccountManagementClient.ts:16
createWebhookSigningKey
▸ createWebhookSigningKey(): Promise<MessageResponseWithStatus>
Returns
Promise<MessageResponseWithStatus>
Defined in
Interfaces/AccountManagement/IAccountManagementClient.ts:14
getSandboxAuthorizedRecipients
▸ getSandboxAuthorizedRecipients(): Promise<AuthorizedRecipientsResult>
Returns
Promise<AuthorizedRecipientsResult>
Defined in
Interfaces/AccountManagement/IAccountManagementClient.ts:15
getWebhookSigningKey
▸ getWebhookSigningKey(): Promise<Omit<ResponseWithSigninKey, "message">>
Returns
Promise<Omit<ResponseWithSigninKey, "message">>
Defined in
Interfaces/AccountManagement/IAccountManagementClient.ts:13
removeSandboxAuthorizedRecipient
▸ removeSandboxAuthorizedRecipient(email): Promise<MessageResponseWithStatus>
Parameters
| Name | Type |
|---|---|
email | string |
Returns
Promise<MessageResponseWithStatus>
Defined in
Interfaces/AccountManagement/IAccountManagementClient.ts:17
resendActivationEmail
▸ resendActivationEmail(): Promise<SuccessResult>
Returns
Promise<SuccessResult>
Defined in
Interfaces/AccountManagement/IAccountManagementClient.ts:18
updateAccountFeature
▸ updateAccountFeature(data): Promise<SuccessResult>
Parameters
| Name | Type |
|---|---|
data | AccountFeatureInput |
Returns
Promise<SuccessResult>
Defined in
Interfaces/AccountManagement/IAccountManagementClient.ts:19
updateAccountSettings
▸ updateAccountSettings(settingsObj): Promise<MessageResponseWithStatus>
Parameters
| Name | Type |
|---|---|
settingsObj | AccountSettings |
Returns
Promise<MessageResponseWithStatus>