Module: definitions

June 1, 2026 · View on GitHub

mailgun.js / Modules / definitions

Module: definitions

Table of contents

Namespaces

Interfaces

Type Aliases

Type Aliases

APIErrorOptions

Ƭ APIErrorOptions: Object

Type declaration

NameType
body{ error?: string ; message?: string }
body.error?string
body.message?string
headers?{ [key: string]: unknown; }
message?string
statusnumber
statusText?string
url?string

Defined in

Types/Common/Error.ts:1

APIErrorType

Ƭ APIErrorType: Object

Type declaration

NameType
detailsstring
messagestring
stackstring
statusnumber

Defined in

Types/Common/Error.ts:13

APIResponse

Ƭ APIResponse: Object

Type declaration

NameType
bodyany
statusnumber

Defined in

Types/Common/ApiResponse.ts:1

APIWebhook

Ƭ APIWebhook: Object

Type declaration

NameType
url?string
urls?string[]

Defined in

Types/Webhooks/Webhooks.ts:1

AccountFeatureData

Ƭ AccountFeatureData: Object

Type declaration

NameType
ai_insights?string
webhooks_redact_pii?string

Defined in

Types/AccountManagement/AccountManagement.ts:23

AccountFeatureInput

Ƭ AccountFeatureInput: Object

Type declaration

NameType
ai_insights?{ enabled: boolean }
ai_insights.enabledboolean
webhooks_redact_pii?{ enabled: boolean }
webhooks_redact_pii.enabledboolean

Defined in

Types/AccountManagement/AccountManagement.ts:14

AccountSettings

Ƭ AccountSettings: Object

Type declaration

NameType
absolute_session_timeout?number
inactive_session_timeout?number
logout_redirect_url?string
name?string

Defined in

Types/AccountManagement/AccountManagement.ts:3

ActivateDomainKeyResponse

Ƭ ActivateDomainKeyResponse: Object

Type declaration

NameType
activeboolean
authoritystring
messagestring
selectorstring
statusnumber

Defined in

Types/Domains/DomainKeys.ts:66

AtLeastOneKeyPresent

Ƭ AtLeastOneKeyPresent<Object_, Keys>: Pick<Object_, Exclude<keyof Object_, Keys>> & { [K in Keys]-?: Required<Pick<Object_, K>> & Partial<Pick<Object_, Exclude<Keys, K>>> }[Keys]

Ensures the object has least one key present and not undefined

See

https://stackoverflow.com/a/49725198

Type parameters

NameType
Object_Object_
Keysextends keyof Object_ = keyof Object_

Defined in

Types/Messages/Messages.ts:7

AttachmentInfo

Ƭ AttachmentInfo: Object

Type declaration

NameType
contentType?string
filename?string
knownLength?number

Defined in

Types/Common/Attachments.ts:8

AuthorizedRecipient

Ƭ AuthorizedRecipient: Object

Type declaration

NameType
activatedboolean
emailstring

Defined in

Types/AccountManagement/AccountManagement.ts:32

AuthorizedRecipientResult

Ƭ AuthorizedRecipientResult: Object

Type declaration

NameType
limitnumber
recipientAuthorizedRecipient
statusnumber

Defined in

Types/AccountManagement/AccountManagement.ts:42

AuthorizedRecipientsResult

Ƭ AuthorizedRecipientsResult: Object

Type declaration

NameType
recipientsAuthorizedRecipient[]
statusnumber

Defined in

Types/AccountManagement/AccountManagement.ts:37

BoolToString

Ƭ BoolToString: Object

Type declaration

NameType
encrypt_incoming_messageDomainInfo["encrypt_incoming_message"]
force_dkim_authorityDomainInfo["force_dkim_authority"]
force_root_dkim_hostDomainInfo["force_root_dkim_host"]
use_automatic_sender_securityDomainInfo["use_automatic_sender_security"]
wildcardDomainInfo["wildcard"]

Defined in

Types/Domains/Domains.ts:45

BounceClassificationAPIQuery

Ƭ BounceClassificationAPIQuery: Omit<BounceClassificationQueryData, "start" | "end"> & { end?: string ; start?: string }

Defined in

Types/BounceClassification/BounceClassification.ts:68

BounceClassificationAPIResponse

Ƭ BounceClassificationAPIResponse: Omit<BounceClassificationResult, "start" | "end"> & { end: string ; start: string }

Defined in

Types/BounceClassification/BounceClassification.ts:112

BounceClassificationQueryData

Ƭ BounceClassificationQueryData: Object

Type declaration

NameType
dimensions?BounceClassificationQueryDimensions[]
duration?string
end?Date
filter?BounceClassificationQueryFilter
include_subaccounts?boolean
metrics?BounceClassificationQueryMetrics[]
pagination{ limit?: number ; skip?: number ; sort?: string }
pagination.limit?number
pagination.skip?number
pagination.sort?string
resolution?"hour" | "day"
start?Date

Defined in

Types/BounceClassification/BounceClassification.ts:51

BounceClassificationQueryDimensions

Ƭ BounceClassificationQueryDimensions: "entity-name" | "domain.name" | "envelope.sending-ip" | "account.name" | "envelope.i-ip-pool-name" | "tags" | "tag" | "recipient-domain" | "group-id" | "criticality" | "severity" | "category" | "timestamp"

Defined in

Types/BounceClassification/BounceClassification.ts:1

BounceClassificationQueryFilter

Ƭ BounceClassificationQueryFilter: Object

Type declaration

NameType
AND{ attribute: BounceClassificationQueryFilterAttribute ; comparator: string ; values: { label: string ; value: string }[] }[]

Defined in

Types/BounceClassification/BounceClassification.ts:40

BounceClassificationQueryFilterAttribute

Ƭ BounceClassificationQueryFilterAttribute: "entity-name" | "domain.name" | "envelope.sending-ip" | "account.name" | "envelope.i-ip-pool-name" | "tags" | "tag" | "recipient-domain" | "group-id" | "criticality" | "severity" | "category"

Defined in

Types/BounceClassification/BounceClassification.ts:27

BounceClassificationQueryMetrics

Ƭ BounceClassificationQueryMetrics: "critical_bounce_count" | "non_critical_bounce_count" | "critical_delay_count" | "non_critical_delay_count" | "delivered_smtp_count" | "classified_failures_count" | "critical_bounce_rate" | "non_critical_bounce_rate" | "critical_delay_rate" | "non_critical_delay_rate"

Defined in

Types/BounceClassification/BounceClassification.ts:15

BounceClassificationResult

Ƭ BounceClassificationResult: Object

Type declaration

NameType
dimensions?BounceClassificationQueryDimensions[]
duration?string
endDate
itemsBounceClassificationResultItem[]
pagination{ limit: number ; skip: number ; sort: string ; total: number }
pagination.limitnumber
pagination.skipnumber
pagination.sortstring
pagination.totalnumber
resolution"hour" | "day" | "month"
startDate

Defined in

Types/BounceClassification/BounceClassification.ts:97

BounceClassificationResultItem

Ƭ BounceClassificationResultItem: Object

Type declaration

NameType
account.idstring | null
account.namestring | null
categorystring | null
criticalitystring | null
domain.namestring | null
entity-namestring | null
envelope.i-ip-pool-idstring | null
envelope.i-ip-pool-namestring | null
envelope.sending-ipstring | null
explanationstring | null
group-idstring | null
metrics{ [K in BounceClassificationQueryMetrics]: number }
recipient-domainstring | null
recipient-providerstring | null
sample-textstring | null
severitystring | null
tagstring | null
tagsstring | null
timestampstring | null

Defined in

Types/BounceClassification/BounceClassification.ts:73

BounceData

Ƭ BounceData: Object

Type declaration

NameType
addressstring
codenumber
created_atstring | Date
errorstring

Defined in

Types/Suppressions/Bounce.ts:2

BrowserPipeFunction

Ƭ BrowserPipeFunction: (destination: WritableStream) => void

Type declaration

▸ (destination): void

Parameters
NameType
destinationWritableStream
Returns

void

Defined in

Types/Common/Attachments.ts:2

CanceledMultipleValidationJob

Ƭ CanceledMultipleValidationJob: Object

Type declaration

NameType
messagestring
statusnumber

Defined in

Types/Validations/MultipleValidation.ts:91

ClearMessagesQueueResult

Ƭ ClearMessagesQueueResult: Object

Type declaration

NameType
messagestring

Defined in

Types/Messages/Messages.ts:319

ClickTrackingInfo

Ƭ ClickTrackingInfo: Object

Type declaration

NameType
active?"yes" | "no" | "true" | "false" | "htmlonly" | boolean

Defined in

Types/Domains/DomainTracking.ts:40

ClientProxyConfig

Ƭ ClientProxyConfig: Object

Type declaration

NameType
auth?{ password: string ; username: string }
auth.passwordstring
auth.usernamestring
hoststring
portnumber
protocol?string

Defined in

Types/Common/RequestProvider.ts:3

CommandQuery

Ƭ CommandQuery: Object

Type declaration

NameType
query?PutQueryTypes | DeleteQueryTypes

Defined in

Types/Common/RequestOptions.ts:113

ComplaintData

Ƭ ComplaintData: Object

Type declaration

NameType
addressstring
created_atstring | Date

Defined in

Types/Suppressions/Complaint.ts:2

ConnectionSettings

Ƭ ConnectionSettings: Object

Type declaration

NameType
require_tls?boolean
skip_verification?boolean

Defined in

Types/Domains/Domains.ts:110

ConnectionSettingsResponse

Ƭ ConnectionSettingsResponse: Object

Type declaration

NameType
bodyConnectionSettings
statusnumber

Defined in

Types/Domains/Domains.ts:114

ContainsPrefix

Ƭ ContainsPrefix<T>: `\{T}{string}`

Type parameters

NameType
Textends string

Defined in

Types/Common/RequestOptions.ts:97

CreateDomainTemplateAPIResponse

Ƭ CreateDomainTemplateAPIResponse: Object

Type declaration

NameType
body{ message: string ; template: IDomainTemplate }
body.messagestring
body.templateIDomainTemplate
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:71

CreateDomainTemplateVersionAPIResponse

Ƭ CreateDomainTemplateVersionAPIResponse: Object

Type declaration

NameType
body{ message: string ; template: IDomainTemplate }
body.messagestring
body.templateIDomainTemplate
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:133

CreateDomainTemplateVersionResult

Ƭ CreateDomainTemplateVersionResult: Object

Type declaration

NameType
messagestring
statusnumber
templateIDomainTemplate

Defined in

Types/Domains/DomainTemplates.ts:141

CreateUpdateList

Ƭ CreateUpdateList: Object

Type declaration

NameType
access_level?"readonly" | "members" | "everyone"
addressstring
description?string
name?string
reply_preference?"list" | "sender"

Defined in

Types/MailingLists/MailingLists.ts:15

CreateUpdateMailListMembers

Ƭ CreateUpdateMailListMembers: Object

Type declaration

NameType
addressstring
name?string
subscribed?"yes" | "no" | boolean
upsert?"yes" | "no"
vars?string

Defined in

Types/MailingLists/MailingListMembers.ts:37

CreateUpdateMailListMembersReq

Ƭ CreateUpdateMailListMembersReq: Object

Type declaration

NameType
addressstring
name?string
subscribed?"yes" | "no" | boolean
upsert?"yes" | "no"
vars?string

Defined in

Types/MailingLists/MailingListMembers.ts:45

CreateUpdateRouteData

Ƭ CreateUpdateRouteData: Object

Type declaration

NameType
actionstring[]
description?string
expressionstring
priority?number

Defined in

Types/Routes/Routes.ts:20

CreatedFormData

Ƭ CreatedFormData: Object

Type declaration

NameType
dataSize?number
formDataNodeFormData | FormData

Defined in

Types/Common/FormData.ts:24

CreatedMultipleValidationJob

Ƭ CreatedMultipleValidationJob: Object

Type declaration

NameType
idstring
messagestring

Defined in

Types/Validations/MultipleValidation.ts:60

CreatedUpdatedDomainCredentialsResponse

Ƭ CreatedUpdatedDomainCredentialsResponse: Object

Type declaration

NameType
body{ message: string }
body.messagestring
statusnumber

Defined in

Types/Domains/DomainCredentials.ts:38

CustomFile

Ƭ CustomFile: Object

Index signature

▪ [key: string]: unknown

Type declaration

NameType
contentType?string
dataCustomFileData
filename?string
knownLength?number

Defined in

Types/Messages/Messages.ts:19

CustomFileData

Ƭ CustomFileData: string | Blob | File | Buffer | NodeJS.ReadableStream

Defined in

Types/Messages/Messages.ts:17

DKIMAuthorityInfo

Ƭ DKIMAuthorityInfo: Object

Type declaration

NameType
selfboolean | "yes" | "no" | "true" | "false"

Defined in

Types/Domains/Domains.ts:130

DKIMRotateImmediatelyResult

Ƭ DKIMRotateImmediatelyResult: Object

Type declaration

NameType
messagestring

Defined in

Types/DKIM/DKIM.ts:30

DKIMRotationData

Ƭ DKIMRotationData: Object

Type declaration

NameType
rotation_enabledboolean | string
rotation_interval?string

Defined in

Types/DKIM/DKIM.ts:1

DKIMSelectorInfo

Ƭ DKIMSelectorInfo: Object

Type declaration

NameType
dkimSelectorstring

Defined in

Types/Domains/Domains.ts:145

DKIMUpdateRotationResult

Ƭ DKIMUpdateRotationResult: Object

Type declaration

NameType
domainDKIMDomain

Defined in

Types/DKIM/DKIM.ts:26

DeactivateDomainKeyResponse

Ƭ DeactivateDomainKeyResponse: Object

Type declaration

NameType
activeboolean
authoritystring
messagestring
selectorstring
statusnumber

Defined in

Types/Domains/DomainKeys.ts:74

DeleteDataTypes

Ƭ DeleteDataTypes: IpPoolDeleteData | TagDeleteData

Defined in

Types/Common/RequestOptions.ts:93

DeleteQueryTypes

Ƭ DeleteQueryTypes: DeletedDomainKeysQuery

Defined in

Types/Common/RequestOptions.ts:79

DeletedDomainCredentialsResponse

Ƭ DeletedDomainCredentialsResponse: Object

Type declaration

NameType
body{ message: string ; spec: string }
body.messagestring
body.specstring
statusnumber

Defined in

Types/Domains/DomainCredentials.ts:45

DeletedDomainKeysQuery

Ƭ DeletedDomainKeysQuery: Object

Type declaration

NameType
selectorstring
signing_domainstring

Defined in

Types/Domains/DomainKeys.ts:57

DeletedDomainKeysResult

Ƭ DeletedDomainKeysResult: Object

Type declaration

NameType
messagestring

Defined in

Types/Domains/DomainKeys.ts:62

DeletedMember

Ƭ DeletedMember: Object

Type declaration

NameType
member{ address: string }
member.addressstring
messagestring

Defined in

Types/MailingLists/MailingListMembers.ts:53

DestroyRouteResponse

Ƭ DestroyRouteResponse: Object

Type declaration

NameType
idstring
messagestring

Defined in

Types/Routes/Routes.ts:15

DestroyedDomainResponse

Ƭ DestroyedDomainResponse: Object

Type declaration

NameType
bodyMessageResponse
statusnumber

Defined in

Types/Domains/Domains.ts:105

DestroyedList

Ƭ DestroyedList: Object

Type declaration

NameType
addressstring
messagestring

Defined in

Types/MailingLists/MailingLists.ts:23

DeviceStatistic

Ƭ DeviceStatistic: Object

Type declaration

NameType
clickednumber
complainednumber
openednumber
unique_clickednumber
unique_openednumber
unsubscribednumber

Defined in

Types/Domains/DomainTags.ts:176

DevicesTypes

Ƭ DevicesTypes: Object

Type declaration

NameType
desktopDeviceStatistic
mobileDeviceStatistic
tabletDeviceStatistic
unknownDeviceStatistic

Defined in

Types/Domains/DomainTags.ts:185

DomainCredentials

Ƭ DomainCredentials: Object

Type declaration

NameType
loginstring
passwordstring

Defined in

Types/Domains/DomainCredentials.ts:7

DomainCredentialsItem

Ƭ DomainCredentialsItem: Object

Type declaration

NameType
created_atstring
loginstring
mailboxstring
size_bytesnumber | null

Defined in

Types/Domains/DomainCredentials.ts:12

DomainCredentialsList

Ƭ DomainCredentialsList: Object

Type declaration

NameType
itemsDomainCredentialsItem[]
totalCountnumber

Defined in

Types/Domains/DomainCredentials.ts:27

DomainCredentialsQuery

Ƭ DomainCredentialsQuery: Object

Type declaration

NameType
limitnumber
skipnumber

Defined in

Types/Domains/DomainCredentials.ts:2

DomainCredentialsResponseData

Ƭ DomainCredentialsResponseData: Object

Type declaration

NameType
body{ items: DomainCredentialsItem[] ; total_count: number }
body.itemsDomainCredentialsItem[]
body.total_countnumber
statusnumber

Defined in

Types/Domains/DomainCredentials.ts:19

DomainCredentialsResult

Ƭ DomainCredentialsResult: Object

Type declaration

NameType
messagestring
spec?string
statusnumber

Defined in

Types/Domains/DomainCredentials.ts:32

DomainData

Ƭ DomainData: Object

Type declaration

NameType
created_atstring
dkim_host?string
idstring
is_disabledboolean
mailfrom_host?string
namestring
require_tlsboolean
skip_verificationboolean
smtp_loginstring
smtp_passwordstring
spam_actionstring
statestring
typestring
use_automatic_sender_securityboolean
web_prefixstring
web_schemestring
wildcardboolean

Defined in

Types/Domains/Domains.ts:53

DomainDynamicPropsType

Ƭ DomainDynamicPropsType: Pick<DomainData, "dkim_host" | "mailfrom_host">

Defined in

Types/Domains/Domains.ts:198

DomainEvent

Ƭ DomainEvent: Object

Type declaration

NameType
campaigns[]
delivery-status{ attempt-no: number ; certificate-verified: boolean ; code: number ; description: string ; message: string ; mx-host: string ; session-seconds: number ; tls: boolean ; utf8: boolean }
delivery-status.attempt-nonumber
delivery-status.certificate-verifiedboolean
delivery-status.codenumber
delivery-status.descriptionstring
delivery-status.messagestring
delivery-status.mx-hoststring
delivery-status.session-secondsnumber
delivery-status.tlsboolean
delivery-status.utf8boolean
envelope{ sender: string ; sending-ip: string ; targets: string ; transport: string }
envelope.senderstring
envelope.sending-ipstring
envelope.targetsstring
envelope.transportstring
eventstring
flags{ is-authenticated: boolean ; is-routed: boolean ; is-system-test: boolean ; is-test-mode: boolean }
flags.is-authenticatedboolean
flags.is-routedboolean
flags.is-system-testboolean
flags.is-test-modeboolean
idstring
log-levelstring
message{ attachments: [] ; headers: { from: string ; message-id: string ; subject: string ; to: string } ; size: 308 }
message.attachments[]
message.headers{ from: string ; message-id: string ; subject: string ; to: string }
message.headers.fromstring
message.headers.message-idstring
message.headers.subjectstring
message.headers.tostring
message.size308
reasonstring
recipientstring
recipient-domainstring
severitystring
storage{ key: string ; url: string }
storage.keystring
storage.urlstring
tagsstring[]
template?unknown
timestampnumber
user-variables{ [key: string]: unknown; }

Defined in

Types/Events/Events.ts:38

DomainGetAPIQuery

Ƭ DomainGetAPIQuery: Object

Type declaration

NameType
h:extended?boolean
h:with_dns?boolean

Defined in

Types/Domains/Domains.ts:205

DomainGetQuery

Ƭ DomainGetQuery: Object

Type declaration

NameType
extended?boolean
with_dns?boolean

Defined in

Types/Domains/Domains.ts:200

DomainInfo

Ƭ DomainInfo: DomainUpdateInfo & { dkim_host_name?: string ; dkim_key_size?: 1024 | 2048 ; dkim_selector?: string ; encrypt_incoming_message?: boolean | "true" | "false" ; force_dkim_authority?: boolean | "true" | "false" ; force_root_dkim_host?: boolean | "true" | "false" ; ips?: "" ; name: string ; pool_id?: "" }

Defined in

Types/Domains/Domains.ts:29

DomainInfoReq

Ƭ DomainInfoReq: DomainInfo & { force_dkim_authority?: "true" | "false" }

Defined in

Types/Domains/Domains.ts:41

DomainKeyCreateData

Ƭ DomainKeyCreateData: Object

Type declaration

NameType
bits?"1024" | "2048"
pem?string
selectorstring
signingDomainstring

Defined in

Types/Domains/DomainKeys.ts:15

DomainKeyCreateDataApi

Ƭ DomainKeyCreateDataApi: Omit<DomainKeyCreateData, "signingDomain"> & { signing_domain: string }

Defined in

Types/Domains/DomainKeys.ts:22

DomainKeyCreateDataResult

Ƭ DomainKeyCreateDataResult: Omit<DomainKeyItem, "dns_record"> & { dns_record: Omit<DNSRecord, "priority"> & { is_active: boolean } ; status: number }

Defined in

Types/Domains/DomainKeys.ts:10

DomainKeyItem

Ƭ DomainKeyItem: Object

Type declaration

NameType
dns_recordOmit<DNSRecord, "priority"> & { is_active: boolean }
selectorstring
signing_domainstring

Defined in

Types/Domains/DomainKeys.ts:4

DomainKeysList

Ƭ DomainKeysList: Object

Type declaration

NameType
itemsDomainKeyItem[]

Defined in

Types/Domains/DomainKeys.ts:26

DomainKeysListAllApi

Ƭ DomainKeysListAllApi: Object

Type declaration

NameType
body{ items: DomainKeyItem[] ; paging: PagesList }
body.itemsDomainKeyItem[]
body.pagingPagesList
statusnumber

Defined in

Types/Domains/DomainKeys.ts:49

DomainKeysListAllQuery

Ƭ DomainKeysListAllQuery: Object

Type declaration

NameType
limit?number
page?string
selector?string
signingDomain?string

Defined in

Types/Domains/DomainKeys.ts:35

DomainKeysListAllResult

Ƭ DomainKeysListAllResult: Object

Type declaration

NameType
itemsDomainKeyItem[]
pagesParsedPagesList
statusnumber

Defined in

Types/Domains/DomainKeys.ts:43

DomainKeysListResult

Ƭ DomainKeysListResult: Object

Type declaration

NameType
itemsDomainKeyItem[]
statusnumber

Defined in

Types/Domains/DomainKeys.ts:30

DomainListResponseData

Ƭ DomainListResponseData: Object

Type declaration

NameType
body{ items: DomainsListItem[] | null ; total_count: number }
body.itemsDomainsListItem[] | null
body.total_countnumber
statusnumber

Defined in

Types/Domains/Domains.ts:97

DomainResponseData

Ƭ DomainResponseData: Object

Type declaration

NameType
body{ domain: DomainData ; message?: string ; receiving_dns_records: DNSRecord[] ; sending_dns_records: DNSRecord[] }
body.domainDomainData
body.message?string
body.receiving_dns_recordsDNSRecord[]
body.sending_dns_recordsDNSRecord[]
statusnumber

Defined in

Types/Domains/Domains.ts:87

DomainTagAPIResponseStatsItem

Ƭ DomainTagAPIResponseStatsItem: Object

Type declaration

NameType
accepted?{ incoming: number ; outgoing: number ; total: number }
accepted.incomingnumber
accepted.outgoingnumber
accepted.totalnumber
clicked?{ total: number }
clicked.totalnumber
complained?{ total: number }
complained.totalnumber
delivered?{ http: number ; optimized: number ; smtp: number ; total: number }
delivered.httpnumber
delivered.optimizednumber
delivered.smtpnumber
delivered.totalnumber
failed?{ permanent: { bounce: number ; delayed-bounce: number ; optimized: number ; suppress-bounce: number ; suppress-complaint: number ; suppress-unsubscribe: number ; total: number ; webhook: number } ; temporary: { espblock: number ; total: number } }
failed.permanent{ bounce: number ; delayed-bounce: number ; optimized: number ; suppress-bounce: number ; suppress-complaint: number ; suppress-unsubscribe: number ; total: number ; webhook: number }
failed.permanent.bouncenumber
failed.permanent.delayed-bouncenumber
failed.permanent.optimizednumber
failed.permanent.suppress-bouncenumber
failed.permanent.suppress-complaintnumber
failed.permanent.suppress-unsubscribenumber
failed.permanent.totalnumber
failed.permanent.webhooknumber
failed.temporary{ espblock: number ; total: number }
failed.temporary.espblocknumber
failed.temporary.totalnumber
opened?{ total: number }
opened.totalnumber
stored?{ total: number }
stored.totalnumber
timestring
unsubscribed?{ total: number }
unsubscribed.totalnumber

Defined in

Types/Domains/DomainTags.ts:51

DomainTagCountriesAPIResponse

Ƭ DomainTagCountriesAPIResponse: Object

Type declaration

NameType
body{ country: { [key: string]: { clicked: number ; complained: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; } ; tag: string }
body.country{ [key: string]: { clicked: number ; complained: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; }
body.tagstring

Defined in

Types/Domains/DomainTags.ts:111

DomainTagCountriesAggregation

Ƭ DomainTagCountriesAggregation: Object

Type declaration

NameType
country{ [key: string]: { clicked: number ; complained: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; }
tagstring

Defined in

Types/Domains/DomainTags.ts:127

DomainTagDevicesAPIResponse

Ƭ DomainTagDevicesAPIResponse: Object

Type declaration

NameType
body{ device: DevicesTypes ; tag: string }
body.deviceDevicesTypes
body.tagstring
statusnumber

Defined in

Types/Domains/DomainTags.ts:192

DomainTagDevicesAggregation

Ƭ DomainTagDevicesAggregation: Object

Type declaration

NameType
deviceDevicesTypes
tagstring

Defined in

Types/Domains/DomainTags.ts:200

DomainTagProvidersAPIResponse

Ƭ DomainTagProvidersAPIResponse: Object

Type declaration

NameType
body{ provider: { [key: string]: { accepted: number ; clicked: number ; complained: number ; delivered: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; } ; tag: string }
body.provider{ [key: string]: { accepted: number ; clicked: number ; complained: number ; delivered: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; }
body.tagstring
statusnumber

Defined in

Types/Domains/DomainTags.ts:141

DomainTagProvidersAggregation

Ƭ DomainTagProvidersAggregation: Object

Type declaration

NameType
provider{ [key: string]: { accepted: number ; clicked: number ; complained: number ; delivered: number ; opened: number ; unique_clicked: number ; unique_opened: number ; unsubscribed: number }; }
tagstring

Defined in

Types/Domains/DomainTags.ts:160

DomainTagStatAPIResponse

Ƭ DomainTagStatAPIResponse: Object

Type declaration

NameType
body{ description: string ; end: string ; resolution: Resolution ; start: string ; stats: DomainTagAPIResponseStatsItem[] ; tag: string }
body.descriptionstring
body.endstring
body.resolutionResolution
body.startstring
body.statsDomainTagAPIResponseStatsItem[]
body.tagstring

Defined in

Types/Domains/DomainTags.ts:97

DomainTagStatisticItem

Ƭ DomainTagStatisticItem: Omit<DomainTagAPIResponseStatsItem, "time"> & { time: Date }

Defined in

Types/Domains/DomainTags.ts:107

DomainTagsItem

Ƭ DomainTagsItem: Object

Type declaration

NameType
descriptionstring
first-seenDate
last-seenDate
tagstring

Defined in

Types/Domains/DomainTags.ts:25

DomainTagsItemInfo

Ƭ DomainTagsItemInfo: Object

Type declaration

NameType
descriptionstring
first-seenstring
last-seenstring
tagstring

Defined in

Types/Domains/DomainTags.ts:18

DomainTagsList

Ƭ DomainTagsList: Object

Type declaration

NameType
itemsDomainTagsItem[]
pagesParsedPagesList
statusnumber

Defined in

Types/Domains/DomainTags.ts:40

DomainTagsMessageRes

Ƭ DomainTagsMessageRes: Object

Type declaration

NameType
messagestring
status?number

Defined in

Types/Domains/DomainTags.ts:46

DomainTagsQuery

Ƭ DomainTagsQuery: Object

Type declaration

NameType
limitnumber
page?string

Defined in

Types/Domains/DomainTags.ts:5

DomainTagsResponseData

Ƭ DomainTagsResponseData: Object

Type declaration

NameType
body{ items: DomainTagsItemInfo[] ; paging: PagesList }
body.itemsDomainTagsItemInfo[]
body.pagingPagesList
statusnumber

Defined in

Types/Domains/DomainTags.ts:32

DomainTagsStatisticQuery

Ƭ DomainTagsStatisticQuery: Object

Type declaration

NameType
duration?string
end?number
eventstring
resolution?Resolution
start?number

Defined in

Types/Domains/DomainTags.ts:10

DomainTemplateAllowedHeaders

Ƭ DomainTemplateAllowedHeaders: Object

Type declaration

NameType
From?string
Reply-To?string
Subject?string

Defined in

Types/Domains/DomainTemplates.ts:5

DomainTemplateData

Ƭ DomainTemplateData: Object

Type declaration

NameType
comment?string
createdBy?string
descriptionstring
engine?string
headers?DomainTemplateAllowedHeaders
namestring
tag?string
templatestring

Defined in

Types/Domains/DomainTemplates.ts:12

DomainTemplateUpdateData

Ƭ DomainTemplateUpdateData: Object

Type declaration

NameType
descriptionstring

Defined in

Types/Domains/DomainTemplates.ts:32

DomainTemplateUpdateVersionData

Ƭ DomainTemplateUpdateVersionData: Object

Type declaration

NameType
active?YesNo
comment?string
headers?DomainTemplateAllowedHeaders
template?string

Defined in

Types/Domains/DomainTemplates.ts:36

DomainTemplateVersionData

Ƭ DomainTemplateVersionData: Object

Type declaration

NameType
active?YesNo
comment?string
engine?string
headers?DomainTemplateAllowedHeaders
tagstring
templatestring

Defined in

Types/Domains/DomainTemplates.ts:23

DomainTemplatesQuery

Ƭ DomainTemplatesQuery: Object

Type declaration

NameTypeDescription
limit?numberNumber of records to retrieve. Default value is 10.
page?`?${string}`'page' (optionally 'p') params from previous response's 'paging' object. Value must be stringified as query params. Ex: '?page=first','?page=next&p=name-of-last-item' ....

Defined in

Types/Domains/DomainTemplates.ts:43

DomainTrackingData

Ƭ DomainTrackingData: Object

Type declaration

NameType
click{ active: boolean }
click.activeboolean
open{ active: boolean }
open.activeboolean
unsubscribe{ active: boolean ; html_footer: string ; text_footer: string }
unsubscribe.activeboolean
unsubscribe.html_footerstring
unsubscribe.text_footerstring

Defined in

Types/Domains/DomainTracking.ts:3

DomainTrackingResponse

Ƭ DomainTrackingResponse: Object

Type declaration

NameType
body{ tracking: DomainTrackingData }
body.trackingDomainTrackingData
statusnumber

Defined in

Types/Domains/DomainTracking.ts:13

DomainUpdateInfo

Ƭ DomainUpdateInfo: Object

Type declaration

NameType
mailfrom_host?string
message_ttl?number
smtp_password?string
spam_action?"disabled" | "block" | "tag"
use_automatic_sender_security?boolean | "true" | "false"
web_prefix?string
web_scheme?"http" | "https"
wildcard?boolean | "true" | "false"

Defined in

Types/Domains/Domains.ts:13

DomainUpdateInfoReq

Ƭ DomainUpdateInfoReq: Omit<DomainUpdateInfo, "message_ttl"> & { use_automatic_sender_security?: "true" | "false" ; wildcard?: "true" | "false" }

Defined in

Types/Domains/Domains.ts:24

DomainsQuery

Ƭ DomainsQuery: Object

Type declaration

NameType
authority?string
limit?number
search?string
skip?number
sort?"name:asc" | "name: desc"
state?"active" | "unverified" | "disabled"

Defined in

Types/Domains/Domains.ts:4

EmailQuery

Ƭ EmailQuery: Object

Type declaration

NameType
emailstring

Defined in

Types/AccountManagement/AccountManagement.ts:10

EventsList

Ƭ EventsList: Object

Type declaration

NameType
itemsDomainEvent[]
pagesParsedPagesList
statusnumber

Defined in

Types/Events/Events.ts:92

EventsPage

Ƭ EventsPage: Object

Type declaration

NameType
idstring
numberstring
urlstring

Defined in

Types/Events/Events.ts:3

EventsQuery

Ƭ EventsQuery: FilterField & { ascending?: "yes" | "no" ; begin?: string ; end?: string ; limit?: number ; page?: string }

Defined in

Types/Events/Events.ts:24

EventsResponse

Ƭ EventsResponse: Object

Type declaration

NameType
body{ items: [] ; paging: PagesList }
body.items[]
body.pagingPagesList
statusnumber

Defined in

Types/Events/Events.ts:31

FetchSupportedData

Ƭ FetchSupportedData: Blob | BufferSource | FormData | URLSearchParams | string

Defined in

Types/Common/RequestProvider.ts:28

FilterField

Ƭ FilterField: Object

Type declaration

NameType
attachment?string
event?string
from?string
list?string
message-id?string
recipient?string
recipients?string
severity?string
size?string
subject?string
tags?string
to?string

Defined in

Types/Events/Events.ts:9

FormDataBuilderConfig

Ƭ FormDataBuilderConfig: Object

Type declaration

NameType
useFetch?boolean

Defined in

Types/Common/FormData.ts:20

FormDataInput

Ƭ FormDataInput: Object

Index signature

▪ [key: string]: FormDataInputValue

Defined in

Types/Common/FormData.ts:16

FormDataInputValue

Ƭ FormDataInputValue: MimeMessage | CustomFileData | string | string[] | boolean | MessageAttachment | undefined | number | JsonObject

Defined in

Types/Messages/Messages.ts:36

FormDataOptions

Ƭ FormDataOptions: Object

Index signature

▪ [key: string]: NodeFormData

Defined in

Types/Common/FormData.ts:4

GenerateDomainTrackingCertificateResponse

Ƭ GenerateDomainTrackingCertificateResponse: Object

Type declaration

NameType
locationstring
messagestring
statusnumber

Defined in

Types/Domains/DomainTracking.ts:57

GetDomainTemplateAPIResponse

Ƭ GetDomainTemplateAPIResponse: Object

Type declaration

NameType
body{ template: IDomainTemplate }
body.templateIDomainTemplate
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:98

GetDomainTrackingCertificateResponse

Ƭ GetDomainTrackingCertificateResponse: Object

Type declaration

NameType
certificatestring
errorstring
responseStatusCodenumber
statusstring

Defined in

Types/Domains/DomainTracking.ts:50

GetQueryTypes

Ƭ GetQueryTypes: IPsListQuery | RoutesListQuery | SubaccountsQuery | WebhooksQuery | DomainsQuery | DomainGetAPIQuery | DomainCredentialsQuery | DomainTagsStatisticQuery | TemplateQuery | DomainTemplatesQuery | InboxPlacementsResultsApiQuery | SeedsListsAPIQuery | RoutesMatchQuery | EmailQuery | { searchParams?: string[][] } | ValidationQuery

Defined in

Types/Common/RequestOptions.ts:61

HeadersWithKeysMethod

Ƭ HeadersWithKeysMethod: Headers & { keys: () => KeysWithToArray }

Defined in

Types/Common/RequestProvider.ts:31

IPsListQuery

Ƭ IPsListQuery: Object

Type declaration

NameType
dedicatedboolean | string

Defined in

Types/IPs/IPs.ts:14

InputFormData

Ƭ InputFormData: (form?: HTMLFormElement, submitter?: null | HTMLElement) => FormData | (options?: FormDataOptions) => FormData

Defined in

Types/Common/FormData.ts:8

IpData

Ƭ IpData: Object

Type declaration

NameType
dedicatedboolean
ipstring
rdnsstring

Defined in

Types/IPs/IPs.ts:8

IpPool

Ƭ IpPool: Object

Type declaration

NameType
descriptionstring
ipsstring[]
is_linkedboolean
namestring
pool_idstring

Defined in

Types/IPPools/IpPools.ts:2

IpPoolCreateData

Ƭ IpPoolCreateData: Object

Type declaration

NameType
description?string
ips?string[]
namestring

Defined in

Types/IPPools/IpPools.ts:47

IpPoolCreateResponse

Ƭ IpPoolCreateResponse: Object

Type declaration

NameType
body{ message: string ; pool_id: string }
body.messagestring
body.pool_idstring
statusnumber

Defined in

Types/IPPools/IpPools.ts:53

IpPoolCreateResult

Ƭ IpPoolCreateResult: Object

Type declaration

NameType
messagestring
pool_idstring
statusnumber

Defined in

Types/IPPools/IpPools.ts:61

IpPoolDeleteData

Ƭ IpPoolDeleteData: Object

Type declaration

NameType
ip?string
pool_id?string

Defined in

Types/IPPools/IpPools.ts:42

IpPoolListResponse

Ƭ IpPoolListResponse: Object

Type declaration

NameType
body{ ip_pools: IpPool ; message: string }
body.ip_poolsIpPool
body.messagestring
statusnumber

Defined in

Types/IPPools/IpPools.ts:10

IpPoolListResult

Ƭ IpPoolListResult: Object

Type declaration

NameType
ip_poolsIpPool
messagestring
statusnumber

Defined in

Types/IPPools/IpPools.ts:18

IpPoolMessageResponse

Ƭ IpPoolMessageResponse: Object

Type declaration

NameType
body{ message: string }
body.messagestring
statusnumber

Defined in

Types/IPPools/IpPools.ts:30

IpPoolMessageResult

Ƭ IpPoolMessageResult: Object

Type declaration

NameType
messagestring
statusnumber

Defined in

Types/IPPools/IpPools.ts:37

IpPoolUpdateData

Ƭ IpPoolUpdateData: Object

Type declaration

NameType
descriptionstring
ipsstring[]
namestring

Defined in

Types/IPPools/IpPools.ts:24

IpsListResponseBody

Ƭ IpsListResponseBody: Object

Type declaration

NameType
assignable_to_poolsboolean
itemsstring[]
total_countnumber

Defined in

Types/IPs/IPs.ts:2

Json

Ƭ Json: JsonPrimitive | JsonComposite

Defined in

Types/Messages/Messages.ts:51

JsonArray

Ƭ JsonArray: Json[]

Defined in

Types/Messages/Messages.ts:48

JsonComposite

Ƭ JsonComposite: JsonArray | JsonObject

Defined in

Types/Messages/Messages.ts:50

JsonObject

Ƭ JsonObject: Object

Index signature

▪ [key: string]: Json

Defined in

Types/Messages/Messages.ts:49

JsonPrimitive

Ƭ JsonPrimitive: string | number | boolean | null

Defined in

Types/Messages/Messages.ts:47

KeysWithToArray

Ƭ KeysWithToArray: Object

Type declaration

NameType
toArray() => string[]

Defined in

Types/Common/RequestProvider.ts:30

ListDomainTemplateVersionsAPIResponse

Ƭ ListDomainTemplateVersionsAPIResponse: Object

Type declaration

NameType
body{ paging: PagesList ; template: { createdAt: string ; createdBy: string ; description: string ; id: string ; name: string ; versions: ShortTemplateVersion[] } }
body.pagingPagesList
body.template{ createdAt: string ; createdBy: string ; description: string ; id: string ; name: string ; versions: ShortTemplateVersion[] }
body.template.createdAtstring
body.template.createdBystring
body.template.descriptionstring
body.template.idstring
body.template.namestring
body.template.versionsShortTemplateVersion[]
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:169

ListDomainTemplateVersionsResult

Ƭ ListDomainTemplateVersionsResult: Object

Type declaration

NameType
pagesParsedPagesList
templateIDomainTemplate

Defined in

Types/Domains/DomainTemplates.ts:184

ListDomainTemplatesAPIResponse

Ƭ ListDomainTemplatesAPIResponse: Object

Type declaration

NameType
body{ items: IDomainTemplate[] ; paging: { first: string ; last: string ; next: string ; previous: string } }
body.itemsIDomainTemplate[]
body.paging{ first: string ; last: string ; next: string ; previous: string }
body.paging.firststring
body.paging.laststring
body.paging.nextstring
body.paging.previousstring
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:79

ListDomainTemplatesResult

Ƭ ListDomainTemplatesResult: Object

Type declaration

NameType
itemsIDomainTemplate[]
pagesParsedPagesList
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:92

ListsByAddressQuery

Ƭ ListsByAddressQuery: Object

Type declaration

NameType
address?string
limit?number
skip?number

Defined in

Types/MailingLists/MailingLists.ts:9

ListsQuery

Ƭ ListsQuery: Object

Type declaration

NameType
limit?number
page?string

Defined in

Types/MailingLists/MailingLists.ts:4

LogsDeliveryStatus

Ƭ LogsDeliveryStatus: Object

Type declaration

NameType
attempt-no?number
bounce-type?string
certificate-verified?boolean
code?number
description?string
enhanced-code?string
first-delivery-attempt-seconds?number
last-code?number
last-message?string
message?string
mx-host?string
retry-seconds?number
session-seconds?number
tls?boolean
utf8?boolean

Defined in

Types/Logs/Logs.ts:34

LogsEvent

Ƭ LogsEvent: Object

Type declaration

NameType
@timestampstring
account?{ id: string ; parent-id: string }
account.idstring
account.parent-idstring
api-key-id?string
campaigns?{ id: string ; name: string }[]
client-info?{ bot?: string ; client-name?: string ; client-os?: string ; client-type?: string ; device-type?: string ; ip?: string ; user-agent?: string }
client-info.bot?string
client-info.client-name?string
client-info.client-os?string
client-info.client-type?string
client-info.device-type?string
client-info.ip?string
client-info.user-agent?string
delivery-status?LogsDeliveryStatus
domain{ name: string }
domain.namestring
envelope?{ i-ip-pool-id?: string ; sender?: string ; sending-ip?: string ; targets?: string ; transport?: string }
envelope.i-ip-pool-id?string
envelope.sender?string
envelope.sending-ip?string
envelope.targets?string
envelope.transport?string
eventstring
flags?{ is-amp?: boolean ; is-authenticated: boolean ; is-callback: boolean ; is-delayed-bounce: boolean ; is-encrypted: boolean ; is-routed: boolean ; is-system-test: boolean ; is-test-mode: boolean }
flags.is-amp?boolean
flags.is-authenticatedboolean
flags.is-callbackboolean
flags.is-delayed-bounceboolean
flags.is-encryptedboolean
flags.is-routedboolean
flags.is-system-testboolean
flags.is-test-modeboolean
geolocation?{ city?: string ; country?: string ; region?: string ; timezone?: string }
geolocation.city?string
geolocation.country?string
geolocation.region?string
geolocation.timezone?string
i-delivery-optimizer?string
idstring
ip?string
log-level?string
mailing-list?{ address?: string ; list-id?: string ; sid?: string }
mailing-list.address?string
mailing-list.list-id?string
mailing-list.sid?string
message?{ attachments?: { content-type?: string ; filename?: string ; size?: number }[] ; headers?: { from: string ; message-id: string ; subject: string ; to: string } ; recipients?: string[] ; scheduled-for?: number ; size?: number }
message.attachments?{ content-type?: string ; filename?: string ; size?: number }[]
message.headers?{ from: string ; message-id: string ; subject: string ; to: string }
message.headers.fromstring
message.headers.message-idstring
message.headers.subjectstring
message.headers.tostring
message.recipients?string[]
message.scheduled-for?number
message.size?number
method?string
originating-ip?string
primary-dkim?string
reason?string
recipient?string
recipient-domain?string
recipient-provider?string
routes?{ actions?: string ; description?: string ; expression?: string ; id?: string ; match?: { recipient?: string } ; priority?: number }
routes.actions?string
routes.description?string
routes.expression?string
routes.id?string
routes.match?{ recipient?: string }
routes.match.recipient?string
routes.priority?number
severity?string
storage?{ env?: string ; key?: string ; region?: string ; url?: string[] }
storage.env?string
storage.key?string
storage.region?string
storage.url?string[]
tags?string[]
template?{ is-text?: boolean ; name?: string ; version?: string }
template.is-text?boolean
template.name?string
template.version?string
url?string
user-variables?string

Defined in

Types/Logs/Logs.ts:52

LogsEventItem

Ƭ LogsEventItem: Omit<LogsEvent, "@timestamp"> & { @timestamp: Date }

Defined in

Types/Logs/Logs.ts:159

LogsFilter

Ƭ LogsFilter: Object

Type declaration

NameType
AND{ attribute: string ; comparator: string ; values: LogsFilterValue[] }[]

Defined in

Types/Logs/Logs.ts:6

LogsFilterValue

Ƭ LogsFilterValue: Object

Type declaration

NameType
labelstring
valuestring

Defined in

Types/Logs/Logs.ts:1

LogsList

Ƭ LogsList: Object

Type declaration

NameType
aggregates{ all: number ; metrics: object }
aggregates.allnumber
aggregates.metricsobject
endDate
itemsLogsEventItem[]
pagination{ first?: string ; last?: string ; next?: string ; previous?: string ; total?: number }
pagination.first?string
pagination.last?string
pagination.next?string
pagination.previous?string
pagination.total?number
startDate
statusnumber

Defined in

Types/Logs/Logs.ts:163

LogsParsedQuery

Ƭ LogsParsedQuery: Omit<LogsQuery, "start" | "end"> & { end?: string ; start?: string }

Defined in

Types/Logs/Logs.ts:29

LogsQuery

Ƭ LogsQuery: Object

Type declaration

NameType
end?Date
events?string[]
filter?LogsFilter
include_subaccounts?boolean
include_totals?boolean
metric_events?string[]
pagination?{ limit?: number ; sort?: string ; token?: string }
pagination.limit?number
pagination.sort?string
pagination.token?string
start?Date

Defined in

Types/Logs/Logs.ts:14

MailListMember

Ƭ MailListMember: Object

Type declaration

NameType
addressstring
namestring
subscribedboolean
vars{ [key: string]: unknown; }

Defined in

Types/MailingLists/MailingListMembers.ts:5

MailListMembersByAddressQuery

Ƭ MailListMembersByAddressQuery: Object

Type declaration

NameType
address?string
limit?number
skip?number
subscribed?boolean

Defined in

Types/MailingLists/MailingListMembers.ts:20

MailListMembersByAddressResult

Ƭ MailListMembersByAddressResult: Object

Type declaration

NameType
itemsMailListMember[]
statusnumber
total_countnumber

Defined in

Types/MailingLists/MailingListMembers.ts:80

MailListMembersQuery

Ƭ MailListMembersQuery: Object

Type declaration

NameType
limit?number
page?string
subscribed?"yes" | "no"

Defined in

Types/MailingLists/MailingListMembers.ts:14

MailListMembersResponse

Ƭ MailListMembersResponse: Object

Type declaration

NameType
body{ items: MailListMember[] ; paging: PagesList }
body.itemsMailListMember[]
body.pagingPagesList
statusnumber

Defined in

Types/MailingLists/MailingListMembers.ts:66

MailListMembersResult

Ƭ MailListMembersResult: Object

Type declaration

NameType
itemsMailListMember[]
pagesParsedPagesList
statusnumber

Defined in

Types/MailingLists/MailingListMembers.ts:74

MailListMembersUploadData

Ƭ MailListMembersUploadData: CustomFileData | CustomFile

Defined in

Types/MailingLists/MailingListMembers.ts:86

MailListMembersUploadDataUpdated

Ƭ MailListMembersUploadDataUpdated: Object

Type declaration

NameType
listMembersUploadFileMailListMembersUploadData
subscribedstring
upsertstring

Defined in

Types/MailingLists/MailingListMembers.ts:87

MailListMembersUploadResponse

Ƭ MailListMembersUploadResponse: Object

Type declaration

NameType
listMailingList
messagestring
task-idstring

Defined in

Types/MailingLists/MailingListMembers.ts:93

MailgunClientOptions

Ƭ MailgunClientOptions: Object

Type declaration

NameType
keystring
proxy?ClientProxyConfig
public_key?string
timeout?number
url?string
useFetch?boolean
usernamestring

Defined in

Types/MailgunClient/MailgunClientOptions.ts:3

MailgunMessageContent

Ƭ MailgunMessageContent: AtLeastOneKeyPresent<{ html?: string ; message?: MimeMessage ; template?: string ; text?: string }>

Defined in

Types/Messages/Messages.ts:53

MailgunMessageData

Ƭ MailgunMessageData: MailgunMessageContent & { [key: string]: FormDataInputValue; amp-html?: string ; attachment?: MessageAttachment ; bcc?: string | string[] ; cc?: string | string[] ; from?: string ; h:X-My-Header?: string ; inline?: any ; o:deliverytime?: string ; o:deliverytime-optimize-period?: string ; o:dkim?: boolean | "yes" | "no" ; o:require-tls?: boolean | "yes" | "no" ; o:skip-verification?: boolean | "yes" | "no" ; o:tag?: string | string[] ; o:testmode?: boolean | "yes" | "no" ; o:time-zone-localize?: string ; o:tracking?: boolean | "yes" | "no" ; o:tracking-clicks?: boolean | "yes" | "no" | "htmlonly" ; o:tracking-opens?: boolean | "yes" | "no" ; recipient-variables?: string ; subject?: string ; t:text?: boolean | "yes" | "no" ; t:variables?: string | JsonObject ; t:version?: string ; to?: string | string[] ; v:my-var?: string }

Defined in

Types/Messages/Messages.ts:73

MailingList

Ƭ MailingList: Object

Type declaration

NameType
access_levelstring
addressstring
created_atstring
descriptionstring
members_countnumber
namestring
reply_preferencenull | string

Defined in

Types/MailingLists/MailingLists.ts:74

MailingListApiResponse

Ƭ MailingListApiResponse: Object

Type declaration

NameType
body{ items: MailingList[] ; paging: PagesList }
body.itemsMailingList[]
body.pagingPagesList
statusnumber

Defined in

Types/MailingLists/MailingLists.ts:96

MailingListByAddressResult

Ƭ MailingListByAddressResult: Object

Type declaration

NameType
itemsMailingList[]
statusnumber
total_countnumber

Defined in

Types/MailingLists/MailingLists.ts:90

MailingListCancelValidationResult

Ƭ MailingListCancelValidationResult: Object

Type declaration

NameType
messagestring
statusnumber

Defined in

Types/MailingLists/MailingLists.ts:70

MailingListResult

Ƭ MailingListResult: Object

Type declaration

NameType
itemsMailingList[]
pagesParsedPagesList
statusnumber

Defined in

Types/MailingLists/MailingLists.ts:84

MailingListValidationApiResponse

Ƭ MailingListValidationApiResponse: MailingListValidationResponse & { created_at: number }

Defined in

Types/MailingLists/MailingLists.ts:59

MailingListValidationResponse

Ƭ MailingListValidationResponse: Object

Type declaration

NameType
download_url{ csv: string ; json: string }
download_url.csvstring
download_url.jsonstring
idstring
quantitynumber
records_processednumber
statusstring
summary{ result: { catch_all: number ; deliverable: number ; do_not_send: number ; undeliverable: number ; unknown: number } ; risk: { high: number ; low: number ; medium: number ; unknown: number } }
summary.result{ catch_all: number ; deliverable: number ; do_not_send: number ; undeliverable: number ; unknown: number }
summary.result.catch_allnumber
summary.result.deliverablenumber
summary.result.do_not_sendnumber
summary.result.undeliverablenumber
summary.result.unknownnumber
summary.risk{ high: number ; low: number ; medium: number ; unknown: number }
summary.risk.highnumber
summary.risk.lownumber
summary.risk.mediumnumber
summary.risk.unknownnumber

Defined in

Types/MailingLists/MailingLists.ts:34

MailingListValidationResult

Ƭ MailingListValidationResult: Object

Type declaration

NameType
statusnumber
validationResultMailingListValidationResultData

Defined in

Types/MailingLists/MailingLists.ts:65

MailingListValidationResultData

Ƭ MailingListValidationResultData: MailingListValidationResponse & { created_at: Date }

Defined in

Types/MailingLists/MailingLists.ts:62

MessageAttachment

Ƭ MessageAttachment: CustomFile | CustomFile[] | File | File[] | string | CustomFileData | CustomFileData[]

Defined in

Types/Messages/Messages.ts:27

MessageHeader

Ƭ MessageHeader: [string, string]

Defined in

Types/Messages/Messages.ts:260

MessageResponse

Ƭ MessageResponse: Object

Type declaration

NameType
messagestring

Defined in

Types/Common/ApiResponse.ts:7

MessageResponseWithStatus

Ƭ MessageResponseWithStatus: Object

Type declaration

NameType
messagestring
statusnumber

Defined in

Types/Common/ApiResponse.ts:11

MessagesQueueStatusAPIResponse

Ƭ MessagesQueueStatusAPIResponse: Object

Type declaration

NameType
regularQueueStatusAPI
scheduledQueueStatusAPI

Defined in

Types/Messages/Messages.ts:309

MessagesQueueStatusResult

Ƭ MessagesQueueStatusResult: Object

Type declaration

NameType
regularQueueStatus
scheduledQueueStatus

Defined in

Types/Messages/Messages.ts:314

MessagesSendAPIResponse

Ƭ MessagesSendAPIResponse: Object

Type declaration

NameType
body{ id: string ; message: string }
body.idstring
body.messagestring
statusnumber

Defined in

Types/Messages/Messages.ts:245

MessagesSendResult

Ƭ MessagesSendResult: Object

Type declaration

NameType
details?string
id?string
message?string
statusnumber

Defined in

Types/Messages/Messages.ts:253

Metrics

Ƭ Metrics: Object

Type declaration

NameType
accepted_count?number
accepted_incoming_count?number
accepted_outgoing_count?number
bounce_rate?string
bounced_count?number
clicked_count?number
clicked_rate?string
complained_count?number
complained_rate?string
delayed_bounce_count?number
delayed_first_attempt_count?number
delayed_rate?string
delivered_count?number
delivered_first_attempt_count?number
delivered_http_count?number
delivered_optimized_count?number
delivered_rate?string
delivered_smtp_count?number
delivered_subsequent_count?number
delivered_two_plus_attempts_count?number
esp_block_count?number
fail_rate?string
failed_count?number
hard_bounces_count?number
opened_count?number
opened_rate?string
permanent_fail_rate?string
permanent_failed_count?number
permanent_failed_old_count?number
permanent_failed_optimized_count?number
processed_count?number
rate_limit_count?number
sent_count?number
soft_bounces_count?number
stored_count?number
suppressed_bounces_count?number
suppressed_complaints_count?number
suppressed_unsubscribed_count?number
temporary_fail_rate?string
temporary_failed_count?number
unique_clicked_count?number
unique_clicked_rate?string
unique_opened_count?number
unique_opened_rate?string
unsubscribed_count?number
unsubscribed_rate?string
webhook_count?number

Defined in

Types/Metrics/Metrics.ts:28

MetricsAPIQuery

Ƭ MetricsAPIQuery: Omit<MetricsQuery, "start" | "end"> & { end?: string ; start?: string }

Defined in

Types/Metrics/MetricsAPI.ts:8

MetricsAPIResponse

Ƭ MetricsAPIResponse: Object

Type declaration

NameType
body{ aggregates: { metrics: Metrics } ; dimensions: string[] ; duration?: string ; end: string ; items: MetricsResponseItem[] ; pagination: MetricsPagination ; resolution: string ; start: string }
body.aggregates{ metrics: Metrics }
body.aggregates.metricsMetrics
body.dimensionsstring[]
body.duration?string
body.endstring
body.itemsMetricsResponseItem[]
body.paginationMetricsPagination
body.resolutionstring
body.startstring
statusnumber

Defined in

Types/Metrics/MetricsAPI.ts:13

MetricsDimension

Ƭ MetricsDimension: Object

Type declaration

NameType
dimensionstring
display_valuestring
valuestring

Defined in

Types/Metrics/Metrics.ts:85

MetricsFilter

Ƭ MetricsFilter: Object

Type declaration

NameType
attributestring
comparatorstring
valuesMetricsFilterValue[]

Defined in

Types/Metrics/Metrics.ts:8

MetricsFilterValue

Ƭ MetricsFilterValue: Object

Type declaration

NameType
label?string
valuestring

Defined in

Types/Metrics/Metrics.ts:4

MetricsPagination

Ƭ MetricsPagination: Object

Type declaration

NameType
limitnumber
skipnumber
sortstring
totalnumber

Defined in

Types/Metrics/Metrics.ts:78

MetricsQuery

Ƭ MetricsQuery: Object

Type declaration

NameType
dimensions?string[]
duration?string
end?Date | string
filter?{ AND: MetricsFilter[] }
filter.ANDMetricsFilter[]
include_aggregates?boolean
include_subaccounts?boolean
metrics?string[]
resolution?Resolution
start?Date | string

Defined in

Types/Metrics/Metrics.ts:14

MetricsResponseItem

Ƭ MetricsResponseItem: Object

Type declaration

NameType
dimensionsMetricsDimension[]
metricsMetrics

Defined in

Types/Metrics/Metrics.ts:91

MetricsResult

Ƭ MetricsResult: Object

Type declaration

NameType
aggregates{ metrics: Metrics }
aggregates.metricsMetrics
dimensionsstring[]
duration?string
endDate | null
itemsMetricsResponseItem[]
paginationMetricsPagination
resolutionstring
startDate | null
statusnumber

Defined in

Types/Metrics/Metrics.ts:96

MimeMessage

Ƭ MimeMessage: string | Blob | Buffer | NodeJS.ReadableStream

Defined in

Types/Messages/Messages.ts:16

MultipleMembersData

Ƭ MultipleMembersData: Object

Type declaration

NameType
membersMailListMember[]
upsert"yes" | "no"

Defined in

Types/MailingLists/MailingListMembers.ts:27

MultipleMembersReqData

Ƭ MultipleMembersReqData: Object

Type declaration

NameType
membersstring
upsert"yes" | "no"

Defined in

Types/MailingLists/MailingListMembers.ts:32

MultipleValidationCreationData

Ƭ MultipleValidationCreationData: Object

Type declaration

NameType
fileCustomFileData | CustomFile

Defined in

Types/Validations/MultipleValidation.ts:64

MultipleValidationCreationDataUpdated

Ƭ MultipleValidationCreationDataUpdated: Object

Type declaration

NameType
multipleValidationFileCustomFileData | CustomFile

Defined in

Types/Validations/MultipleValidation.ts:67

MultipleValidationJobData

Ƭ MultipleValidationJobData: Object

Type declaration

NameType
created_atnumber
download_url?{ csv: string ; json: string }
download_url.csvstring
download_url.jsonstring
idstring
quantitynumber
records_processednumber | null
statusstring
summary?{ result: { catch_all: number ; deliverable: number ; do_not_send: number ; undeliverable: number ; unknown: number } ; risk: { high: number ; low: number ; medium: number ; unknown: number } }
summary.result{ catch_all: number ; deliverable: number ; do_not_send: number ; undeliverable: number ; unknown: number }
summary.result.catch_allnumber
summary.result.deliverablenumber
summary.result.do_not_sendnumber
summary.result.undeliverablenumber
summary.result.unknownnumber
summary.risk{ high: number ; low: number ; medium: number ; unknown: number }
summary.risk.highnumber
summary.risk.lownumber
summary.risk.mediumnumber
summary.risk.unknownnumber

Defined in

Types/Validations/MultipleValidation.ts:5

MultipleValidationJobResult

Ƭ MultipleValidationJobResult: Object

Type declaration

NameType
createdAtDate
downloadUrl?{ csv: string ; json: string }
downloadUrl.csvstring
downloadUrl.jsonstring
idstring
quantitynumber
recordsProcessednumber | null
responseStatusCodenumber
statusstring
summary?{ result: { catchAll: number ; deliverable: number ; doNotSend: number ; undeliverable: number ; unknown: number } ; risk: { high: number ; low: number ; medium: number ; unknown: number } }
summary.result{ catchAll: number ; deliverable: number ; doNotSend: number ; undeliverable: number ; unknown: number }
summary.result.catchAllnumber
summary.result.deliverablenumber
summary.result.doNotSendnumber
summary.result.undeliverablenumber
summary.result.unknownnumber
summary.risk{ high: number ; low: number ; medium: number ; unknown: number }
summary.risk.highnumber
summary.risk.lownumber
summary.risk.mediumnumber
summary.risk.unknownnumber

Defined in

Types/Validations/MultipleValidation.ts:32

MultipleValidationJobsListQuery

Ƭ MultipleValidationJobsListQuery: Object

Type declaration

NameType
limitnumber
page?string

Defined in

Types/Validations/MultipleValidation.ts:78

MultipleValidationJobsListResponse

Ƭ MultipleValidationJobsListResponse: Object

Type declaration

NameType
body{ jobs: MultipleValidationJobData[] ; paging: PagesList ; total: number }
body.jobsMultipleValidationJobData[]
body.pagingPagesList
body.totalnumber
statusnumber

Defined in

Types/Validations/MultipleValidation.ts:83

MultipleValidationJobsListResult

Ƭ MultipleValidationJobsListResult: Object

Type declaration

NameType
jobsMultipleValidationJobResult[]
pagesParsedPagesList
statusnumber
totalnumber

Defined in

Types/Validations/MultipleValidation.ts:71

MutateDomainTemplateVersionAPIResponse

Ƭ MutateDomainTemplateVersionAPIResponse: Object

Type declaration

NameType
body{ message: string ; template: { name: string ; version: { tag: string } } }
body.messagestring
body.template{ name: string ; version: { tag: string } }
body.template.namestring
body.template.version{ tag: string }
body.template.version.tagstring
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:147

MutateDomainTemplateVersionResult

Ƭ MutateDomainTemplateVersionResult: Object

Type declaration

NameType
messagestring
statusnumber
templateNamestring
templateVersion{ tag: string }
templateVersion.tagstring

Defined in

Types/Domains/DomainTemplates.ts:160

NewMultipleMembersResponse

Ƭ NewMultipleMembersResponse: Object

Type declaration

NameType
listMailingList
messagestring
task-idstring

Defined in

Types/MailingLists/MailingListMembers.ts:60

NodePipeFunction

Ƭ NodePipeFunction: (destination: WritableStream, options?: { end?: boolean }) => void

Type declaration

▸ (destination, options?): void

Parameters
NameType
destinationWritableStream
options?Object
options.end?boolean
Returns

void

Defined in

Types/Common/Attachments.ts:1

NotificationAPIResponse

Ƭ NotificationAPIResponse: Object

Type declaration

NameType
body{ message: string }
body.messagestring
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:121

NotificationResult

Ƭ NotificationResult: Object

Type declaration

NameType
messagestring
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:128

OnCallEmptyHeaders

Ƭ OnCallEmptyHeaders: Object

Index signature

▪ [key: string]: undefined

Defined in

Types/Common/RequestOptions.ts:32

OnCallRequestOptions

Ƭ OnCallRequestOptions: Object

Index signature

▪ [key: string]: unknown | undefined

Type declaration

NameType
query?any
timeout?number

Defined in

Types/Common/RequestOptions.ts:54

OpenTrackingInfo

Ƭ OpenTrackingInfo: Object

Type declaration

NameType
active"yes" | "no" | "true" | "false" | boolean
place_at_the_top?"yes" | "no" | "true" | "false" | boolean

Defined in

Types/Domains/DomainTracking.ts:36

PagesList

Ƭ PagesList: Object

Type declaration

NameType
firststring
laststring
nextstring
previousstring

Defined in

Types/Common/NavigationThruPages.ts:1

PagesListAccumulator

Ƭ PagesListAccumulator: Object

Index signature

▪ [index: string]: ParsedPage

Defined in

Types/Common/NavigationThruPages.ts:22

PaginationInResponse

Ƭ PaginationInResponse: Omit<TagsListPagination, "sort" | "limit"> & { limit: number ; sort: string }

Defined in

Types/Tags/Tags.ts:58

ParsedPage

Ƭ ParsedPage: Object

Type declaration

NameType
idstring
iteratorPositionstring | undefined
pagestring
urlstring

Defined in

Types/Common/NavigationThruPages.ts:8

ParsedPagesList

Ƭ ParsedPagesList: Object

Type declaration

NameType
firstParsedPage
lastParsedPage
nextParsedPage
previousParsedPage

Defined in

Types/Common/NavigationThruPages.ts:15

PostDataTypes

Ƭ PostDataTypes: InboxPlacementsData | MetricsQuery | LogsQuery | BounceClassificationAPIQuery | string

Defined in

Types/Common/RequestOptions.ts:81

PutDataTypes

Ƭ PutDataTypes: SeedsListsUpdatingData | object | FormDataInput | ConnectionSettings | TagsUpdateData

Defined in

Types/Common/RequestOptions.ts:87

PutOptionsType

Ƭ PutOptionsType: Object

Type declaration

NameType
query?PutQueryTypes

Defined in

Types/Common/RequestOptions.ts:111

PutQueryTypes

Ƭ PutQueryTypes: EnableQuery | DkimSelectorQuery | SelfQuery | WebPrefixQuery | LimitQuery

Defined in

Types/Common/RequestOptions.ts:105

QueryWithPage

Ƭ QueryWithPage: Object

Type declaration

NameType
page?string

Defined in

Types/Common/NavigationThruPages.ts:32

RegenerateDomainTrackingCertificateResponse

Ƭ RegenerateDomainTrackingCertificateResponse: Object

Type declaration

NameType
locationstring
messagestring
statusnumber

Defined in

Types/Domains/DomainTracking.ts:63

ReplacementForPool

Ƭ ReplacementForPool: Object

Type declaration

NameType
ip?string
pool_id?string

Defined in

Types/Domains/Domains.ts:170

RequestData

Ƭ RequestData: IpPoolDeleteData | PostDataTypes | PutDataTypes | NodeFormData | FormData

Defined in

Types/Common/RequestOptions.ts:95

RequestHeaders

Ƭ RequestHeaders: Partial<{ [key: string]: HeaderValue; } & { [Key in CommonRequestHeadersList]: HeaderValue } & { Content-Type: ContentType }>

Defined in

Types/Common/RequestOptions.ts:40

RequestOptions

Ƭ RequestOptions: MailgunClientOptions & { headers?: RequestHeaders ; timeout?: number }

Defined in

Types/Common/RequestOptions.ts:49

RequestProviderConfig

Ƭ RequestProviderConfig: Object

Type declaration

NameType
configHeaders?RequestHeaders
keystring
maxBodyLengthnumber
proxy?ClientProxyConfig
timeout?number
useFetch?boolean
usernamestring

Defined in

Types/Common/RequestProvider.ts:13

RequestProviderData

Ƭ RequestProviderData: Object

Type declaration

NameType
data?RequestData
params?URLSearchParams

Defined in

Types/Common/RequestProvider.ts:23

ResponseWithPaging

Ƭ ResponseWithPaging: Object

Type declaration

NameType
body{ paging: PagesList }
body.pagingPagesList

Defined in

Types/Common/NavigationThruPages.ts:26

ResponseWithSigninKey

Ƭ ResponseWithSigninKey: MessageResponseWithStatus & { http_signing_key: string }

Defined in

Types/AccountManagement/AccountManagement.ts:28

Route

Ƭ Route: Object

Type declaration

NameType
actionsstring[]
created_atstring
descriptionstring
expressionstring
idstring
prioritynumber

Defined in

Types/Routes/Routes.ts:2

RoutesListQuery

Ƭ RoutesListQuery: Object

Type declaration

NameType
limit?number
skip?number

Defined in

Types/Routes/Routes.ts:27

RoutesMatchQuery

Ƭ RoutesMatchQuery: Object

Type declaration

NameType
address?string

Defined in

Types/Routes/Routes.ts:32

SendingLimitResult

Ƭ SendingLimitResult: Object

Type declaration

NameType
currentnumber
limitnumber
periodstring

Defined in

Types/CustomMessageLimit/CustomMessageLimitClient.ts:1

ShortTemplateVersion

Ƭ ShortTemplateVersion: Object

Type declaration

NameType
activeboolean
commentstring
createdAtstring | Date
enginestring
idstring
mjmlstring
tagstring

Defined in

Types/Domains/DomainTemplates.ts:56

StartValidationResult

Ƭ StartValidationResult: Object

Type declaration

NameType
idstring
messagestring
statusnumber

Defined in

Types/MailingLists/MailingLists.ts:28

Stat

Ƭ Stat: Object

Type declaration

NameType
delivered{ http: number ; smtp: number ; total: number }
delivered.httpnumber
delivered.smtpnumber
delivered.totalnumber
timestring | Date

Defined in

Types/Stats/Stats.ts:1

StatsEvent

Ƭ StatsEvent: "accepted" | "delivered" | "opened" | "clicked" | "unsubscribed" | "stored" | "complained" | "failed"

Defined in

Types/Stats/Stats.ts:17

StatsOptions

Ƭ StatsOptions: Object

Type declaration

NameType
endstring | Date
resolutionstring
startstring | Date
statsStat[]

Defined in

Types/Stats/Stats.ts:10

StatsQuery

Ƭ StatsQuery: Object

Type declaration

NameType
duration?string
end?string | Date
eventStatsEvent | StatsEvent[]
resolution?"hour" | "day" | "month"
start?string | Date

Defined in

Types/Stats/Stats.ts:19

StoredEmailResponse

Ƭ StoredEmailResponse: Object

Type declaration

NameType
Content-Transfer-Encoding?string
Content-Typestring
Fromstring
Message-Idstring
Mime-Versionstring
Subjectstring
Tostring
X-Mailgun-Deliver-By?string
X-Mailgun-Tag?string
X-Mailgun-Template-Name?string
X-Mailgun-Template-Variables?string
attachments?[{ content-type: string ; name: string ; size: number ; url: string }]
body-htmlstring
body-plainstring
content-id-map?object
from?string
message-headersMessageHeader[]
recipientsstring
senderstring
stripped-htmlstring
stripped-signaturestring
stripped-textstring
subject?string

Defined in

Types/Messages/Messages.ts:262

StreamValue

Ƭ StreamValue: Object

Type declaration

NameType
pipeNodePipeFunction | BrowserPipeFunction

Defined in

Types/Common/Attachments.ts:4

SubaccountAPIResponseData

Ƭ SubaccountAPIResponseData: Object

Type declaration

NameType
body{ subaccount: SubaccountApiItem }
body.subaccountSubaccountApiItem

Defined in

Types/Subaccounts/Subaccounts.ts:60

SubaccountApiItem

Ƭ SubaccountApiItem: Object

Type declaration

NameType
created_atstring
featuresSubaccountFeatures
idstring
namestring
statusstring
updated_atstring

Defined in

Types/Subaccounts/Subaccounts.ts:33

SubaccountDestroyResponse

Ƭ SubaccountDestroyResponse: Object

Type declaration

NameType
messagestring

Defined in

Types/Subaccounts/Subaccounts.ts:80

SubaccountFeatureValue

Ƭ SubaccountFeatureValue: Object

Type declaration

NameType
enabledboolean

Defined in

Types/Subaccounts/Subaccounts.ts:9

SubaccountFeatures

Ƭ SubaccountFeatures: Object

Type declaration

NameType
email_preview?SubaccountFeatureValue
inbox_placement?SubaccountFeatureValue
sending?SubaccountFeatureValue
validations?SubaccountFeatureValue
validations_bulk?SubaccountFeatureValue

Defined in

Types/Subaccounts/Subaccounts.ts:13

SubaccountFeaturesData

Ƭ SubaccountFeaturesData: Object

Type declaration

NameType
email_preview?boolean
inbox_placement?boolean
sending?boolean
validations?boolean
validations_bulk?boolean

Defined in

Types/Subaccounts/Subaccounts.ts:25

SubaccountFeaturesResult

Ƭ SubaccountFeaturesResult: Object

Type declaration

NameType
featuresSubaccountFeatures

Defined in

Types/Subaccounts/Subaccounts.ts:21

SubaccountItem

Ƭ SubaccountItem: Omit<SubaccountApiItem, "created_at" | "updated_at"> & { created_at: Date ; updated_at: Date }

Defined in

Types/Subaccounts/Subaccounts.ts:42

SubaccountListAPIResponseData

Ƭ SubaccountListAPIResponseData: Object

Type declaration

NameType
body{ subaccounts: SubaccountApiItem[] ; total: number }
body.subaccountsSubaccountApiItem[]
body.totalnumber

Defined in

Types/Subaccounts/Subaccounts.ts:48

SubaccountListResponseData

Ƭ SubaccountListResponseData: Object

Type declaration

NameType
subaccountsSubaccountItem[]
totalnumber

Defined in

Types/Subaccounts/Subaccounts.ts:55

SubaccountResponseData

Ƭ SubaccountResponseData: Object

Type declaration

NameType
subaccountSubaccountItem

Defined in

Types/Subaccounts/Subaccounts.ts:66

SubaccountSendingLimitResponse

Ƭ SubaccountSendingLimitResponse: Object

Type declaration

NameType
currentnumber
limitnumber
periodstring

Defined in

Types/Subaccounts/Subaccounts.ts:70

SubaccountSetSendingLimitResponse

Ƭ SubaccountSetSendingLimitResponse: Object

Type declaration

NameType
successboolean

Defined in

Types/Subaccounts/Subaccounts.ts:76

SubaccountsQuery

Ƭ SubaccountsQuery: Object

Type declaration

NameType
enabled?boolean
limit?number
skip?number
sort?"asc" | "desc"

Defined in

Types/Subaccounts/Subaccounts.ts:2

SuccessResult

Ƭ SuccessResult: Object

Type declaration

NameType
successboolean

Defined in

Types/CustomMessageLimit/CustomMessageLimitClient.ts:7

SuppressionCreationData

Ƭ SuppressionCreationData: Object

Type declaration

NameType
addressstring
code?number
created_at?string
domain?string
error?string
tag?string
tags?string[]

Defined in

Types/Suppressions/Suppressions.ts:65

SuppressionCreationResponse

Ƭ SuppressionCreationResponse: Object

Type declaration

NameType
body{ message: string ; type?: string ; value?: string }
body.messagestring
body.type?string
body.value?string
statusnumber

Defined in

Types/Suppressions/Suppressions.ts:75

SuppressionCreationResult

Ƭ SuppressionCreationResult: Object

Type declaration

NameType
messagestring
statusnumber
typestring
valuestring

Defined in

Types/Suppressions/Suppressions.ts:84

SuppressionDataType

Ƭ SuppressionDataType: BounceData | ComplaintData | UnsubscribeData | WhiteListData

Defined in

Types/Suppressions/Suppressions.ts:27

SuppressionDestroyAllResponse

Ƭ SuppressionDestroyAllResponse: Object

Type declaration

NameType
body{ message: string }
body.messagestring
statusnumber

Defined in

Types/Suppressions/Suppressions.ts:58

SuppressionDestroyResponse

Ƭ SuppressionDestroyResponse: Object

Type declaration

NameType
body{ address?: string ; message: string ; value?: string }
body.address?string
body.messagestring
body.value?string
statusnumber

Defined in

Types/Suppressions/Suppressions.ts:42

SuppressionDestroyResult

Ƭ SuppressionDestroyResult: Object

Type declaration

NameType
addressstring
messagestring
statusnumber
valuestring

Defined in

Types/Suppressions/Suppressions.ts:51

SuppressionList

Ƭ SuppressionList: Object

Type declaration

NameType
items(IBounce | IComplaint | IUnsubscribe | IWhiteList)[]
pagesParsedPagesList
statusnumber

Defined in

Types/Suppressions/Suppressions.ts:16

SuppressionListQuery

Ƭ SuppressionListQuery: Object

Type declaration

NameType
limit?number
page?string

Defined in

Types/Suppressions/Suppressions.ts:22

SuppressionListResponse

Ƭ SuppressionListResponse: Object

Type declaration

NameType
body{ items: BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[] ; paging: PagesList }
body.itemsBounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[]
body.pagingPagesList
statusnumber

Defined in

Types/Suppressions/Suppressions.ts:29

SuppressionModelNames

Ƭ SuppressionModelNames: "bounces" | "complaints" | "unsubscribes" | "whitelists"

Defined in

Types/Suppressions/Suppressions.ts:96

SuppressionResponse

Ƭ SuppressionResponse: Object

Type declaration

NameType
bodySuppressionDataType
statusnumber

Defined in

Types/Suppressions/Suppressions.ts:37

SuppressionUploadData

Ƭ SuppressionUploadData: CustomFileData | CustomFile

Defined in

Types/Suppressions/Suppressions.ts:91

SuppressionUploadDataUpdated

Ƭ SuppressionUploadDataUpdated: Object

Type declaration

NameType
suppressionUploadFileSuppressionUploadData

Defined in

Types/Suppressions/Suppressions.ts:92

TDomain

Ƭ TDomain: Object

Type declaration

NameType
created_atDate
dkim_host?string
idstring
is_disabledboolean
mailfrom_host?string
message?string
namestring
receiving_dns_recordsDNSRecord[] | null
require_tlsboolean
sending_dns_recordsDNSRecord[] | null
skip_verificationboolean
smtp_loginstring
smtp_passwordstring
spam_actionstring
statestring
typestring
use_automatic_sender_securityboolean
web_prefixstring
web_schemestring
wildcardboolean

Defined in

Types/Domains/Domains.ts:175

TagDeleteData

Ƭ TagDeleteData: Omit<TagsUpdateData, "description">

Defined in

Types/Tags/Tags.ts:83

TagItem

Ƭ TagItem: Object

Type declaration

NameType
account_idstring
account_namestring
descriptionstring
first_seenDate
last_seenDate
metricsTagMetrics
parent_account_idstring
tagstring

Defined in

Types/Tags/Tags.ts:42

TagItemAPI

Ƭ TagItemAPI: Omit<TagItem, "first_seen" | "last_seen"> & { first_seen: string ; last_seen: string }

Defined in

Types/Tags/Tags.ts:53

TagLimitsResult

Ƭ TagLimitsResult: Object

Type declaration

NameType
countnumber
limitnumber
limit_reachedboolean

Defined in

Types/Tags/Tags.ts:72

TagMetrics

Ƭ TagMetrics: Partial<Metrics> & Partial<{ accessibility_count: number ; accessibility_failed_count: number ; email_preview_count: number ; email_preview_failed_count: number ; email_validation_bulk_count: number ; email_validation_count: number ; email_validation_list_count: number ; email_validation_mailgun_count: number ; email_validation_mailjet_count: number ; email_validation_public_count: number ; email_validation_single_count: number ; email_validation_valid_count: number ; hard_bounce_rate: string ; image_validation_count: number ; image_validation_failed_count: number ; link_validation_count: number ; link_validation_failed_count: number ; permanent_failed_esp_block_count: number ; seed_test_count: number ; soft_bounce_rate: string ; temporary_failed_esp_block_count: number }>

Defined in

Types/Tags/Tags.ts:18

TagsListPagination

Ƭ TagsListPagination: Object

Type declaration

NameType
include_total?boolean
limit?number
skip?number
sort?string
total?number

Defined in

Types/Tags/Tags.ts:3

TagsListQuery

Ƭ TagsListQuery: Object

Type declaration

NameType
include_metrics?boolean
include_subaccounts?boolean
pagination?TagsListPagination
tag?string

Defined in

Types/Tags/Tags.ts:11

TagsListResponse

Ƭ TagsListResponse: Object

Type declaration

NameType
itemsTagItemAPI[]
paginationPaginationInResponse

Defined in

Types/Tags/Tags.ts:67

TagsListResult

Ƭ TagsListResult: Object

Type declaration

NameType
itemsTagItem[]
paginationPaginationInResponse

Defined in

Types/Tags/Tags.ts:62

TagsUpdateData

Ƭ TagsUpdateData: Object

Type declaration

NameType
descriptionstring
tagstring

Defined in

Types/Tags/Tags.ts:78

TemplateQuery

Ƭ TemplateQuery: Object

Type declaration

NameType
activeYesNo

Defined in

Types/Domains/DomainTemplates.ts:52

TemplateVersion

Ƭ TemplateVersion: ShortTemplateVersion & { headers?: DomainTemplateAllowedHeaders ; template: string }

Defined in

Types/Domains/DomainTemplates.ts:66

UnsubscribeData

Ƭ UnsubscribeData: Object

Type declaration

NameType
addressstring
created_atstring | Date
tagsstring[]

Defined in

Types/Suppressions/Unsubscribe.ts:2

UnsubscribeTrackingInfo

Ƭ UnsubscribeTrackingInfo: Object

Type declaration

NameType
active?"yes" | "no" | "true" | "false" | boolean
html_footer?string
text_footer?string

Defined in

Types/Domains/DomainTracking.ts:44

UpdateDomainCredentialsData

Ƭ UpdateDomainCredentialsData: Object

Type declaration

NameType
passwordstring

Defined in

Types/Domains/DomainCredentials.ts:53

UpdateDomainTrackingResponse

Ƭ UpdateDomainTrackingResponse: Object

Type declaration

NameType
bodyUpdatedOpenTracking
statusnumber

Defined in

Types/Domains/DomainTracking.ts:31

UpdateOrDeleteDomainTemplateAPIResponse

Ƭ UpdateOrDeleteDomainTemplateAPIResponse: Object

Type declaration

NameType
body{ message: string ; template: { name: string } }
body.messagestring
body.template{ name: string }
body.template.namestring
statusnumber

Defined in

Types/Domains/DomainTemplates.ts:105

UpdateOrDeleteDomainTemplateResult

Ƭ UpdateOrDeleteDomainTemplateResult: Object

Type declaration

NameType
messagestring
statusnumber
templateName?string

Defined in

Types/Domains/DomainTemplates.ts:115

UpdateRouteResponse

Ƭ UpdateRouteResponse: Route & { message: string }

Defined in

Types/Routes/Routes.ts:11

UpdatedConnectionSettings

Ƭ UpdatedConnectionSettings: Object

Type declaration

NameType
messagestring
require_tlsboolean
skip_verificationboolean

Defined in

Types/Domains/Domains.ts:119

UpdatedConnectionSettingsRes

Ƭ UpdatedConnectionSettingsRes: Object

Type declaration

NameType
bodyUpdatedConnectionSettings
statusnumber

Defined in

Types/Domains/Domains.ts:125

UpdatedDKIMAuthority

Ƭ UpdatedDKIMAuthority: Object

Type declaration

NameType
changedboolean
messagestring
sending_dns_recordsDNSRecord[]

Defined in

Types/Domains/Domains.ts:134

UpdatedDKIMAuthorityResponse

Ƭ UpdatedDKIMAuthorityResponse: Object

Type declaration

NameType
bodyUpdatedDKIMAuthority
statusnumber

Defined in

Types/Domains/Domains.ts:140

UpdatedDKIMSelectorResponse

Ƭ UpdatedDKIMSelectorResponse: Object

Type declaration

NameType
bodyMessageResponse
statusnumber

Defined in

Types/Domains/Domains.ts:149

UpdatedDKIMSelectorResult

Ƭ UpdatedDKIMSelectorResult: MessageResponse & { status: number }

Defined in

Types/Domains/Domains.ts:154

UpdatedOpenTracking

Ƭ UpdatedOpenTracking: Object

Type declaration

NameType
click?{ active: boolean | "htmlonly" }
click.activeboolean | "htmlonly"
messagestring
open?{ active: boolean }
open.activeboolean
unsubscribe?{ active: boolean ; html_footer: string ; text_footer: string }
unsubscribe.activeboolean
unsubscribe.html_footerstring
unsubscribe.text_footerstring

Defined in

Types/Domains/DomainTracking.ts:20

UpdatedUrlAndQuery

Ƭ UpdatedUrlAndQuery: Object

Type declaration

NameType
updatedQueryRecord<string, unknown>
urlstring

Defined in

Types/Common/NavigationThruPages.ts:36

UpdatedWebPrefix

Ƭ UpdatedWebPrefix: Object

Type declaration

NameType
messagestring

Defined in

Types/Domains/Domains.ts:162

UpdatedWebPrefixResponse

Ƭ UpdatedWebPrefixResponse: Object

Type declaration

NameType
bodyMessageResponse
statusnumber

Defined in

Types/Domains/Domains.ts:165

ValidationQuery

Ƭ ValidationQuery: Object

Type declaration

NameType
addressstring

Defined in

Types/Validations/Validation.ts:3

ValidationResponse

Ƭ ValidationResponse: Object

Type declaration

NameType
bodyValidationResult
statusnumber

Defined in

Types/Validations/Validation.ts:15

ValidationResult

Ƭ ValidationResult: Object

Type declaration

NameType
addressstring
is_disposable_addressboolean
is_role_addressboolean
reasonstring[]
resultstring
riskstring

Defined in

Types/Validations/Validation.ts:6

WebPrefixInfo

Ƭ WebPrefixInfo: Object

Type declaration

NameType
webPrefixstring

Defined in

Types/Domains/Domains.ts:158

WebhookList

Ƭ WebhookList: Object

Index signature

▪ [id: string]: { urls: string[] }

Defined in

Types/Webhooks/Webhooks.ts:16

WebhookResponse

Ƭ WebhookResponse: Object

Type declaration

NameType
bodyWebhookResponseBody
statusnumber

Defined in

Types/Webhooks/Webhooks.ts:11

WebhookResponseBody

Ƭ WebhookResponseBody: Object

Type declaration

NameType
messagestring
webhookAPIWebhook

Defined in

Types/Webhooks/Webhooks.ts:6

WebhookResult

Ƭ WebhookResult: Object

Type declaration

NameTypeDescription
idstring-
urlstring | undefinedDeprecated url property is deprecated. Use "urls" instead.
urlsstring[]-

Defined in

Types/Webhooks/Webhooks.ts:32

WebhookValidationResponse

Ƭ WebhookValidationResponse: Object

Type declaration

NameType
codenumber
messagestring

Defined in

Types/Webhooks/Webhooks.ts:27

WebhooksQuery

Ƭ WebhooksQuery: Object

Type declaration

NameType
limit?number
skip?number

Defined in

Types/Webhooks/Webhooks.ts:22

WhiteListData

Ƭ WhiteListData: Object

Type declaration

NameType
createdAtstring | Date
reasonstring
typestring
valuestring

Defined in

Types/Suppressions/WhiteList.ts:1

onCallReqConfig

Ƭ onCallReqConfig: Object

Type declaration

NameType
dataSize?number
isApplicationJSON?boolean
isFormURLEncoded?boolean
isMultipartFormData?boolean
isStorageAPI?boolean

Defined in

Types/Common/RequestOptions.ts:117