Class MailServerControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

MailServerControllerApi

Implements

IMailServerControllerApi

IMailServerControllerApiSync

IMailServerControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class MailServerControllerApi : IMailServerControllerApi, IMailServerControllerApiSync, IMailServerControllerApiAsync, IApiAccessor

Constructors

View Source

MailServerControllerApi()

Initializes a new instance of the MailServerControllerApi class.

Declaration

public MailServerControllerApi()

View Source

MailServerControllerApi(Configuration)

Initializes a new instance of the MailServerControllerApi class using Configuration object

Declaration

public MailServerControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

MailServerControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the MailServerControllerApi class using a Configuration object and client instance.

Declaration

public MailServerControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

View Source

MailServerControllerApi(string)

Initializes a new instance of the MailServerControllerApi class.

Declaration

public MailServerControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

DescribeMailServerDomain(DescribeDomainOptions, int)

Get DNS Mail Server records for a domain

Declaration

public DescribeMailServerDomainResult DescribeMailServerDomain(DescribeDomainOptions describeDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
DescribeDomainOptions	describeDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DescribeMailServerDomainResult	DescribeMailServerDomainResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DescribeMailServerDomainAsync(DescribeDomainOptions, int, CancellationToken)

Get DNS Mail Server records for a domain

Declaration

public 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

DescribeMailServerDomainWithHttpInfo(DescribeDomainOptions, int)

Get DNS Mail Server records for a domain

Declaration

public ApiResponse<DescribeMailServerDomainResult> DescribeMailServerDomainWithHttpInfo(DescribeDomainOptions describeDomainOptions, int operationIndex = 0)

Parameters

Type	Name	Description
DescribeDomainOptions	describeDomainOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DescribeMailServerDomainResult>	ApiResponse 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

public 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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetDnsLookup(DNSLookupOptions, int)

Lookup DNS records for a domain

Declaration

public DNSLookupResults GetDnsLookup(DNSLookupOptions dNSLookupOptions, int operationIndex = 0)

Parameters

Type	Name	Description
DNSLookupOptions	dNSLookupOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DNSLookupResults	DNSLookupResults

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDnsLookupAsync(DNSLookupOptions, int, CancellationToken)

Lookup DNS records for a domain

Declaration

public 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

GetDnsLookups(DNSLookupsOptions, int)

Lookup DNS records for multiple domains

Declaration

public DNSLookupResults GetDnsLookups(DNSLookupsOptions dNSLookupsOptions, int operationIndex = 0)

Parameters

Type	Name	Description
DNSLookupsOptions	dNSLookupsOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DNSLookupResults	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

public 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

GetDnsLookupsWithHttpInfo(DNSLookupsOptions, int)

Lookup DNS records for multiple domains

Declaration

public ApiResponse<DNSLookupResults> GetDnsLookupsWithHttpInfo(DNSLookupsOptions dNSLookupsOptions, int operationIndex = 0)

Parameters

Type	Name	Description
DNSLookupsOptions	dNSLookupsOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DNSLookupResults>	ApiResponse 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

public 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

GetDnsLookupWithHttpInfo(DNSLookupOptions, int)

Lookup DNS records for a domain

Declaration

public ApiResponse<DNSLookupResults> GetDnsLookupWithHttpInfo(DNSLookupOptions dNSLookupOptions, int operationIndex = 0)

Parameters

Type	Name	Description
DNSLookupOptions	dNSLookupOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DNSLookupResults>	ApiResponse of 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

public 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

GetIpAddress(string, int)

Get IP address for a domain

Declaration

public IPAddressResult GetIpAddress(string name, int operationIndex = 0)

Parameters

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

Returns

Type	Description
IPAddressResult	IPAddressResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetIpAddressAsync(string, int, CancellationToken)

Get IP address for a domain

Declaration

public 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

GetIpAddressWithHttpInfo(string, int)

Get IP address for a domain

Declaration

public ApiResponse<IPAddressResult> GetIpAddressWithHttpInfo(string name, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<IPAddressResult>	ApiResponse 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

public 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

VerifyEmailAddress(VerifyEmailAddressOptions, int)

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]
public EmailVerificationResult VerifyEmailAddress(VerifyEmailAddressOptions verifyEmailAddressOptions, int operationIndex = 0)

Parameters

Type	Name	Description
VerifyEmailAddressOptions	verifyEmailAddressOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmailVerificationResult	EmailVerificationResult

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]
public 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

VerifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions, int)

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]
public ApiResponse<EmailVerificationResult> VerifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions verifyEmailAddressOptions, int operationIndex = 0)

Parameters

Type	Name	Description
VerifyEmailAddressOptions	verifyEmailAddressOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmailVerificationResult>	ApiResponse 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]
public 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

Implements

IMailServerControllerApi

IMailServerControllerApiSync

IMailServerControllerApiAsync

IApiAccessor