Class ToolsControllerApi

Hierarchy

BaseAPI
- ToolsControllerApi

Index

Constructors

Properties

Methods

analyzeDmarcReport analyzeDmarcReportRaw analyzeEmailHeaders analyzeEmailHeadersRaw checkCampaignProbe checkCampaignProbeRaw checkDnsPropagation checkDnsPropagationRaw checkDomainMonitor checkDomainMonitorRaw checkEmailAudit checkEmailAuditRaw checkEmailAuthStack checkEmailAuthStackRaw checkEmailBlacklist checkEmailBlacklistRaw checkEmailFeaturesClientSupport checkEmailFeaturesClientSupportRaw createNewFakeEmailAddress createNewFakeEmailAddressRaw deleteNewFakeEmailAddress deleteNewFakeEmailAddressRaw generateBimiRecord generateBimiRecordRaw generateDmarcRecord generateDmarcRecordRaw generateMtaStsRecord generateMtaStsRecordRaw generateSpfRecord generateSpfRecordRaw generateTlsReportingRecord generateTlsReportingRecordRaw getFakeEmailByEmailAddress getFakeEmailByEmailAddressRaw getFakeEmailById getFakeEmailByIdRaw getFakeEmailRaw getFakeEmailRawRaw getFakeEmailsForAddress getFakeEmailsForAddressRaw lookupBimiDomain lookupBimiDomainRaw lookupDkimDomain lookupDkimDomainRaw lookupDmarcDomain lookupDmarcDomainRaw lookupMtaStsDomain lookupMtaStsDomainRaw lookupMxRecord lookupMxRecordRaw lookupPtr lookupPtrRaw lookupSpfDomain lookupSpfDomainRaw lookupTlsReportingDomain lookupTlsReportingDomainRaw request testSmtpServer testSmtpServerRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new ToolsControllerApi(configuration?: Configuration): ToolsControllerApi
Parameters
- configuration: Configuration = ...
Returns ToolsControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

analyzeDmarcReport

analyzeDmarcReport(requestParameters: AnalyzeDmarcReportRequest, initOverrides?: RequestInit): Promise<AnalyzeDmarcReportResults>
Parse and summarize a DMARC aggregate XML report
Parameters
- requestParameters: AnalyzeDmarcReportRequest
- Optional initOverrides: RequestInit
Returns Promise<AnalyzeDmarcReportResults>

analyzeDmarcReportRaw

analyzeDmarcReportRaw(requestParameters: AnalyzeDmarcReportRequest, initOverrides?: RequestInit): Promise<ApiResponse<AnalyzeDmarcReportResults>>
Parse and summarize a DMARC aggregate XML report
Parameters
- requestParameters: AnalyzeDmarcReportRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AnalyzeDmarcReportResults>>

analyzeEmailHeaders

analyzeEmailHeaders(requestParameters: AnalyzeEmailHeadersRequest, initOverrides?: RequestInit): Promise<AnalyzeEmailHeadersResults>
Analyze email headers for auth results and delivery path
Parameters
- requestParameters: AnalyzeEmailHeadersRequest
- Optional initOverrides: RequestInit
Returns Promise<AnalyzeEmailHeadersResults>

analyzeEmailHeadersRaw

analyzeEmailHeadersRaw(requestParameters: AnalyzeEmailHeadersRequest, initOverrides?: RequestInit): Promise<ApiResponse<AnalyzeEmailHeadersResults>>
Analyze email headers for auth results and delivery path
Parameters
- requestParameters: AnalyzeEmailHeadersRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AnalyzeEmailHeadersResults>>

checkCampaignProbe

checkCampaignProbe(requestParameters: CheckCampaignProbeRequest, initOverrides?: RequestInit): Promise<CheckCampaignProbeResults>
Run a one-shot free campaign probe preflight check
Parameters
- requestParameters: CheckCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<CheckCampaignProbeResults>

checkCampaignProbeRaw

checkCampaignProbeRaw(requestParameters: CheckCampaignProbeRequest, initOverrides?: RequestInit): Promise<ApiResponse<CheckCampaignProbeResults>>
Run a one-shot free campaign probe preflight check
Parameters
- requestParameters: CheckCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CheckCampaignProbeResults>>

checkDnsPropagation

checkDnsPropagation(requestParameters: CheckDnsPropagationRequest, initOverrides?: RequestInit): Promise<CheckDnsPropagationResults>
Check DNS propagation for a host and record type across configured resolvers
Parameters
- requestParameters: CheckDnsPropagationRequest
- Optional initOverrides: RequestInit
Returns Promise<CheckDnsPropagationResults>

checkDnsPropagationRaw

checkDnsPropagationRaw(requestParameters: CheckDnsPropagationRequest, initOverrides?: RequestInit): Promise<ApiResponse<CheckDnsPropagationResults>>
Check DNS propagation for a host and record type across configured resolvers
Parameters
- requestParameters: CheckDnsPropagationRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CheckDnsPropagationResults>>

checkDomainMonitor

checkDomainMonitor(requestParameters: CheckDomainMonitorRequest, initOverrides?: RequestInit): Promise<CheckDomainMonitorResults>
Run a one-shot free domain monitor posture check
Parameters
- requestParameters: CheckDomainMonitorRequest
- Optional initOverrides: RequestInit
Returns Promise<CheckDomainMonitorResults>

checkDomainMonitorRaw

checkDomainMonitorRaw(requestParameters: CheckDomainMonitorRequest, initOverrides?: RequestInit): Promise<ApiResponse<CheckDomainMonitorResults>>
Run a one-shot free domain monitor posture check
Parameters
- requestParameters: CheckDomainMonitorRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CheckDomainMonitorResults>>

checkEmailAudit

checkEmailAudit(requestParameters: CheckEmailAuditRequest, initOverrides?: RequestInit): Promise<EmailAuditAnalysisResult>
Run a one-shot free email audit across links, images, HTML, and client support
Parameters
- requestParameters: CheckEmailAuditRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailAuditAnalysisResult>

checkEmailAuditRaw

checkEmailAuditRaw(requestParameters: CheckEmailAuditRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailAuditAnalysisResult>>
Run a one-shot free email audit across links, images, HTML, and client support
Parameters
- requestParameters: CheckEmailAuditRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailAuditAnalysisResult>>

checkEmailAuthStack

checkEmailAuthStack(requestParameters: CheckEmailAuthStackRequest, initOverrides?: RequestInit): Promise<CheckEmailAuthStackResults>
Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check
Parameters
- requestParameters: CheckEmailAuthStackRequest
- Optional initOverrides: RequestInit
Returns Promise<CheckEmailAuthStackResults>

checkEmailAuthStackRaw

checkEmailAuthStackRaw(requestParameters: CheckEmailAuthStackRequest, initOverrides?: RequestInit): Promise<ApiResponse<CheckEmailAuthStackResults>>
Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check
Parameters
- requestParameters: CheckEmailAuthStackRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CheckEmailAuthStackResults>>

checkEmailBlacklist

checkEmailBlacklist(requestParameters: CheckEmailBlacklistRequest, initOverrides?: RequestInit): Promise<CheckEmailBlacklistResults>
Check whether a domain or IP appears on configured DNS blacklists
Parameters
- requestParameters: CheckEmailBlacklistRequest
- Optional initOverrides: RequestInit
Returns Promise<CheckEmailBlacklistResults>

checkEmailBlacklistRaw

checkEmailBlacklistRaw(requestParameters: CheckEmailBlacklistRequest, initOverrides?: RequestInit): Promise<ApiResponse<CheckEmailBlacklistResults>>
Check whether a domain or IP appears on configured DNS blacklists
Parameters
- requestParameters: CheckEmailBlacklistRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CheckEmailBlacklistResults>>

checkEmailFeaturesClientSupport

checkEmailFeaturesClientSupport(requestParameters: CheckEmailFeaturesClientSupportRequest, initOverrides?: RequestInit): Promise<CheckEmailFeaturesClientSupportResults>
Check email client support for email HTML and CSS features
Parameters
- requestParameters: CheckEmailFeaturesClientSupportRequest
- Optional initOverrides: RequestInit
Returns Promise<CheckEmailFeaturesClientSupportResults>

checkEmailFeaturesClientSupportRaw

checkEmailFeaturesClientSupportRaw(requestParameters: CheckEmailFeaturesClientSupportRequest, initOverrides?: RequestInit): Promise<ApiResponse<CheckEmailFeaturesClientSupportResults>>
Check email client support for email HTML and CSS features
Parameters
- requestParameters: CheckEmailFeaturesClientSupportRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CheckEmailFeaturesClientSupportResults>>

createNewFakeEmailAddress

createNewFakeEmailAddress(initOverrides?: RequestInit): Promise<NewFakeEmailAddressResult>
Create a new email address using the fake email domains
Parameters
- Optional initOverrides: RequestInit
Returns Promise<NewFakeEmailAddressResult>

createNewFakeEmailAddressRaw

createNewFakeEmailAddressRaw(initOverrides?: RequestInit): Promise<ApiResponse<NewFakeEmailAddressResult>>
Create a new email address using the fake email domains
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<NewFakeEmailAddressResult>>

deleteNewFakeEmailAddress

deleteNewFakeEmailAddress(requestParameters: DeleteNewFakeEmailAddressRequest, initOverrides?: RequestInit): Promise<void>
Delete a fake email address using the fake email domains Delete a fake email address using the fake email domains
Parameters
- requestParameters: DeleteNewFakeEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteNewFakeEmailAddressRaw

deleteNewFakeEmailAddressRaw(requestParameters: DeleteNewFakeEmailAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete a fake email address using the fake email domains Delete a fake email address using the fake email domains
Parameters
- requestParameters: DeleteNewFakeEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

generateBimiRecord

generateBimiRecord(requestParameters: GenerateBimiRecordRequest, initOverrides?: RequestInit): Promise<GenerateBimiRecordResults>
Create a BIMI record policy
Parameters
- requestParameters: GenerateBimiRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<GenerateBimiRecordResults>

generateBimiRecordRaw

generateBimiRecordRaw(requestParameters: GenerateBimiRecordRequest, initOverrides?: RequestInit): Promise<ApiResponse<GenerateBimiRecordResults>>
Create a BIMI record policy
Parameters
- requestParameters: GenerateBimiRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GenerateBimiRecordResults>>

generateDmarcRecord

generateDmarcRecord(requestParameters: GenerateDmarcRecordRequest, initOverrides?: RequestInit): Promise<GenerateDmarcRecordResults>
Create a DMARC record policy
Parameters
- requestParameters: GenerateDmarcRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<GenerateDmarcRecordResults>

generateDmarcRecordRaw

generateDmarcRecordRaw(requestParameters: GenerateDmarcRecordRequest, initOverrides?: RequestInit): Promise<ApiResponse<GenerateDmarcRecordResults>>
Create a DMARC record policy
Parameters
- requestParameters: GenerateDmarcRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GenerateDmarcRecordResults>>

generateMtaStsRecord

generateMtaStsRecord(requestParameters: GenerateMtaStsRecordRequest, initOverrides?: RequestInit): Promise<GenerateMtaStsRecordResults>
Create a TLS reporting record policy
Parameters
- requestParameters: GenerateMtaStsRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<GenerateMtaStsRecordResults>

generateMtaStsRecordRaw

generateMtaStsRecordRaw(requestParameters: GenerateMtaStsRecordRequest, initOverrides?: RequestInit): Promise<ApiResponse<GenerateMtaStsRecordResults>>
Create a TLS reporting record policy
Parameters
- requestParameters: GenerateMtaStsRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GenerateMtaStsRecordResults>>

generateSpfRecord

generateSpfRecord(requestParameters: GenerateSpfRecordRequest, initOverrides?: RequestInit): Promise<GenerateSpfRecordResults>
Create an SPF record
Parameters
- requestParameters: GenerateSpfRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<GenerateSpfRecordResults>

generateSpfRecordRaw

generateSpfRecordRaw(requestParameters: GenerateSpfRecordRequest, initOverrides?: RequestInit): Promise<ApiResponse<GenerateSpfRecordResults>>
Create an SPF record
Parameters
- requestParameters: GenerateSpfRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GenerateSpfRecordResults>>

generateTlsReportingRecord

generateTlsReportingRecord(requestParameters: GenerateTlsReportingRecordRequest, initOverrides?: RequestInit): Promise<GenerateTlsReportingRecordResults>
Create a TLS reporting record policy
Parameters
- requestParameters: GenerateTlsReportingRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<GenerateTlsReportingRecordResults>

generateTlsReportingRecordRaw

generateTlsReportingRecordRaw(requestParameters: GenerateTlsReportingRecordRequest, initOverrides?: RequestInit): Promise<ApiResponse<GenerateTlsReportingRecordResults>>
Create a TLS reporting record policy
Parameters
- requestParameters: GenerateTlsReportingRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<GenerateTlsReportingRecordResults>>

getFakeEmailByEmailAddress

getFakeEmailByEmailAddress(requestParameters: GetFakeEmailByEmailAddressRequest, initOverrides?: RequestInit): Promise<FakeEmailResult>
Parameters
- requestParameters: GetFakeEmailByEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<FakeEmailResult>

getFakeEmailByEmailAddressRaw

getFakeEmailByEmailAddressRaw(requestParameters: GetFakeEmailByEmailAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<FakeEmailResult>>
Parameters
- requestParameters: GetFakeEmailByEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<FakeEmailResult>>

getFakeEmailById

getFakeEmailById(requestParameters: GetFakeEmailByIdRequest, initOverrides?: RequestInit): Promise<FakeEmailResult>
Get a fake email by its ID Get a fake email by its ID
Parameters
- requestParameters: GetFakeEmailByIdRequest
- Optional initOverrides: RequestInit
Returns Promise<FakeEmailResult>

getFakeEmailByIdRaw

getFakeEmailByIdRaw(requestParameters: GetFakeEmailByIdRequest, initOverrides?: RequestInit): Promise<ApiResponse<FakeEmailResult>>
Get a fake email by its ID Get a fake email by its ID
Parameters
- requestParameters: GetFakeEmailByIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<FakeEmailResult>>

getFakeEmailRaw

getFakeEmailRaw(requestParameters: GetFakeEmailRawRequest, initOverrides?: RequestInit): Promise<string>
Retrieve the raw content of a fake email by its ID Get raw fake email content
Parameters
- requestParameters: GetFakeEmailRawRequest
- Optional initOverrides: RequestInit
Returns Promise<string>

getFakeEmailRawRaw

getFakeEmailRawRaw(requestParameters: GetFakeEmailRawRequest, initOverrides?: RequestInit): Promise<ApiResponse<string>>
Retrieve the raw content of a fake email by its ID Get raw fake email content
Parameters
- requestParameters: GetFakeEmailRawRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>

getFakeEmailsForAddress

getFakeEmailsForAddress(requestParameters: GetFakeEmailsForAddressRequest, initOverrides?: RequestInit): Promise<FakeEmailPreview[]>
Get fake emails for an address Get fake emails for an address
Parameters
- requestParameters: GetFakeEmailsForAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<FakeEmailPreview[]>

getFakeEmailsForAddressRaw

getFakeEmailsForAddressRaw(requestParameters: GetFakeEmailsForAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<FakeEmailPreview[]>>
Get fake emails for an address Get fake emails for an address
Parameters
- requestParameters: GetFakeEmailsForAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<FakeEmailPreview[]>>

lookupBimiDomain

lookupBimiDomain(requestParameters: LookupBimiDomainRequest, initOverrides?: RequestInit): Promise<LookupBimiDomainResults>
Lookup a BIMI record policy
Parameters
- requestParameters: LookupBimiDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<LookupBimiDomainResults>

lookupBimiDomainRaw

lookupBimiDomainRaw(requestParameters: LookupBimiDomainRequest, initOverrides?: RequestInit): Promise<ApiResponse<LookupBimiDomainResults>>
Lookup a BIMI record policy
Parameters
- requestParameters: LookupBimiDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LookupBimiDomainResults>>

lookupDkimDomain

lookupDkimDomain(requestParameters: LookupDkimDomainRequest, initOverrides?: RequestInit): Promise<LookupDkimDomainResults>
Lookup and validate a DKIM record
Parameters
- requestParameters: LookupDkimDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<LookupDkimDomainResults>

lookupDkimDomainRaw

lookupDkimDomainRaw(requestParameters: LookupDkimDomainRequest, initOverrides?: RequestInit): Promise<ApiResponse<LookupDkimDomainResults>>
Lookup and validate a DKIM record
Parameters
- requestParameters: LookupDkimDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LookupDkimDomainResults>>

lookupDmarcDomain

lookupDmarcDomain(requestParameters: LookupDmarcDomainRequest, initOverrides?: RequestInit): Promise<LookupDmarcDomainResults>
Lookup a DMARC record policy
Parameters
- requestParameters: LookupDmarcDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<LookupDmarcDomainResults>

lookupDmarcDomainRaw

lookupDmarcDomainRaw(requestParameters: LookupDmarcDomainRequest, initOverrides?: RequestInit): Promise<ApiResponse<LookupDmarcDomainResults>>
Lookup a DMARC record policy
Parameters
- requestParameters: LookupDmarcDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LookupDmarcDomainResults>>

lookupMtaStsDomain

lookupMtaStsDomain(requestParameters: LookupMtaStsDomainRequest, initOverrides?: RequestInit): Promise<LookupMtaStsDomainResults>
Lookup a MTA-STS domain policy
Parameters
- requestParameters: LookupMtaStsDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<LookupMtaStsDomainResults>

lookupMtaStsDomainRaw

lookupMtaStsDomainRaw(requestParameters: LookupMtaStsDomainRequest, initOverrides?: RequestInit): Promise<ApiResponse<LookupMtaStsDomainResults>>
Lookup a MTA-STS domain policy
Parameters
- requestParameters: LookupMtaStsDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LookupMtaStsDomainResults>>

lookupMxRecord

lookupMxRecord(requestParameters: LookupMxRecordRequest, initOverrides?: RequestInit): Promise<LookupMxRecordsResults>
Lookup a MX records for a domain
Parameters
- requestParameters: LookupMxRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<LookupMxRecordsResults>

lookupMxRecordRaw

lookupMxRecordRaw(requestParameters: LookupMxRecordRequest, initOverrides?: RequestInit): Promise<ApiResponse<LookupMxRecordsResults>>
Lookup a MX records for a domain
Parameters
- requestParameters: LookupMxRecordRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LookupMxRecordsResults>>

lookupPtr

lookupPtr(requestParameters: LookupPtrRequest, initOverrides?: RequestInit): Promise<LookupPtrResults>
Lookup PTR records for an IP address
Parameters
- requestParameters: LookupPtrRequest
- Optional initOverrides: RequestInit
Returns Promise<LookupPtrResults>

lookupPtrRaw

lookupPtrRaw(requestParameters: LookupPtrRequest, initOverrides?: RequestInit): Promise<ApiResponse<LookupPtrResults>>
Lookup PTR records for an IP address
Parameters
- requestParameters: LookupPtrRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LookupPtrResults>>

lookupSpfDomain

lookupSpfDomain(requestParameters: LookupSpfDomainRequest, initOverrides?: RequestInit): Promise<LookupSpfDomainResults>
Lookup and validate an SPF record
Parameters
- requestParameters: LookupSpfDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<LookupSpfDomainResults>

lookupSpfDomainRaw

lookupSpfDomainRaw(requestParameters: LookupSpfDomainRequest, initOverrides?: RequestInit): Promise<ApiResponse<LookupSpfDomainResults>>
Lookup and validate an SPF record
Parameters
- requestParameters: LookupSpfDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LookupSpfDomainResults>>

lookupTlsReportingDomain

lookupTlsReportingDomain(requestParameters: LookupTlsReportingDomainRequest, initOverrides?: RequestInit): Promise<LookupTlsReportingDomainResults>
Lookup a TLS reporting domain policy
Parameters
- requestParameters: LookupTlsReportingDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<LookupTlsReportingDomainResults>

lookupTlsReportingDomainRaw

lookupTlsReportingDomainRaw(requestParameters: LookupTlsReportingDomainRequest, initOverrides?: RequestInit): Promise<ApiResponse<LookupTlsReportingDomainResults>>
Lookup a TLS reporting domain policy
Parameters
- requestParameters: LookupTlsReportingDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LookupTlsReportingDomainResults>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

testSmtpServer

testSmtpServer(requestParameters: TestSmtpServerRequest, initOverrides?: RequestInit): Promise<TestSmtpServerResults>
Run a conservative SMTP connectivity, TLS, and AUTH diagnostic
Parameters
- requestParameters: TestSmtpServerRequest
- Optional initOverrides: RequestInit
Returns Promise<TestSmtpServerResults>

testSmtpServerRaw

testSmtpServerRaw(requestParameters: TestSmtpServerRequest, initOverrides?: RequestInit): Promise<ApiResponse<TestSmtpServerResults>>
Run a conservative SMTP connectivity, TLS, and AUTH diagnostic
Parameters
- requestParameters: TestSmtpServerRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TestSmtpServerResults>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware