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

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

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

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

GetFakeEmailById(Guid, int)

Declaration

FakeEmailResult GetFakeEmailById(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id
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

GetFakeEmailByIdWithHttpInfo(Guid, int)

Declaration

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

Parameters

Type	Name	Description
System.Guid	id
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

GetFakeEmailsForAddress(string, int?, int)

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
System.Collections.Generic.List<T><FakeEmailPreview>	List<FakeEmailPreview>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailsForAddressWithHttpInfo(string, int?, int)

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<System.Collections.Generic.List<T><FakeEmailPreview>>	ApiResponse of List<FakeEmailPreview>

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

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

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