MailSlurp::MailServerControllerApi

Load the API package

use MailSlurp::Object::MailServerControllerApi;

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

MethodHTTP requestDescription
describe_mail_server_domainPOST /mail-server/describe/domainGet DNS Mail Server records for a domain
get_dns_lookupPOST /mail-server/describe/dns-lookupLookup DNS records for a domain
get_ip_addressPOST /mail-server/describe/ip-addressGet IP address for a domain
verify_email_addressPOST /mail-server/verify/email-addressVerify the existence of an email address at a given mail server.

describe_mail_server_domain

DescribeMailServerDomainResult describe_mail_server_domain(describe_options => $describe_options)

Get DNS Mail Server records for a domain

Example

use Data::Dumper;
use MailSlurp::MailServerControllerApi;
my $api_instance = MailSlurp::MailServerControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $describe_options = MailSlurp::Object::DescribeDomainOptions->new(); # DescribeDomainOptions | describeOptions

eval { 
    my $result = $api_instance->describe_mail_server_domain(describe_options => $describe_options);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MailServerControllerApi->describe_mail_server_domain: $@n";
}

Parameters

NameTypeDescriptionNotes
describe_optionsDescribeDomainOptionsdescribeOptions

Return type

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 ]

get_dns_lookup

DNSLookupResults get_dns_lookup(dns_lookup_options => $dns_lookup_options)

Lookup DNS records for a domain

Example

use Data::Dumper;
use MailSlurp::MailServerControllerApi;
my $api_instance = MailSlurp::MailServerControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $dns_lookup_options = MailSlurp::Object::DNSLookupOptions->new(); # DNSLookupOptions | dnsLookupOptions

eval { 
    my $result = $api_instance->get_dns_lookup(dns_lookup_options => $dns_lookup_options);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MailServerControllerApi->get_dns_lookup: $@n";
}

Parameters

NameTypeDescriptionNotes
dns_lookup_optionsDNSLookupOptionsdnsLookupOptions

Return type

DNSLookupResults

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 ]

get_ip_address

IPAddressResult get_ip_address(name => $name)

Get IP address for a domain

Example

use Data::Dumper;
use MailSlurp::MailServerControllerApi;
my $api_instance = MailSlurp::MailServerControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $name = "name_example"; # string | name

eval { 
    my $result = $api_instance->get_ip_address(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MailServerControllerApi->get_ip_address: $@n";
}

Parameters

NameTypeDescriptionNotes
namestringname

Return type

IPAddressResult

Authorization

API_KEY

HTTP request headers

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

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

verify_email_address

EmailVerificationResult verify_email_address(verify_options => $verify_options)

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

Example

use Data::Dumper;
use MailSlurp::MailServerControllerApi;
my $api_instance = MailSlurp::MailServerControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $verify_options = MailSlurp::Object::VerifyEmailAddressOptions->new(); # VerifyEmailAddressOptions | verifyOptions

eval { 
    my $result = $api_instance->verify_email_address(verify_options => $verify_options);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MailServerControllerApi->verify_email_address: $@n";
}

Parameters

NameTypeDescriptionNotes
verify_optionsVerifyEmailAddressOptionsverifyOptions

Return type

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 ]