mailslurp
v15.17.22

MailSlurpAPI.Api.DomainController (mailslurp v15.17.22)

API calls for all endpoints tagged DomainController.

Summary

Functions

add_domain_wildcard_catch_all(connection, id, opts \\ [])

Add catch all wild card inbox to domain Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated

create_domain(connection, create_domain_options, opts \\ [])

Create Domain Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.

delete_domain(connection, id, opts \\ [])

Delete a domain Delete a domain. This will disable any existing inboxes that use this domain.

get_domain(connection, id, opts \\ [])

Get a domain Returns domain verification status and tokens for a given domain

get_domain_issues(connection, opts \\ [])

Get domain issues List domain issues for domains you have created

get_domain_wildcard_catch_all_inbox(connection, id, opts \\ [])

Get catch all wild card inbox for domain Get the catch all inbox for a domain for missed emails

get_domains(connection, opts \\ [])

Get domains List all custom domains you have created

update_domain(connection, id, update_domain_options, opts \\ [])

Update a domain Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.

Functions

Link to this function

add_domain_wildcard_catch_all(connection, id, opts \\ [])

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

Add catch all wild card inbox to domain Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

create_domain(connection, create_domain_options, opts \\ [])

@spec create_domain(
  Tesla.Env.client(),
  MailSlurpAPI.Model.CreateDomainOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.DomainDto.t()} | {:error, Tesla.Env.t()}

Create Domain Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

delete_domain(connection, id, opts \\ [])

@spec delete_domain(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [String.t()]} | {:error, Tesla.Env.t()}

Delete a domain Delete a domain. This will disable any existing inboxes that use this domain.

Parameters

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

Returns

, ...]} on success {:error, info} on failure

Link to this function

get_domain(connection, id, opts \\ [])

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

Get a domain Returns domain verification status and tokens for a given domain

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

get_domain_issues(connection, opts \\ [])

@spec get_domain_issues(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.DomainIssuesDto.t()} | {:error, Tesla.Env.t()}

Get domain issues List domain issues for domains you have created

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

get_domain_wildcard_catch_all_inbox(connection, id, opts \\ [])

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

Get catch all wild card inbox for domain Get the catch all inbox for a domain for missed emails

Parameters

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

Returns

} on success {:error, info} on failure

Link to this function

get_domains(connection, opts \\ [])

@spec get_domains(Tesla.Env.client(), keyword()) ::
  {:ok, [MailSlurpAPI.Model.DomainPreview.t()]} | {:error, Tesla.Env.t()}

Get domains List all custom domains you have created

Parameters

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

Returns

, ...]} on success {:error, info} on failure

Link to this function

update_domain(connection, id, update_domain_options, opts \\ [])

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

Update a domain Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.

Parameters

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

Returns

} on success {:error, info} on failure