mailslurp
v15.17.22

MailSlurpAPI.Api.MailServerController (mailslurp v15.17.22)

API calls for all endpoints tagged MailServerController.

Summary

Functions

describe_mail_server_domain(connection, describe_domain_options, opts \\ [])

Get DNS Mail Server records for a domain

get_dns_lookup(connection, dns_lookup_options, opts \\ [])

Lookup DNS records for a domain

get_ip_address(connection, name, opts \\ [])

Get IP address for a domain

verify_email_address(connection, verify_email_address_options, opts \\ [])

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

Functions

Link to this function

describe_mail_server_domain(connection, describe_domain_options, opts \\ [])

@spec describe_mail_server_domain(
  Tesla.Env.client(),
  MailSlurpAPI.Model.DescribeDomainOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.DescribeMailServerDomainResult.t()}
  | {:error, Tesla.Env.t()}

Get DNS Mail Server records for a domain

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • describe_domain_options (DescribeDomainOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

get_dns_lookup(connection, dns_lookup_options, opts \\ [])

@spec get_dns_lookup(
  Tesla.Env.client(),
  MailSlurpAPI.Model.DnsLookupOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.DnsLookupResults.t()} | {:error, Tesla.Env.t()}

Lookup DNS records for a domain

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • dns_lookup_options (DnsLookupOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

get_ip_address(connection, name, opts \\ [])

@spec get_ip_address(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.IpAddressResult.t()} | {:error, Tesla.Env.t()}

Get IP address for a domain

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • name (String.t):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

verify_email_address(connection, verify_email_address_options, opts \\ [])

@spec verify_email_address(
  Tesla.Env.client(),
  MailSlurpAPI.Model.VerifyEmailAddressOptions.t(),
  keyword()
) ::
  {:ok, MailSlurpAPI.Model.EmailVerificationResult.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • verify_email_address_options (VerifyEmailAddressOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure