Class ToolsControllerApi

Hierarchy

BaseAPI
- ToolsControllerApi

Index

Constructors

constructor

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

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

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>>

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>>

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>>

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

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