# mailslurp.Api.MailServerControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
DescribeMailServerDomain | POST /mail-server/describe/domain | Get DNS Mail Server records for a domain |
GetDnsLookup | POST /mail-server/describe/dns-lookup | Lookup DNS records for a domain |
GetIpAddress | POST /mail-server/describe/ip-address | Get IP address for a domain |
VerifyEmailAddress | POST /mail-server/verify/email-address | Verify 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.Api;
using mailslurp.Client;
using mailslurp.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
Name | Type | Description | Notes |
---|---|---|---|
describeOptions | DescribeDomainOptions | describeOptions |
# Return type
DescribeMailServerDomainResult
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetDnsLookup
DNSLookupResults GetDnsLookup (DNSLookupOptions dnsLookupOptions)
Lookup DNS records for a domain
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.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
Name | Type | Description | Notes |
---|---|---|---|
dnsLookupOptions | DNSLookupOptions | dnsLookupOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetIpAddress
IPAddressResult GetIpAddress (string name)
Get IP address for a domain
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.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
Name | Type | Description | Notes |
---|---|---|---|
name | string | name |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# 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.Api;
using mailslurp.Client;
using mailslurp.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
Name | Type | Description | Notes |
---|---|---|---|
verifyOptions | VerifyEmailAddressOptions | verifyOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]