# MailSlurp\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
verifyEmailAddress POST /mail-server/verify/email-address Verify the existence of an email address at a given mail server.

# describeMailServerDomain

\MailSlurp\Models\DescribeMailServerDomainResult describeMailServerDomain($describe_options)

Get DNS Mail Server records for a domain

# Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: API_KEY
$config = MailSlurp\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new MailSlurp\Api\MailServerControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$describe_options = new \MailSlurp\Models\DescribeDomainOptions(); // \MailSlurp\Models\DescribeDomainOptions | describeOptions
try {
    $result = $apiInstance->describeMailServerDomain($describe_options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailServerControllerApi->describeMailServerDomain: ', $e->getMessage(), PHP_EOL;
}
?>

# Parameters

Name Type Description Notes
describe_options \MailSlurp\Models\DescribeDomainOptions describeOptions

# Return type

\MailSlurp\Models\DescribeMailServerDomainResult

# Authorization

API_KEY

# HTTP request headers

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

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

# verifyEmailAddress

\MailSlurp\Models\EmailVerificationResult verifyEmailAddress($verify_options)

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

# Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: API_KEY
$config = MailSlurp\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new MailSlurp\Api\MailServerControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$verify_options = new \MailSlurp\Models\VerifyEmailAddressOptions(); // \MailSlurp\Models\VerifyEmailAddressOptions | verifyOptions
try {
    $result = $apiInstance->verifyEmailAddress($verify_options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailServerControllerApi->verifyEmailAddress: ', $e->getMessage(), PHP_EOL;
}
?>

# Parameters

Name Type Description Notes
verify_options \MailSlurp\Models\VerifyEmailAddressOptions verifyOptions

# Return type

\MailSlurp\Models\EmailVerificationResult

# Authorization

API_KEY

# HTTP request headers

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

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