Interface IToolsControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IToolsControllerApiAsync : IApiAccessor

Methods

View Source

CheckEmailFeaturesClientSupportAsync(CheckEmailFeaturesClientSupportOptions, int, CancellationToken)

Check email client support for email HTML and CSS features

Declaration

Task<CheckEmailFeaturesClientSupportResults> CheckEmailFeaturesClientSupportAsync(CheckEmailFeaturesClientSupportOptions checkEmailFeaturesClientSupportOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CheckEmailFeaturesClientSupportOptions	checkEmailFeaturesClientSupportOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CheckEmailFeaturesClientSupportResults>	Task of CheckEmailFeaturesClientSupportResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CheckEmailFeaturesClientSupportWithHttpInfoAsync(CheckEmailFeaturesClientSupportOptions, int, CancellationToken)

Check email client support for email HTML and CSS features

Declaration

Task<ApiResponse<CheckEmailFeaturesClientSupportResults>> CheckEmailFeaturesClientSupportWithHttpInfoAsync(CheckEmailFeaturesClientSupportOptions checkEmailFeaturesClientSupportOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CheckEmailFeaturesClientSupportOptions	checkEmailFeaturesClientSupportOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CheckEmailFeaturesClientSupportResults>>	Task of ApiResponse (CheckEmailFeaturesClientSupportResults)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewFakeEmailAddressAsync(int, CancellationToken)

Create a new email address using the fake email domains

Declaration

Task<NewFakeEmailAddressResult> CreateNewFakeEmailAddressAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<NewFakeEmailAddressResult>	Task of NewFakeEmailAddressResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewFakeEmailAddressWithHttpInfoAsync(int, CancellationToken)

Create a new email address using the fake email domains

Declaration

Task<ApiResponse<NewFakeEmailAddressResult>> CreateNewFakeEmailAddressWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<NewFakeEmailAddressResult>>	Task of ApiResponse (NewFakeEmailAddressResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateBimiRecordAsync(GenerateBimiRecordOptions, int, CancellationToken)

Create a BIMI record policy

Declaration

Task<GenerateBimiRecordResults> GenerateBimiRecordAsync(GenerateBimiRecordOptions generateBimiRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateBimiRecordOptions	generateBimiRecordOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GenerateBimiRecordResults>	Task of GenerateBimiRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateBimiRecordWithHttpInfoAsync(GenerateBimiRecordOptions, int, CancellationToken)

Create a BIMI record policy

Declaration

Task<ApiResponse<GenerateBimiRecordResults>> GenerateBimiRecordWithHttpInfoAsync(GenerateBimiRecordOptions generateBimiRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateBimiRecordOptions	generateBimiRecordOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GenerateBimiRecordResults>>	Task of ApiResponse (GenerateBimiRecordResults)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateDmarcRecordAsync(GenerateDmarcRecordOptions, int, CancellationToken)

Create a DMARC record policy

Declaration

Task<GenerateDmarcRecordResults> GenerateDmarcRecordAsync(GenerateDmarcRecordOptions generateDmarcRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateDmarcRecordOptions	generateDmarcRecordOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GenerateDmarcRecordResults>	Task of GenerateDmarcRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateDmarcRecordWithHttpInfoAsync(GenerateDmarcRecordOptions, int, CancellationToken)

Create a DMARC record policy

Declaration

Task<ApiResponse<GenerateDmarcRecordResults>> GenerateDmarcRecordWithHttpInfoAsync(GenerateDmarcRecordOptions generateDmarcRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateDmarcRecordOptions	generateDmarcRecordOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GenerateDmarcRecordResults>>	Task of ApiResponse (GenerateDmarcRecordResults)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateMtaStsRecordAsync(GenerateMtaStsRecordOptions, int, CancellationToken)

Create a TLS reporting record policy

Declaration

Task<GenerateMtaStsRecordResults> GenerateMtaStsRecordAsync(GenerateMtaStsRecordOptions generateMtaStsRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateMtaStsRecordOptions	generateMtaStsRecordOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GenerateMtaStsRecordResults>	Task of GenerateMtaStsRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateMtaStsRecordWithHttpInfoAsync(GenerateMtaStsRecordOptions, int, CancellationToken)

Create a TLS reporting record policy

Declaration

Task<ApiResponse<GenerateMtaStsRecordResults>> GenerateMtaStsRecordWithHttpInfoAsync(GenerateMtaStsRecordOptions generateMtaStsRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateMtaStsRecordOptions	generateMtaStsRecordOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GenerateMtaStsRecordResults>>	Task of ApiResponse (GenerateMtaStsRecordResults)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateTlsReportingRecordAsync(GenerateTlsReportingRecordOptions, int, CancellationToken)

Create a TLS reporting record policy

Declaration

Task<GenerateTlsReportingRecordResults> GenerateTlsReportingRecordAsync(GenerateTlsReportingRecordOptions generateTlsReportingRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateTlsReportingRecordOptions	generateTlsReportingRecordOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GenerateTlsReportingRecordResults>	Task of GenerateTlsReportingRecordResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GenerateTlsReportingRecordWithHttpInfoAsync(GenerateTlsReportingRecordOptions, int, CancellationToken)

Create a TLS reporting record policy

Declaration

Task<ApiResponse<GenerateTlsReportingRecordResults>> GenerateTlsReportingRecordWithHttpInfoAsync(GenerateTlsReportingRecordOptions generateTlsReportingRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GenerateTlsReportingRecordOptions	generateTlsReportingRecordOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GenerateTlsReportingRecordResults>>	Task of ApiResponse (GenerateTlsReportingRecordResults)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailByIdAsync(Guid, int, CancellationToken)

Declaration

Task<FakeEmailResult> GetFakeEmailByIdAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<FakeEmailResult>	Task of FakeEmailResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailByIdWithHttpInfoAsync(Guid, int, CancellationToken)

Declaration

Task<ApiResponse<FakeEmailResult>> GetFakeEmailByIdWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<FakeEmailResult>>	Task of ApiResponse (FakeEmailResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailsForAddressAsync(string, int?, int, CancellationToken)

Declaration

Task<List<FakeEmailPreview>> GetFakeEmailsForAddressAsync(string emailAddress, int? page = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress
int?	page	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<System.Collections.Generic.List<T><FakeEmailPreview>>	Task of List<FakeEmailPreview>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetFakeEmailsForAddressWithHttpInfoAsync(string, int?, int, CancellationToken)

Declaration

Task<ApiResponse<List<FakeEmailPreview>>> GetFakeEmailsForAddressWithHttpInfoAsync(string emailAddress, int? page = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	emailAddress
int?	page	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<System.Collections.Generic.List<T><FakeEmailPreview>>>	Task of ApiResponse (List<FakeEmailPreview>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupBimiDomainAsync(LookupBimiDomainOptions, int, CancellationToken)

Lookup a BIMI record policy

Declaration

Task<LookupBimiDomainResults> LookupBimiDomainAsync(LookupBimiDomainOptions lookupBimiDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LookupBimiDomainOptions	lookupBimiDomainOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<LookupBimiDomainResults>	Task of LookupBimiDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupBimiDomainWithHttpInfoAsync(LookupBimiDomainOptions, int, CancellationToken)

Lookup a BIMI record policy

Declaration

Task<ApiResponse<LookupBimiDomainResults>> LookupBimiDomainWithHttpInfoAsync(LookupBimiDomainOptions lookupBimiDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LookupBimiDomainOptions	lookupBimiDomainOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<LookupBimiDomainResults>>	Task of ApiResponse (LookupBimiDomainResults)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupDmarcDomainAsync(LookupDmarcDomainOptions, int, CancellationToken)

Lookup a DMARC record policy

Declaration

Task<LookupDmarcDomainResults> LookupDmarcDomainAsync(LookupDmarcDomainOptions lookupDmarcDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LookupDmarcDomainOptions	lookupDmarcDomainOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<LookupDmarcDomainResults>	Task of LookupDmarcDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupDmarcDomainWithHttpInfoAsync(LookupDmarcDomainOptions, int, CancellationToken)

Lookup a DMARC record policy

Declaration

Task<ApiResponse<LookupDmarcDomainResults>> LookupDmarcDomainWithHttpInfoAsync(LookupDmarcDomainOptions lookupDmarcDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LookupDmarcDomainOptions	lookupDmarcDomainOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<LookupDmarcDomainResults>>	Task of ApiResponse (LookupDmarcDomainResults)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupMtaStsDomainAsync(LookupMtaStsDomainOptions, int, CancellationToken)

Lookup a MTA-STS domain policy

Declaration

Task<LookupMtaStsDomainResults> LookupMtaStsDomainAsync(LookupMtaStsDomainOptions lookupMtaStsDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LookupMtaStsDomainOptions	lookupMtaStsDomainOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<LookupMtaStsDomainResults>	Task of LookupMtaStsDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupMtaStsDomainWithHttpInfoAsync(LookupMtaStsDomainOptions, int, CancellationToken)

Lookup a MTA-STS domain policy

Declaration

Task<ApiResponse<LookupMtaStsDomainResults>> LookupMtaStsDomainWithHttpInfoAsync(LookupMtaStsDomainOptions lookupMtaStsDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LookupMtaStsDomainOptions	lookupMtaStsDomainOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<LookupMtaStsDomainResults>>	Task of ApiResponse (LookupMtaStsDomainResults)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupTlsReportingDomainAsync(LookupTlsReportingDomainOptions, int, CancellationToken)

Lookup a TLS reporting domain policy

Declaration

Task<LookupTlsReportingDomainResults> LookupTlsReportingDomainAsync(LookupTlsReportingDomainOptions lookupTlsReportingDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LookupTlsReportingDomainOptions	lookupTlsReportingDomainOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<LookupTlsReportingDomainResults>	Task of LookupTlsReportingDomainResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

LookupTlsReportingDomainWithHttpInfoAsync(LookupTlsReportingDomainOptions, int, CancellationToken)

Lookup a TLS reporting domain policy

Declaration

Task<ApiResponse<LookupTlsReportingDomainResults>> LookupTlsReportingDomainWithHttpInfoAsync(LookupTlsReportingDomainOptions lookupTlsReportingDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
LookupTlsReportingDomainOptions	lookupTlsReportingDomainOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<LookupTlsReportingDomainResults>>	Task of ApiResponse (LookupTlsReportingDomainResults)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call