mailslurp_netstandard_2x.Api.MailServerControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
DescribeMailServerDomainPOST /mail-server/describe/domainGet DNS Mail Server records for a domain
GetDnsLookupPOST /mail-server/describe/dns-lookupLookup DNS records for a domain
GetIpAddressPOST /mail-server/describe/ip-addressGet IP address for a domain
VerifyEmailAddressPOST /mail-server/verify/email-addressVerify the existence of an email address at a given mail server.

DescribeMailServerDomain

DescribeMailServerDomainResult DescribeMailServerDomain (DescribeDomainOptions describeOptions)

Get DNS Mail Server records for a domain

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;

namespace Example
{
    public class DescribeMailServerDomainExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new MailServerControllerApi(config);
            var describeOptions = new DescribeDomainOptions(); // DescribeDomainOptions | describeOptions

            try
            {
                // Get DNS Mail Server records for a domain
                DescribeMailServerDomainResult result = apiInstance.DescribeMailServerDomain(describeOptions);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MailServerControllerApi.DescribeMailServerDomain: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
describeOptionsDescribeDomainOptionsdescribeOptions

Return type

DescribeMailServerDomainResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetDnsLookup

DNSLookupResults GetDnsLookup (DNSLookupOptions dnsLookupOptions)

Lookup DNS records for a domain

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;

namespace Example
{
    public class GetDnsLookupExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new MailServerControllerApi(config);
            var dnsLookupOptions = new DNSLookupOptions(); // DNSLookupOptions | dnsLookupOptions

            try
            {
                // Lookup DNS records for a domain
                DNSLookupResults result = apiInstance.GetDnsLookup(dnsLookupOptions);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MailServerControllerApi.GetDnsLookup: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
dnsLookupOptionsDNSLookupOptionsdnsLookupOptions

Return type

DNSLookupResults

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetIpAddress

IPAddressResult GetIpAddress (string name)

Get IP address for a domain

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;

namespace Example
{
    public class GetIpAddressExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new MailServerControllerApi(config);
            var name = name_example;  // string | name

            try
            {
                // Get IP address for a domain
                IPAddressResult result = apiInstance.GetIpAddress(name);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MailServerControllerApi.GetIpAddress: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
namestringname

Return type

IPAddressResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

VerifyEmailAddress

EmailVerificationResult VerifyEmailAddress (VerifyEmailAddressOptions verifyOptions)

Verify the existence of an email address at a given mail server.

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;

namespace Example
{
    public class VerifyEmailAddressExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new MailServerControllerApi(config);
            var verifyOptions = new VerifyEmailAddressOptions(); // VerifyEmailAddressOptions | verifyOptions

            try
            {
                // Verify the existence of an email address at a given mail server.
                EmailVerificationResult result = apiInstance.VerifyEmailAddress(verifyOptions);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MailServerControllerApi.VerifyEmailAddress: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
verifyOptionsVerifyEmailAddressOptionsverifyOptions

Return type

EmailVerificationResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]