Interface IMailServerControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IMailServerControllerApiAsync : IApiAccessor

Methods

View Source

DescribeMailServerDomainAsync(DescribeDomainOptions, int, CancellationToken)

Get DNS Mail Server records for a domain

Declaration

Task<DescribeMailServerDomainResult> DescribeMailServerDomainAsync(DescribeDomainOptions describeDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DescribeMailServerDomainResult>	Task of DescribeMailServerDomainResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DescribeMailServerDomainWithHttpInfoAsync(DescribeDomainOptions, int, CancellationToken)

Get DNS Mail Server records for a domain

Declaration

Task<ApiResponse<DescribeMailServerDomainResult>> DescribeMailServerDomainWithHttpInfoAsync(DescribeDomainOptions describeDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDnsLookupAsync(DNSLookupOptions, int, CancellationToken)

Lookup DNS records for a domain

Declaration

Task<DNSLookupResults> GetDnsLookupAsync(DNSLookupOptions dNSLookupOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DNSLookupResults>	Task of DNSLookupResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDnsLookupsAsync(DNSLookupsOptions, int, CancellationToken)

Lookup DNS records for multiple domains

Declaration

Task<DNSLookupResults> GetDnsLookupsAsync(DNSLookupsOptions dNSLookupsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DNSLookupResults>	Task of DNSLookupResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDnsLookupsWithHttpInfoAsync(DNSLookupsOptions, int, CancellationToken)

Lookup DNS records for multiple domains

Declaration

Task<ApiResponse<DNSLookupResults>> GetDnsLookupsWithHttpInfoAsync(DNSLookupsOptions dNSLookupsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDnsLookupWithHttpInfoAsync(DNSLookupOptions, int, CancellationToken)

Lookup DNS records for a domain

Declaration

Task<ApiResponse<DNSLookupResults>> GetDnsLookupWithHttpInfoAsync(DNSLookupOptions dNSLookupOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetIpAddressAsync(string, int, CancellationToken)

Get IP address for a domain

Declaration

Task<IPAddressResult> GetIpAddressAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<IPAddressResult>	Task of IPAddressResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetIpAddressWithHttpInfoAsync(string, int, CancellationToken)

Get IP address for a domain

Declaration

Task<ApiResponse<IPAddressResult>> GetIpAddressWithHttpInfoAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

VerifyEmailAddressAsync(VerifyEmailAddressOptions, int, CancellationToken)

Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.

Declaration

[Obsolete]
Task<EmailVerificationResult> VerifyEmailAddressAsync(VerifyEmailAddressOptions verifyEmailAddressOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<EmailVerificationResult>	Task of EmailVerificationResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

VerifyEmailAddressWithHttpInfoAsync(VerifyEmailAddressOptions, int, CancellationToken)

Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.

Declaration

[Obsolete]
Task<ApiResponse<EmailVerificationResult>> VerifyEmailAddressWithHttpInfoAsync(VerifyEmailAddressOptions verifyEmailAddressOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call