Interface IToolsControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IToolsControllerApiSync : IApiAccessor

Methods

View Source

AnalyzeDmarcReport(AnalyzeDmarcReportOptions, int)

Parse and summarize a DMARC aggregate XML report

Declaration

AnalyzeDmarcReportResults AnalyzeDmarcReport(AnalyzeDmarcReportOptions analyzeDmarcReportOptions, int operationIndex = 0)

Parameters

Type	Name	Description
AnalyzeDmarcReportOptions	analyzeDmarcReportOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AnalyzeDmarcReportResults	AnalyzeDmarcReportResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

AnalyzeDmarcReportWithHttpInfo(AnalyzeDmarcReportOptions, int)

Parse and summarize a DMARC aggregate XML report

Declaration

ApiResponse<AnalyzeDmarcReportResults> AnalyzeDmarcReportWithHttpInfo(AnalyzeDmarcReportOptions analyzeDmarcReportOptions, int operationIndex = 0)

Parameters

Type	Name	Description
AnalyzeDmarcReportOptions	analyzeDmarcReportOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AnalyzeDmarcReportResults>	ApiResponse of AnalyzeDmarcReportResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

AnalyzeEmailHeaders(AnalyzeEmailHeadersOptions, int)

Analyze email headers for auth results and delivery path

Declaration

AnalyzeEmailHeadersResults AnalyzeEmailHeaders(AnalyzeEmailHeadersOptions analyzeEmailHeadersOptions, int operationIndex = 0)

Parameters

Type	Name	Description
AnalyzeEmailHeadersOptions	analyzeEmailHeadersOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AnalyzeEmailHeadersResults	AnalyzeEmailHeadersResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

AnalyzeEmailHeadersWithHttpInfo(AnalyzeEmailHeadersOptions, int)

Analyze email headers for auth results and delivery path

Declaration

ApiResponse<AnalyzeEmailHeadersResults> AnalyzeEmailHeadersWithHttpInfo(AnalyzeEmailHeadersOptions analyzeEmailHeadersOptions, int operationIndex = 0)

Parameters

Type	Name	Description
AnalyzeEmailHeadersOptions	analyzeEmailHeadersOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AnalyzeEmailHeadersResults>	ApiResponse of AnalyzeEmailHeadersResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckCampaignProbe(CheckCampaignProbeOptions, int)

Run a one-shot free campaign probe preflight check

Declaration

CheckCampaignProbeResults CheckCampaignProbe(CheckCampaignProbeOptions checkCampaignProbeOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckCampaignProbeOptions	checkCampaignProbeOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CheckCampaignProbeResults	CheckCampaignProbeResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckCampaignProbeWithHttpInfo(CheckCampaignProbeOptions, int)

Run a one-shot free campaign probe preflight check

Declaration

ApiResponse<CheckCampaignProbeResults> CheckCampaignProbeWithHttpInfo(CheckCampaignProbeOptions checkCampaignProbeOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckCampaignProbeOptions	checkCampaignProbeOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CheckCampaignProbeResults>	ApiResponse of CheckCampaignProbeResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckDnsPropagation(CheckDnsPropagationOptions, int)

Check DNS propagation for a host and record type across configured resolvers

Declaration

CheckDnsPropagationResults CheckDnsPropagation(CheckDnsPropagationOptions checkDnsPropagationOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckDnsPropagationOptions	checkDnsPropagationOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CheckDnsPropagationResults	CheckDnsPropagationResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckDnsPropagationWithHttpInfo(CheckDnsPropagationOptions, int)

Check DNS propagation for a host and record type across configured resolvers

Declaration

ApiResponse<CheckDnsPropagationResults> CheckDnsPropagationWithHttpInfo(CheckDnsPropagationOptions checkDnsPropagationOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckDnsPropagationOptions	checkDnsPropagationOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CheckDnsPropagationResults>	ApiResponse of CheckDnsPropagationResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckDomainMonitor(CheckDomainMonitorOptions, int)

Run a one-shot free domain monitor posture check

Declaration

CheckDomainMonitorResults CheckDomainMonitor(CheckDomainMonitorOptions checkDomainMonitorOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckDomainMonitorOptions	checkDomainMonitorOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CheckDomainMonitorResults	CheckDomainMonitorResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckDomainMonitorWithHttpInfo(CheckDomainMonitorOptions, int)

Run a one-shot free domain monitor posture check

Declaration

ApiResponse<CheckDomainMonitorResults> CheckDomainMonitorWithHttpInfo(CheckDomainMonitorOptions checkDomainMonitorOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckDomainMonitorOptions	checkDomainMonitorOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CheckDomainMonitorResults>	ApiResponse of CheckDomainMonitorResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckEmailAudit(CheckEmailAuditOptions, int)

Run a one-shot free email audit across links, images, HTML, and client support

Declaration

EmailAuditAnalysisResult CheckEmailAudit(CheckEmailAuditOptions checkEmailAuditOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailAuditOptions	checkEmailAuditOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailAuditAnalysisResult	EmailAuditAnalysisResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckEmailAuditWithHttpInfo(CheckEmailAuditOptions, int)

Run a one-shot free email audit across links, images, HTML, and client support

Declaration

ApiResponse<EmailAuditAnalysisResult> CheckEmailAuditWithHttpInfo(CheckEmailAuditOptions checkEmailAuditOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailAuditOptions	checkEmailAuditOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailAuditAnalysisResult>	ApiResponse of EmailAuditAnalysisResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckEmailAuthStack(CheckEmailAuthStackOptions, int)

Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check

Declaration

CheckEmailAuthStackResults CheckEmailAuthStack(CheckEmailAuthStackOptions checkEmailAuthStackOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailAuthStackOptions	checkEmailAuthStackOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CheckEmailAuthStackResults	CheckEmailAuthStackResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckEmailAuthStackWithHttpInfo(CheckEmailAuthStackOptions, int)

Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check

Declaration

ApiResponse<CheckEmailAuthStackResults> CheckEmailAuthStackWithHttpInfo(CheckEmailAuthStackOptions checkEmailAuthStackOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailAuthStackOptions	checkEmailAuthStackOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CheckEmailAuthStackResults>	ApiResponse of CheckEmailAuthStackResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckEmailBlacklist(CheckEmailBlacklistOptions, int)

Check whether a domain or IP appears on configured DNS blacklists

Declaration

CheckEmailBlacklistResults CheckEmailBlacklist(CheckEmailBlacklistOptions checkEmailBlacklistOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailBlacklistOptions	checkEmailBlacklistOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CheckEmailBlacklistResults	CheckEmailBlacklistResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckEmailBlacklistWithHttpInfo(CheckEmailBlacklistOptions, int)

Check whether a domain or IP appears on configured DNS blacklists

Declaration

ApiResponse<CheckEmailBlacklistResults> CheckEmailBlacklistWithHttpInfo(CheckEmailBlacklistOptions checkEmailBlacklistOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailBlacklistOptions	checkEmailBlacklistOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CheckEmailBlacklistResults>	ApiResponse of CheckEmailBlacklistResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckEmailFeaturesClientSupport(CheckEmailFeaturesClientSupportOptions, int)

Check email client support for email HTML and CSS features

Declaration

CheckEmailFeaturesClientSupportResults CheckEmailFeaturesClientSupport(CheckEmailFeaturesClientSupportOptions checkEmailFeaturesClientSupportOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailFeaturesClientSupportOptions	checkEmailFeaturesClientSupportOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CheckEmailFeaturesClientSupportResults	CheckEmailFeaturesClientSupportResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckEmailFeaturesClientSupportWithHttpInfo(CheckEmailFeaturesClientSupportOptions, int)

Check email client support for email HTML and CSS features

Declaration

ApiResponse<CheckEmailFeaturesClientSupportResults> CheckEmailFeaturesClientSupportWithHttpInfo(CheckEmailFeaturesClientSupportOptions checkEmailFeaturesClientSupportOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CheckEmailFeaturesClientSupportOptions	checkEmailFeaturesClientSupportOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CheckEmailFeaturesClientSupportResults>	ApiResponse of CheckEmailFeaturesClientSupportResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewFakeEmailAddress(int)

Create a new email address using the fake email domains

Declaration

NewFakeEmailAddressResult CreateNewFakeEmailAddress(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
NewFakeEmailAddressResult	NewFakeEmailAddressResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewFakeEmailAddressWithHttpInfo(int)

Create a new email address using the fake email domains

Declaration

ApiResponse<NewFakeEmailAddressResult> CreateNewFakeEmailAddressWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<NewFakeEmailAddressResult>	ApiResponse of NewFakeEmailAddressResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteNewFakeEmailAddress(string, int)

Delete a fake email address using the fake email domains

Declaration

void DeleteNewFakeEmailAddress(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int	operationIndex	Index associated with the operation.

Remarks

Delete a fake email address using the fake email domains

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteNewFakeEmailAddressWithHttpInfo(string, int)

Delete a fake email address using the fake email domains

Declaration

ApiResponse<object> DeleteNewFakeEmailAddressWithHttpInfo(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Remarks

Delete a fake email address using the fake email domains

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateBimiRecord(GenerateBimiRecordOptions, int)

Create a BIMI record policy

Declaration

GenerateBimiRecordResults GenerateBimiRecord(GenerateBimiRecordOptions generateBimiRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateBimiRecordOptions	generateBimiRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GenerateBimiRecordResults	GenerateBimiRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateBimiRecordWithHttpInfo(GenerateBimiRecordOptions, int)

Create a BIMI record policy

Declaration

ApiResponse<GenerateBimiRecordResults> GenerateBimiRecordWithHttpInfo(GenerateBimiRecordOptions generateBimiRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateBimiRecordOptions	generateBimiRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GenerateBimiRecordResults>	ApiResponse of GenerateBimiRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateDmarcRecord(GenerateDmarcRecordOptions, int)

Create a DMARC record policy

Declaration

GenerateDmarcRecordResults GenerateDmarcRecord(GenerateDmarcRecordOptions generateDmarcRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateDmarcRecordOptions	generateDmarcRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GenerateDmarcRecordResults	GenerateDmarcRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateDmarcRecordWithHttpInfo(GenerateDmarcRecordOptions, int)

Create a DMARC record policy

Declaration

ApiResponse<GenerateDmarcRecordResults> GenerateDmarcRecordWithHttpInfo(GenerateDmarcRecordOptions generateDmarcRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateDmarcRecordOptions	generateDmarcRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GenerateDmarcRecordResults>	ApiResponse of GenerateDmarcRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateMtaStsRecord(GenerateMtaStsRecordOptions, int)

Create a TLS reporting record policy

Declaration

GenerateMtaStsRecordResults GenerateMtaStsRecord(GenerateMtaStsRecordOptions generateMtaStsRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateMtaStsRecordOptions	generateMtaStsRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GenerateMtaStsRecordResults	GenerateMtaStsRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateMtaStsRecordWithHttpInfo(GenerateMtaStsRecordOptions, int)

Create a TLS reporting record policy

Declaration

ApiResponse<GenerateMtaStsRecordResults> GenerateMtaStsRecordWithHttpInfo(GenerateMtaStsRecordOptions generateMtaStsRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateMtaStsRecordOptions	generateMtaStsRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GenerateMtaStsRecordResults>	ApiResponse of GenerateMtaStsRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateSpfRecord(GenerateSpfRecordOptions, int)

Create an SPF record

Declaration

GenerateSpfRecordResults GenerateSpfRecord(GenerateSpfRecordOptions generateSpfRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateSpfRecordOptions	generateSpfRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GenerateSpfRecordResults	GenerateSpfRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateSpfRecordWithHttpInfo(GenerateSpfRecordOptions, int)

Create an SPF record

Declaration

ApiResponse<GenerateSpfRecordResults> GenerateSpfRecordWithHttpInfo(GenerateSpfRecordOptions generateSpfRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateSpfRecordOptions	generateSpfRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GenerateSpfRecordResults>	ApiResponse of GenerateSpfRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateTlsReportingRecord(GenerateTlsReportingRecordOptions, int)

Create a TLS reporting record policy

Declaration

GenerateTlsReportingRecordResults GenerateTlsReportingRecord(GenerateTlsReportingRecordOptions generateTlsReportingRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateTlsReportingRecordOptions	generateTlsReportingRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GenerateTlsReportingRecordResults	GenerateTlsReportingRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateTlsReportingRecordWithHttpInfo(GenerateTlsReportingRecordOptions, int)

Create a TLS reporting record policy

Declaration

ApiResponse<GenerateTlsReportingRecordResults> GenerateTlsReportingRecordWithHttpInfo(GenerateTlsReportingRecordOptions generateTlsReportingRecordOptions, int operationIndex = 0)

Parameters

Type	Name	Description
GenerateTlsReportingRecordOptions	generateTlsReportingRecordOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GenerateTlsReportingRecordResults>	ApiResponse of GenerateTlsReportingRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailByEmailAddress(string, int)

Declaration

FakeEmailResult GetFakeEmailByEmailAddress(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int	operationIndex	Index associated with the operation.

Returns

Type	Description
FakeEmailResult	FakeEmailResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailByEmailAddressWithHttpInfo(string, int)

Declaration

ApiResponse<FakeEmailResult> GetFakeEmailByEmailAddressWithHttpInfo(string emailAddress, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<FakeEmailResult>	ApiResponse of FakeEmailResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailById(Guid, int)

Get a fake email by its ID

Declaration

FakeEmailResult GetFakeEmailById(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
FakeEmailResult	FakeEmailResult

Remarks

Get a fake email by its ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailByIdWithHttpInfo(Guid, int)

Get a fake email by its ID

Declaration

ApiResponse<FakeEmailResult> GetFakeEmailByIdWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<FakeEmailResult>	ApiResponse of FakeEmailResult

Remarks

Get a fake email by its ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailRaw(Guid, int)

Get raw fake email content

Declaration

string GetFakeEmailRaw(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
string	string

Remarks

Retrieve the raw content of a fake email by its ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailRawWithHttpInfo(Guid, int)

Get raw fake email content

Declaration

ApiResponse<string> GetFakeEmailRawWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<string>	ApiResponse of string

Remarks

Retrieve the raw content of a fake email by its ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailsForAddress(string, int?, int)

Get fake emails for an address

Declaration

List<FakeEmailPreview> GetFakeEmailsForAddress(string emailAddress, int? page = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int?	page	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<FakeEmailPreview>	List<FakeEmailPreview>

Remarks

Get fake emails for an address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailsForAddressWithHttpInfo(string, int?, int)

Get fake emails for an address

Declaration

ApiResponse<List<FakeEmailPreview>> GetFakeEmailsForAddressWithHttpInfo(string emailAddress, int? page = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	emailAddress
int?	page	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<FakeEmailPreview>>	ApiResponse of List<FakeEmailPreview>

Remarks

Get fake emails for an address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupBimiDomain(LookupBimiDomainOptions, int)

Lookup a BIMI record policy

Declaration

LookupBimiDomainResults LookupBimiDomain(LookupBimiDomainOptions lookupBimiDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupBimiDomainOptions	lookupBimiDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
LookupBimiDomainResults	LookupBimiDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupBimiDomainWithHttpInfo(LookupBimiDomainOptions, int)

Lookup a BIMI record policy

Declaration

ApiResponse<LookupBimiDomainResults> LookupBimiDomainWithHttpInfo(LookupBimiDomainOptions lookupBimiDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupBimiDomainOptions	lookupBimiDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<LookupBimiDomainResults>	ApiResponse of LookupBimiDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupDkimDomain(LookupDkimDomainOptions, int)

Lookup and validate a DKIM record

Declaration

LookupDkimDomainResults LookupDkimDomain(LookupDkimDomainOptions lookupDkimDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupDkimDomainOptions	lookupDkimDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
LookupDkimDomainResults	LookupDkimDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupDkimDomainWithHttpInfo(LookupDkimDomainOptions, int)

Lookup and validate a DKIM record

Declaration

ApiResponse<LookupDkimDomainResults> LookupDkimDomainWithHttpInfo(LookupDkimDomainOptions lookupDkimDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupDkimDomainOptions	lookupDkimDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<LookupDkimDomainResults>	ApiResponse of LookupDkimDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupDmarcDomain(LookupDmarcDomainOptions, int)

Lookup a DMARC record policy

Declaration

LookupDmarcDomainResults LookupDmarcDomain(LookupDmarcDomainOptions lookupDmarcDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupDmarcDomainOptions	lookupDmarcDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
LookupDmarcDomainResults	LookupDmarcDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupDmarcDomainWithHttpInfo(LookupDmarcDomainOptions, int)

Lookup a DMARC record policy

Declaration

ApiResponse<LookupDmarcDomainResults> LookupDmarcDomainWithHttpInfo(LookupDmarcDomainOptions lookupDmarcDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupDmarcDomainOptions	lookupDmarcDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<LookupDmarcDomainResults>	ApiResponse of LookupDmarcDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupMtaStsDomain(LookupMtaStsDomainOptions, int)

Lookup a MTA-STS domain policy

Declaration

LookupMtaStsDomainResults LookupMtaStsDomain(LookupMtaStsDomainOptions lookupMtaStsDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupMtaStsDomainOptions	lookupMtaStsDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
LookupMtaStsDomainResults	LookupMtaStsDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupMtaStsDomainWithHttpInfo(LookupMtaStsDomainOptions, int)

Lookup a MTA-STS domain policy

Declaration

ApiResponse<LookupMtaStsDomainResults> LookupMtaStsDomainWithHttpInfo(LookupMtaStsDomainOptions lookupMtaStsDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupMtaStsDomainOptions	lookupMtaStsDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<LookupMtaStsDomainResults>	ApiResponse of LookupMtaStsDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupMxRecord(LookupMxRecordsOptions, int)

Lookup a MX records for a domain

Declaration

LookupMxRecordsResults LookupMxRecord(LookupMxRecordsOptions lookupMxRecordsOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupMxRecordsOptions	lookupMxRecordsOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
LookupMxRecordsResults	LookupMxRecordsResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupMxRecordWithHttpInfo(LookupMxRecordsOptions, int)

Lookup a MX records for a domain

Declaration

ApiResponse<LookupMxRecordsResults> LookupMxRecordWithHttpInfo(LookupMxRecordsOptions lookupMxRecordsOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupMxRecordsOptions	lookupMxRecordsOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<LookupMxRecordsResults>	ApiResponse of LookupMxRecordsResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupPtr(LookupPtrOptions, int)

Lookup PTR records for an IP address

Declaration

LookupPtrResults LookupPtr(LookupPtrOptions lookupPtrOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupPtrOptions	lookupPtrOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
LookupPtrResults	LookupPtrResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupPtrWithHttpInfo(LookupPtrOptions, int)

Lookup PTR records for an IP address

Declaration

ApiResponse<LookupPtrResults> LookupPtrWithHttpInfo(LookupPtrOptions lookupPtrOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupPtrOptions	lookupPtrOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<LookupPtrResults>	ApiResponse of LookupPtrResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupSpfDomain(LookupSpfDomainOptions, int)

Lookup and validate an SPF record

Declaration

LookupSpfDomainResults LookupSpfDomain(LookupSpfDomainOptions lookupSpfDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupSpfDomainOptions	lookupSpfDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
LookupSpfDomainResults	LookupSpfDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupSpfDomainWithHttpInfo(LookupSpfDomainOptions, int)

Lookup and validate an SPF record

Declaration

ApiResponse<LookupSpfDomainResults> LookupSpfDomainWithHttpInfo(LookupSpfDomainOptions lookupSpfDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupSpfDomainOptions	lookupSpfDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<LookupSpfDomainResults>	ApiResponse of LookupSpfDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupTlsReportingDomain(LookupTlsReportingDomainOptions, int)

Lookup a TLS reporting domain policy

Declaration

LookupTlsReportingDomainResults LookupTlsReportingDomain(LookupTlsReportingDomainOptions lookupTlsReportingDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupTlsReportingDomainOptions	lookupTlsReportingDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
LookupTlsReportingDomainResults	LookupTlsReportingDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupTlsReportingDomainWithHttpInfo(LookupTlsReportingDomainOptions, int)

Lookup a TLS reporting domain policy

Declaration

ApiResponse<LookupTlsReportingDomainResults> LookupTlsReportingDomainWithHttpInfo(LookupTlsReportingDomainOptions lookupTlsReportingDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
LookupTlsReportingDomainOptions	lookupTlsReportingDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<LookupTlsReportingDomainResults>	ApiResponse of LookupTlsReportingDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestSmtpServer(TestSmtpServerOptions, int)

Run a conservative SMTP connectivity, TLS, and AUTH diagnostic

Declaration

TestSmtpServerResults TestSmtpServer(TestSmtpServerOptions testSmtpServerOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestSmtpServerOptions	testSmtpServerOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
TestSmtpServerResults	TestSmtpServerResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

TestSmtpServerWithHttpInfo(TestSmtpServerOptions, int)

Run a conservative SMTP connectivity, TLS, and AUTH diagnostic

Declaration

ApiResponse<TestSmtpServerResults> TestSmtpServerWithHttpInfo(TestSmtpServerOptions testSmtpServerOptions, int operationIndex = 0)

Parameters

Type	Name	Description
TestSmtpServerOptions	testSmtpServerOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<TestSmtpServerResults>	ApiResponse of TestSmtpServerResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call