/ docs/ python/ docs/ MailServerControllerApi.html

mailslurp_client.MailServerControllerApi

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

Method	HTTP request	Description
describe_mail_server_domain	POST /mail-server/describe/domain	Get DNS Mail Server records for a domain
verify_email_address	POST /mail-server/verify/email-address	Verify the existence of an email address at a given mail server.

describe_mail_server_domain

DescribeMailServerDomainResult describe_mail_server_domain(describe_options)

Get DNS Mail Server records for a domain

Example

• Api Key Authentication (API_KEY):

from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.MailServerControllerApi(api_client)
    describe_options = mailslurp_client.DescribeDomainOptions() # DescribeDomainOptions | describeOptions
    try:
        # Get DNS Mail Server records for a domain
        api_response = api_instance.describe_mail_server_domain(describe_options)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MailServerControllerApi->describe_mail_server_domain: %s\n" % e)

Parameters

Name	Type	Description	Notes
describe_options	DescribeDomainOptions	describeOptions

Return type

DescribeMailServerDomainResult

Authorization

API_KEY

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]

verify_email_address

EmailVerificationResult verify_email_address(verify_options)

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

Example

• Api Key Authentication (API_KEY):

from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.MailServerControllerApi(api_client)
    verify_options = mailslurp_client.VerifyEmailAddressOptions() # VerifyEmailAddressOptions | verifyOptions
    try:
        # Verify the existence of an email address at a given mail server.
        api_response = api_instance.verify_email_address(verify_options)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MailServerControllerApi->verify_email_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
verify_options	VerifyEmailAddressOptions	verifyOptions

Return type

EmailVerificationResult

Authorization

API_KEY

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]