Interface IMailServerControllerApiSync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IMailServerControllerApiSync : IApiAccessor
Methods
View SourceDescribeMailServerDomain(DescribeDomainOptions, int)
Get DNS Mail Server records for a domain
Declaration
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 |
DescribeMailServerDomainWithHttpInfo(DescribeDomainOptions, int)
Get DNS Mail Server records for a domain
Declaration
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 |
GetDnsLookup(DNSLookupOptions, int)
Lookup DNS records for a domain
Declaration
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 |
GetDnsLookupWithHttpInfo(DNSLookupOptions, int)
Lookup DNS records for a domain
Declaration
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 |
GetDnsLookups(DNSLookupsOptions, int)
Lookup DNS records for multiple domains
Declaration
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 |
GetDnsLookupsWithHttpInfo(DNSLookupsOptions, int)
Lookup DNS records for multiple domains
Declaration
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 |
GetIpAddress(string, int)
Get IP address for a domain
Declaration
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 |
GetIpAddressWithHttpInfo(string, int)
Get IP address for a domain
Declaration
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 |
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]
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 |
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]
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 |