/** * MailSlurp API * MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository * * The version of the OpenAPI document: 6.5.2 * Contact: contact@mailslurp.dev * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { AnalyzeDmarcReportOptions, AnalyzeDmarcReportResults, AnalyzeEmailHeadersOptions, AnalyzeEmailHeadersResults, CheckCampaignProbeOptions, CheckCampaignProbeResults, CheckDnsPropagationOptions, CheckDnsPropagationResults, CheckDomainMonitorOptions, CheckDomainMonitorResults, CheckEmailAuditOptions, CheckEmailAuthStackOptions, CheckEmailAuthStackResults, CheckEmailBlacklistOptions, CheckEmailBlacklistResults, CheckEmailFeaturesClientSupportOptions, CheckEmailFeaturesClientSupportResults, EmailAuditAnalysisResult, FakeEmailPreview, FakeEmailResult, GenerateBimiRecordOptions, GenerateBimiRecordResults, GenerateDmarcRecordOptions, GenerateDmarcRecordResults, GenerateMtaStsRecordOptions, GenerateMtaStsRecordResults, GenerateSpfRecordOptions, GenerateSpfRecordResults, GenerateTlsReportingRecordOptions, GenerateTlsReportingRecordResults, LookupBimiDomainOptions, LookupBimiDomainResults, LookupDkimDomainOptions, LookupDkimDomainResults, LookupDmarcDomainOptions, LookupDmarcDomainResults, LookupMtaStsDomainOptions, LookupMtaStsDomainResults, LookupMxRecordsOptions, LookupMxRecordsResults, LookupPtrOptions, LookupPtrResults, LookupSpfDomainOptions, LookupSpfDomainResults, LookupTlsReportingDomainOptions, LookupTlsReportingDomainResults, NewFakeEmailAddressResult, TestSmtpServerOptions, TestSmtpServerResults } from '../models'; export interface AnalyzeDmarcReportRequest { analyzeDmarcReportOptions: AnalyzeDmarcReportOptions; } export interface AnalyzeEmailHeadersRequest { analyzeEmailHeadersOptions: AnalyzeEmailHeadersOptions; } export interface CheckCampaignProbeRequest { checkCampaignProbeOptions: CheckCampaignProbeOptions; } export interface CheckDnsPropagationRequest { checkDnsPropagationOptions: CheckDnsPropagationOptions; } export interface CheckDomainMonitorRequest { checkDomainMonitorOptions: CheckDomainMonitorOptions; } export interface CheckEmailAuditRequest { checkEmailAuditOptions: CheckEmailAuditOptions; } export interface CheckEmailAuthStackRequest { checkEmailAuthStackOptions: CheckEmailAuthStackOptions; } export interface CheckEmailBlacklistRequest { checkEmailBlacklistOptions: CheckEmailBlacklistOptions; } export interface CheckEmailFeaturesClientSupportRequest { checkEmailFeaturesClientSupportOptions: CheckEmailFeaturesClientSupportOptions; } export interface DeleteNewFakeEmailAddressRequest { emailAddress: string; } export interface GenerateBimiRecordRequest { generateBimiRecordOptions: GenerateBimiRecordOptions; } export interface GenerateDmarcRecordRequest { generateDmarcRecordOptions: GenerateDmarcRecordOptions; } export interface GenerateMtaStsRecordRequest { generateMtaStsRecordOptions: GenerateMtaStsRecordOptions; } export interface GenerateSpfRecordRequest { generateSpfRecordOptions: GenerateSpfRecordOptions; } export interface GenerateTlsReportingRecordRequest { generateTlsReportingRecordOptions: GenerateTlsReportingRecordOptions; } export interface GetFakeEmailByEmailAddressRequest { emailAddress: string; } export interface GetFakeEmailByIdRequest { id: string; } export interface GetFakeEmailRawRequest { id: string; } export interface GetFakeEmailsForAddressRequest { emailAddress: string; page?: number; } export interface LookupBimiDomainRequest { lookupBimiDomainOptions: LookupBimiDomainOptions; } export interface LookupDkimDomainRequest { lookupDkimDomainOptions: LookupDkimDomainOptions; } export interface LookupDmarcDomainRequest { lookupDmarcDomainOptions: LookupDmarcDomainOptions; } export interface LookupMtaStsDomainRequest { lookupMtaStsDomainOptions: LookupMtaStsDomainOptions; } export interface LookupMxRecordRequest { lookupMxRecordsOptions: LookupMxRecordsOptions; } export interface LookupPtrRequest { lookupPtrOptions: LookupPtrOptions; } export interface LookupSpfDomainRequest { lookupSpfDomainOptions: LookupSpfDomainOptions; } export interface LookupTlsReportingDomainRequest { lookupTlsReportingDomainOptions: LookupTlsReportingDomainOptions; } export interface TestSmtpServerRequest { testSmtpServerOptions: TestSmtpServerOptions; } /** * */ export declare class ToolsControllerApi extends runtime.BaseAPI { /** * Parse and summarize a DMARC aggregate XML report */ analyzeDmarcReportRaw(requestParameters: AnalyzeDmarcReportRequest, initOverrides?: RequestInit): Promise>; /** * Parse and summarize a DMARC aggregate XML report */ analyzeDmarcReport(requestParameters: AnalyzeDmarcReportRequest, initOverrides?: RequestInit): Promise; /** * Analyze email headers for auth results and delivery path */ analyzeEmailHeadersRaw(requestParameters: AnalyzeEmailHeadersRequest, initOverrides?: RequestInit): Promise>; /** * Analyze email headers for auth results and delivery path */ analyzeEmailHeaders(requestParameters: AnalyzeEmailHeadersRequest, initOverrides?: RequestInit): Promise; /** * Run a one-shot free campaign probe preflight check */ checkCampaignProbeRaw(requestParameters: CheckCampaignProbeRequest, initOverrides?: RequestInit): Promise>; /** * Run a one-shot free campaign probe preflight check */ checkCampaignProbe(requestParameters: CheckCampaignProbeRequest, initOverrides?: RequestInit): Promise; /** * Check DNS propagation for a host and record type across configured resolvers */ checkDnsPropagationRaw(requestParameters: CheckDnsPropagationRequest, initOverrides?: RequestInit): Promise>; /** * Check DNS propagation for a host and record type across configured resolvers */ checkDnsPropagation(requestParameters: CheckDnsPropagationRequest, initOverrides?: RequestInit): Promise; /** * Run a one-shot free domain monitor posture check */ checkDomainMonitorRaw(requestParameters: CheckDomainMonitorRequest, initOverrides?: RequestInit): Promise>; /** * Run a one-shot free domain monitor posture check */ checkDomainMonitor(requestParameters: CheckDomainMonitorRequest, initOverrides?: RequestInit): Promise; /** * Run a one-shot free email audit across links, images, HTML, and client support */ checkEmailAuditRaw(requestParameters: CheckEmailAuditRequest, initOverrides?: RequestInit): Promise>; /** * Run a one-shot free email audit across links, images, HTML, and client support */ checkEmailAudit(requestParameters: CheckEmailAuditRequest, initOverrides?: RequestInit): Promise; /** * Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check */ checkEmailAuthStackRaw(requestParameters: CheckEmailAuthStackRequest, initOverrides?: RequestInit): Promise>; /** * Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check */ checkEmailAuthStack(requestParameters: CheckEmailAuthStackRequest, initOverrides?: RequestInit): Promise; /** * Check whether a domain or IP appears on configured DNS blacklists */ checkEmailBlacklistRaw(requestParameters: CheckEmailBlacklistRequest, initOverrides?: RequestInit): Promise>; /** * Check whether a domain or IP appears on configured DNS blacklists */ checkEmailBlacklist(requestParameters: CheckEmailBlacklistRequest, initOverrides?: RequestInit): Promise; /** * Check email client support for email HTML and CSS features */ checkEmailFeaturesClientSupportRaw(requestParameters: CheckEmailFeaturesClientSupportRequest, initOverrides?: RequestInit): Promise>; /** * Check email client support for email HTML and CSS features */ checkEmailFeaturesClientSupport(requestParameters: CheckEmailFeaturesClientSupportRequest, initOverrides?: RequestInit): Promise; /** * Create a new email address using the fake email domains */ createNewFakeEmailAddressRaw(initOverrides?: RequestInit): Promise>; /** * Create a new email address using the fake email domains */ createNewFakeEmailAddress(initOverrides?: RequestInit): Promise; /** * Delete a fake email address using the fake email domains * Delete a fake email address using the fake email domains */ deleteNewFakeEmailAddressRaw(requestParameters: DeleteNewFakeEmailAddressRequest, initOverrides?: RequestInit): Promise>; /** * Delete a fake email address using the fake email domains * Delete a fake email address using the fake email domains */ deleteNewFakeEmailAddress(requestParameters: DeleteNewFakeEmailAddressRequest, initOverrides?: RequestInit): Promise; /** * Create a BIMI record policy */ generateBimiRecordRaw(requestParameters: GenerateBimiRecordRequest, initOverrides?: RequestInit): Promise>; /** * Create a BIMI record policy */ generateBimiRecord(requestParameters: GenerateBimiRecordRequest, initOverrides?: RequestInit): Promise; /** * Create a DMARC record policy */ generateDmarcRecordRaw(requestParameters: GenerateDmarcRecordRequest, initOverrides?: RequestInit): Promise>; /** * Create a DMARC record policy */ generateDmarcRecord(requestParameters: GenerateDmarcRecordRequest, initOverrides?: RequestInit): Promise; /** * Create a TLS reporting record policy */ generateMtaStsRecordRaw(requestParameters: GenerateMtaStsRecordRequest, initOverrides?: RequestInit): Promise>; /** * Create a TLS reporting record policy */ generateMtaStsRecord(requestParameters: GenerateMtaStsRecordRequest, initOverrides?: RequestInit): Promise; /** * Create an SPF record */ generateSpfRecordRaw(requestParameters: GenerateSpfRecordRequest, initOverrides?: RequestInit): Promise>; /** * Create an SPF record */ generateSpfRecord(requestParameters: GenerateSpfRecordRequest, initOverrides?: RequestInit): Promise; /** * Create a TLS reporting record policy */ generateTlsReportingRecordRaw(requestParameters: GenerateTlsReportingRecordRequest, initOverrides?: RequestInit): Promise>; /** * Create a TLS reporting record policy */ generateTlsReportingRecord(requestParameters: GenerateTlsReportingRecordRequest, initOverrides?: RequestInit): Promise; /** */ getFakeEmailByEmailAddressRaw(requestParameters: GetFakeEmailByEmailAddressRequest, initOverrides?: RequestInit): Promise>; /** */ getFakeEmailByEmailAddress(requestParameters: GetFakeEmailByEmailAddressRequest, initOverrides?: RequestInit): Promise; /** * Get a fake email by its ID * Get a fake email by its ID */ getFakeEmailByIdRaw(requestParameters: GetFakeEmailByIdRequest, initOverrides?: RequestInit): Promise>; /** * Get a fake email by its ID * Get a fake email by its ID */ getFakeEmailById(requestParameters: GetFakeEmailByIdRequest, initOverrides?: RequestInit): Promise; /** * Retrieve the raw content of a fake email by its ID * Get raw fake email content */ getFakeEmailRawRaw(requestParameters: GetFakeEmailRawRequest, initOverrides?: RequestInit): Promise>; /** * Retrieve the raw content of a fake email by its ID * Get raw fake email content */ getFakeEmailRaw(requestParameters: GetFakeEmailRawRequest, initOverrides?: RequestInit): Promise; /** * Get fake emails for an address * Get fake emails for an address */ getFakeEmailsForAddressRaw(requestParameters: GetFakeEmailsForAddressRequest, initOverrides?: RequestInit): Promise>>; /** * Get fake emails for an address * Get fake emails for an address */ getFakeEmailsForAddress(requestParameters: GetFakeEmailsForAddressRequest, initOverrides?: RequestInit): Promise>; /** * Lookup a BIMI record policy */ lookupBimiDomainRaw(requestParameters: LookupBimiDomainRequest, initOverrides?: RequestInit): Promise>; /** * Lookup a BIMI record policy */ lookupBimiDomain(requestParameters: LookupBimiDomainRequest, initOverrides?: RequestInit): Promise; /** * Lookup and validate a DKIM record */ lookupDkimDomainRaw(requestParameters: LookupDkimDomainRequest, initOverrides?: RequestInit): Promise>; /** * Lookup and validate a DKIM record */ lookupDkimDomain(requestParameters: LookupDkimDomainRequest, initOverrides?: RequestInit): Promise; /** * Lookup a DMARC record policy */ lookupDmarcDomainRaw(requestParameters: LookupDmarcDomainRequest, initOverrides?: RequestInit): Promise>; /** * Lookup a DMARC record policy */ lookupDmarcDomain(requestParameters: LookupDmarcDomainRequest, initOverrides?: RequestInit): Promise; /** * Lookup a MTA-STS domain policy */ lookupMtaStsDomainRaw(requestParameters: LookupMtaStsDomainRequest, initOverrides?: RequestInit): Promise>; /** * Lookup a MTA-STS domain policy */ lookupMtaStsDomain(requestParameters: LookupMtaStsDomainRequest, initOverrides?: RequestInit): Promise; /** * Lookup a MX records for a domain */ lookupMxRecordRaw(requestParameters: LookupMxRecordRequest, initOverrides?: RequestInit): Promise>; /** * Lookup a MX records for a domain */ lookupMxRecord(requestParameters: LookupMxRecordRequest, initOverrides?: RequestInit): Promise; /** * Lookup PTR records for an IP address */ lookupPtrRaw(requestParameters: LookupPtrRequest, initOverrides?: RequestInit): Promise>; /** * Lookup PTR records for an IP address */ lookupPtr(requestParameters: LookupPtrRequest, initOverrides?: RequestInit): Promise; /** * Lookup and validate an SPF record */ lookupSpfDomainRaw(requestParameters: LookupSpfDomainRequest, initOverrides?: RequestInit): Promise>; /** * Lookup and validate an SPF record */ lookupSpfDomain(requestParameters: LookupSpfDomainRequest, initOverrides?: RequestInit): Promise; /** * Lookup a TLS reporting domain policy */ lookupTlsReportingDomainRaw(requestParameters: LookupTlsReportingDomainRequest, initOverrides?: RequestInit): Promise>; /** * Lookup a TLS reporting domain policy */ lookupTlsReportingDomain(requestParameters: LookupTlsReportingDomainRequest, initOverrides?: RequestInit): Promise; /** * Run a conservative SMTP connectivity, TLS, and AUTH diagnostic */ testSmtpServerRaw(requestParameters: TestSmtpServerRequest, initOverrides?: RequestInit): Promise>; /** * Run a conservative SMTP connectivity, TLS, and AUTH diagnostic */ testSmtpServer(requestParameters: TestSmtpServerRequest, initOverrides?: RequestInit): Promise; }