Skip to content

mailslurp.api.MailServerControllerApi

Load the API package

import 'package:mailslurp/api.dart';

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 Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.

DescribeMailServerDomainResult describeMailServerDomain(describeDomainOptions)

Get DNS Mail Server records for a domain

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = MailServerControllerApi();
final describeDomainOptions = DescribeDomainOptions(); // DescribeDomainOptions | 

try { 
    final result = api_instance.describeMailServerDomain(describeDomainOptions);
    print(result);
} catch (e) {
    print('Exception when calling MailServerControllerApi->describeMailServerDomain: $en');
}

Parameters

Name Type Description Notes
describeDomainOptions DescribeDomainOptions

Return type

DescribeMailServerDomainResult

Authorization

API_KEY

HTTP request headers

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

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

DNSLookupResults getDnsLookup(dNSLookupOptions)

Lookup DNS records for a domain

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = MailServerControllerApi();
final dNSLookupOptions = DNSLookupOptions(); // DNSLookupOptions | 

try { 
    final result = api_instance.getDnsLookup(dNSLookupOptions);
    print(result);
} catch (e) {
    print('Exception when calling MailServerControllerApi->getDnsLookup: $en');
}

Parameters

Name Type Description Notes
dNSLookupOptions DNSLookupOptions

Return type

DNSLookupResults

Authorization

API_KEY

HTTP request headers

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

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

IPAddressResult getIpAddress(name)

Get IP address for a domain

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = MailServerControllerApi();
final name = name_example; // String | 

try { 
    final result = api_instance.getIpAddress(name);
    print(result);
} catch (e) {
    print('Exception when calling MailServerControllerApi->getIpAddress: $en');
}

Parameters

Name Type Description Notes
name String

Return type

IPAddressResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

EmailVerificationResult verifyEmailAddress(verifyEmailAddressOptions)

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

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = MailServerControllerApi();
final verifyEmailAddressOptions = VerifyEmailAddressOptions(); // VerifyEmailAddressOptions | 

try { 
    final result = api_instance.verifyEmailAddress(verifyEmailAddressOptions);
    print(result);
} catch (e) {
    print('Exception when calling MailServerControllerApi->verifyEmailAddress: $en');
}

Parameters

Name Type Description Notes
verifyEmailAddressOptions VerifyEmailAddressOptions

Return type

EmailVerificationResult

Authorization

API_KEY

HTTP request headers

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

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